org.modeshape.jcr.security.acl

Class JcrAccessControlList

java.lang.Object

org.modeshape.jcr.security.acl.JcrAccessControlList

All Implemented Interfaces:

javax.jcr.security.AccessControlList, javax.jcr.security.AccessControlPolicy

public class JcrAccessControlList
extends Object
implements javax.jcr.security.AccessControlList

Resources based Access Control List implementation. ACLs are stored per node in a special child node called mode:acl. This node has a list of mode:{$principal_name} child nodes which has multi-value property permissions. Permissions are defined by JCR specifications.

 {node} {mode:AccessControllable}
  +mode:acl {mode:Acl}
    +user-name {mode:permission}
       -permissions {String}
 

Constructor Summary

Constructors

Constructor and Description
JcrAccessControlList(String path) Creates new empty access control list.

Method Summary

Modifier and Type	Method and Description
boolean	addAccessControlEntry(Principal principal, javax.jcr.security.Privilege[] privileges)
static JcrAccessControlList	defaultAcl(AccessControlManagerImpl acm) Creates default Access Control List.
boolean	equals(Object other)
javax.jcr.security.AccessControlEntry[]	getAccessControlEntries()
javax.jcr.security.Privilege[]	getPrivileges(SecurityContext context) Lists all privileges defined by this access list for the given user.
boolean	hasEntry(String name)
int	hashCode()
boolean	hasPrivileges(SecurityContext sc, javax.jcr.security.Privilege[] privileges) Tests privileges relatively to the given security context.
boolean	isEmpty() Checks entries of this access control list.
void	removeAccessControlEntry(javax.jcr.security.AccessControlEntry accessControlEntry)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JcrAccessControlList

public JcrAccessControlList(String path)

Creates new empty access control list.

Parameters:

path - the path to which this access list is applied.

Method Detail

defaultAcl

public static JcrAccessControlList defaultAcl(AccessControlManagerImpl acm)

Creates default Access Control List.

Parameters:

acm - access control manager instance

Returns:

Access Control List with all permissions granted to everyone.

isEmpty

public boolean isEmpty()

Checks entries of this access control list.

Returns:

true if this access list does not have entries and false otherwise.

getAccessControlEntries

public javax.jcr.security.AccessControlEntry[] getAccessControlEntries()

Specified by:

getAccessControlEntries in interface javax.jcr.security.AccessControlList

addAccessControlEntry

public boolean addAccessControlEntry(Principal principal,
                                     javax.jcr.security.Privilege[] privileges)
                              throws javax.jcr.security.AccessControlException,
                                     javax.jcr.RepositoryException

Specified by:

addAccessControlEntry in interface javax.jcr.security.AccessControlList

Throws:

javax.jcr.security.AccessControlException

javax.jcr.RepositoryException

removeAccessControlEntry

public void removeAccessControlEntry(javax.jcr.security.AccessControlEntry accessControlEntry)
                              throws javax.jcr.security.AccessControlException,
                                     javax.jcr.RepositoryException

Specified by:

removeAccessControlEntry in interface javax.jcr.security.AccessControlList

Throws:

javax.jcr.security.AccessControlException

javax.jcr.RepositoryException

hasPrivileges

public boolean hasPrivileges(SecurityContext sc,
                             javax.jcr.security.Privilege[] privileges)

Tests privileges relatively to the given security context.

Parameters:

sc - security context carrying information about principals

privileges - privileges for test

Returns:

true when access list grants all given privileges within given security context.

getPrivileges

public javax.jcr.security.Privilege[] getPrivileges(SecurityContext context)

Lists all privileges defined by this access list for the given user.

Parameters:

context - the security context of the user; never null

Returns:

list of privilege objects.

hasEntry

public boolean hasEntry(String name)

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object