org.alfresco.repo.web.scripts.archive
Class AbstractArchivedNodeWebScript

java.lang.Object
  extended by org.springframework.extensions.webscripts.AbstractWebScript
      extended by org.springframework.extensions.webscripts.DeclarativeWebScript
          extended by 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

Nested Class Summary
protected  class AbstractArchivedNodeWebScript.ArchivedDateComparator
          This class is used to sort ChildAssociationRefs into the correct order based on archivedDate.
 
Nested classes/interfaces inherited from class org.springframework.extensions.webscripts.AbstractWebScript
org.springframework.extensions.webscripts.AbstractWebScript.ScriptDetails
 
Field Summary
static java.lang.String ARCHIVED_BY
           
static java.lang.String ARCHIVED_DATE
           
static java.lang.String DELETED_NODES
           
static java.lang.String DESCRIPTION
           
static java.lang.String DISPLAY_PATH
           
static java.lang.String FIRST_NAME
           
static java.lang.String LAST_NAME
           
static java.lang.String NAME
           
static java.lang.String NODE_TYPE
           
protected  org.alfresco.repo.node.archive.NodeArchiveService nodeArchiveService
           
static java.lang.String NODEREF
           
protected  org.alfresco.service.ServiceRegistry serviceRegistry
           
static java.lang.String TITLE
           
static java.lang.String USER_NAME
           
 
Constructor Summary
AbstractArchivedNodeWebScript()
           
 
Method Summary
protected  java.util.SortedSet getArchivedNodesFrom(org.alfresco.service.cmr.repository.StoreRef storeRef)
          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, java.lang.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 setNodeArchiveService(org.alfresco.repo.node.archive.NodeArchiveService nodeArchiveService)
          Sets the nodeArchiveService instance
 void setServiceRegistry(org.alfresco.service.ServiceRegistry serviceRegistry)
          Sets the serviceRegistry instance
 
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
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 java.lang.String NAME
See Also:
Constant Field Values

TITLE

public static final java.lang.String TITLE
See Also:
Constant Field Values

DESCRIPTION

public static final java.lang.String DESCRIPTION
See Also:
Constant Field Values

NODEREF

public static final java.lang.String NODEREF
See Also:
Constant Field Values

ARCHIVED_BY

public static final java.lang.String ARCHIVED_BY
See Also:
Constant Field Values

ARCHIVED_DATE

public static final java.lang.String ARCHIVED_DATE
See Also:
Constant Field Values

DISPLAY_PATH

public static final java.lang.String DISPLAY_PATH
See Also:
Constant Field Values

USER_NAME

public static final java.lang.String USER_NAME
See Also:
Constant Field Values

FIRST_NAME

public static final java.lang.String FIRST_NAME
See Also:
Constant Field Values

LAST_NAME

public static final java.lang.String LAST_NAME
See Also:
Constant Field Values

NODE_TYPE

public static final java.lang.String NODE_TYPE
See Also:
Constant Field Values

DELETED_NODES

public static final java.lang.String DELETED_NODES
See Also:
Constant Field Values

serviceRegistry

protected org.alfresco.service.ServiceRegistry serviceRegistry

nodeArchiveService

protected org.alfresco.repo.node.archive.NodeArchiveService nodeArchiveService
Constructor Detail

AbstractArchivedNodeWebScript

public AbstractArchivedNodeWebScript()
Method Detail

setServiceRegistry

public void setServiceRegistry(org.alfresco.service.ServiceRegistry serviceRegistry)
Sets the serviceRegistry instance

Parameters:
serviceRegistry - the serviceRegistry to set

setNodeArchiveService

public void setNodeArchiveService(org.alfresco.repo.node.archive.NodeArchiveService nodeArchiveService)
Sets the nodeArchiveService instance

Parameters:
nodeArchiveService - the nodeArchiveService to set

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,
                              java.lang.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 java.util.SortedSet getArchivedNodesFrom(org.alfresco.service.cmr.repository.StoreRef storeRef)
This method gets all nodes from the archive which were originally contained within the specified StoreRef.



Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.