org.alfresco.module.org_alfresco_module_rm.security

Class ExtendedSecurityServiceImpl

java.lang.Object

org.alfresco.module.org_alfresco_module_rm.util.ServiceBaseImpl

org.alfresco.module.org_alfresco_module_rm.security.ExtendedSecurityServiceImpl

All Implemented Interfaces:

RecordsManagementCustomModel, RecordsManagementModel, ExtendedSecurityService, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class ExtendedSecurityServiceImpl
extends ServiceBaseImpl
implements ExtendedSecurityService, RecordsManagementModel

Extended security service implementation.

Since:

2.1

Author:

Roy Wetherall

Field Summary

Fields inherited from class org.alfresco.module.org_alfresco_module_rm.util.ServiceBaseImpl

applicationContext, authenticationUtil, dictionaryService, nodeService, renditionService, transactionalResourceHelper

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

ASPECT_ASCENDED, ASPECT_CAVEAT_CONFIG_ROOT, ASPECT_COUNTABLE, ASPECT_CUSTOM_RM_DATA, ASPECT_CUT_OFF, ASPECT_DECLARED_RECORD, ASPECT_DISPOSITION_LIFECYCLE, 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_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_RECORDS, ASSOC_HOLDS, ASSOC_NEXT_DISPOSITION_ACTION, ASSOC_TRANSFERRED, ASSOC_TRANSFERS, 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_REASON, PROP_IDENTIFIER, PROP_IS_CLOSED, PROP_LOADED_DATA_SET_IDS, PROP_LOCATION, PROP_NOTIFICATION_ISSUED, 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_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

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

Constructor Summary

Constructors

Constructor and Description
ExtendedSecurityServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	addExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef nodeRef, Set<String> readers, Set<String> writers) Add extended security for the specified authorities to a node.
void	addExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef nodeRef, Set<String> readers, Set<String> writers, boolean applyToParents) Add extended security for the specified authorities to a node.
Set<String>	getExtendedReaders(org.alfresco.service.cmr.repository.NodeRef nodeRef) Gets the set of authorities that are extended readers for the given node.
Set<String>	getExtendedWriters(org.alfresco.service.cmr.repository.NodeRef nodeRef) Get the set of authorities that are extended writers for the given node.
boolean	hasExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef nodeRef) Indicates whether a node has extended security.
void	removeAllExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef nodeRef) Remove all extended readers and writers from the given node reference.
void	removeAllExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef nodeRef, boolean applyToParents) Remove all extended readers and writers from the given node reference.
void	removeExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef nodeRef, Set<String> readers, Set<String> writers) Remove the extended security for the specified authorities from a node.
void	removeExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef nodeRef, Set<String> readers, Set<String> writers, boolean applyToParents) Remove the extended security for the specified authorities from a node.
void	setFilePlanRoleService(FilePlanRoleService filePlanRoleService)
void	setFilePlanService(FilePlanService filePlanService)

Methods inherited from class org.alfresco.module.org_alfresco_module_rm.util.ServiceBaseImpl

getFilePlan, getFilePlanComponentKind, getFilePlanComponentKindFromType, getInternalNodeService, getNextCount, getTypeAndApsects, instanceOf, instanceOf, isDeclared, isFilePlan, isFilePlanComponent, isFilePlanContainer, isHold, isRecord, isRecordCategory, isRecordFolder, isTransfer, isUnfiledRecordsContainer, setApplicationContext, setAuthenticationUtil, setDictionaryService, setNodeService, setRenditionService, setTransactionalResourceHelper

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtendedSecurityServiceImpl

public ExtendedSecurityServiceImpl()

Method Detail

setFilePlanService

public void setFilePlanService(FilePlanService filePlanService)

Parameters:

filePlanService - file plan service

setFilePlanRoleService

public void setFilePlanRoleService(FilePlanRoleService filePlanRoleService)

Parameters:

filePlanRoleService - file plan role service

hasExtendedSecurity

public boolean hasExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Description copied from interface: ExtendedSecurityService

Indicates whether a node has extended security.

Specified by:

hasExtendedSecurity in interface ExtendedSecurityService

Parameters:

nodeRef - node reference

Returns:

boolean true if the node has extedned security, false otherwise

See Also:

ExtendedSecurityService.hasExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef)

getExtendedReaders

public Set<String> getExtendedReaders(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Description copied from interface: ExtendedSecurityService

Gets the set of authorities that are extended readers for the given node.

Specified by:

getExtendedReaders in interface ExtendedSecurityService

Parameters:

nodeRef - node reference

Returns:

Set<String> set of extended readers

See Also:

org.alfresco.module.org_alfresco_module_rm.security.RecordsManagementSecurityService#getExtendedReaders(org.alfresco.service.cmr.repository.NodeRef)

getExtendedWriters

public Set<String> getExtendedWriters(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Description copied from interface: ExtendedSecurityService

Get the set of authorities that are extended writers for the given node.

Specified by:

getExtendedWriters in interface ExtendedSecurityService

Parameters:

nodeRef - node reference

Returns:

Set<String> set of extended writers

See Also:

ExtendedSecurityService.getExtendedWriters(org.alfresco.service.cmr.repository.NodeRef)

addExtendedSecurity

public void addExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                Set<String> readers,
                                Set<String> writers)

Description copied from interface: ExtendedSecurityService

Add extended security for the specified authorities to a node.

Specified by:

addExtendedSecurity in interface ExtendedSecurityService

Parameters:

nodeRef - node reference

readers - set of authorities to add extended read permissions

writers - set of authorities to add extended write permissions

See Also:

ExtendedSecurityService.addExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef, java.util.Set, java.util.Set)

addExtendedSecurity

public void addExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                Set<String> readers,
                                Set<String> writers,
                                boolean applyToParents)

Description copied from interface: ExtendedSecurityService

Add extended security for the specified authorities to a node.

If specified, the read and write extended permissions are applied to all parents up to the file plan as extended read. This ensures parental read, but not parental write.

Specified by:

addExtendedSecurity in interface ExtendedSecurityService

Parameters:

nodeRef - node reference

readers - set of authorities to add extended read permissions

writers - set of authorities to add extended write permissions

applyToParents - true if extended security applied to parents (read only) false otherwise.

See Also:

ExtendedSecurityService.addExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef, java.util.Set, java.util.Set, boolean)

removeExtendedSecurity

public void removeExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                   Set<String> readers,
                                   Set<String> writers)

Description copied from interface: ExtendedSecurityService

Remove the extended security for the specified authorities from a node.

Specified by:

removeExtendedSecurity in interface ExtendedSecurityService

Parameters:

nodeRef - node reference

readers - set of authorities to remove as extended readers

writers - set of authorities to remove as extended writers

See Also:

ExtendedSecurityService.removeExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef, java.util.Set, java.util.Set)

removeExtendedSecurity

public void removeExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                   Set<String> readers,
                                   Set<String> writers,
                                   boolean applyToParents)

Description copied from interface: ExtendedSecurityService

Remove the extended security for the specified authorities from a node.

If specified, extended security will also be removed from the parent hierarchy.(read only). Note that extended security is records as a reference count, so security will only be utterly removed from the parent hierarchy if all references to the authority are removed.

Specified by:

removeExtendedSecurity in interface ExtendedSecurityService

Parameters:

nodeRef - node reference

readers - set of authorities to remove as extended readers

writers - set of authorities to remove as extedned writers

applyToParents - true if removal of extended security is applied to parent hierarchy (read only), false otherwise

See Also:

ExtendedSecurityService.removeExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef, java.util.Set, java.util.Set, boolean)

removeAllExtendedSecurity

public void removeAllExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Description copied from interface: ExtendedSecurityService

Remove all extended readers and writers from the given node reference.

Specified by:

removeAllExtendedSecurity in interface ExtendedSecurityService

Parameters:

nodeRef - node reference

See Also:

ExtendedSecurityService.removeAllExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef)

removeAllExtendedSecurity

public void removeAllExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                      boolean applyToParents)

Description copied from interface: ExtendedSecurityService

Remove all extended readers and writers from the given node reference.

Specified by:

removeAllExtendedSecurity in interface ExtendedSecurityService

Parameters:

nodeRef - node reference

applyToParents - if true then apply removal to parent hierarchy (read only) false otherwise.

See Also:

ExtendedSecurityService.removeAllExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef, boolean)