org.alfresco.slingshot.web.scripts

Class NodeBrowserScript

java.lang.Object

org.springframework.extensions.webscripts.AbstractWebScript

org.springframework.extensions.webscripts.DeclarativeWebScript

org.alfresco.slingshot.web.scripts.NodeBrowserScript

All Implemented Interfaces:

org.springframework.extensions.webscripts.WebScript

public class NodeBrowserScript
extends org.springframework.extensions.webscripts.DeclarativeWebScript

Node browser web script to handle search results, node details and workspaces

Author:

dcaruana, wabson

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	NodeBrowserScript.Aspect Aspect wrapper class
class	NodeBrowserScript.Association Association wrapper class
class	NodeBrowserScript.ChildAssociation Child assoc wrapper class
class	NodeBrowserScript.Node Node wrapper class
static class	NodeBrowserScript.NoReadPermissionGranted Permission representing the fact that "Read Permissions" has not been granted
static class	NodeBrowserScript.NoStoreMask
class	NodeBrowserScript.PeerAssociation Peer assoc wrapper class
static class	NodeBrowserScript.Permission Permission bean
class	NodeBrowserScript.Property Property wrapper class
class	NodeBrowserScript.QNameBean Qname wrapper class

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

org.springframework.extensions.webscripts.AbstractWebScript.ScriptDetails

Constructor Summary

Constructors

Constructor and Description
NodeBrowserScript()

Method Summary

Methods

Modifier and Type	Method and Description
protected Map<String,Object>	executeImpl(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.Status status, org.springframework.extensions.webscripts.Cache cache)
List<NodeBrowserScript.Aspect>	getAspects(NodeRef nodeRef) Gets the current node aspects
List<NodeBrowserScript.PeerAssociation>	getAssocs(NodeRef nodeRef) Gets the current node associations
List<Map<String,String>>	getAVMStoreProperties(NodeRef nodeRef)
List<NodeBrowserScript.ChildAssociation>	getChildren(NodeRef nodeRef) Gets the current node children
boolean	getInAVMStore(NodeRef nodeRef)
boolean	getInheritPermissions(NodeRef nodeRef) Gets whether the current node inherits its permissions from a parent node
org.alfresco.service.namespace.QName	getNodeType(NodeRef nodeRef) Gets the current node type
OwnableService	getOwnableService()
List<NodeBrowserScript.ChildAssociation>	getParents(NodeRef nodeRef) Gets the current node parents
List<NodeBrowserScript.Permission>	getPermissions(NodeRef nodeRef) Gets the current node permissions
NodeRef	getPrimaryParent(NodeRef nodeRef) Gets the current node primary parent reference
String	getPrimaryPath(NodeRef nodeRef) Gets the current node primary path
String	getPrimaryPrefixedPath(NodeRef nodeRef) Gets the current node primary path
List<NodeBrowserScript.Property>	getProperties(NodeRef nodeRef) Gets the current node properties
protected Long	getSearchElapsedTime()
List<NodeBrowserScript.PeerAssociation>	getSourceAssocs(NodeRef nodeRef) Gets the current source associations
List<NodeBrowserScript.Permission>	getStorePermissionMasks(NodeRef nodeRef) Gets the current node permissions
List<StoreRef>	getStores() Gets the list of repository stores
void	setAVMService(AVMService avmService)
void	setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
void	setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)
void	setNodeService(NodeService nodeService)
void	setOwnableService(OwnableService ownableService)
void	setPermissionService(PermissionService permissionService)
void	setSearchService(SearchService searchService)
void	setTransactionService(TransactionService transactionService)
List<NodeBrowserScript.Node>	submitSearch(String store, String query, String queryLanguage, int maxResults) Action to submit search

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

execute, executeFinallyImpl, 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

Constructor Detail

NodeBrowserScript

public NodeBrowserScript()

Method Detail

setTransactionService

public void setTransactionService(TransactionService transactionService)

Parameters:

transactionService - transaction service

setNodeService

public void setNodeService(NodeService nodeService)

Parameters:

nodeService - node service

setSearchService

public void setSearchService(SearchService searchService)

Parameters:

searchService - search service

setDictionaryService

public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)

Parameters:

dictionaryService - dictionary service

setNamespaceService

public void setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)

Parameters:

namespaceService - namespace service

setPermissionService

public void setPermissionService(PermissionService permissionService)

Parameters:

permissionService - permission service

setOwnableService

public void setOwnableService(OwnableService ownableService)

getOwnableService

public OwnableService getOwnableService()

setAVMService

public void setAVMService(AVMService avmService)

Parameters:

avmService - AVM service

getStores

public List<StoreRef> getStores()

Gets the list of repository stores

Returns:

stores

getNodeType

public org.alfresco.service.namespace.QName getNodeType(NodeRef nodeRef)

Gets the current node type

Returns:

node type

getPrimaryPath

public String getPrimaryPath(NodeRef nodeRef)

Gets the current node primary path

Returns:

primary path

getPrimaryPrefixedPath

public String getPrimaryPrefixedPath(NodeRef nodeRef)

Gets the current node primary path

Returns:

primary path

getPrimaryParent

public NodeRef getPrimaryParent(NodeRef nodeRef)

Gets the current node primary parent reference

Returns:

primary parent ref

getAspects

public List<NodeBrowserScript.Aspect> getAspects(NodeRef nodeRef)

Gets the current node aspects

Returns:

node aspects

getParents

public List<NodeBrowserScript.ChildAssociation> getParents(NodeRef nodeRef)

Gets the current node parents

Returns:

node parents

getProperties

public List<NodeBrowserScript.Property> getProperties(NodeRef nodeRef)

Gets the current node properties

Returns:

properties

getInheritPermissions

public boolean getInheritPermissions(NodeRef nodeRef)

Gets whether the current node inherits its permissions from a parent node

Returns:

true => inherits permissions

getPermissions

public List<NodeBrowserScript.Permission> getPermissions(NodeRef nodeRef)

Gets the current node permissions

Returns:

the permissions

getStorePermissionMasks

public List<NodeBrowserScript.Permission> getStorePermissionMasks(NodeRef nodeRef)

Gets the current node permissions

Returns:

the permissions

getChildren

public List<NodeBrowserScript.ChildAssociation> getChildren(NodeRef nodeRef)

Gets the current node children

Returns:

node children

getAssocs

public List<NodeBrowserScript.PeerAssociation> getAssocs(NodeRef nodeRef)

Gets the current node associations

Returns:

associations

getSourceAssocs

public List<NodeBrowserScript.PeerAssociation> getSourceAssocs(NodeRef nodeRef)

Gets the current source associations

Returns:

associations

getInAVMStore

public boolean getInAVMStore(NodeRef nodeRef)

getAVMStoreProperties

public List<Map<String,String>> getAVMStoreProperties(NodeRef nodeRef)

submitSearch

public List<NodeBrowserScript.Node> submitSearch(String store,
                                        String query,
                                        String queryLanguage,
                                        int maxResults)
                                          throws IOException

Action to submit search

Returns:

next action

Throws:

IOException

getSearchElapsedTime

protected Long getSearchElapsedTime()

Returns:

the searchElapsedTime

executeImpl

protected Map<String,Object> executeImpl(org.springframework.extensions.webscripts.WebScriptRequest req,
                             org.springframework.extensions.webscripts.Status status,
                             org.springframework.extensions.webscripts.Cache cache)

Overrides:

executeImpl in class org.springframework.extensions.webscripts.DeclarativeWebScript