org.alfresco.cmis

Interface CMISAccessControlService

All Known Implementing Classes:

CMISAccessControlServiceImpl

public interface CMISAccessControlService

Service for CMIS access control support.

Author:

andyh

Field Summary

Fields

Modifier and Type	Field and Description
static String	CMIS_ALL_PERMISSION CMIS ALL permissions (includes all permissions defined within the repository)
static String	CMIS_READ_PERMISSION CMIS Read (properties and content)
static String	CMIS_WRITE_PERMISSION CMIS Write (properties and content)

Method Summary

Methods

Modifier and Type	Method and Description
CMISAccessControlReport	applyAcl(org.alfresco.service.cmr.repository.NodeRef nodeRef, List<CMISAccessControlEntry> acesToApply) Update the ACEs on a node.
CMISAccessControlReport	applyAcl(org.alfresco.service.cmr.repository.NodeRef nodeRef, List<CMISAccessControlEntry> acesToRemove, List<CMISAccessControlEntry> acesToAdd, CMISAclPropagationEnum propagation, org.alfresco.opencmis.CMISAccessControlFormatEnum format) Update the ACEs on a node.
CMISAccessControlReport	getAcl(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.opencmis.CMISAccessControlFormatEnum format) Get the ACLs set on a node.
CMISAclCapabilityEnum	getAclCapability() Get the ACL capability enum.
CMISAclPropagationEnum	getAclPropagation() Get the ACL propagation enum.
List<? extends CMISPermissionMapping>	getPermissionMappings() Get the list of permission mappings.
String	getPrincipalAnonymous() Gets the name of the principal who is used for anonymous access.
String	getPrincipalAnyone() Gets the name of the principal who is used to indicate any authenticated user.
List<CMISPermissionDefinition>	getRepositoryPermissions() Get all the permissions defined by the repository.
CMISAclSupportedPermissionEnum	getSupportedPermissions() Gets the supported permission types

Field Detail

CMIS_READ_PERMISSION

static final String CMIS_READ_PERMISSION

CMIS Read (properties and content)

See Also:

Constant Field Values

CMIS_WRITE_PERMISSION

static final String CMIS_WRITE_PERMISSION

CMIS Write (properties and content)

See Also:

Constant Field Values

CMIS_ALL_PERMISSION

static final String CMIS_ALL_PERMISSION

CMIS ALL permissions (includes all permissions defined within the repository)

See Also:

Constant Field Values

Method Detail

getAclCapability

CMISAclCapabilityEnum getAclCapability()

Get the ACL capability enum.

Returns:

the ACL capability enum.

getSupportedPermissions

CMISAclSupportedPermissionEnum getSupportedPermissions()

Gets the supported permission types

Returns:

the supported permission types

getAclPropagation

CMISAclPropagationEnum getAclPropagation()

Get the ACL propagation enum.

Returns:

the ACL propagation enum.

getRepositoryPermissions

List<CMISPermissionDefinition> getRepositoryPermissions()

Get all the permissions defined by the repository.

Returns:

a list of permissions

getPermissionMappings

List<? extends CMISPermissionMapping> getPermissionMappings()

Get the list of permission mappings.

Returns:

get the permission mapping as defined by the CMIS specification.

getPrincipalAnonymous

String getPrincipalAnonymous()

Gets the name of the principal who is used for anonymous access. This principal can then be passed to the ACL services to specify what permissions anonymous users should have.

Returns:

name of the principal who is used for anonymous access

getPrincipalAnyone

String getPrincipalAnyone()

Gets the name of the principal who is used to indicate any authenticated user. This principal can then be passed to the ACL services to specify what permissions any authenticated user should have.

Returns:

name of the principal who is used to indicate any authenticated user

getAcl

CMISAccessControlReport getAcl(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                             org.alfresco.opencmis.CMISAccessControlFormatEnum format)

Get the ACLs set on a node.

Parameters:

nodeRef -

format -

Returns:

an access control report

applyAcl

CMISAccessControlReport applyAcl(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                               List<CMISAccessControlEntry> acesToApply)
                                 throws CMISConstraintException

Update the ACEs on a node. Those already existing, are preserved, those new are added and those missing are removed.

Parameters:

nodeRef -

acesToApply -

Returns:

an access control report of the final state

Throws:

CMISConstraintException

applyAcl

CMISAccessControlReport applyAcl(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                               List<CMISAccessControlEntry> acesToRemove,
                               List<CMISAccessControlEntry> acesToAdd,
                               CMISAclPropagationEnum propagation,
                               org.alfresco.opencmis.CMISAccessControlFormatEnum format)
                                 throws CMISConstraintException

Update the ACEs on a node. The deletions are applied before the additions. Existing ACEs not deleted or added remain unchanged.

Parameters:

nodeRef -

acesToRemove -

acesToAdd -

propagation -

format -

Returns:

an access control report of the final state

Throws:

CMISConstraintException