Package org.alfresco.module.org_alfresco_module_rm.security

Class RecordsManagementSecurityServiceImpl

java.lang.Object

org.alfresco.module.org_alfresco_module_rm.security.RecordsManagementSecurityServiceImpl

All Implemented Interfaces:

RecordsManagementCustomModel, RecordsManagementModel, RecordsManagementSecurityService

public class RecordsManagementSecurityServiceImpl
extends Object
implements RecordsManagementSecurityService, RecordsManagementModel

Records management permission service implementation

Author:

Roy Wetherall

Field Summary

Fields inherited from interface org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementCustomModel

ASPECT_CUSTOM_ASSOCIATIONS, ASPECT_SUPPLEMENTAL_MARKING_LIST, CONSTRAINT_CUSTOM_SMLIST, CUSTOM_REF_CROSSREFERENCE, CUSTOM_REF_OBSOLETES, CUSTOM_REF_RENDITION, CUSTOM_REF_SUPERSEDES, CUSTOM_REF_SUPPORTS, CUSTOM_REF_VERSIONS, PROP_SUPPLEMENTAL_MARKING_LIST, RM_CUSTOM_MODEL, RM_CUSTOM_PREFIX, RM_CUSTOM_URI

Fields inherited from interface org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementModel

ASPECT_ARCHIVED, ASPECT_ASCENDED, ASPECT_CAVEAT_CONFIG_ROOT, ASPECT_COMMON_RECORD_DETAILS, ASPECT_COUNTABLE, ASPECT_CUSTOM_RM_DATA, ASPECT_CUT_OFF, ASPECT_DECLARED_RECORD, ASPECT_DISPOSITION_LIFECYCLE, ASPECT_DISPOSITION_PROCESSED, ASPECT_EMAIL_CONFIG_ROOT, ASPECT_EXTENDED_SECURITY, ASPECT_FILABLE, ASPECT_FILE_PLAN_COMPONENT, ASPECT_FROZEN, ASPECT_GHOSTED, ASPECT_HELD_CHILDREN, ASPECT_LOADED_DATA_SET_ID, ASPECT_RECORD, ASPECT_RECORD_COMPONENT_ID, ASPECT_RECORD_META_DATA, ASPECT_RECORD_ORIGINATING_DETAILS, ASPECT_RECORD_REJECTION_DETAILS, ASPECT_RECORDS_MANAGEMENT_ROOT, ASPECT_RM_SEARCH, ASPECT_SAVED_SEARCH, ASPECT_SCHEDULED, ASPECT_TRANSFERRED, ASPECT_TRANSFERRING, ASPECT_UNCUT_OFF, ASPECT_UNPUBLISHED_UPDATE, ASPECT_VERSIONED_RECORD, ASPECT_VITAL_RECORD, ASPECT_VITAL_RECORD_DEFINITION, ASSOC_CAVEAT_CONFIG, ASSOC_DISPOSITION_ACTION_DEFINITIONS, ASSOC_DISPOSITION_ACTION_HISTORY, ASSOC_DISPOSITION_SCHEDULE, ASSOC_EMAIL_CONFIG, ASSOC_EVENT_EXECUTIONS, ASSOC_FROZEN_CONTENT, ASSOC_FROZEN_RECORDS, ASSOC_HOLDS, ASSOC_NEXT_DISPOSITION_ACTION, ASSOC_TRANSFERRED, ASSOC_TRANSFERS, GL_URI, PROP_COMBINE_DISPOSITION_STEP_CONDITIONS, PROP_COUNT, PROP_CUT_OFF_DATE, PROP_DATE_FILED, PROP_DB_UNIQUENESS_ID, PROP_DECLARED_AT, PROP_DECLARED_BY, PROP_DISPOSITION_ACTION, PROP_DISPOSITION_ACTION_COMPLETED_AT, PROP_DISPOSITION_ACTION_COMPLETED_BY, PROP_DISPOSITION_ACTION_GHOST_ON_DESTROY, PROP_DISPOSITION_ACTION_ID, PROP_DISPOSITION_ACTION_NAME, PROP_DISPOSITION_ACTION_STARTED_AT, PROP_DISPOSITION_ACTION_STARTED_BY, PROP_DISPOSITION_AS_OF, PROP_DISPOSITION_AUTHORITY, PROP_DISPOSITION_DESCRIPTION, PROP_DISPOSITION_EVENT, PROP_DISPOSITION_EVENT_COMBINATION, PROP_DISPOSITION_EVENTS_ELIGIBLE, PROP_DISPOSITION_INSTRUCTIONS, PROP_DISPOSITION_LOCATION, PROP_DISPOSITION_PERIOD, PROP_DISPOSITION_PERIOD_PROPERTY, PROP_EVENT_EXECUTION_AUTOMATIC, PROP_EVENT_EXECUTION_COMPLETE, PROP_EVENT_EXECUTION_COMPLETED_AT, PROP_EVENT_EXECUTION_COMPLETED_BY, PROP_EVENT_EXECUTION_NAME, PROP_FROZEN_AT, PROP_FROZEN_BY, PROP_HELD_CHILDREN_COUNT, PROP_HOLD_DELETION_REASON, PROP_HOLD_REASON, PROP_IDENTIFIER, PROP_IS_CLOSED, PROP_LOADED_DATA_SET_IDS, PROP_LOCATION, PROP_MANUALLY_SET_AS_OF, PROP_ORIGIONAL_NAME, PROP_PUBLISH_IN_PROGRESS, PROP_READERS, PROP_RECORD_LEVEL_DISPOSITION, PROP_RECORD_ORIGINATING_CREATION_DATE, PROP_RECORD_ORIGINATING_LOCATION, PROP_RECORD_ORIGINATING_USER_ID, PROP_RECORD_REJECTION_DATE, PROP_RECORD_REJECTION_REASON, PROP_RECORD_REJECTION_USER_ID, PROP_REVIEW_AS_OF, PROP_REVIEW_PERIOD, PROP_ROOT_NODEREF, PROP_RS_DECLASSIFICATION_REVIEW_COMPLETED_AT, PROP_RS_DECLASSIFICATION_REVIEW_COMPLETED_BY, PROP_RS_DISPOITION_AUTHORITY, PROP_RS_DISPOITION_INSTRUCTIONS, PROP_RS_DISPOSITION_ACTION_AS_OF, PROP_RS_DISPOSITION_ACTION_NAME, PROP_RS_DISPOSITION_EVENTS, PROP_RS_DISPOSITION_EVENTS_ELIGIBLE, PROP_RS_DISPOSITION_PERIOD, PROP_RS_DISPOSITION_PERIOD_EXPRESSION, PROP_RS_HAS_DISPOITION_SCHEDULE, PROP_RS_HOLD_REASON, PROP_RS_VITAL_RECORD_REVIEW_PERIOD, PROP_RS_VITAL_RECORD_REVIEW_PERIOD_EXPRESSION, PROP_TRANSFER_ACCESSION_INDICATOR, PROP_TRANSFER_LOCATION, PROP_TRANSFER_PDF_INDICATOR, PROP_UNPUBLISHED_UPDATE, PROP_UPDATE_TO, PROP_UPDATED_PROPERTIES, PROP_VITAL_RECORD_INDICATOR, PROP_WRITERS, RM_MODEL, RM_PREFIX, RM_URI, TYPE_CAVEAT_CONFIG, TYPE_DISPOSITION_ACTION, TYPE_DISPOSITION_ACTION_DEFINITION, TYPE_DISPOSITION_SCHEDULE, TYPE_EMAIL_CONFIG, TYPE_EVENT_EXECUTION, TYPE_FILE_PLAN, TYPE_HOLD, TYPE_HOLD_CONTAINER, TYPE_NON_ELECTRONIC_DOCUMENT, TYPE_RECORD_CATEGORY, TYPE_RECORD_FOLDER, TYPE_RECORDS_MANAGEMENT_CONTAINER, TYPE_RM_SITE, TYPE_TRANSFER, TYPE_TRANSFER_CONTAINER, TYPE_UNFILED_RECORD_CONTAINER, TYPE_UNFILED_RECORD_FOLDER, UPDATE_TO_DISPOSITION_ACTION_DEFINITION

Constructor Summary

Constructors

Constructor	Description
RecordsManagementSecurityServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	assignRoleToAuthority(NodeRef rmRootNode, String role, String authorityName)	Deprecated.
void	bootstrapDefaultRoles(NodeRef rmRootNode)	Deprecated.
Role	createRole(NodeRef rmRootNode, String role, String roleDisplayLabel, Set<Capability> capabilities)	Deprecated.
void	deletePermission(NodeRef nodeRef, String authority, String permission)	Deprecated.
void	deleteRole(NodeRef rmRootNode, String role)	Deprecated.
boolean	existsRole(NodeRef rmRootNode, String role)	Deprecated.
String	getAllRolesContainerGroup(NodeRef filePlan)	Deprecated.
Set<QName>	getProtectedAspects()	Deprecated.
Set<QName>	getProtectedProperties()	Deprecated.
Role	getRole(NodeRef rmRootNode, String role)	Deprecated.
Set<Role>	getRoles(NodeRef rmRootNode)	Deprecated.
Set<Role>	getRolesByUser(NodeRef rmRootNode, String user)	Deprecated.
boolean	hasRMAdminRole(NodeRef rmRootNode, String user)	Deprecated.
void	setFilePlanPermissionService(FilePlanPermissionService filePlanPermissionService)
void	setFilePlanRoleService(FilePlanRoleService filePlanRoleService)
void	setModelSecurityService(ModelSecurityService modelSecurityService)
void	setPermission(NodeRef nodeRef, String authority, String permission)	Deprecated.
Role	updateRole(NodeRef rmRootNode, String role, String roleDisplayLabel, Set<Capability> capabilities)	Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Details

RecordsManagementSecurityServiceImpl

public RecordsManagementSecurityServiceImpl()

Method Details

setModelSecurityService

public void setModelSecurityService(ModelSecurityService modelSecurityService)

Parameters:

modelSecurityService - model security service

setFilePlanRoleService

public void setFilePlanRoleService(FilePlanRoleService filePlanRoleService)

Parameters:

filePlanRoleService - file plan role service

setFilePlanPermissionService

public void setFilePlanPermissionService(FilePlanPermissionService filePlanPermissionService)

Parameters:

filePlanPermissionService - file plan permission service

getProtectedAspects

@Deprecated
public Set<QName> getProtectedAspects()

Deprecated.

Specified by:

getProtectedAspects in interface RecordsManagementSecurityService

Returns:

Set<QName> protected aspect names

See Also:

• RecordsManagementSecurityService.getProtectedAspects()

getProtectedProperties

@Deprecated
public Set<QName> getProtectedProperties()

Deprecated.

Specified by:

getProtectedProperties in interface RecordsManagementSecurityService

Returns:

Set<QName> protected properties

See Also:

• RecordsManagementSecurityService.getProtectedProperties()

assignRoleToAuthority

@Deprecated
public void assignRoleToAuthority(NodeRef rmRootNode,
 String role,
 String authorityName)

Deprecated.

Description copied from interface: RecordsManagementSecurityService

Assign a role to an authority

Specified by:

assignRoleToAuthority in interface RecordsManagementSecurityService

See Also:

• RecordsManagementSecurityService.assignRoleToAuthority(org.alfresco.service.cmr.repository.NodeRef, java.lang.String, java.lang.String)

bootstrapDefaultRoles

@Deprecated
public void bootstrapDefaultRoles(NodeRef rmRootNode)

Deprecated.

Description copied from interface: RecordsManagementSecurityService

Creates the initial set of default roles for a root records management node

Specified by:

bootstrapDefaultRoles in interface RecordsManagementSecurityService

Parameters:

rmRootNode - root node

See Also:

• RecordsManagementSecurityService.bootstrapDefaultRoles(org.alfresco.service.cmr.repository.NodeRef)

createRole

@Deprecated
public Role createRole(NodeRef rmRootNode,
 String role,
 String roleDisplayLabel,
 Set<Capability> capabilities)

Deprecated.

Description copied from interface: RecordsManagementSecurityService

Create a new role

Specified by:

createRole in interface RecordsManagementSecurityService

Returns:

See Also:

• RecordsManagementSecurityService.createRole(org.alfresco.service.cmr.repository.NodeRef, java.lang.String, java.lang.String, java.util.Set)

deleteRole

@Deprecated
public void deleteRole(NodeRef rmRootNode,
 String role)

Deprecated.

Description copied from interface: RecordsManagementSecurityService

Delete a role

Specified by:

deleteRole in interface RecordsManagementSecurityService

See Also:

• RecordsManagementSecurityService.deleteRole(org.alfresco.service.cmr.repository.NodeRef, java.lang.String)

existsRole

@Deprecated
public boolean existsRole(NodeRef rmRootNode,
 String role)

Deprecated.

Description copied from interface: RecordsManagementSecurityService

Indicate whether a role exists for a given records management root node

Specified by:

existsRole in interface RecordsManagementSecurityService

Returns:

See Also:

• RecordsManagementSecurityService.existsRole(org.alfresco.service.cmr.repository.NodeRef, java.lang.String)

getAllRolesContainerGroup

@Deprecated
public String getAllRolesContainerGroup(NodeRef filePlan)

Deprecated.

Description copied from interface: RecordsManagementSecurityService

Returns the name of the container group for all roles of a specified file plan.

Specified by:

getAllRolesContainerGroup in interface RecordsManagementSecurityService

Parameters:

filePlan - file plan node reference

Returns:

String group name

See Also:

• RecordsManagementSecurityService.getAllRolesContainerGroup(org.alfresco.service.cmr.repository.NodeRef)

getRole

@Deprecated
public Role getRole(NodeRef rmRootNode,
 String role)

Deprecated.

Description copied from interface: RecordsManagementSecurityService

Get a role by name

Specified by:

getRole in interface RecordsManagementSecurityService

Returns:

See Also:

• RecordsManagementSecurityService.getRole(org.alfresco.service.cmr.repository.NodeRef, java.lang.String)

getRoles

@Deprecated
public Set<Role> getRoles(NodeRef rmRootNode)

Deprecated.

Description copied from interface: RecordsManagementSecurityService

Get all the available roles for the given records management root node

Specified by:

getRoles in interface RecordsManagementSecurityService

Parameters:

rmRootNode - root node

Returns:

Set<Role> all roles for a given root node

See Also:

• RecordsManagementSecurityService.getRoles(org.alfresco.service.cmr.repository.NodeRef)

getRolesByUser

@Deprecated
public Set<Role> getRolesByUser(NodeRef rmRootNode,
 String user)

Deprecated.

Description copied from interface: RecordsManagementSecurityService

Gets the roles for a given user

Specified by:

getRolesByUser in interface RecordsManagementSecurityService

Returns:

See Also:

• RecordsManagementSecurityService.getRolesByUser(org.alfresco.service.cmr.repository.NodeRef, java.lang.String)

hasRMAdminRole

@Deprecated
public boolean hasRMAdminRole(NodeRef rmRootNode,
 String user)

Deprecated.

Description copied from interface: RecordsManagementSecurityService

Determines whether the given user has the RM Admin role

Specified by:

hasRMAdminRole in interface RecordsManagementSecurityService

Parameters:

rmRootNode - RM root node

user - user name to check

Returns:

true if the user has the RM Admin role, false otherwise

See Also:

• RecordsManagementSecurityService.hasRMAdminRole(org.alfresco.service.cmr.repository.NodeRef, java.lang.String)

updateRole

@Deprecated
public Role updateRole(NodeRef rmRootNode,
 String role,
 String roleDisplayLabel,
 Set<Capability> capabilities)

Deprecated.

Description copied from interface: RecordsManagementSecurityService

Update an existing role

Specified by:

updateRole in interface RecordsManagementSecurityService

Returns:

See Also:

• RecordsManagementSecurityService.updateRole(org.alfresco.service.cmr.repository.NodeRef, java.lang.String, java.lang.String, java.util.Set)

deletePermission

@Deprecated
public void deletePermission(NodeRef nodeRef,
 String authority,
 String permission)

Deprecated.

Description copied from interface: RecordsManagementSecurityService

Deletes a permission from a RM object. Cascades removal down to record folder.

Specified by:

deletePermission in interface RecordsManagementSecurityService

Parameters:

nodeRef - node reference

authority - authority

permission - permission

See Also:

• RecordsManagementSecurityService.deletePermission(org.alfresco.service.cmr.repository.NodeRef, java.lang.String, java.lang.String)

setPermission

@Deprecated
public void setPermission(NodeRef nodeRef,
 String authority,
 String permission)

Deprecated.

Description copied from interface: RecordsManagementSecurityService

Sets a permission on a RM object. Assumes allow is true. Cascades permission down to record folder. Cascades ReadRecord up to file plan.

Specified by:

setPermission in interface RecordsManagementSecurityService

Parameters:

nodeRef - node reference

authority - authority

permission - permission

See Also:

• RecordsManagementSecurityService.setPermission(org.alfresco.service.cmr.repository.NodeRef, java.lang.String, java.lang.String)