info.magnolia.security.app.dialog.field

Class AccessControlList<E extends AccessControlList.Entry>

java.lang.Object

info.magnolia.security.app.dialog.field.AccessControlList<E>

Type Parameters:

E - the type of Access Control Entries (ACEs) managed by this list.

Direct Known Subclasses:

WorkspaceAccessControlList

public class AccessControlList<E extends AccessControlList.Entry>
extends Object

A simple ACL representation reading entries from, and saving them to a given JCR node. Entries simply consist of a permission value and a path.

See Also:

WebAccessFieldFactory

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AccessControlList.Entry An entry in the access control list.
static class	AccessControlList.EntryKey Deprecated. since 5.4.8, equality is implemented on the entry directly, while same-key merging logic was moved to the more specific WorkspaceAccessControlList

Field Summary

Fields

Modifier and Type	Field and Description
static long	ACCESS_TYPE_CHILDREN Deprecated. since 5.4.8, moved to WorkspaceAccessControlList.ACCESS_TYPE_CHILDREN
static long	ACCESS_TYPE_NODE Deprecated. since 5.4.8, moved to WorkspaceAccessControlList.ACCESS_TYPE_NODE
static long	ACCESS_TYPE_NODE_AND_CHILDREN Deprecated. since 5.4.8, moved to WorkspaceAccessControlList.ACCESS_TYPE_NODE_AND_CHILDREN
static String	PATH_PROPERTY_NAME Deprecated. since 5.4.8, intended for internal usage only (package visibility)
static String	PERMISSIONS_PROPERTY_NAME Deprecated. since 5.4.8, intended for internal usage only (package visibility)

Constructor Summary

Constructors

Constructor and Description
AccessControlList()

Method Summary

Modifier and Type	Method and Description
void	addEntry(E entry)
protected Collection<E>	createEntries(javax.jcr.Node aclNode)
protected E	createEntry(javax.jcr.Node entryNode) Default implementation simply retrieves the path and permissions values from corresponding JCR properties, and delegates entry construction to doCreateRawEntry(long, String).
protected E	doCreateRawEntry(long permissions, String path) Subclasses of AccessControlList may override this to create their own specialized Entries.
Collection<E>	getEntries()
AccessControlList.Entry	getEntryByNode(javax.jcr.Node entryNode) Deprecated. since 5.4.8, replaced by createEntry(Node) and doCreateRawEntry(long, String)
void	readEntries(javax.jcr.Node aclNode) Initializes this AccessControlList by reading existing entries from the given ACL node.
void	readEntry(javax.jcr.Node entryNode) Deprecated. since 5.4.8, replaced by addEntry(Entry) and createEntry(Node)
void	removeEntry(E entry)
void	saveEntries(javax.jcr.Node aclNode) Saves entries of this AccessControlList (back) to the given ACL node.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PATH_PROPERTY_NAME

@Deprecated
public static final String PATH_PROPERTY_NAME

Deprecated. since 5.4.8, intended for internal usage only (package visibility)

See Also:

Constant Field Values

PERMISSIONS_PROPERTY_NAME

@Deprecated
public static final String PERMISSIONS_PROPERTY_NAME

Deprecated. since 5.4.8, intended for internal usage only (package visibility)

See Also:

Constant Field Values

ACCESS_TYPE_NODE

@Deprecated
public static final long ACCESS_TYPE_NODE

Deprecated. since 5.4.8, moved to WorkspaceAccessControlList.ACCESS_TYPE_NODE

See Also:

Constant Field Values

ACCESS_TYPE_CHILDREN

@Deprecated
public static final long ACCESS_TYPE_CHILDREN

Deprecated. since 5.4.8, moved to WorkspaceAccessControlList.ACCESS_TYPE_CHILDREN

See Also:

Constant Field Values

ACCESS_TYPE_NODE_AND_CHILDREN

@Deprecated
public static final long ACCESS_TYPE_NODE_AND_CHILDREN

Deprecated. since 5.4.8, moved to WorkspaceAccessControlList.ACCESS_TYPE_NODE_AND_CHILDREN

See Also:

Constant Field Values

Constructor Detail

AccessControlList

public AccessControlList()

Method Detail

getEntries

public Collection<E> getEntries()

addEntry

public void addEntry(E entry)

removeEntry

public void removeEntry(E entry)

readEntries

public void readEntries(javax.jcr.Node aclNode)
                 throws javax.jcr.RepositoryException

Initializes this AccessControlList by reading existing entries from the given ACL node.

Parameters:

aclNode - the JCR node corresponding to the given ACL, usually named acl_<foobar>

Throws:

javax.jcr.RepositoryException

createEntries

protected Collection<E> createEntries(javax.jcr.Node aclNode)
                               throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

createEntry

protected E createEntry(javax.jcr.Node entryNode)
                 throws javax.jcr.RepositoryException

Default implementation simply retrieves the path and permissions values from corresponding JCR properties, and delegates entry construction to doCreateRawEntry(long, String).

Throws:

javax.jcr.RepositoryException

doCreateRawEntry

protected E doCreateRawEntry(long permissions,
                             String path)

Subclasses of AccessControlList may override this to create their own specialized Entries.

saveEntries

public void saveEntries(javax.jcr.Node aclNode)
                 throws javax.jcr.RepositoryException

Saves entries of this AccessControlList (back) to the given ACL node.

Parameters:

aclNode - the JCR node corresponding to the given ACL, usually named acl_<foobar>

Throws:

javax.jcr.RepositoryException

readEntry

@Deprecated
public void readEntry(javax.jcr.Node entryNode)
                           throws javax.jcr.RepositoryException

Deprecated. since 5.4.8, replaced by addEntry(Entry) and createEntry(Node)

Throws:

javax.jcr.RepositoryException

getEntryByNode

@Deprecated
public AccessControlList.Entry getEntryByNode(javax.jcr.Node entryNode)
                                                   throws javax.jcr.RepositoryException

Deprecated. since 5.4.8, replaced by createEntry(Node) and doCreateRawEntry(long, String)

Throws:

javax.jcr.RepositoryException