org.alfresco.repo.web.scripts.archive

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

Fields

Modifier and Type	Field and Description
static String	ARCHIVED_BY
static String	ARCHIVED_DATE
static int	DEFAULT_MAX_ITEMS_PER_PAGE
static String	DELETED_NODES
static String	DESCRIPTION
static String	DISPLAY_PATH
static String	FIRST_NAME
static String	LAST_NAME
protected int	maxSizeView
static String	NAME
static String	NODE_TYPE
protected NodeArchiveService	nodeArchiveService
static String	NODEREF
protected ServiceRegistry	serviceRegistry
static String	TITLE
static String	USER_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractArchivedNodeWebScript()

Method Summary

Modifier and Type	Method and Description
protected org.alfresco.query.PagingResults<org.alfresco.service.cmr.repository.NodeRef>	getArchivedNodesFrom(org.alfresco.service.cmr.repository.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 returned
protected org.alfresco.service.cmr.repository.NodeRef	parseRequestForNodeRef(org.springframework.extensions.webscripts.WebScriptRequest req)
protected org.alfresco.service.cmr.repository.StoreRef	parseRequestForStoreRef(org.springframework.extensions.webscripts.WebScriptRequest req)
void	setMaxSizeView(int maxSizeView) Sets the maxSizeView
void	setNodeArchiveService(NodeArchiveService nodeArchiveService) Sets the nodeArchiveService instance
void	setServiceRegistry(ServiceRegistry serviceRegistry) Sets the serviceRegistry instance
protected void	validatePermission(org.alfresco.service.cmr.repository.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

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

TITLE

public static final String TITLE

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

See Also:

Constant Field Values

NODEREF

public static final String NODEREF

See Also:

Constant Field Values

ARCHIVED_BY

public static final String ARCHIVED_BY

See Also:

Constant Field Values

ARCHIVED_DATE

public static final String ARCHIVED_DATE

See Also:

Constant Field Values

DISPLAY_PATH

public static final String DISPLAY_PATH

See Also:

Constant Field Values

USER_NAME

public static final String USER_NAME

See Also:

Constant Field Values

FIRST_NAME

public static final String FIRST_NAME

See Also:

Constant Field Values

LAST_NAME

public static final String LAST_NAME

See Also:

Constant Field Values

NODE_TYPE

public static final String NODE_TYPE

See Also:

Constant Field Values

DELETED_NODES

public static final String DELETED_NODES

See Also:

Constant Field Values

DEFAULT_MAX_ITEMS_PER_PAGE

public static final int DEFAULT_MAX_ITEMS_PER_PAGE

See Also:

Constant Field Values

serviceRegistry

protected ServiceRegistry serviceRegistry

nodeArchiveService

protected NodeArchiveService nodeArchiveService

maxSizeView

protected int maxSizeView

Constructor Detail

AbstractArchivedNodeWebScript

public AbstractArchivedNodeWebScript()

Method Detail

setServiceRegistry

public void setServiceRegistry(ServiceRegistry serviceRegistry)

Sets the serviceRegistry instance

Parameters:

serviceRegistry - the serviceRegistry to set

setNodeArchiveService

public void setNodeArchiveService(NodeArchiveService nodeArchiveService)

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 org.alfresco.service.cmr.repository.StoreRef parseRequestForStoreRef(org.springframework.extensions.webscripts.WebScriptRequest req)

parseRequestForNodeRef

protected org.alfresco.service.cmr.repository.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 request

paramName - The name of parameter to look for

defaultValue - 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<org.alfresco.service.cmr.repository.NodeRef> getArchivedNodesFrom(org.alfresco.service.cmr.repository.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 ref

paging - mandatory paging

filter - optional filter

validatePermission

protected void validatePermission(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                  String currentUser)