com.centrasite.jaxr.security
Interface CentraSiteACE


public interface CentraSiteACE

A CentraSiteACE represents one access control element as part of a CentraSiteACL. It corresponds to a WebDAV ACE element. A CentraSiteACE maintains Principal and Privilege information. By default, the privileges are granted (vs. denied). WebDAV also has "protected" and "inherited" attributes, however these are currently not supported by the CentraSite XML server.


Method Summary
 void addPrivilege(CentraSitePrivilege privilege)
          Add a privilege.
 CentraSitePrincipal getPrincipal()
          Get the principal.
 java.util.Collection getPrivileges()
          Get the privileges.
 boolean isGrant()
          Returns true, if the privileges of this ACE are all granted, and false if the privileges of this ACE are all denied.
 void removePrivilege(CentraSitePrivilege privilege)
          Remove a privilege.
 void setGrant(boolean grant)
          Set whether the privileges of this ACE are granted (grant=true) or denied (grant=false)
 void setOwnerObject(CentraSiteACL owner)
          Set this CentraSiteACE's owner object
 void setPrincipal(CentraSitePrincipal principal)
          Set the principal.
 void setPrincipal(javax.xml.namespace.QName principal)
          Set the principal.
 

Method Detail

setPrincipal

void setPrincipal(CentraSitePrincipal principal)
Set the principal.

Parameters:
principal - the principal

setPrincipal

void setPrincipal(javax.xml.namespace.QName principal)
Set the principal.

Parameters:
principal - the principal

getPrincipal

CentraSitePrincipal getPrincipal()
Get the principal.

Returns:
the principal

addPrivilege

void addPrivilege(CentraSitePrivilege privilege)
Add a privilege.

Parameters:
privilege - a privilege

removePrivilege

void removePrivilege(CentraSitePrivilege privilege)
Remove a privilege.

Parameters:
privilege - the privilege to be removed

getPrivileges

java.util.Collection getPrivileges()
Get the privileges.

Returns:
the collection of privileges, maybe empty but not null

setGrant

void setGrant(boolean grant)
Set whether the privileges of this ACE are granted (grant=true) or denied (grant=false)

Parameters:
grant - true to grant, false to deny

isGrant

boolean isGrant()
Returns true, if the privileges of this ACE are all granted, and false if the privileges of this ACE are all denied.

Returns:
true if the privileges are granted, false if the privileges are denied

setOwnerObject

void setOwnerObject(CentraSiteACL owner)
Set this CentraSiteACE's owner object

Parameters:
owner - this CentraSiteACE's owner object, maybe null