org.springframework.extensions.webscripts

Class WebApplicationStore

java.lang.Object

org.springframework.extensions.webscripts.AbstractStore

org.springframework.extensions.webscripts.ResourceStore

org.springframework.extensions.webscripts.WebApplicationStore

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.extensions.webscripts.Store, org.springframework.web.context.ServletContextAware

public class WebApplicationStore
extends ResourceStore
implements org.springframework.web.context.ServletContextAware

Store implementation which points to web application root

Author:

muzquiano

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.extensions.webscripts.ResourceStore

ResourceStore.WebApplicationStoreScriptLoader

Field Summary

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

resolver

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

DESC_PATH_PATTERN

Constructor Summary

Constructors

Constructor and Description
WebApplicationStore()

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.core.io.support.PathMatchingResourcePatternResolver	getResourceResolver() Returns the resource resolver to be used in resolving resource references by this resources tore.
protected javax.servlet.ServletContext	getServletContext() Retrieves the servlet context
protected boolean	isForbidden(String documentPath) Determines whether the given document is a forbidden path (i.e.
boolean	isReadOnly()
boolean	isSecure()
protected List<String>	matchDocumentPaths(String documentPathPattern) Returns a list of document paths for a given document pattern
void	setServletContext(javax.servlet.ServletContext servletContext)
String	toString()

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

createDocument, exists, getAllDocumentPaths, getBasePath, getDescriptionDocumentPaths, getDocument, getDocumentPaths, getDocumentResources, getPath, getRoot, getRootResource, getScriptDocumentPaths, getScriptLoader, getTemplateLoader, hasDocument, init, lastModified, removeDocument, setPath, toDocumentPath, toResourcePath, updateDocument

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

createDocuments, getDocumentPaths, getPreviewContext, setPreviewContextProvider, setReadOnly

Methods inherited from class java.lang.Object

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

Constructor Detail

WebApplicationStore

public WebApplicationStore()

Method Detail

setServletContext

public void setServletContext(javax.servlet.ServletContext servletContext)

Specified by:

setServletContext in interface org.springframework.web.context.ServletContextAware

getServletContext

protected javax.servlet.ServletContext getServletContext()

Retrieves the servlet context

Returns:

ServletContext

getResourceResolver

public org.springframework.core.io.support.PathMatchingResourcePatternResolver getResourceResolver()

Description copied from class: ResourceStore

Returns the resource resolver to be used in resolving resource references by this resources tore.

Specified by:

getResourceResolver in class ResourceStore

Returns:

resource resolver

isForbidden

protected boolean isForbidden(String documentPath)

Description copied from class: ResourceStore

Determines whether the given document is a forbidden path (i.e. a path that has been explicitly filtered or restricted). By default, this doesn't do any filtering but it can be overridden by implementation classes that may wish to do so.

Overrides:

isForbidden in class ResourceStore

Parameters:

documentPath - String

Returns:

boolean

isSecure

public boolean isSecure()

Specified by:

isSecure in interface org.springframework.extensions.webscripts.Store

Overrides:

isSecure in class ResourceStore

toString

public String toString()

Overrides:

toString in class Object

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface org.springframework.extensions.webscripts.Store

Overrides:

isReadOnly in class org.springframework.extensions.webscripts.AbstractStore

matchDocumentPaths

protected List<String> matchDocumentPaths(String documentPathPattern)
                                   throws IOException

Description copied from class: ResourceStore

Returns a list of document paths for a given document pattern

Specified by:

matchDocumentPaths in class ResourceStore

Parameters:

documentPathPattern - String

Returns:

List

Throws:

IOException