com.sapportals.wcm.repository.security
Interface IResourceAclEntry

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

All Known Subinterfaces:

IResourceAclEntryRaw

public interface IResourceAclEntry

An IResourceAclEntry is a wrapper for an IAclEntry which passes the user in the resource context of the belonging IResourceAcl as 'callers' to IAclEntry methods 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 - the sequence is only relevant if the IResourceAclManager supports negative ACEs (check with the areNegativeAclEntriesSupported() method)
boolean	isNegative() check whether the ACE denies its permission
boolean	isReadOnly() check wether the ACE is read only
void	setSortIndex(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,
                               InvalidClassException

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

Parameters:

permission - the permission

Returns:

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

Throws:

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

InvalidClassException - the permission was created by a foreign resource IResourceAclManager

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

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

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 - 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,
                         NotAuthorizedException

set the sort index of the ACE

Parameters:

sortIndex - sortIndex to be set

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