Class AbstractRuntimeContainer
- java.lang.Object
-
- org.springframework.extensions.webscripts.AbstractRuntimeContainer
-
- All Implemented Interfaces:
java.util.EventListener,org.springframework.beans.factory.Aware,org.springframework.context.ApplicationContextAware,org.springframework.context.ApplicationListener,Container,RuntimeContainer
- Direct Known Subclasses:
PresentationContainer
public abstract class AbstractRuntimeContainer extends java.lang.Object implements RuntimeContainer, org.springframework.context.ApplicationListener, org.springframework.context.ApplicationContextAware
Encapsulates a Container within which the Web Script Runtime executes. Container examples - presentation (web tier), repository (server tier)- Author:
- dcaruana
-
-
Field Summary
Fields Modifier and Type Field Description protected org.springframework.context.ApplicationContextapplicationContext
-
Constructor Summary
Constructors Constructor Description AbstractRuntimeContainer()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanallowCallbacks()Returns if this container should allow callback methods such as json_callbackbooleanauthenticate(Authenticator auth, Description.RequiredAuthentication required)Pre-authenticate container, if requiredprotected org.springframework.context.ApplicationContextgetApplicationContext()Gets the Application Contextorg.springframework.extensions.config.ConfigServicegetConfigService()Gets the Config ServiceFormatRegistrygetFormatRegistry()Gets the response format registryjava.lang.StringgetName()Gets the name of the ContainerRegistrygetRegistry()Gets the registry of Web ScriptsDescription.RequiredAuthenticationgetRequiredAuthentication()Gets the required container authentication level (for matching web scripts)ScriptParameterFactoryRegistrygetScriptParameterFactoryRegistry()Get the Script Parameter Factory Registryjava.util.Map<java.lang.String,java.lang.Object>getScriptParameters()Gets parameters for the Script ProcessorScriptProcessorRegistrygetScriptProcessorRegistry()Gets the Script Processor RegistrySearchPathgetSearchPath()Gets the Search Pathjava.util.Map<java.lang.String,java.lang.Object>getTemplateParameters()Gets parameters for the Template ProcessorTemplateProcessorRegistrygetTemplateProcessorRegistry()Gets the Template Processor RegistryvoidonApplicationEvent(org.springframework.context.ApplicationEvent event)voidreset()Re-initialise the Web Script ContainervoidsetAllowCallbacks(boolean allowCallbacks)voidsetApplicationContext(org.springframework.context.ApplicationContext applicationContext)voidsetConfigService(org.springframework.extensions.config.ConfigService configService)voidsetFormatRegistry(FormatRegistry formatRegistry)voidsetName(java.lang.String name)voidsetRegistry(Registry registry)voidsetScriptObjects(java.util.Map<java.lang.String,java.lang.Object> scriptObjects)voidsetScriptParameterFactoryRegistry(ScriptParameterFactoryRegistry scriptParameterFactoryRegistry)voidsetScriptProcessorRegistry(ScriptProcessorRegistry scriptProcessorRegistry)voidsetSearchPath(SearchPath searchPath)voidsetTemplateObjects(java.util.Map<java.lang.String,java.lang.Object> templateObjects)voidsetTemplateProcessorRegistry(TemplateProcessorRegistry templateProcessorRegistry)-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.springframework.extensions.webscripts.Container
getDescription
-
Methods inherited from interface org.springframework.extensions.webscripts.RuntimeContainer
executeScript
-
-
-
-
Method Detail
-
setName
public void setName(java.lang.String name)
- Parameters:
name- String
-
setFormatRegistry
public void setFormatRegistry(FormatRegistry formatRegistry)
- Parameters:
formatRegistry- FormatRegistry
-
setRegistry
public void setRegistry(Registry registry)
- Parameters:
registry- Registry
-
setScriptProcessorRegistry
public void setScriptProcessorRegistry(ScriptProcessorRegistry scriptProcessorRegistry)
- Parameters:
scriptProcessorRegistry- ScriptProcessorRegistry
-
setTemplateProcessorRegistry
public void setTemplateProcessorRegistry(TemplateProcessorRegistry templateProcessorRegistry)
- Parameters:
templateProcessorRegistry- TemplateProcessorRegistry
-
setScriptParameterFactoryRegistry
public void setScriptParameterFactoryRegistry(ScriptParameterFactoryRegistry scriptParameterFactoryRegistry)
- Parameters:
scriptParameterFactoryRegistry- ScriptParameterFactoryRegistry
-
setSearchPath
public void setSearchPath(SearchPath searchPath)
- Parameters:
searchPath- SearchPath
-
setConfigService
public void setConfigService(org.springframework.extensions.config.ConfigService configService)
- Parameters:
configService- ConfigService
-
setScriptObjects
public void setScriptObjects(java.util.Map<java.lang.String,java.lang.Object> scriptObjects)
- Parameters:
scriptObjects- Map
-
setTemplateObjects
public void setTemplateObjects(java.util.Map<java.lang.String,java.lang.Object> templateObjects)
- Parameters:
templateObjects- Map
-
setAllowCallbacks
public void setAllowCallbacks(boolean allowCallbacks)
- Parameters:
allowCallbacks- try to enable callback methods, such as json_callback
-
allowCallbacks
public boolean allowCallbacks()
Description copied from interface:ContainerReturns if this container should allow callback methods such as json_callback- Specified by:
allowCallbacksin interfaceContainer- Returns:
- true if this container should allow callback methods such as json_callback, false otherwise
-
getName
public java.lang.String getName()
Description copied from interface:ContainerGets the name of the Container
-
getScriptParameters
public java.util.Map<java.lang.String,java.lang.Object> getScriptParameters()
Description copied from interface:ContainerGets parameters for the Script Processor- Specified by:
getScriptParametersin interfaceContainer- Returns:
- parameters
-
getTemplateParameters
public java.util.Map<java.lang.String,java.lang.Object> getTemplateParameters()
Description copied from interface:ContainerGets parameters for the Template Processor- Specified by:
getTemplateParametersin interfaceContainer- Returns:
- parameters
-
getFormatRegistry
public FormatRegistry getFormatRegistry()
Description copied from interface:ContainerGets the response format registry- Specified by:
getFormatRegistryin interfaceContainer- Returns:
- response format registry
-
getRegistry
public Registry getRegistry()
Description copied from interface:ContainerGets the registry of Web Scripts- Specified by:
getRegistryin interfaceContainer- Returns:
- registry of web scripts
-
getConfigService
public org.springframework.extensions.config.ConfigService getConfigService()
Description copied from interface:ContainerGets the Config Service- Specified by:
getConfigServicein interfaceContainer- Returns:
- config service
-
getScriptProcessorRegistry
public ScriptProcessorRegistry getScriptProcessorRegistry()
Description copied from interface:ContainerGets the Script Processor Registry- Specified by:
getScriptProcessorRegistryin interfaceContainer- Returns:
- script processor registry
-
getTemplateProcessorRegistry
public TemplateProcessorRegistry getTemplateProcessorRegistry()
Description copied from interface:ContainerGets the Template Processor Registry- Specified by:
getTemplateProcessorRegistryin interfaceContainer- Returns:
- template processor registry
-
getScriptParameterFactoryRegistry
public ScriptParameterFactoryRegistry getScriptParameterFactoryRegistry()
Description copied from interface:ContainerGet the Script Parameter Factory Registry- Specified by:
getScriptParameterFactoryRegistryin interfaceContainer- Returns:
- script parameter factory registry
-
getSearchPath
public SearchPath getSearchPath()
Description copied from interface:ContainerGets the Search Path- Specified by:
getSearchPathin interfaceContainer- Returns:
- search path
-
reset
public void reset()
Description copied from interface:ContainerRe-initialise the Web Script Container
-
onApplicationEvent
public void onApplicationEvent(org.springframework.context.ApplicationEvent event)
- Specified by:
onApplicationEventin interfaceorg.springframework.context.ApplicationListener
-
setApplicationContext
public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext) throws org.springframework.beans.BeansException- Specified by:
setApplicationContextin interfaceorg.springframework.context.ApplicationContextAware- Throws:
org.springframework.beans.BeansException
-
getApplicationContext
protected org.springframework.context.ApplicationContext getApplicationContext()
Gets the Application Context- Returns:
- application context
-
getRequiredAuthentication
public Description.RequiredAuthentication getRequiredAuthentication()
Description copied from interface:RuntimeContainerGets the required container authentication level (for matching web scripts)- Specified by:
getRequiredAuthenticationin interfaceRuntimeContainer- Returns:
- the required authentication level
-
authenticate
public boolean authenticate(Authenticator auth, Description.RequiredAuthentication required)
Description copied from interface:RuntimeContainerPre-authenticate container, if required- Specified by:
authenticatein interfaceRuntimeContainer- Parameters:
auth- Authenticatorrequired- RequiredAuthentication
-
-