Class AbstractArchivedNodeWebScript
java.lang.Object
org.springframework.extensions.webscripts.AbstractWebScript
org.springframework.extensions.webscripts.DeclarativeWebScript
org.alfresco.repo.web.scripts.archive.AbstractArchivedNodeWebScript
- All Implemented Interfaces:
org.springframework.extensions.webscripts.WebScript
- Direct Known Subclasses:
ArchivedNodePut
,ArchivedNodesDelete
,ArchivedNodesGet
public abstract class AbstractArchivedNodeWebScript
extends org.springframework.extensions.webscripts.DeclarativeWebScript
This class is an abstract base class for the various webscript controllers in the
NodeArchiveService.
- Since:
- 3.5
- Author:
- Neil McErlean, Jamal Kaabi-Mofrad
-
Nested Class Summary
Nested classes/interfaces inherited from class org.springframework.extensions.webscripts.AbstractWebScript
org.springframework.extensions.webscripts.AbstractWebScript.ScriptDetails
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
static final String
static final int
static final String
static final String
static final String
static final String
static final String
protected int
static final String
static final String
protected NodeArchiveService
static final String
protected ServiceRegistry
static final String
static final String
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected org.alfresco.query.PagingResults<NodeRef>
getArchivedNodesFrom
(StoreRef storeRef, ScriptPagingDetails paging, String filter) * This method gets all nodes from the archive which were originally contained within the specified StoreRef.protected int
getIntParameter
(org.springframework.extensions.webscripts.WebScriptRequest req, String paramName, int defaultValue) Retrieves the named parameter as an integer, if the parameter is not present the default value is returnedprotected NodeRef
parseRequestForNodeRef
(org.springframework.extensions.webscripts.WebScriptRequest req) protected StoreRef
parseRequestForStoreRef
(org.springframework.extensions.webscripts.WebScriptRequest req) void
setMaxSizeView
(int maxSizeView) Sets the maxSizeViewvoid
setNodeArchiveService
(NodeArchiveService nodeArchiveService) Sets the nodeArchiveService instancevoid
setServiceRegistry
(ServiceRegistry serviceRegistry) Sets the serviceRegistry instanceprotected void
validatePermission
(NodeRef nodeRef, String currentUser) Methods inherited from class org.springframework.extensions.webscripts.DeclarativeWebScript
execute, executeFinallyImpl, executeImpl, executeImpl, executeImpl, getTemplateModel, renderFormatTemplate
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
-
Field Details
-
NAME
- See Also:
-
TITLE
- See Also:
-
DESCRIPTION
- See Also:
-
NODEREF
- See Also:
-
ARCHIVED_BY
- See Also:
-
ARCHIVED_DATE
- See Also:
-
DISPLAY_PATH
- See Also:
-
USER_NAME
- See Also:
-
FIRST_NAME
- See Also:
-
LAST_NAME
- See Also:
-
NODE_TYPE
- See Also:
-
DELETED_NODES
- See Also:
-
DEFAULT_MAX_ITEMS_PER_PAGE
public static final int DEFAULT_MAX_ITEMS_PER_PAGE- See Also:
-
serviceRegistry
-
nodeArchiveService
-
maxSizeView
protected int maxSizeView
-
-
Constructor Details
-
AbstractArchivedNodeWebScript
public AbstractArchivedNodeWebScript()
-
-
Method Details
-
setServiceRegistry
Sets the serviceRegistry instance- Parameters:
serviceRegistry
- the serviceRegistry to set
-
setNodeArchiveService
Sets the nodeArchiveService instance- Parameters:
nodeArchiveService
- the nodeArchiveService to set
-
setMaxSizeView
public void setMaxSizeView(int maxSizeView) Sets the maxSizeView- Parameters:
maxSizeView
- the maxSizeView
-
parseRequestForStoreRef
protected StoreRef parseRequestForStoreRef(org.springframework.extensions.webscripts.WebScriptRequest req) -
parseRequestForNodeRef
protected NodeRef parseRequestForNodeRef(org.springframework.extensions.webscripts.WebScriptRequest req) -
getIntParameter
protected int getIntParameter(org.springframework.extensions.webscripts.WebScriptRequest req, String paramName, int defaultValue) Retrieves the named parameter as an integer, if the parameter is not present the default value is returned- Parameters:
req
- The WebScript requestparamName
- The name of parameter to look fordefaultValue
- The default value that should be returned if parameter is not present in request or if it is not positive- Returns:
- The request parameter or default value
-
getArchivedNodesFrom
protected org.alfresco.query.PagingResults<NodeRef> getArchivedNodesFrom(StoreRef storeRef, ScriptPagingDetails paging, String filter) * This method gets all nodes from the archive which were originally contained within the specified StoreRef.- Parameters:
storeRef
- mandatory store refpaging
- mandatory pagingfilter
- optional filter
-
validatePermission
-