org.alfresco.repo.web.scripts.roles

Class DynamicAuthoritiesGet

java.lang.Object

org.springframework.extensions.webscripts.AbstractWebScript

org.alfresco.repo.web.scripts.roles.DynamicAuthoritiesGet

All Implemented Interfaces:

RecordsManagementCustomModel, RecordsManagementModel, org.springframework.extensions.webscripts.WebScript

public class DynamicAuthoritiesGet
extends org.springframework.extensions.webscripts.AbstractWebScript
implements RecordsManagementModel

Webscript used for removing dynamic authorities from the records.

Since:

2.3.0.7

Author:

Silviu Dinuta

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.extensions.webscripts.AbstractWebScript

org.springframework.extensions.webscripts.AbstractWebScript.ScriptDetails

Field Summary

Fields

Modifier and Type	Field and Description
protected org.alfresco.repo.web.scripts.content.ContentStreamer	contentStreamer Content Streamer

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

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_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_RECORDS, ASSOC_HOLDS, ASSOC_NEXT_DISPOSITION_ACTION, ASSOC_TRANSFERRED, ASSOC_TRANSFERS, 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_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_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
DynamicAuthoritiesGet()

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	buildModel(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res)
void	execute(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res)
protected Long	getBatchSizeParameter(org.springframework.extensions.webscripts.WebScriptRequest req) Obtain batchsize parameter from the request.
protected boolean	getExportParameter(org.springframework.extensions.webscripts.WebScriptRequest req) Get export parameter from the request
protected Long	getMaxToProccessParameter(org.springframework.extensions.webscripts.WebScriptRequest req, Long batchSize) Obtain maximum of the records to be processed from the request if it is specified or bachsize value otherwise
protected org.alfresco.service.cmr.repository.NodeRef	getParentNodeRefParameter(org.springframework.extensions.webscripts.WebScriptRequest req) Get parentNodeRef parameter from the request
protected List<org.alfresco.service.cmr.repository.NodeRef>	processChildrenNodes(org.alfresco.service.cmr.repository.NodeRef parentNodeRef, int batchSize, org.alfresco.util.Pair<Long,org.alfresco.service.namespace.QName> recordAspectPair, int maxRecordsToProcess, BufferedWriter out, boolean attach)
protected void	processNode(org.alfresco.service.cmr.repository.NodeRef nodeRef) Process each node
protected List<org.alfresco.service.cmr.repository.NodeRef>	processNodes(Long batchSize, Long maxNodeId, org.alfresco.util.Pair<Long,org.alfresco.service.namespace.QName> recordAspectPair, Long totalNumberOfRecordsToProcess, BufferedWriter out, boolean attach) Process nodes all nodes or the maximum number of nodes specified by batchsize or totalNumberOfRecordsToProcess parameters
protected void	renderFormatTemplate(String format, Map<String,Object> model, Writer writer)
void	setContentStreamer(org.alfresco.repo.web.scripts.content.ContentStreamer contentStreamer)
void	setExtendedSecurityService(ExtendedSecurityService extendedSecurityService)
void	setFileFolderService(org.alfresco.service.cmr.model.FileFolderService fileFolderService)
void	setNodeDAO(org.alfresco.repo.domain.node.NodeDAO nodeDAO)
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
void	setPatchDAO(org.alfresco.repo.domain.patch.PatchDAO patchDAO) service setters
void	setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)
void	setQnameDAO(org.alfresco.repo.domain.qname.QNameDAO qnameDAO)
void	setTransactionService(org.alfresco.service.transaction.TransactionService transactionService)

Methods inherited from class org.springframework.extensions.webscripts.AbstractWebScript

addModuleBundleToCache, checkModuleBundleCache, createArgs, createArgsM, createHeaders, createHeadersM, createScriptParameters, createStatusException, createTemplateParameters, executeScript, getContainer, getDescription, getExecuteScript, getResources, getStatusTemplate, init, renderString, renderString, renderTemplate, sendStatus, setURLModelFactory, toString

Methods inherited from class java.lang.Object

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

Field Detail

contentStreamer

protected org.alfresco.repo.web.scripts.content.ContentStreamer contentStreamer

Content Streamer

Constructor Detail

DynamicAuthoritiesGet

public DynamicAuthoritiesGet()

Method Detail

setPatchDAO

public void setPatchDAO(org.alfresco.repo.domain.patch.PatchDAO patchDAO)

service setters

setNodeDAO

public void setNodeDAO(org.alfresco.repo.domain.node.NodeDAO nodeDAO)

setQnameDAO

public void setQnameDAO(org.alfresco.repo.domain.qname.QNameDAO qnameDAO)

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

setPermissionService

public void setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)

setExtendedSecurityService

public void setExtendedSecurityService(ExtendedSecurityService extendedSecurityService)

setTransactionService

public void setTransactionService(org.alfresco.service.transaction.TransactionService transactionService)

setContentStreamer

public void setContentStreamer(org.alfresco.repo.web.scripts.content.ContentStreamer contentStreamer)

setFileFolderService

public void setFileFolderService(org.alfresco.service.cmr.model.FileFolderService fileFolderService)

buildModel

protected Map<String,Object> buildModel(org.springframework.extensions.webscripts.WebScriptRequest req,
                                        org.springframework.extensions.webscripts.WebScriptResponse res)
                                 throws IOException

Throws:

IOException

getExportParameter

protected boolean getExportParameter(org.springframework.extensions.webscripts.WebScriptRequest req)

Get export parameter from the request

Parameters:

req -

Returns:

execute

public void execute(org.springframework.extensions.webscripts.WebScriptRequest req,
                    org.springframework.extensions.webscripts.WebScriptResponse res)
             throws IOException

Specified by:

execute in interface org.springframework.extensions.webscripts.WebScript

Throws:

IOException

renderFormatTemplate

protected void renderFormatTemplate(String format,
                                    Map<String,Object> model,
                                    Writer writer)

getMaxToProccessParameter

protected Long getMaxToProccessParameter(org.springframework.extensions.webscripts.WebScriptRequest req,
                                         Long batchSize)

Obtain maximum of the records to be processed from the request if it is specified or bachsize value otherwise

Parameters:

req -

Returns:

maximum of the records to be processed from the request if it is specified or bachsize value otherwise

getBatchSizeParameter

protected Long getBatchSizeParameter(org.springframework.extensions.webscripts.WebScriptRequest req)

Obtain batchsize parameter from the request.

Parameters:

req -

Returns:

batchsize parameter from the request

getParentNodeRefParameter

protected org.alfresco.service.cmr.repository.NodeRef getParentNodeRefParameter(org.springframework.extensions.webscripts.WebScriptRequest req)

Get parentNodeRef parameter from the request

Parameters:

req -

Returns:

processNodes

protected List<org.alfresco.service.cmr.repository.NodeRef> processNodes(Long batchSize,
                                                                         Long maxNodeId,
                                                                         org.alfresco.util.Pair<Long,org.alfresco.service.namespace.QName> recordAspectPair,
                                                                         Long totalNumberOfRecordsToProcess,
                                                                         BufferedWriter out,
                                                                         boolean attach)

Process nodes all nodes or the maximum number of nodes specified by batchsize or totalNumberOfRecordsToProcess parameters

Parameters:

batchSize -

maxNodeId -

recordAspectPair -

totalNumberOfRecordsToProcess -

Returns:

the list of processed nodes

processChildrenNodes

protected List<org.alfresco.service.cmr.repository.NodeRef> processChildrenNodes(org.alfresco.service.cmr.repository.NodeRef parentNodeRef,
                                                                                 int batchSize,
                                                                                 org.alfresco.util.Pair<Long,org.alfresco.service.namespace.QName> recordAspectPair,
                                                                                 int maxRecordsToProcess,
                                                                                 BufferedWriter out,
                                                                                 boolean attach)

processNode

protected void processNode(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Process each node

Parameters:

nodeRef -