AbstractRequestContext (Surf 6.2 API)

java.lang.Object
- org.springframework.extensions.surf.support.BaseFactoryBean
- - org.springframework.extensions.surf.support.ThreadLocalRequestContext
  - - org.springframework.extensions.surf.support.AbstractRequestContext

All Implemented Interfaces:

Serializable, org.springframework.extensions.surf.extensibility.HandlesExtensibility, RequestContext

Direct Known Subclasses:

ServletRequestContext
```
public abstract class AbstractRequestContext
extends ThreadLocalRequestContext
implements org.springframework.extensions.surf.extensibility.HandlesExtensibility
```
Abstract base class for RequestContext implementations. This is provided as a convenience to developers who wish to build their own custom RequestContext variations.
Implementations that inherit from this class will benefit from having automatic thread local bindings for their custom request context types.

Author:

muzquiano, David Draper

See Also:
ThreadLocalRequestContext, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<String,Serializable>`	`attributesMap`
`protected Map<String,Component>`	`components`
`protected String`	`contextPath`
`protected static AtomicLong`	`counter`
`protected String`	`currentFormatId`
`protected Page`	`currentPage`
`protected Resource`	`currentResource`
`protected TemplateInstance`	`currentTemplate`
`protected Map<String,String>`	`headersMap`
`protected String`	`id`
`protected String`	`method`
`protected Map<String,Object>`	`model`
`protected Map<String,String>`	`parametersMap`
`protected Page`	`rootPage`
`protected String`	`scheme`
`protected Configuration`	`siteConfiguration`
`protected String`	`storeId`
`protected Theme`	`theme`
`protected String`	`uri`
`protected Map<String,String>`	`uriTokens`
`protected org.springframework.extensions.webscripts.connector.User`	`user`
`static String`	`VALUE_HEAD_TAGS`
`protected Map<String,Serializable>`	`valuesMap`
`protected String`	`viewName`

Fields inherited from interface org.springframework.extensions.surf.RequestContext
ATTR_REQUEST_CONTEXT, DEBUG_MODE_VALUE_COMPONENTS, USER_ENDPOINT, VALUE_CREDENTIAL_VAULT, VALUE_IDENTITY_VAULT

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractRequestContext(WebFrameworkServiceRegistry serviceRegistry)` Deprecated.
`protected`	`AbstractRequestContext(WebFrameworkServiceRegistry serviceRegistry, FrameworkBean frameworkUtil)` Constructs a new Request Context.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addCssDependency(String dependency, String media)` This method allows CSS resources to be added into the same list of dependencies added to by extension modules.
`void`	`addExtensibilityDirectives(Map<String,Object> freeMarkerModel, org.springframework.extensions.surf.extensibility.ExtensibilityModel extModel)`
`void`	`addExtensionBundleToCache(String webScriptId, org.springframework.extensions.webscripts.WebScriptPropertyResourceBundle extensionBundle)` Adds a new extended bundle to the cache.
`void`	`addJSDependency(String dependency)` This method allows JavaScript resources to be added into the same list of dependencies added to by extension modules.
`void`	`addSubComponentDebugData(String id, SubComponent.RenderData data)` Adds the `SubComponent.RenderData` for the specified `SubComponent`.
`void`	`closeExtensibilityModel(org.springframework.extensions.surf.extensibility.ExtensibilityModel model, Writer out)`
`boolean`	`dependencyAlreadyRequested(String dep)` Checks whether or not the supplied dependency has already been requested.
`Serializable`	`getAttribute(String key)` Retrieves an attribute from the request context
`Map<String,Serializable>`	`getAttributes()` Returns a map of attributes
`ResourceBundle`	`getCachedExtendedBundle(String webScriptId)` Checks the cache to see if it has cached an extended bundle (that is a basic `ResourceBundle` that has had extension modules applied to it.
`String`	`getContentAsString()` This method must be implemented to return the result of calling `getContentAsString()` method of the `FakeHttpServletResponse` that is returned from the `getResponse()` method when the `RequestContext` is in passive mode.
`String`	`getContextPath()` Returns the request context path
`org.springframework.extensions.webscripts.connector.CredentialVault`	`getCredentialVault()` Returns a `CredentialVault`.
`org.springframework.extensions.surf.extensibility.ExtensibilityModel`	`getCurrentExtensibilityModel()`
`Resource`	`getCurrentObject()` Returns the current object If no object has been set, then null is returned
`String`	`getCurrentObjectId()` Returns the id of the current object If no object has been set, then the id will be null.
`List<ExtensionModule>`	`getEvaluatedModules()` Retrieve the list of `ExtensionModule` instances that have been evaluated as applicable for the current request.
`Map<String,Serializable>`	`getEvaluatedProperties()`
`org.springframework.extensions.webscripts.ScriptConfigModel`	`getExtendedScriptConfigModel(String xmlConfig)` Creates a new `ExtendedScriptConfigModel` instance using the local configuration generated for this request.
`org.springframework.extensions.webscripts.TemplateConfigModel`	`getExtendedTemplateConfigModel(String xmlConfig)` Creates a new `TemplateConfigModel` instance using the local configuration generated for this request.
`List<String>`	`getExtendingModuleFiles(String pathBeingProcessed)` Retrieves a list of files that should be provided by the evaluated modules.
`String`	`getExtensionDependencies()` Returns the dependencies requested by extension modules as a formatted String.
`String`	`getFileBeingProcessed()`
`String`	`getFormatId()` Returns the current format id
`String`	`getHeader(String key)` Retrieves an header from the request context
`Map<String,String>`	`getHeaders()` Returns a map of headers
`String`	`getId()` Each request context instance is stamped with a unique id
`abstract LinkBuilder`	`getLinkBuilder()` Returns the LinkBuilder to be used for the currently executing page.
`Map<String,Object>`	`getModel()` Returns the spring mvc model
`ModelObject`	`getObject()`
`ModelObjectService`	`getObjectService()` Gets the model object service
`Page`	`getPage()` If a page instance is currently executing, it can be retrieved from the request context.
`String`	`getPageId()` Returns the id of the currently executing page.
`String`	`getPageTitle()` Returns the title of the current page.
`String`	`getParameter(String key)` Retrieves a parameter from the request context
`Map<String,String>`	`getParameters()` Returns a map of parameters
`Component[]`	`getRenderingComponents()` Returns the components that were bound to this and any of its parent context during the rendering.
`RenderMode`	`getRenderMode()` A `RenderMode` can be set by a ComponentTypes to allow different outputs to be rendered when requesting a Component directly by specifying a "mode" request parameter.
`org.springframework.web.context.request.WebRequest`	`getRequest()`
`org.springframework.extensions.surf.util.Content`	`getRequestContent()` Returns the body of the incoming POST content This is applicable for multipart form requests
`String`	`getRequestMethod()` Returns the method of the incoming request
`String`	`getRequestScheme()` Returns the protocol (e.g.
`javax.servlet.http.HttpServletResponse`	`getResponse()` This method must be implemented to return the `HttpServletResponse` associated with the `RequestContext`.
`Page`	`getRootPage()` Returns the root page for a site.
`String`	`getServletContextPath()` Returns the context path of the servlet being used to process the request.
`Configuration`	`getSiteConfiguration()` If the site has a configuration XML, then this will return it
`SubComponent.RenderData`	`getSubComponentDebugData(String id)` Retrieves the `SubComponent.RenderData` for the specified `SubComponent`.
`TemplateInstance`	`getTemplate()` Returns the current executing template.
`String`	`getTemplateId()` Returns the id of the currently executing template.
`Theme`	`getTheme()`
`String`	`getThemeId()` Returns the current theme id
`String`	`getUri()`
`Map<String,String>`	`getUriTokens()` Retrieves any URI tokens parsed in the view resolver.
`org.springframework.extensions.webscripts.connector.User`	`getUser()` Returns the current user
`String`	`getUserId()` Returns the current user id
`Serializable`	`getValue(String key)` Retrieves a custom value from the request context
`Map<String,Serializable>`	`getValuesMap()` Returns the underlying map of the custom key/values pairs stored on this RequestContext instance.
`String`	`getViewName()`
`String`	`getWebsiteTitle()` Returns the title of the web site.
`boolean`	`hasAttribute(String key)` Returns true if an attribute exists in the request context
`boolean`	`hasHeader(String key)` Returns true if an header exists in the request context
`boolean`	`hasParameter(String key)` Returns true if a parameter exists in the request context
`boolean`	`hasValue(String key)` Returns true if a custom value exists in the request context
`boolean`	`isPassiveMode()` Indicates whether or not the `RequestContext` is currently in "passive mode".
`void`	`markDependencyAsRequested(String dep)` This method can be used to indicate that the supplied dependency has been requested by other means.
`org.springframework.extensions.surf.extensibility.ExtensibilityModel`	`openExtensibilityModel()`
`void`	`removeValue(String key)` Removes a custom value from the request context
`void`	`setConfigService(org.springframework.extensions.config.ConfigService configService)`
`void`	`setCurrentObject(Resource resource)` Sets the current object
`void`	`setDependencyHandler(DependencyHandler dependencyHandler)`
`void`	`setEvaluatedProperties(Map<String,Serializable> properties)`
`void`	`setExtensibilityModuleHandler(ExtensibilityModuleHandler extensibilityModuleHandler)` This method is provided for `AbstractRequestContextFactory` instances to set the `ExtensibilityModuleHandler` that is required to evaluate which `ExtensionModule` instances are applicable for a request.
`void`	`setFileBeingProcessed(String file)`
`void`	`setFormatId(String formatId)` Sets the current format id
`void`	`setModel(Map<String,Object> model)` Sets the spring mvc model
`void`	`setObject(ModelObject object)`
`void`	`setPage(Page page)` Sets the currently executing page.
`void`	`setPassiveMode(boolean passiveMode)` This switches the `RequestContext` into or out of "passive mode" (depending upon the value of the supplied `passiveMode` argument).
`void`	`setRenderingComponent(Component component)` Indicates that the given component is being rendered as part of the rendering execution for this and any parent rendering context.
`void`	`setRenderMode(RenderMode mode)` This method can be called to update the `RenderMode` used for rendering.
`void`	`setRequest(org.springframework.web.context.request.WebRequest request)`
`void`	`setResponse(javax.servlet.http.HttpServletResponse response)` This method must be implemented to set the supplied `HttpServletResponse` as the response for the `RequestContext`.
`void`	`setServletContextPath(String path)` This method should be used to set the context path of the servlet being used to process the request.
`void`	`setTemplate(TemplateInstance currentTemplate)` Sets the current executing template.
`void`	`setTheme(Theme theme)` Sets the theme
`void`	`setUri(String uri)` Sets the currently executing uri.
`void`	`setUriTokens(Map<String,String> _uriTokens)` Sets the parsed URI tokens
`void`	`setUser(org.springframework.extensions.webscripts.connector.User user)` Sets the current user for this request
`void`	`setValue(String key, Serializable value)` Sets a custom attribute onto the request context
`void`	`setViewName(String viewName)` Spring MVC view name - generally the same as the page ID but may be different due to URI template 'pageid' token matching.
`void`	`setWebFrameworkConfigElement(WebFrameworkConfigElement webFrameworkConfigElement)` This method is provided for `AbstractRequestContextFactory` instances to set the `WebFrameworkConfigElement` for the application.
`String`	`toString()`
`void`	`updateExtendingModuleDependencies(String path, Map<String,Object> model)` Updates the dependencies requested by extension modules for the current request.

Methods inherited from class org.springframework.extensions.surf.support.ThreadLocalRequestContext
getRequestContext, release

Methods inherited from class org.springframework.extensions.surf.support.BaseFactoryBean
getResourceService, getServiceRegistry, getWebFrameworkConfiguration

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.extensions.surf.extensibility.HandlesExtensibility
isExtensibilitySuppressed

Methods inherited from interface org.springframework.extensions.surf.RequestContext
getServiceRegistry

- Field Detail
  - VALUE_HEAD_TAGS
```
public static final String VALUE_HEAD_TAGS
```
    See Also:
    Constant Field Values
  - counter
```
protected static AtomicLong counter
```
  - valuesMap
```
protected Map<String,Serializable> valuesMap
```
  - parametersMap
```
protected Map<String,String> parametersMap
```
  - attributesMap
```
protected Map<String,Serializable> attributesMap
```
  - headersMap
```
protected Map<String,String> headersMap
```
  - uriTokens
```
protected Map<String,String> uriTokens
```
  - rootPage
```
protected Page rootPage
```
  - siteConfiguration
```
protected Configuration siteConfiguration
```
  - currentPage
```
protected Page currentPage
```
  - currentTemplate
```
protected TemplateInstance currentTemplate
```
  - currentResource
```
protected Resource currentResource
```
  - currentFormatId
```
protected String currentFormatId
```
  - storeId
```
protected String storeId
```
  - user
```
protected org.springframework.extensions.webscripts.connector.User user
```
  - id
```
protected String id
```
  - uri
```
protected String uri
```
  - viewName
```
protected String viewName
```
  - theme
```
protected Theme theme
```
  - components
```
protected Map<String,Component> components
```
  - model
```
protected Map<String,Object> model
```
  - method
```
protected String method
```
  - scheme
```
protected String scheme
```
  - contextPath
```
protected String contextPath
```
- Constructor Detail
  - AbstractRequestContext
```
protected AbstractRequestContext(WebFrameworkServiceRegistry serviceRegistry,
                      FrameworkBean frameworkUtil)
```
    Constructs a new Request Context. In general, you should not have to construct these by hand. They are constructed by the framework via a RequestContextFactory.
  - AbstractRequestContext
```
protected AbstractRequestContext(WebFrameworkServiceRegistry serviceRegistry)
```
    Deprecated.
    
    Constructs a new Request Context. In general, you should not have to construct these by hand. They are constructed by the framework via a RequestContextFactory.
    
    This method has been deprecated as it depends upon the deprecated static helper methods of FrameworkUtil which have been replaced by non-static helper methods accessed by using FrameworkUtil as a Spring bean
    
    Parameters:
    serviceRegistry - WebFrameworkServiceRegistry
- Method Detail
  - getId
```
public String getId()
```
    Description copied from interface: RequestContext
    
    Each request context instance is stamped with a unique id
    
    Specified by:
    
    getId in interface RequestContext
    
    Returns:
    The id of the request context
  - getSiteConfiguration
```
public Configuration getSiteConfiguration()
```
    Description copied from interface: RequestContext
    
    If the site has a configuration XML, then this will return it
    
    Specified by:
    
    getSiteConfiguration in interface RequestContext
    
    Returns:
    Configuration instance for the site
  - getWebsiteTitle
```
public String getWebsiteTitle()
```
    Description copied from interface: RequestContext
    
    Returns the title of the web site. This is drawn from the site configuration XML if available.
    
    Specified by:
    
    getWebsiteTitle in interface RequestContext
    
    Returns:
    String
  - getPageTitle
```
public String getPageTitle()
```
    Description copied from interface: RequestContext
    
    Returns the title of the current page. This is drawn from the current page instance, if set.
    
    Specified by:
    
    getPageTitle in interface RequestContext
    
    Returns:
    The title of the current page.
  - getUri
```
public String getUri()
```
    Specified by:
    
    getUri in interface RequestContext
    
    Returns:
    the currently executing uri.
  - setUri
```
public void setUri(String uri)
```
    Description copied from interface: RequestContext
    
    Sets the currently executing uri.
    
    Specified by:
    
    setUri in interface RequestContext
  - getViewName
```
public String getViewName()
```
    Specified by:
    
    getViewName in interface RequestContext
    
    Returns:
    Spring MVC view name
  - setViewName
```
public void setViewName(String viewName)
```
    Description copied from interface: RequestContext
    
    Spring MVC view name - generally the same as the page ID but may be different due to URI template 'pageid' token matching.
    
    Specified by:
    
    setViewName in interface RequestContext
    
    Parameters:
    viewName - Spring MVC view name
  - getPage
```
public Page getPage()
```
    Description copied from interface: RequestContext
    
    If a page instance is currently executing, it can be retrieved from the request context.
    
    Specified by:
    
    getPage in interface RequestContext
    
    Returns:
    The current page
  - setPage
```
public void setPage(Page page)
```
    Description copied from interface: RequestContext
    
    Sets the currently executing page.
    
    Specified by:
    
    setPage in interface RequestContext
    
    Parameters:
    page - Page
  - getPageId
```
public String getPageId()
```
    Description copied from interface: RequestContext
    
    Returns the id of the currently executing page. If a currently executing page is not set, this will return null.
    
    Specified by:
    
    getPageId in interface RequestContext
    
    Returns:
    The current page id (or null)
  - getLinkBuilder
```
public abstract LinkBuilder getLinkBuilder()
```
    Description copied from interface: RequestContext
    
    Returns the LinkBuilder to be used for the currently executing page. In general, you will have one link builder per site but this hook allows for the possibility of multiple.
    
    Specified by:
    
    getLinkBuilder in interface RequestContext
    
    Returns:
    LinkBuilder
  - getRootPage
```
public Page getRootPage()
```
    Description copied from interface: RequestContext
    
    Returns the root page for a site. A root page is designated if it either has a root-page property in its XML or the site configuration has specifically designated a root page.
    
    Specified by:
    
    getRootPage in interface RequestContext
    
    Returns:
    The root page of the application
  - getTemplate
```
public TemplateInstance getTemplate()
```
    Description copied from interface: RequestContext
    
    Returns the current executing template.
    
    Specified by:
    
    getTemplate in interface RequestContext
    
    Returns:
    TemplateInstance
  - setTemplate
```
public void setTemplate(TemplateInstance currentTemplate)
```
    Description copied from interface: RequestContext
    
    Sets the current executing template.
    
    Specified by:
    
    setTemplate in interface RequestContext
  - getTemplateId
```
public String getTemplateId()
```
    Description copied from interface: RequestContext
    
    Returns the id of the currently executing template. If no template is set, this will return null.
    
    Specified by:
    
    getTemplateId in interface RequestContext
    
    Returns:
    The current template id or null
  - getCurrentObjectId
```
public String getCurrentObjectId()
```
    Description copied from interface: RequestContext
    
    Returns the id of the current object If no object has been set, then the id will be null.
    
    Specified by:
    
    getCurrentObjectId in interface RequestContext
    
    Returns:
    The id of the current object
  - setCurrentObject
```
public void setCurrentObject(Resource resource)
```
    Description copied from interface: RequestContext
    
    Sets the current object
    
    Specified by:
    
    setCurrentObject in interface RequestContext
    
    Parameters:
    resource - Resource
  - getCurrentObject
```
public Resource getCurrentObject()
```
    Description copied from interface: RequestContext
    
    Returns the current object If no object has been set, then null is returned
    
    Specified by:
    
    getCurrentObject in interface RequestContext
    
    Returns:
    The current object
  - getFormatId
```
public String getFormatId()
```
    Description copied from interface: RequestContext
    
    Returns the current format id
    
    Specified by:
    
    getFormatId in interface RequestContext
    
    Returns:
    String
  - setFormatId
```
public void setFormatId(String formatId)
```
    Description copied from interface: RequestContext
    
    Sets the current format id
    
    Specified by:
    
    setFormatId in interface RequestContext
    
    Parameters:
    formatId - String
  - setUser
```
public void setUser(org.springframework.extensions.webscripts.connector.User user)
```
    Description copied from interface: RequestContext
    
    Sets the current user for this request
    
    Specified by:
    
    setUser in interface RequestContext
    
    Parameters:
    user - User
  - getUser
```
public org.springframework.extensions.webscripts.connector.User getUser()
```
    Description copied from interface: RequestContext
    
    Returns the current user
    
    Specified by:
    
    getUser in interface RequestContext
    
    Returns:
    User
  - getUserId
```
public String getUserId()
```
    Description copied from interface: RequestContext
    
    Returns the current user id
    
    Specified by:
    
    getUserId in interface RequestContext
    
    Returns:
    String
  - getCredentialVault
```
public org.springframework.extensions.webscripts.connector.CredentialVault getCredentialVault()
```
    Returns a CredentialVault. It the subclass has been instantiated using the deprecated constructor then the CredentialVault will be retrieved using the deprecated static helper method from FrameworkUtil.
    
    If the subclass was instantiated using the preferred constructor that accepts a FrameworkBean (adapted from the FrameworkUtil class) then the FrameworkBean will be used instead.
    
    Both methods effectively do the same thing, but the FrameworkBean makes use of properly configured Spring beans so if more flexible and extensible.
    
    Specified by:
    
    getCredentialVault in interface RequestContext
    
    Returns:
    A CredentialVault
  - setValue
```
public void setValue(String key,
            Serializable value)
```
    Description copied from interface: RequestContext
    
    Sets a custom attribute onto the request context
    
    Specified by:
    
    setValue in interface RequestContext
    
    Parameters:
    key - String
    value - Serializable
  - getValue
```
public Serializable getValue(String key)
```
    Description copied from interface: RequestContext
    
    Retrieves a custom value from the request context
    
    Specified by:
    
    getValue in interface RequestContext
    
    Parameters:
    key - String
    
    Returns:
    Serializable
  - removeValue
```
public void removeValue(String key)
```
    Description copied from interface: RequestContext
    
    Removes a custom value from the request context
    
    Specified by:
    
    removeValue in interface RequestContext
    
    Parameters:
    key - String
  - hasValue
```
public boolean hasValue(String key)
```
    Description copied from interface: RequestContext
    
    Returns true if a custom value exists in the request context
    
    Specified by:
    
    hasValue in interface RequestContext
    
    Parameters:
    key - String
    
    Returns:
    true if a custom value exists in the request context
  - getValuesMap
```
public Map<String,Serializable> getValuesMap()
```
    Description copied from interface: RequestContext
    
    Returns the underlying map of the custom key/values pairs stored on this RequestContext instance. Use with caution!
    
    Specified by:
    
    getValuesMap in interface RequestContext
    
    Returns:
    the underlying map of custom key/value pairs.
  - getParameter
```
public String getParameter(String key)
```
    Description copied from interface: RequestContext
    
    Retrieves a parameter from the request context
    
    Specified by:
    
    getParameter in interface RequestContext
    
    Parameters:
    key - String
    
    Returns:
    String
  - hasParameter
```
public boolean hasParameter(String key)
```
    Description copied from interface: RequestContext
    
    Returns true if a parameter exists in the request context
    
    Specified by:
    
    hasParameter in interface RequestContext
    
    Parameters:
    key - String
    
    Returns:
    true if a custom value exists in the request context
  - getParameters
```
public Map<String,String> getParameters()
```
    Description copied from interface: RequestContext
    
    Returns a map of parameters
    
    Specified by:
    
    getParameters in interface RequestContext
    
    Returns:
    the underlying map of parameters
  - getRenderingComponents
```
public Component[] getRenderingComponents()
```
    Description copied from interface: RequestContext
    
    Returns the components that were bound to this and any of its parent context during the rendering. This is useful to determine what other components are configured on the current page. If no rendering components are set, null will be returned
    
    Specified by:
    
    getRenderingComponents in interface RequestContext
    
    Returns:
    An array of Component objects
  - setRenderingComponent
```
public void setRenderingComponent(Component component)
```
    Description copied from interface: RequestContext
    
    Indicates that the given component is being rendered as part of the rendering execution for this and any parent rendering context.
    
    Specified by:
    
    setRenderingComponent in interface RequestContext
    
    Parameters:
    component - The component that is being rendered
  - getTheme
```
public Theme getTheme()
```
    Specified by:
    
    getTheme in interface RequestContext
    
    Returns:
    the current Theme object or null if not set
  - setTheme
```
public void setTheme(Theme theme)
```
    Description copied from interface: RequestContext
    
    Sets the theme
    
    Specified by:
    
    setTheme in interface RequestContext
    
    Parameters:
    theme - Theme
  - getThemeId
```
public String getThemeId()
```
    Description copied from interface: RequestContext
    
    Returns the current theme id
    
    Specified by:
    
    getThemeId in interface RequestContext
  - getRequestMethod
```
public String getRequestMethod()
```
    Description copied from interface: RequestContext
    
    Returns the method of the incoming request
    
    Specified by:
    
    getRequestMethod in interface RequestContext
    
    Returns:
    request method
  - getRequestScheme
```
public String getRequestScheme()
```
    Description copied from interface: RequestContext
    
    Returns the protocol (e.g. HTTP/HTTPS) of the request.
    
    Specified by:
    
    getRequestScheme in interface RequestContext
    
    Returns:
    String
  - getObjectService
```
public ModelObjectService getObjectService()
```
    Description copied from class: BaseFactoryBean
    
    Gets the model object service
    
    Specified by:
    
    getObjectService in interface RequestContext
    
    Overrides:
    
    getObjectService in class BaseFactoryBean
    
    Returns:
    model object service
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - setModel
```
public void setModel(Map<String,Object> model)
```
    Description copied from interface: RequestContext
    
    Sets the spring mvc model
    
    Specified by:
    
    setModel in interface RequestContext
    
    Parameters:
    model - Map
  - getModel
```
public Map<String,Object> getModel()
```
    Description copied from interface: RequestContext
    
    Returns the spring mvc model
    
    Specified by:
    
    getModel in interface RequestContext
    
    Returns:
    model
  - getContextPath
```
public String getContextPath()
```
    Description copied from interface: RequestContext
    
    Returns the request context path
    
    Specified by:
    
    getContextPath in interface RequestContext
    
    Returns:
    context path
  - getAttribute
```
public Serializable getAttribute(String key)
```
    Description copied from interface: RequestContext
    
    Retrieves an attribute from the request context
    
    Specified by:
    
    getAttribute in interface RequestContext
    
    Parameters:
    key - String
    
    Returns:
    Serializable
  - hasAttribute
```
public boolean hasAttribute(String key)
```
    Description copied from interface: RequestContext
    
    Returns true if an attribute exists in the request context
    
    Specified by:
    
    hasAttribute in interface RequestContext
    
    Parameters:
    key - String
    
    Returns:
    whether the attribute exists
  - getAttributes
```
public Map<String,Serializable> getAttributes()
```
    Description copied from interface: RequestContext
    
    Returns a map of attributes
    
    Specified by:
    
    getAttributes in interface RequestContext
    
    Returns:
    the underlying map of attributes
  - getHeader
```
public String getHeader(String key)
```
    Description copied from interface: RequestContext
    
    Retrieves an header from the request context
    
    Specified by:
    
    getHeader in interface RequestContext
    
    Parameters:
    key - String
    
    Returns:
    String
  - hasHeader
```
public boolean hasHeader(String key)
```
    Description copied from interface: RequestContext
    
    Returns true if an header exists in the request context
    
    Specified by:
    
    hasHeader in interface RequestContext
    
    Parameters:
    key - String
    
    Returns:
    whether the header exists
  - getHeaders
```
public Map<String,String> getHeaders()
```
    Description copied from interface: RequestContext
    
    Returns a map of headers
    
    Specified by:
    
    getHeaders in interface RequestContext
    
    Returns:
    the underlying map of headers
  - setUriTokens
```
public void setUriTokens(Map<String,String> _uriTokens)
```
    Description copied from interface: RequestContext
    
    Sets the parsed URI tokens
    
    Specified by:
    
    setUriTokens in interface RequestContext
    
    Parameters:
    _uriTokens - Map
  - getUriTokens
```
public Map<String,String> getUriTokens()
```
    Description copied from interface: RequestContext
    
    Retrieves any URI tokens parsed in the view resolver.
    
    Specified by:
    
    getUriTokens in interface RequestContext
    
    Returns:
    uri tokens
  - getRequestContent
```
public org.springframework.extensions.surf.util.Content getRequestContent()
```
    Description copied from interface: RequestContext
    
    Returns the body of the incoming POST content This is applicable for multipart form requests
    
    Specified by:
    
    getRequestContent in interface RequestContext
    
    Returns:
    content
  - getRenderMode
```
public final RenderMode getRenderMode()
```
    Description copied from interface: RequestContext
    
    A RenderMode can be set by a ComponentTypes to allow different outputs to be rendered when requesting a Component directly by specifying a "mode" request parameter. The RenderMode defaults to RenderMode.VIEW but will be set in the context if the "mode" request parameter is detected when a component is directly requested to be rendered.
    
    Specified by:
    
    getRenderMode in interface RequestContext
    
    Returns:
    The RenderMode for the current context.
  - setRenderMode
```
public final void setRenderMode(RenderMode mode)
```
    Description copied from interface: RequestContext
    
    This method can be called to update the RenderMode used for rendering. The RenderMode only affects the rendering of Components. Different RenderModes can be configured in ComponentType configuration files.
    
    Specified by:
    
    setRenderMode in interface RequestContext
    
    Parameters:
    mode - RenderMode
  - getRequest
```
public final org.springframework.web.context.request.WebRequest getRequest()
```
  - setRequest
```
public final void setRequest(org.springframework.web.context.request.WebRequest request)
```
  - getResponse
```
public final javax.servlet.http.HttpServletResponse getResponse()
```
    Description copied from interface: RequestContext
    
    This method must be implemented to return the HttpServletResponse associated with the RequestContext. However, if the RequestContext has been set to "passive" (via the setPassiveMode method then this should return a FakeHttpServletResponse to ensure that rendering isn't output twice as passive mode is used to calculate dependencies (see TemplateInstanceRenderer).
    
    Specified by:
    
    getResponse in interface RequestContext
    
    Returns:
    An HttpServletResponse when isPassiveMode() returns false and a FakeHttpServletResponse when isPassiveMode() returns true.
  - getContentAsString
```
public String getContentAsString()
                          throws UnsupportedEncodingException
```
    Description copied from interface: RequestContext
    
    This method must be implemented to return the result of calling getContentAsString() method of the FakeHttpServletResponse that is returned from the getResponse() method when the RequestContext is in passive mode.
    
    Specified by:
    
    getContentAsString in interface RequestContext
    
    Returns:
    A String representing the output that would be generated by a real response.
    
    Throws:
    
    UnsupportedEncodingException
  - setResponse
```
public final void setResponse(javax.servlet.http.HttpServletResponse response)
```
    Description copied from interface: RequestContext
    
    This method must be implemented to set the supplied HttpServletResponse as the response for the RequestContext. More importantly it should also use the supplied HttpServletResponse to instantiate and set the FakeHttpServletResponse to be returned by the .getResponse() method when the RequestContext has been set to run in passive mode.
    
    Specified by:
    
    setResponse in interface RequestContext
    
    Parameters:
    response - The HttpServletResponse to associate with the RequestContext.
  - getObject
```
public ModelObject getObject()
```
  - setObject
```
public void setObject(ModelObject object)
```
  - setPassiveMode
```
public final void setPassiveMode(boolean passiveMode)
```
    This switches the RequestContext into or out of "passive mode" (depending upon the value of the supplied passiveMode argument). In "passive mode" any output generated will be written to a FakeHttpServletResponse rather than the genuine HttpServletResponse. This is useful so that we can generate data that we want to "save for later" (i.e. we generate all the head ouput needed without writing it to the response stream and store it in the model to be accessed at the appropriate time).
    
    Specified by:
    
    setPassiveMode in interface RequestContext
    
    Parameters:
    passiveMode - boolean
  - isPassiveMode
```
public final boolean isPassiveMode()
```
    Indicates whether or not the RequestContext is currently in "passive mode". In "passive mode" any output is written to a FakeHttpServletResponse rather than the genuine HttpServletResponse. Output written to the FakeHttpServletResponse can be retrieved by calling the getContentAsString() method.
    
    Specified by:
    
    isPassiveMode in interface RequestContext
    
    Returns:
    true if the RequestContext has been set to run in passive mode and false otherwise.
  - getServletContextPath
```
public String getServletContextPath()
```
    Returns the context path of the servlet being used to process the request. This path does NOT include the application context, just the servlet context. This may return null if not set, although this should be set by the ServletRequestContextFactory there is no guarantee that it will have been set depending upon the Spring application context.
    
    Specified by:
    
    getServletContextPath in interface RequestContext
    
    Returns:
    The context path of the servlet.
  - setServletContextPath
```
public void setServletContextPath(String path)
```
    This method should be used to set the context path of the servlet being used to process the request. It has been provided for use by the ServletRequestContextFactory but could be used by other classes, however care should be taken to ensure that it is called with the correct value.
    
    Specified by:
    
    setServletContextPath in interface RequestContext
  - openExtensibilityModel
```
public org.springframework.extensions.surf.extensibility.ExtensibilityModel openExtensibilityModel()
```
    Specified by:
    
    openExtensibilityModel in interface org.springframework.extensions.surf.extensibility.HandlesExtensibility
  - closeExtensibilityModel
```
public void closeExtensibilityModel(org.springframework.extensions.surf.extensibility.ExtensibilityModel model,
                           Writer out)
```
    Specified by:
    
    closeExtensibilityModel in interface org.springframework.extensions.surf.extensibility.HandlesExtensibility
  - getCurrentExtensibilityModel
```
public org.springframework.extensions.surf.extensibility.ExtensibilityModel getCurrentExtensibilityModel()
```
    Specified by:
    
    getCurrentExtensibilityModel in interface org.springframework.extensions.surf.extensibility.HandlesExtensibility
  - setEvaluatedProperties
```
public void setEvaluatedProperties(Map<String,Serializable> properties)
```
    Specified by:
    
    setEvaluatedProperties in interface RequestContext
  - getEvaluatedProperties
```
public Map<String,Serializable> getEvaluatedProperties()
```
    Specified by:
    
    getEvaluatedProperties in interface RequestContext
  - setDependencyHandler
```
public void setDependencyHandler(DependencyHandler dependencyHandler)
```
    Specified by:
    
    setDependencyHandler in interface RequestContext
  - setExtensibilityModuleHandler
```
public void setExtensibilityModuleHandler(ExtensibilityModuleHandler extensibilityModuleHandler)
```
    This method is provided for AbstractRequestContextFactory instances to set the ExtensibilityModuleHandler that is required to evaluate which ExtensionModule instances are applicable for a request.
    
    Specified by:
    
    setExtensibilityModuleHandler in interface RequestContext
    
    Parameters:
    extensibilityModuleHandler - A ExtensibilityModuleHandler to be used by this request context.
  - setWebFrameworkConfigElement
```
public void setWebFrameworkConfigElement(WebFrameworkConfigElement webFrameworkConfigElement)
```
    This method is provided for AbstractRequestContextFactory instances to set the WebFrameworkConfigElement for the application.
    
    Specified by:
    
    setWebFrameworkConfigElement in interface RequestContext
    
    Parameters:
    webFrameworkConfigElement - WebFrameworkConfigElement
  - setConfigService
```
public void setConfigService(org.springframework.extensions.config.ConfigService configService)
```
    Specified by:
    
    setConfigService in interface RequestContext
  - getEvaluatedModules
```
public List<ExtensionModule> getEvaluatedModules()
```
    Retrieve the list of ExtensionModule instances that have been evaluated as applicable for the current request. If this list has not yet been populated then use the ExtensibilityModuleHandler configured in the Spring application context to evaluate them.
    
    Specified by:
    
    getEvaluatedModules in interface RequestContext
    
    Returns:
    A list of ExtensionModule instances that are applicable to the current request.
  - addJSDependency
```
public void addJSDependency(String dependency)
```
    Description copied from interface: RequestContext
    
    This method allows JavaScript resources to be added into the same list of dependencies added to by extension modules. This has only been added as a workaround for the migration of applications from double-pass to single-pass WebScript processing. This allows both WebScripts with and without .head.ftl files to add dependencies.
    
    Specified by:
    
    addJSDependency in interface RequestContext
    
    Parameters:
    dependency - The JavaScript resource to add as a dependency.
  - addCssDependency
```
public void addCssDependency(String dependency,
                    String media)
```
    Description copied from interface: RequestContext
    
    This method allows CSS resources to be added into the same list of dependencies added to by extension modules. This has only been added as a workaround for the migration of applications from double-pass to single-pass WebScript processing. This allows both WebScripts with and without .head.ftl files to add dependencies.
    
    Specified by:
    
    addCssDependency in interface RequestContext
    
    Parameters:
    dependency - The CSS resource to add as a dependency.
  - getExtensionDependencies
```
public String getExtensionDependencies()
```
    Returns the dependencies requested by extension modules as a formatted String. The dependency requests are processed by the associated DependencyHandler to take advantage of caching and optional checksum identification and CSS data image generation.
    
    Specified by:
    
    getExtensionDependencies in interface RequestContext
    
    Returns:
    A String of dependency requests.
  - updateExtendingModuleDependencies
```
public void updateExtendingModuleDependencies(String path,
                                     Map<String,Object> model)
```
    Updates the dependencies requested by extension modules for the current request.
    
    Specified by:
    
    updateExtendingModuleDependencies in interface org.springframework.extensions.surf.extensibility.HandlesExtensibility
    
    Parameters:
    path - The current path being processed.
    model - The current model.
  - getExtendingModuleFiles
```
public List<String> getExtendingModuleFiles(String pathBeingProcessed)
```
    Retrieves a list of files that should be provided by the evaluated modules.
    
    Specified by:
    
    getExtendingModuleFiles in interface org.springframework.extensions.surf.extensibility.HandlesExtensibility
  - dependencyAlreadyRequested
```
public boolean dependencyAlreadyRequested(String dep)
```
    Checks whether or not the supplied dependency has already been requested.
    
    Specified by:
    
    dependencyAlreadyRequested in interface RequestContext
    
    Parameters:
    dep - The path to the dependency to check.
    
    Returns:
    true if the dependency has already been requested and false otherwise.
  - markDependencyAsRequested
```
public void markDependencyAsRequested(String dep)
```
    This method can be used to indicate that the supplied dependency has been requested by other means. This is provided to ensure that dependencies requested directly on the output stream (e.g. via the JavaScriptDependencyDirective, CssDependencyDirective, etc.)
    
    Specified by:
    
    markDependencyAsRequested in interface RequestContext
    
    Parameters:
    dep - The path to the dependency to mark as requested.
  - getFileBeingProcessed
```
public String getFileBeingProcessed()
```
    Specified by:
    
    getFileBeingProcessed in interface org.springframework.extensions.surf.extensibility.HandlesExtensibility
  - setFileBeingProcessed
```
public void setFileBeingProcessed(String file)
```
    Specified by:
    
    setFileBeingProcessed in interface org.springframework.extensions.surf.extensibility.HandlesExtensibility
  - getSubComponentDebugData
```
public SubComponent.RenderData getSubComponentDebugData(String id)
```
    Description copied from interface: RequestContext
    
    Retrieves the SubComponent.RenderData for the specified SubComponent. This will contain all the information about the SubComponentEvaluation that ultimately determined the content of the SubComponent and the URI, properties, etc. that were used.
    
    Specified by:
    
    getSubComponentDebugData in interface RequestContext
    
    Parameters:
    id - The identifier of the SubComponent to retrieve the SubComponent.RenderData for.
    
    Returns:
    The SubComponent.RenderData for the requested SubComponent or null if it could not be found.
  - addSubComponentDebugData
```
public void addSubComponentDebugData(String id,
                            SubComponent.RenderData data)
```
    Description copied from interface: RequestContext
    
    Adds the SubComponent.RenderData for the specified SubComponent. This will contain all the information about the SubComponentEvaluation that ultimately determined the content of the SubComponent and the URI, properties, etc. that were used.
    
    Specified by:
    
    addSubComponentDebugData in interface RequestContext
    
    Parameters:
    id - The identifier of the SubComponent to retrieve the SubComponent.RenderData for.
    data - The SubComponent.RenderData to add.
  - getCachedExtendedBundle
```
public ResourceBundle getCachedExtendedBundle(String webScriptId)
```
    Checks the cache to see if it has cached an extended bundle (that is a basic ResourceBundle that has had extension modules applied to it. Extended bundles can only be safely cached once per request as the modules applied can vary for each request.
    
    Specified by:
    
    getCachedExtendedBundle in interface org.springframework.extensions.surf.extensibility.HandlesExtensibility
    
    Parameters:
    webScriptId - The id of the WebScript to retrieve the extended bundle for.
    
    Returns:
    A cached bundle or null if the bundle has not previously been cached.
  - addExtensionBundleToCache
```
public void addExtensionBundleToCache(String webScriptId,
                             org.springframework.extensions.webscripts.WebScriptPropertyResourceBundle extensionBundle)
```
    Adds a new extended bundle to the cache. An extended bundle is a WebScript ResourceBundle that has had ResourceBundle instances merged into it from extension modules that have been applied. These can only be cached for the lifetime of the request as different modules may be applied to the same WebScript for different requests.
    
    Specified by:
    
    addExtensionBundleToCache in interface org.springframework.extensions.surf.extensibility.HandlesExtensibility
    
    Parameters:
    webScriptId - The id of the WebScript to cache the extended bundle against.
    extensionBundle - The extended bundle to cache.
  - getExtendedScriptConfigModel
```
public org.springframework.extensions.webscripts.ScriptConfigModel getExtendedScriptConfigModel(String xmlConfig)
```
    Creates a new ExtendedScriptConfigModel instance using the local configuration generated for this request. If configuration for the request will be generated if it does not yet exist. It is likely that this method will be called multiple times within the context of a single request and although the configuration containers will always be the same a new ExtendedScriptConfigModel instance will always be created as the the supplied xmlConfig string could be different for each call (because each WebScript invoked in the request will supply different configuration.
    
    Specified by:
    
    getExtendedScriptConfigModel in interface org.springframework.extensions.surf.extensibility.HandlesExtensibility
  - getExtendedTemplateConfigModel
```
public org.springframework.extensions.webscripts.TemplateConfigModel getExtendedTemplateConfigModel(String xmlConfig)
```
    Creates a new TemplateConfigModel instance using the local configuration generated for this request. If configuration for the request will be generated if it does not yet exist. It is likely that this method will be called multiple times within the context of a single request and although the configuration containers will always be the same a new TemplateConfigModel instance will always be created as the the supplied xmlConfig string could be different for each call (because each WebScript invoked in the request will supply different configuration.
    
    Specified by:
    
    getExtendedTemplateConfigModel in interface org.springframework.extensions.surf.extensibility.HandlesExtensibility
  - addExtensibilityDirectives
```
public void addExtensibilityDirectives(Map<String,Object> freeMarkerModel,
                              org.springframework.extensions.surf.extensibility.ExtensibilityModel extModel)
```
    Specified by:
    
    addExtensibilityDirectives in interface org.springframework.extensions.surf.extensibility.HandlesExtensibility

Class AbstractRequestContext

Field Summary

Fields inherited from interface org.springframework.extensions.surf.RequestContext

Constructor Summary

Method Summary

Methods inherited from class org.springframework.extensions.surf.support.ThreadLocalRequestContext

Methods inherited from class org.springframework.extensions.surf.support.BaseFactoryBean

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.extensions.surf.extensibility.HandlesExtensibility

Methods inherited from interface org.springframework.extensions.surf.RequestContext

Field Detail

VALUE_HEAD_TAGS

counter

valuesMap

parametersMap

attributesMap

headersMap

uriTokens

rootPage

siteConfiguration

currentPage

currentTemplate

currentResource

currentFormatId

storeId

user

id

uri

viewName

theme

components

model

method

scheme

contextPath

Constructor Detail

AbstractRequestContext

AbstractRequestContext

Method Detail

getId

getSiteConfiguration

getWebsiteTitle

getPageTitle

getUri

setUri

getViewName

setViewName

getPage

setPage

getPageId

getLinkBuilder

getRootPage

getTemplate

setTemplate

getTemplateId

getCurrentObjectId

setCurrentObject

getCurrentObject

getFormatId

setFormatId

setUser

getUser

getUserId

getCredentialVault

setValue

getValue

removeValue

hasValue

getValuesMap

getParameter

hasParameter

getParameters

getRenderingComponents

setRenderingComponent

getTheme

setTheme

getThemeId

getRequestMethod

getRequestScheme

getObjectService