org.alfresco.module.org_alfresco_module_rm.script

Class BaseTransferWebScript

java.lang.Object

org.springframework.extensions.webscripts.AbstractWebScript

org.alfresco.repo.web.scripts.content.StreamContent

org.alfresco.repo.web.scripts.content.StreamACP

org.alfresco.module.org_alfresco_module_rm.script.BaseTransferWebScript

All Implemented Interfaces:

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

Direct Known Subclasses:

TransferGet, TransferReportGet, TransferReportPost

public abstract class BaseTransferWebScript
extends org.alfresco.repo.web.scripts.content.StreamACP
implements RecordsManagementModel

Abstract base class for transfer related web scripts.

Author:

Gavin Cornwell

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 FilePlanService	filePlanService

Fields inherited from class org.alfresco.repo.web.scripts.content.StreamACP

exporterService, MULTIPART_FORMDATA, PARAM_NODE_REFS, TEMP_FILE_PREFIX, ZIP_EXTENSION

Fields inherited from class org.alfresco.repo.web.scripts.content.StreamContent

delegate, mimetypeService, nodeService, permissionService, repository

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
BaseTransferWebScript()

Method Summary

Modifier and Type	Method and Description
void	execute(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res)
protected abstract File	executeTransfer(org.alfresco.service.cmr.repository.NodeRef transferNode, org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res, org.springframework.extensions.webscripts.Status status, org.springframework.extensions.webscripts.Cache cache) Abstract method subclasses implement to perform the actual logic required.
protected org.alfresco.service.cmr.repository.NodeRef	findTransferNode(org.alfresco.service.cmr.repository.NodeRef filePlan, String transferId) Finds a transfer object with the given id in the given file plan.
protected org.alfresco.service.cmr.repository.NodeRef[]	getTransferNodes(org.alfresco.service.cmr.repository.NodeRef transferNode) Returns an array of NodeRefs representing the items to be transferred.
void	setFilePlanService(FilePlanService filePlanService)

Methods inherited from class org.alfresco.repo.web.scripts.content.StreamACP

createACP, getNodeRefs, getNodeRefs, setExporterService

Methods inherited from class org.alfresco.repo.web.scripts.content.StreamContent

createObjectReferenceFromUrl, executeImpl, executeImpl, executeImpl, renderFormatTemplate, setAttachment, setDelegate, setMimetypeService, setNodeService, setPermissionService, setRepository, streamContent, streamContent, streamContent, streamContentImpl

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

filePlanService

protected FilePlanService filePlanService

Constructor Detail

BaseTransferWebScript

public BaseTransferWebScript()

Method Detail

setFilePlanService

public void setFilePlanService(FilePlanService filePlanService)

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

Overrides:

execute in class org.alfresco.repo.web.scripts.content.StreamACP

Throws:

IOException

See Also:

org.alfresco.web.scripts.WebScript#execute(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.WebScriptResponse)

executeTransfer

protected abstract File executeTransfer(org.alfresco.service.cmr.repository.NodeRef transferNode,
                                        org.springframework.extensions.webscripts.WebScriptRequest req,
                                        org.springframework.extensions.webscripts.WebScriptResponse res,
                                        org.springframework.extensions.webscripts.Status status,
                                        org.springframework.extensions.webscripts.Cache cache)
                                 throws IOException

Abstract method subclasses implement to perform the actual logic required.

Parameters:

transferNode - The transfer node

req - The request

res - The response

status - Status object

cache - Cache object

Returns:

File object representing the file containing the JSON of the report

Throws:

IOException

findTransferNode

protected org.alfresco.service.cmr.repository.NodeRef findTransferNode(org.alfresco.service.cmr.repository.NodeRef filePlan,
                                                                       String transferId)

Finds a transfer object with the given id in the given file plan. This method returns null if a transfer with the given id is not found.

Parameters:

filePlan - The file plan to search

transferId - The id of the transfer being requested

Returns:

The transfer node or null if not found

getTransferNodes

protected org.alfresco.service.cmr.repository.NodeRef[] getTransferNodes(org.alfresco.service.cmr.repository.NodeRef transferNode)

Returns an array of NodeRefs representing the items to be transferred.

Parameters:

transferNode - The transfer object

Returns:

Array of NodeRefs