com.sssw.fw.security.api
Interface EbiAcl

All Superinterfaces:

Acl, Owner

public interface EbiAcl

extends Acl

This provides an interface for security Acl provided by the Director's security service.

Method Summary

EbiAcl	copy(EbiContext context, String[] rights) Gets a copy of this instance with subset of required permissions
void	fromXML(EbiContext context, Node node) Populates this acl instance with values from an XML Node describing an Acl per framework-acl_3_0.dtd.
void	fromXML(EbiContext context, String xml) Populates this acl instance with values from an XML String describing an Acl per framework-acl_3_0.dtd.
String[]	getRestrictedAclPermissions() Gets a list of access right permissions that are set to be retricted.
boolean	isAclPermissionRestricted(String right) Checks to see if an access right permission is set to be restricted.
void	resetAclPremission(String right) Reset an access right permission to be unrestricted.
void	setElementType(String elementType) Sets the element type.
void	setRestrictedAclPermission(String right) Sets an access right permission that carries acl.
Document	toXML(EbiContext context) Gets a DOM object from this acl object.

Methods implemented from interface java.security.acl.Acl

addEntry, checkPermission, entries, getName, getPermissions, removeEntry, setName, toString

Methods implemented from interface java.security.acl.Owner

addOwner, deleteOwner, isOwner

Method Detail

copy

public EbiAcl copy(EbiContext context,
                   String[] rights)

Gets a copy of this instance with subset of required permissions

Parameters:

context - an EbiContext object.

rights - a list of rights that are needed by the copy.

Returns:

a cloned acl with only specified permissions.

fromXML

public void fromXML(EbiContext context,
                    String xml)

Populates this acl instance with values from an XML String describing an Acl per framework-acl_3_0.dtd. This operation is only allowed if this instance contains no acl entries. Otherwise, an exception will be thrown.

Parameters:

context - an EbiContext object.

xml - an XML String.

fromXML

public void fromXML(EbiContext context,
                    Node node)

Populates this acl instance with values from an XML Node describing an Acl per framework-acl_3_0.dtd. This operation is only allowed if this instance contains no acl entries. Otherwise, an exception will be thrown.

Parameters:

context - an EbiContext object.

node - a XML node.

toXML

public Document toXML(EbiContext context)

Gets a DOM object from this acl object.

Parameters:

context - an EbiContext object.

Returns:

the Document object that contains acl information.

getRestrictedAclPermissions

public String[] getRestrictedAclPermissions()

Gets a list of access right permissions that are set to be retricted.

Returns:

a list of permissions that are restricted.

isAclPermissionRestricted

public boolean isAclPermissionRestricted(String right)

Checks to see if an access right permission is set to be restricted.

Parameters:

right - an access right permission.

Returns:

true if the specified permission is set to be restricted, false otherwise.

setRestrictedAclPermission

public void setRestrictedAclPermission(String right)

Sets an access right permission that carries acl.

Parameters:

right - an access right permission.

resetAclPremission

public void resetAclPremission(String right)

Reset an access right permission to be unrestricted.

Parameters:

right - an access right permission.

setElementType

public void setElementType(String elementType)

Sets the element type.

Parameters:

elementType - an element type.