com.adobe.repository.infomodel.bean
Class AccessControlList

java.lang.Object
  extended by com.adobe.repository.infomodel.bean.AccessControlList
All Implemented Interfaces:
java.io.Serializable

public class AccessControlList
extends java.lang.Object
implements java.io.Serializable

Access Control List (ACL) is a data structure that guards access to repository resources. An Access Control List contains multiple ACL entries. Each ACL entry, of type AccessControlEntry, contains a set of permissions associated with a particular user.

See Also:
Serialized Form

Field Summary
static short PROPAGATION_MODE_CONTAINED_FILES_ONLY
          When writing the ACL for a ResourceCollection this propagation mode means that any child Resources in the specified ResourceCollection that are not ResourceCollection objects themselves will have their ACL updated
static short PROPAGATION_MODE_DEFER_TO_PROPAGATE
          Default value.
static short PROPAGATION_MODE_NONE
          Used to specify that the ACL should be written for the specified ResourceCollection only and that no child Resources should have their ACL updated
static short PROPAGATION_MODE_RECURSIVE
          When writing the ACL for a ResourceCollection this propagation mode means that all child Resources with the specified root path will have their ACL updated
 
Constructor Summary
AccessControlList()
          Default constructor.
 
Method Summary
 java.lang.String getAclId()
          Retrieves the ACL identifier for this ACL object.
 java.util.List getEntries()
          Retrieves the entries that make up this ACL object.
 java.util.List getPermissionsForUser(java.lang.String user)
          Retrieves the permissions for the specified user.
 java.util.List getUsersWithPermissions()
          Retrieves the users having access permissions.
 void removeUserAndPermissions(java.lang.String user)
          Removes the specified user and his permissions.
 void setAclId(java.lang.String aclId)
          Sets the ACL identifier for this ACL object.
 void setEntries(java.util.List entries)
          Sets the entries that make up this ACL object.
 void setPermissionsForUser(java.lang.String user, java.util.List permissions)
          Sets the specified permissions for the user.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROPAGATION_MODE_DEFER_TO_PROPAGATE

public static final short PROPAGATION_MODE_DEFER_TO_PROPAGATE
Default value. Used by clients to indicate that the deprecated boolean propagate flag should be used to determine the propagation mode when ACLs are written

See Also:
Constant Field Values

PROPAGATION_MODE_NONE

public static final short PROPAGATION_MODE_NONE
Used to specify that the ACL should be written for the specified ResourceCollection only and that no child Resources should have their ACL updated

See Also:
Constant Field Values

PROPAGATION_MODE_CONTAINED_FILES_ONLY

public static final short PROPAGATION_MODE_CONTAINED_FILES_ONLY
When writing the ACL for a ResourceCollection this propagation mode means that any child Resources in the specified ResourceCollection that are not ResourceCollection objects themselves will have their ACL updated

See Also:
Constant Field Values

PROPAGATION_MODE_RECURSIVE

public static final short PROPAGATION_MODE_RECURSIVE
When writing the ACL for a ResourceCollection this propagation mode means that all child Resources with the specified root path will have their ACL updated

See Also:
Constant Field Values
Constructor Detail

AccessControlList

public AccessControlList()
Default constructor. This creates an empty ACL.

Method Detail

setAclId

public void setAclId(java.lang.String aclId)
Sets the ACL identifier for this ACL object.

Parameters:
aclId - The ACL identifier for this ACL object.

getAclId

public java.lang.String getAclId()
Retrieves the ACL identifier for this ACL object.

Returns:
ACL The ACL identifier for this ACL object.

getEntries

public java.util.List getEntries()
Retrieves the entries that make up this ACL object.

Returns:
A non-null java.util.List of AccessControlEntry objects.

setEntries

public void setEntries(java.util.List entries)
Sets the entries that make up this ACL object.

Parameters:
entries - A java.util.List of AccessControlEntry objects.

getPermissionsForUser

public java.util.List getPermissionsForUser(java.lang.String user)
Retrieves the permissions for the specified user.

Parameters:
user - The user whose permissions are to be retrieved.
Returns:
A java.util.List of AccessControlEntry objects containing the permissions for the user.

getUsersWithPermissions

public java.util.List getUsersWithPermissions()
Retrieves the users having access permissions.

Returns:
A java.util.List of java.lang.String objects representing the user identifiers.

setPermissionsForUser

public void setPermissionsForUser(java.lang.String user,
                                  java.util.List permissions)
Sets the specified permissions for the user.

Parameters:
user - The user whose permissions are to be set.
permissions - A java.util.List of java.lang.String values containing the permissions to be assigned to the user. The permission values can be found in the static constants within the AccessControlEntry class.

removeUserAndPermissions

public void removeUserAndPermissions(java.lang.String user)
Removes the specified user and his permissions.

Parameters:
user - The user to be removed.


[an error occurred while processing this directive] [an error occurred while processing this directive]