Package org.alfresco.repo.web.scripts

Class RepositoryContainer

java.lang.Object

org.springframework.extensions.webscripts.AbstractRuntimeContainer

org.alfresco.repo.web.scripts.RepositoryContainer

All Implemented Interfaces:

EventListener, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener, org.springframework.extensions.webscripts.Container, org.springframework.extensions.webscripts.RuntimeContainer

Direct Known Subclasses:

ExtensibilityContainer, TenantRepositoryContainer

public class RepositoryContainer
extends org.springframework.extensions.webscripts.AbstractRuntimeContainer

Repository (server-tier) container for Web Scripts

Author:

steveglover, davidc

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.apache.commons.logging.Log	logger

Fields inherited from class org.springframework.extensions.webscripts.AbstractRuntimeContainer

applicationContext

Constructor Summary

Constructors

Constructor	Description
RepositoryContainer()

Method Summary

Modifier and Type	Method	Description
boolean	authenticate(org.springframework.extensions.webscripts.Authenticator auth, org.springframework.extensions.webscripts.Description.RequiredAuthentication required)
void	executeScript(org.springframework.extensions.webscripts.WebScriptRequest scriptReq, org.springframework.extensions.webscripts.WebScriptResponse scriptRes, org.springframework.extensions.webscripts.Authenticator auth)
protected void	executeScriptInternal(org.springframework.extensions.webscripts.WebScriptRequest scriptReq, org.springframework.extensions.webscripts.WebScriptResponse scriptRes, org.springframework.extensions.webscripts.Authenticator auth)
org.springframework.extensions.webscripts.ServerModel	getDescription()
Class<?>[]	getNotPublicExceptions()
Class<?>[]	getPublicExceptions()
org.springframework.extensions.webscripts.Description.RequiredAuthentication	getRequiredAuthentication()
Map<String,Object>	getScriptParameters()
Map<String,Object>	getTemplateParameters()
boolean	isAdminOrSystemUser()
void	onApplicationEvent(org.springframework.context.ApplicationEvent event)
void	reset()
void	setAuthorityService(AuthorityService authorityService)
void	setDescriptorService(DescriptorService descriptorService)
void	setEncryptTempFiles(Boolean encryptTempFiles)
void	setFallbackTransactionHelper(RetryingTransactionHelper fallbackTransactionHelper)
void	setMaxContentSize(Long maxContentSize)
void	setMemoryThreshold(Integer memoryThreshold)
void	setNotPublicExceptions(List<Class<?>> notPublicExceptions)	Exceptions which may contain information that cannot be displayed in UI
void	setPreserveHeadersPattern(String preserveHeadersPattern)
void	setPublicExceptions(List<Class<?>> publicExceptions)	Exceptions which may contain information that need to display in UI
void	setRepository(Repository repository)
void	setRepositoryImageResolver(RepositoryImageResolver imageResolver)
void	setTempDirectoryName(String tempDirectoryName)
void	setTransactionService(TransactionService transactionService)
void	setup()
protected void	transactionedExecute(org.springframework.extensions.webscripts.WebScript script, org.springframework.extensions.webscripts.WebScriptRequest scriptReq, org.springframework.extensions.webscripts.WebScriptResponse scriptRes)	Execute script within required level of transaction

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

allowCallbacks, getApplicationContext, getConfigService, getFormatRegistry, getName, getRegistry, getScriptParameterFactoryRegistry, getScriptProcessorRegistry, getSearchPath, getTemplateProcessorRegistry, setAllowCallbacks, setApplicationContext, setConfigService, setFormatRegistry, setName, setRegistry, setScriptObjects, setScriptParameterFactoryRegistry, setScriptProcessorRegistry, setSearchPath, setTemplateObjects, setTemplateProcessorRegistry

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.apache.commons.logging.Log logger

Constructor Detail

RepositoryContainer

public RepositoryContainer()

Method Detail

setup

public void setup()

setEncryptTempFiles

public void setEncryptTempFiles(Boolean encryptTempFiles)

setTempDirectoryName

public void setTempDirectoryName(String tempDirectoryName)

setMemoryThreshold

public void setMemoryThreshold(Integer memoryThreshold)

setMaxContentSize

public void setMaxContentSize(Long maxContentSize)

setPreserveHeadersPattern

public void setPreserveHeadersPattern(String preserveHeadersPattern)

setRepository

public void setRepository(Repository repository)

Parameters:

repository - Repository

setRepositoryImageResolver

public void setRepositoryImageResolver(RepositoryImageResolver imageResolver)

Parameters:

imageResolver - RepositoryImageResolver

setTransactionService

public void setTransactionService(TransactionService transactionService)

Parameters:

transactionService - TransactionService

setFallbackTransactionHelper

public void setFallbackTransactionHelper(RetryingTransactionHelper fallbackTransactionHelper)

Parameters:

fallbackTransactionHelper - an unlimited transaction helper used to generate error responses

setDescriptorService

public void setDescriptorService(DescriptorService descriptorService)

Parameters:

descriptorService - DescriptorService

setAuthorityService

public void setAuthorityService(AuthorityService authorityService)

Parameters:

authorityService - AuthorityService

setNotPublicExceptions

public void setNotPublicExceptions(List<Class<?>> notPublicExceptions)

Exceptions which may contain information that cannot be displayed in UI

Parameters:

notPublicExceptions - - Class<?>[] instance which contains list of not public exceptions

getNotPublicExceptions

public Class<?>[] getNotPublicExceptions()

setPublicExceptions

public void setPublicExceptions(List<Class<?>> publicExceptions)

Exceptions which may contain information that need to display in UI

Parameters:

publicExceptions - - Class<?>[] instance which contains list of public exceptions

getPublicExceptions

public Class<?>[] getPublicExceptions()

getDescription

public org.springframework.extensions.webscripts.ServerModel getDescription()

getScriptParameters

public Map<String,Object> getScriptParameters()

Specified by:

getScriptParameters in interface org.springframework.extensions.webscripts.Container

Overrides:

getScriptParameters in class org.springframework.extensions.webscripts.AbstractRuntimeContainer

getTemplateParameters

public Map<String,Object> getTemplateParameters()

Specified by:

getTemplateParameters in interface org.springframework.extensions.webscripts.Container

Overrides:

getTemplateParameters in class org.springframework.extensions.webscripts.AbstractRuntimeContainer

executeScript

public void executeScript(org.springframework.extensions.webscripts.WebScriptRequest scriptReq,
                          org.springframework.extensions.webscripts.WebScriptResponse scriptRes,
                          org.springframework.extensions.webscripts.Authenticator auth)
                   throws IOException

Throws:

IOException

executeScriptInternal

protected void executeScriptInternal(org.springframework.extensions.webscripts.WebScriptRequest scriptReq,
                                     org.springframework.extensions.webscripts.WebScriptResponse scriptRes,
                                     org.springframework.extensions.webscripts.Authenticator auth)
                              throws IOException

Throws:

IOException

isAdminOrSystemUser

public final boolean isAdminOrSystemUser()

transactionedExecute

protected void transactionedExecute(org.springframework.extensions.webscripts.WebScript script,
                                    org.springframework.extensions.webscripts.WebScriptRequest scriptReq,
                                    org.springframework.extensions.webscripts.WebScriptResponse scriptRes)
                             throws IOException

Execute script within required level of transaction

Parameters:

script - WebScript

scriptReq - WebScriptRequest

scriptRes - WebScriptResponse

Throws:

IOException

onApplicationEvent

public void onApplicationEvent(org.springframework.context.ApplicationEvent event)

Specified by:

onApplicationEvent in interface org.springframework.context.ApplicationListener

Overrides:

onApplicationEvent in class org.springframework.extensions.webscripts.AbstractRuntimeContainer

getRequiredAuthentication

public org.springframework.extensions.webscripts.Description.RequiredAuthentication getRequiredAuthentication()

Specified by:

getRequiredAuthentication in interface org.springframework.extensions.webscripts.RuntimeContainer

Overrides:

getRequiredAuthentication in class org.springframework.extensions.webscripts.AbstractRuntimeContainer

authenticate

public boolean authenticate(org.springframework.extensions.webscripts.Authenticator auth,
                            org.springframework.extensions.webscripts.Description.RequiredAuthentication required)

Specified by:

authenticate in interface org.springframework.extensions.webscripts.RuntimeContainer

Overrides:

authenticate in class org.springframework.extensions.webscripts.AbstractRuntimeContainer

reset

public void reset()

Specified by:

reset in interface org.springframework.extensions.webscripts.Container

Overrides:

reset in class org.springframework.extensions.webscripts.AbstractRuntimeContainer