Package org.alfresco.repo.web.scripts.links

Class AbstractLinksWebScript

java.lang.Object

org.springframework.extensions.webscripts.AbstractWebScript

org.springframework.extensions.webscripts.DeclarativeWebScript

org.alfresco.repo.web.scripts.links.AbstractLinksWebScript

All Implemented Interfaces:

org.springframework.extensions.webscripts.WebScript

Direct Known Subclasses:

LinkDelete, LinkGet, LinkPut, LinksDeletePost, LinksListGet, LinksPost

public abstract class AbstractLinksWebScript
extends org.springframework.extensions.webscripts.DeclarativeWebScript

Since:

4.0

Author:

Nick Burch

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	Description
protected org.alfresco.service.cmr.activities.ActivityService	activityService
static String	LINKS_SERVICE_ACTIVITY_APP_NAME
protected org.alfresco.service.cmr.links.LinksService	linksService
protected org.alfresco.service.cmr.repository.NodeService	nodeService
protected static String	PARAM_ITEM
protected static String	PARAM_MESSAGE
protected org.alfresco.service.cmr.security.PersonService	personService
protected org.alfresco.service.cmr.site.SiteService	siteService

Constructor Summary

Constructors

Constructor	Description
AbstractLinksWebScript()

Method Summary

Modifier and Type	Method	Description
protected void	addActivityEntry(String event, org.alfresco.service.cmr.links.LinkInfo link, org.alfresco.service.cmr.site.SiteInfo site, org.springframework.extensions.webscripts.WebScriptRequest req, org.json.simple.JSONObject json)	Generates an activity entry for the link
protected org.alfresco.query.PagingRequest	buildPagingRequest(org.springframework.extensions.webscripts.WebScriptRequest req)	Builds up a listing Paging request, based on the arguments specified in the URL
protected abstract Map<String,Object>	executeImpl(org.alfresco.service.cmr.site.SiteInfo site, String linkName, org.springframework.extensions.webscripts.WebScriptRequest req, org.json.simple.JSONObject json, org.springframework.extensions.webscripts.Status status, org.springframework.extensions.webscripts.Cache cache)
protected Map<String,Object>	executeImpl(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.Status status, org.springframework.extensions.webscripts.Cache cache)
protected String	getOrNull(org.json.simple.JSONObject json, String key)
protected List<String>	getTags(org.json.simple.JSONObject json)
protected Map<String,Object>	renderLink(org.alfresco.service.cmr.links.LinkInfo link)
void	setActivityService(org.alfresco.service.cmr.activities.ActivityService activityService)
void	setLinksService(org.alfresco.service.cmr.links.LinksService linksService)
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
void	setPersonService(org.alfresco.service.cmr.security.PersonService personService)
void	setProtocolsWhiteList(String protocolsWhiteList)
void	setSiteService(org.alfresco.service.cmr.site.SiteService siteService)
void	setXssRegexp(ArrayList<String> xssRegexp)

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

Field Detail

LINKS_SERVICE_ACTIVITY_APP_NAME

public static final String LINKS_SERVICE_ACTIVITY_APP_NAME

See Also:

Constant Field Values

PARAM_MESSAGE

protected static final String PARAM_MESSAGE

See Also:

Constant Field Values

PARAM_ITEM

protected static final String PARAM_ITEM

See Also:

Constant Field Values

nodeService

protected org.alfresco.service.cmr.repository.NodeService nodeService

siteService

protected org.alfresco.service.cmr.site.SiteService siteService

linksService

protected org.alfresco.service.cmr.links.LinksService linksService

personService

protected org.alfresco.service.cmr.security.PersonService personService

activityService

protected org.alfresco.service.cmr.activities.ActivityService activityService

Constructor Detail

AbstractLinksWebScript

public AbstractLinksWebScript()

Method Detail

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

setSiteService

public void setSiteService(org.alfresco.service.cmr.site.SiteService siteService)

setLinksService

public void setLinksService(org.alfresco.service.cmr.links.LinksService linksService)

setPersonService

public void setPersonService(org.alfresco.service.cmr.security.PersonService personService)

setActivityService

public void setActivityService(org.alfresco.service.cmr.activities.ActivityService activityService)

setProtocolsWhiteList

public void setProtocolsWhiteList(String protocolsWhiteList)

setXssRegexp

public void setXssRegexp(ArrayList<String> xssRegexp)

getOrNull

protected String getOrNull(org.json.simple.JSONObject json,
                           String key)

getTags

protected List<String> getTags(org.json.simple.JSONObject json)

buildPagingRequest

protected org.alfresco.query.PagingRequest buildPagingRequest(org.springframework.extensions.webscripts.WebScriptRequest req)

Builds up a listing Paging request, based on the arguments specified in the URL

addActivityEntry

protected void addActivityEntry(String event,
                                org.alfresco.service.cmr.links.LinkInfo link,
                                org.alfresco.service.cmr.site.SiteInfo site,
                                org.springframework.extensions.webscripts.WebScriptRequest req,
                                org.json.simple.JSONObject json)

Generates an activity entry for the link

renderLink

protected Map<String,Object> renderLink(org.alfresco.service.cmr.links.LinkInfo link)

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

executeImpl

protected abstract Map<String,Object> executeImpl(org.alfresco.service.cmr.site.SiteInfo site,
                                                        String linkName,
                                                        org.springframework.extensions.webscripts.WebScriptRequest req,
                                                        org.json.simple.JSONObject json,
                                                        org.springframework.extensions.webscripts.Status status,
                                                        org.springframework.extensions.webscripts.Cache cache)