org.exoplatform.services.jcr.access

Class AccessControlList

java.lang.Object

org.exoplatform.services.jcr.access.AccessControlList

All Implemented Interfaces:

Externalizable, Serializable

public class AccessControlList
extends Object
implements Externalizable

Created by The eXo Platform SAS
The AccessControlList represents a list of access control entries.

Version:

$Id: AccessControlList.java 14556 2008-05-21 15:22:15Z pnedonosko $

Author:

Gennady Azarenkov

See Also:

Serialized Form

Level API:

Experimental

Field Summary

Fields

Modifier and Type	Field and Description
static String	DELIMITER

Constructor Summary

Constructors

Constructor and Description
AccessControlList()
AccessControlList(String owner, List<AccessControlEntry> accessList) Create ACL from owner name and collection of permission entries.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPermissions(String rawData) Adds permissions
void	addPermissions(String identity, String[] perm) Adds a set of permission types to a given identity
String	dump() Gives a String representation of the AccessControlList with all the details
boolean	equals(Object obj)
String	getOwner() Get owner.
List<AccessControlEntry>	getPermissionEntries() Gives all the permission entries
List<String>	getPermissions(String identity)
int	getPermissionsSize() Gives access to the size of existing permissions.
boolean	hasOwner()
boolean	hasPermissions()
void	readExternal(ObjectInput in)
void	removePermissions(String identity) Removes all the permissions of a given identity
void	removePermissions(String identity, String permission) Removes the permission corresponding to the given identity and the given permission type
void	setOwner(String owner) Sets owner.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

DELIMITER

public static final String DELIMITER

See Also:

Constant Field Values

Constructor Detail

AccessControlList

public AccessControlList()

AccessControlList

public AccessControlList(String owner,
                 List<AccessControlEntry> accessList)

Create ACL from owner name and collection of permission entries.

Parameters:

owner -

accessList - - permission entries

Method Detail

hasPermissions

public boolean hasPermissions()

Returns:

returns true if the permission list has been set, false otherwise

hasOwner

public boolean hasOwner()

Returns:

returns true if the owner has been set, false otherwise

addPermissions

public void addPermissions(String rawData)
                    throws javax.jcr.RepositoryException

Adds permissions

Parameters:

rawData - A semicolon separated string representing the list of permission entries to add, knowing that the syntax of a permission entry is ${identity} [read|add_node|set_property|remove]

Throws:

javax.jcr.RepositoryException

addPermissions

public void addPermissions(String identity,
                  String[] perm)
                    throws javax.jcr.RepositoryException

Adds a set of permission types to a given identity

Parameters:

identity - the member identity

perm - an array of permission types to add

Throws:

javax.jcr.RepositoryException

removePermissions

public void removePermissions(String identity)

Removes all the permissions of a given identity

Parameters:

identity - the member identity

removePermissions

public void removePermissions(String identity,
                     String permission)

Removes the permission corresponding to the given identity and the given permission type

Parameters:

identity - the member identity

permission - the permission type

getOwner

public String getOwner()

Get owner.

Returns:

Returns the owner.

setOwner

public void setOwner(String owner)

Sets owner.

Parameters:

owner - the owner

getPermissionEntries

public List<AccessControlEntry> getPermissionEntries()

Gives all the permission entries

Returns:

a safe copy of all the permission entries

getPermissions

public List<String> getPermissions(String identity)

Parameters:

identity - the member identity

Returns:

returns the list of all the permission types associated to the given identity

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

dump

public String dump()

Gives a String representation of the AccessControlList with all the details

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

getPermissionsSize

public int getPermissionsSize()

Gives access to the size of existing permissions.

Returns:

size of access list