com.sapportals.wcm.util.acl
Interface IAclEntry

[contained in: com.sap.netweaver.bc.util.par - bc.util.public_api.jar]

All Known Subinterfaces:

IAclEntryRaw

public interface IAclEntry

An IAclEntry is an entry in an IAcl which grants or denies a permission to a specific principal.
Abbreviations:

• ACL: Access Control List
• ACE: Access Control List Entry

Method Summary

boolean	checkPermission(IAclPermission permission) check whether some permission is covered by the permission of the ACE
IAclPermission	getPermission() get the permission of the ACE
com.sapportals.portal.security.usermanagement.IUMPrincipal	getPrincipal() get the principal of the ACE
int	getSortIndex() get the sort index of the ACE - the sequence of the ACEs in the ACL is controlled by the sort indices
boolean	isNegative() check whether the ACE denies its permission
boolean	isPropagated() get the propagation flag of the ACE - propagation is no task of the basic acl package - only the flag is persisted
boolean	isReadOnly() check wether the ACE is read only
void	setPropagation(com.sapportals.portal.security.usermanagement.IUMPrincipal caller, boolean propagate) set the propagation flag of the ACE - propagation is no task of the basic acl package - only the flag is persisted
void	setSortIndex(com.sapportals.portal.security.usermanagement.IUMPrincipal caller, int sortIndex) set the sort index of the ACE

Method Detail

getPermission

public IAclPermission getPermission()
                             throws AclPersistenceException

get the permission of the ACE

Returns:

the permission

Throws:

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

checkPermission

public boolean checkPermission(IAclPermission permission)
                        throws AclPersistenceException

check whether some permission is covered by the permission of the ACE

Parameters:

permission - the permission

Returns:

true iff all actions of the permission are contained in the permission of the ACE

Throws:

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

isNegative

public boolean isNegative()
                   throws AclPersistenceException

check whether the ACE denies its permission

Returns:

true iff the ACE denies its permission

Throws:

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

getPrincipal

public com.sapportals.portal.security.usermanagement.IUMPrincipal getPrincipal()
                                                                        throws AclPersistenceException

get the principal of the ACE

Returns:

the principal of the ACE

Throws:

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

getSortIndex

public int getSortIndex()
                 throws AclPersistenceException

get the sort index of the ACE - the sequence of the ACEs in the ACL is controlled by the sort indices

Returns:

the sort index

Throws:

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

setSortIndex

public void setSortIndex(com.sapportals.portal.security.usermanagement.IUMPrincipal caller,
                         int sortIndex)
                  throws AclPersistenceException,
                         NotAuthorizedException

set the sort index of the ACE

Parameters:

caller - the caller which must be an owner of the ACL the ACE is assigned to (may be null in case it is not assigned yet)

sortIndex - the new sort index

Throws:

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

NotAuthorizedException - the user in the resource context of the belonging ACL is not an owner of the ACL

isPropagated

public boolean isPropagated()
                     throws AclPersistenceException

get the propagation flag of the ACE - propagation is no task of the basic acl package - only the flag is persisted

Returns:

the propagation flag of the ACE

Throws:

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

setPropagation

public void setPropagation(com.sapportals.portal.security.usermanagement.IUMPrincipal caller,
                           boolean propagate)
                    throws AclPersistenceException,
                           NotAuthorizedException

set the propagation flag of the ACE - propagation is no task of the basic acl package - only the flag is persisted

Parameters:

caller - the caller which must be an owner of the ACL the ACE is assigned to (may be null in case it is not assigned yet)

propagate - the propagation flag

Throws:

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

NotAuthorizedException - Exception raised in failure situation

isReadOnly

public boolean isReadOnly()
                   throws AclPersistenceException

check wether the ACE is read only

Returns:

true iff the ACE is read only

Throws:

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