com.sap.netweaver.bc.rf.common.security.acl
Interface IAclEntry

[contained in: com.sap.netweaver.bc.rf.par - bc.rf.common_api.jar]

public interface IAclEntry

Interface describing an access control list entry, short ACL entry. Each resource may have an ACL with many ACL entries. An entry describes for one principal (may be a user, group or whatever is considered an entity) a permission this principal has on the given resource. The ACL itself is just an envelope for many ACL entries.

An ACL entry may define a permission this principal has on the given resource, but it may also define a permission a principal is denied to have (so called negative ACL entry).

ACLs are propagated down from above the resource hierarchy on the fly, i.e. they are not really set on the descendants but derived when accessed. All descendants not having an own ACL inherit one from their next legator having one. Legators are ancestors responsible for the security permissions of their descendants.

Method Summary

boolean	checkPermission(IAclPermission permission) Check whether or not the given permission is covered by this ACL entry.
IAclPermission	getPermission() Get permission of the ACL entry.
com.sap.netweaver.bc.rf.common.security.acl.IPrincipal	getPrincipal() Get principal of the ACL entry.
int	getSortIndex() get the sort index of the ACL entry - the sequence of the ACEs in the ACL is controlled by the sort indices - the sequence is only relevant if the IResourceAclManager supports negative ACEs (check with the areNegativeAclEntriesSupported() method)
boolean	isNegative() Check whether or not this ACL entry denies its permission.
boolean	isReadOnly() Check wether or not the ACL entry is read only.
void	setSortIndex(int sortIndex) set the sort index of the ACL entry

Method Detail

getPrincipal

public com.sap.netweaver.bc.rf.common.security.acl.IPrincipal getPrincipal()
                                                                    throws AclPersistenceException

Get principal of the ACL entry.

Returns:

principal of the ACL entry

Throws:

AclPersistenceException - when a problem with the storage where the ACLs are persisted occurred

checkPermission

public boolean checkPermission(IAclPermission permission)
                        throws AclPersistenceException

Check whether or not the given permission is covered by this ACL entry.

Parameters:

permission - permission to be checked

Returns:

true if the given permission is covered by this ACL entry

Throws:

AclPersistenceException - when a problem with the storage where the ACLs are persisted occurred

getPermission

public IAclPermission getPermission()
                             throws AclPersistenceException

Get permission of the ACL entry.

Returns:

permission of the ACL entry

Throws:

AclPersistenceException - when a problem with the storage where the ACLs are persisted occurred

getSortIndex

public int getSortIndex()
                 throws AclPersistenceException

get the sort index of the ACL entry - the sequence of the ACEs in the ACL is controlled by the sort indices - the sequence is only relevant if the IResourceAclManager supports negative ACEs (check with the areNegativeAclEntriesSupported() method)

Returns:

the sort index

Throws:

AclPersistenceException - a problem with the storage where the ACLs are persisted occurred

setSortIndex

public void setSortIndex(int sortIndex)
                  throws AclPersistenceException,
                         AclNotAuthorizedException

set the sort index of the ACL entry

Parameters:

sortIndex - sort index

Throws:

AclPersistenceException - a problem with the storage where the ACLs are persisted occurred

AclNotAuthorizedException - Exception raised in failure situation

isNegative

public boolean isNegative()
                   throws AclPersistenceException

Check whether or not this ACL entry denies its permission.

Returns:

true if this ACL entry denies its permission

Throws:

AclPersistenceException - when a problem with the storage where the ACLs are persisted occurred

isReadOnly

public boolean isReadOnly()
                   throws AclPersistenceException

Check wether or not the ACL entry is read only.

Returns:

true if the ACL entry is read only

Throws:

AclPersistenceException - when a problem with the storage where the ACLs are persisted occurred