Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> acegisecurity >> acl >> [ basic overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.acegisecurity.acl.basic
Interface BasicAclEntry  

All Superinterfaces:

org.acegisecurity.acl.AclEntry, java.io.Serializable

All Known Implementing Classes:

AbstractBasicAclEntry

---

public interface BasicAclEntry

extends org.acegisecurity.acl.AclEntry

Represents an entry in an access control list.

Version:

$Id: BasicAclEntry.java,v 1.3 2005/11/17 00:55:47 benalex Exp $

---

Method Summary
AclObjectIdentity	getAclObjectIdentity()           Indicates the domain object instance that is subject of this BasicAclEntry.
AclObjectIdentity	getAclObjectParentIdentity()           Indicates any ACL parent of the domain object instance.
int	getMask()           Access control lists in this package are based on bit masking.
java.lang.Object	getRecipient()           A domain object instance will usually have multiple BasicAclEntrys.
boolean	isPermitted(int permissionToCheck)           Determine if the mask of this entry includes this permission or not
void	setAclObjectIdentity(AclObjectIdentity aclObjectIdentity)           This setter should only be used by DAO implementations.
void	setAclObjectParentIdentity(AclObjectIdentity aclObjectParentIdentity)           This setter should only be used by DAO implementations.
void	setMask(int mask)           This setter should only be used by DAO implementations.
void	setRecipient(java.lang.Object recipient)           This setter should only be used by DAO implementations.

 

Method Detail

setAclObjectIdentity

public void setAclObjectIdentity(AclObjectIdentity aclObjectIdentity)

This setter should only be used by DAO implementations.

---

getAclObjectIdentity

public AclObjectIdentity getAclObjectIdentity()

Indicates the domain object instance that is subject of this BasicAclEntry. This information may be of interest to relying classes (voters and business methods) that wish to know the actual origination of the ACL entry (so as to distinguish individual ACL entries from others contributed by the inheritance hierarchy).

---

setAclObjectParentIdentity

public void setAclObjectParentIdentity(AclObjectIdentity aclObjectParentIdentity)

This setter should only be used by DAO implementations.

---

getAclObjectParentIdentity

public AclObjectIdentity getAclObjectParentIdentity()

Indicates any ACL parent of the domain object instance. This is used by BasicAclProvider to walk the inheritance hierarchy. An domain object instance need not have a parent.

---

setMask

public void setMask(int mask)

This setter should only be used by DAO implementations.

---

getMask

public int getMask()

Access control lists in this package are based on bit masking. The integer value of the bit mask can be obtained from this method.

---

setRecipient

public void setRecipient(java.lang.Object recipient)

This setter should only be used by DAO implementations.

---

getRecipient

public java.lang.Object getRecipient()

A domain object instance will usually have multiple BasicAclEntrys. Each separate BasicAclEntry applies to a particular "recipient". Typical examples of recipients include (but do not necessarily have to include) usernames, role names, complex granted authorities etc.

It is essential that only one BasicAclEntry exists for a given recipient. Otherwise conflicts as to the mask that should apply to a given recipient will occur.

This method indicates which recipient this BasicAclEntry applies to. The returned object type will vary depending on the type of recipient. For instance, it might be a String containing a username, or a GrantedAuthorityImpl containing a complex granted authority that is being granted the permissions contained in this access control entry. The EffectiveAclsResolver and BasicAclProvider.getAcls(Object, Authentication) 55 can process the different recipient types and return only those that apply to a specified Authentication object.

---

isPermitted

public boolean isPermitted(int permissionToCheck)

Determine if the mask of this entry includes this permission or not

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> acegisecurity >> acl >> [ basic overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---