org.springframework.extensions.surf.mvc

Class ResourceController

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.support.WebContentGenerator

org.springframework.web.servlet.mvc.AbstractController

org.springframework.extensions.webscripts.servlet.mvc.ResourceController

org.springframework.extensions.surf.mvc.ResourceController

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.mvc.Controller

public class ResourceController
extends org.springframework.extensions.webscripts.servlet.mvc.ResourceController

Overrides the VirtualizedResourceController (which in itself overrides the WebScript ResourceController to use the DependencyHandler to process requests for resources that contain content based checksums.

Author:

David Draper

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOUBLE_FULL_STOP Constant for double full stop ".." (or period as it is known in the US).
static String	DOUBLE_QUOTES Constant for the double quote '"'.
static String	FORWARD_SLASH Constant for the forward slash "/"
static String	FULL_STOP Constant for the full stop "." (or period as it is known in the US).
static String	HTTP_HEADER_EXPIRES
static String	HTTP_HEADER_FAR_FUTURE_EXPIRES_VALUE
static String	SINGLE_QUOTE Constant for the single quote "'"

Fields inherited from class org.springframework.web.servlet.support.WebContentGenerator

METHOD_GET, METHOD_HEAD, METHOD_POST

Constructor Summary

Constructors

Constructor and Description
ResourceController()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	dispatchResource(String path, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Overrides the default method to use the DependencyHandler to find resources before falling back on the default WebScript library implementation.
String	getPath(String sourcePath, String dependencyPath)
boolean	isAllowedResourcePath(String pathToCheck) Checks whether resource path provided is allowed by web framework configuration.
void	setDependencyAggregator(DependencyAggregator dependencyAggregator)
void	setDependencyHandler(DependencyHandler dependencyHandler) Sets the DependencyHandler to be used when looking up resources.
void	setDojoDependencyHandler(DojoDependencyHandler dojoDependencyHandler)
void	setWebframeworkConfigElement(WebFrameworkConfigElement webframeworkConfigElement)

Methods inherited from class org.springframework.extensions.webscripts.servlet.mvc.ResourceController

applyHeaders, commitResponse, commitResponse, copyStream, getDefaultUrl, handleRequestInternal, setDefaultUrl

Methods inherited from class org.springframework.web.servlet.mvc.AbstractController

handleRequest, isSynchronizeOnSession, setSynchronizeOnSession

Methods inherited from class org.springframework.web.servlet.support.WebContentGenerator

applyCacheSeconds, applyCacheSeconds, cacheForSeconds, cacheForSeconds, checkAndPrepare, checkAndPrepare, getCacheSeconds, getSupportedMethods, isAlwaysMustRevalidate, isRequireSession, isUseCacheControlHeader, isUseCacheControlNoStore, isUseExpiresHeader, preventCaching, setAlwaysMustRevalidate, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseCacheControlNoStore, setUseExpiresHeader

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

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

Field Detail

HTTP_HEADER_EXPIRES

public static final String HTTP_HEADER_EXPIRES

See Also:

Constant Field Values

HTTP_HEADER_FAR_FUTURE_EXPIRES_VALUE

public static final String HTTP_HEADER_FAR_FUTURE_EXPIRES_VALUE

See Also:

Constant Field Values

FORWARD_SLASH

public static final String FORWARD_SLASH

Constant for the forward slash "/"

See Also:

Constant Field Values

FULL_STOP

public static final String FULL_STOP

Constant for the full stop "." (or period as it is known in the US). In this context it is used to indicate the current location in paths.

See Also:

Constant Field Values

DOUBLE_FULL_STOP

public static final String DOUBLE_FULL_STOP

Constant for double full stop ".." (or period as it is known in the US). In this context it is used to indicate the part folder of the current location.

See Also:

Constant Field Values

DOUBLE_QUOTES

public static final String DOUBLE_QUOTES

Constant for the double quote '"'.

See Also:

Constant Field Values

SINGLE_QUOTE

public static final String SINGLE_QUOTE

Constant for the single quote "'"

See Also:

Constant Field Values

Constructor Detail

ResourceController

public ResourceController()

Method Detail

setDependencyHandler

public void setDependencyHandler(DependencyHandler dependencyHandler)

Sets the DependencyHandler to be used when looking up resources.

Parameters:

dependencyHandler - DependencyHandler

setDependencyAggregator

public void setDependencyAggregator(DependencyAggregator dependencyAggregator)

setDojoDependencyHandler

public void setDojoDependencyHandler(DojoDependencyHandler dojoDependencyHandler)

setWebframeworkConfigElement

public void setWebframeworkConfigElement(WebFrameworkConfigElement webframeworkConfigElement)

dispatchResource

public boolean dispatchResource(String path,
                       javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                         throws javax.servlet.ServletException,
                                IOException

Overrides the default method to use the DependencyHandler to find resources before falling back on the default WebScript library implementation.

Overrides:

dispatchResource in class org.springframework.extensions.webscripts.servlet.mvc.ResourceController

Throws:

javax.servlet.ServletException

IOException

getPath

public String getPath(String sourcePath,
             String dependencyPath)

isAllowedResourcePath

public boolean isAllowedResourcePath(String pathToCheck)

Checks whether resource path provided is allowed by web framework configuration.

Parameters:

pathToCheck - resource path to check

Returns:

true if path is allowed to be viewed, otherwise false