org.springframework.extensions.webscripts

Class ResourceStore

java.lang.Object

org.springframework.extensions.webscripts.AbstractStore

org.springframework.extensions.webscripts.ResourceStore

All Implemented Interfaces:

org.springframework.extensions.webscripts.Store

Direct Known Subclasses:

WebApplicationStore

public abstract class ResourceStore
extends org.springframework.extensions.webscripts.AbstractStore

Store implementation which rides on top of the web application servlet context

Author:

muzquiano

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ResourceStore.WebApplicationStoreScriptLoader Web Application Store implementation of a Script Loader

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.core.io.support.PathMatchingResourcePatternResolver	resolver

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

DESC_PATH_PATTERN

Constructor Summary

Constructors

Constructor and Description
ResourceStore()

Method Summary

Methods

Modifier and Type	Method and Description
void	createDocument(String documentPath, String content)
boolean	exists()
String[]	getAllDocumentPaths()
String	getBasePath()
String[]	getDescriptionDocumentPaths()
InputStream	getDocument(String documentPath)
String[]	getDocumentPaths(String path, boolean includeSubPaths, String documentPattern)
protected org.springframework.core.io.Resource[]	getDocumentResources(String documentPathPattern) Gets resources that match a given location pattern.
String	getPath() Returns the resource path where the store begins.
protected abstract org.springframework.core.io.support.PathMatchingResourcePatternResolver	getResourceResolver() Returns the resource resolver to be used in resolving resource references by this resources tore.
protected String	getRoot()
org.springframework.core.io.Resource	getRootResource() Returns the servlet context resource that is the root of the store
String[]	getScriptDocumentPaths(org.springframework.extensions.webscripts.WebScript script)
org.springframework.extensions.webscripts.ScriptLoader	getScriptLoader()
freemarker.cache.TemplateLoader	getTemplateLoader()
boolean	hasDocument(String documentPath)
void	init()
protected boolean	isForbidden(String documentPath) Determines whether the given document is a forbidden path (i.e.
boolean	isSecure()
long	lastModified(String documentPath)
protected abstract List<String>	matchDocumentPaths(String documentPathPattern) Returns a list of document paths for a given document pattern
boolean	removeDocument(String documentPath)
void	setPath(String root) Sets the path to the root resource on top of which this store will mount.
protected String	toDocumentPath(String resourcePath) Converts from a resource path back to a document path.
protected String	toResourcePath(String documentPath) Converts from a document path to a full resource path that incorporates the root of the store.
void	updateDocument(String documentPath, String content)

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

createDocuments, getDocumentPaths, getPreviewContext, isReadOnly, setPreviewContextProvider, setReadOnly

Methods inherited from class java.lang.Object

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

Field Detail

resolver

protected org.springframework.core.io.support.PathMatchingResourcePatternResolver resolver

Constructor Detail

ResourceStore

public ResourceStore()

Method Detail

getResourceResolver

protected abstract org.springframework.core.io.support.PathMatchingResourcePatternResolver getResourceResolver()

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

Returns:

resource resolver

matchDocumentPaths

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

Returns a list of document paths for a given document pattern

Parameters:

documentPathPattern - String

Returns:

List

Throws:

IOException

isForbidden

protected boolean isForbidden(String documentPath)

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.

Parameters:

documentPath - String

Returns:

boolean

init

public void init()

setPath

public void setPath(String root)

Sets the path to the root resource on top of which this store will mount. If you wanted to mount the store against the WEB-INF directory, you would set root to "/WEB-INF".

Parameters:

root - String

getPath

public String getPath()

Returns the resource path where the store begins.

Returns:

String

getRoot

protected String getRoot()

getRootResource

public org.springframework.core.io.Resource getRootResource()

Returns the servlet context resource that is the root of the store

Returns:

Resource

toResourcePath

protected String toResourcePath(String documentPath)

Converts from a document path to a full resource path that incorporates the root of the store.

Parameters:

documentPath - String

Returns:

String

toDocumentPath

protected String toDocumentPath(String resourcePath)

Converts from a resource path back to a document path.

Parameters:

resourcePath - String

Returns:

String

isSecure

public boolean isSecure()

exists

public boolean exists()

hasDocument

public boolean hasDocument(String documentPath)

lastModified

public long lastModified(String documentPath)
                  throws IOException

Throws:

IOException

updateDocument

public void updateDocument(String documentPath,
                  String content)
                    throws IOException

Throws:

IOException

removeDocument

public boolean removeDocument(String documentPath)
                       throws IOException

Throws:

IOException

createDocument

public void createDocument(String documentPath,
                  String content)
                    throws IOException

Throws:

IOException

getDocument

public InputStream getDocument(String documentPath)
                        throws IOException

Throws:

IOException

getAllDocumentPaths

public String[] getAllDocumentPaths()

getDocumentPaths

public String[] getDocumentPaths(String path,
                        boolean includeSubPaths,
                        String documentPattern)
                          throws IOException

Throws:

IOException

getDescriptionDocumentPaths

public String[] getDescriptionDocumentPaths()
                                     throws IOException

Throws:

IOException

getScriptDocumentPaths

public String[] getScriptDocumentPaths(org.springframework.extensions.webscripts.WebScript script)
                                throws IOException

Throws:

IOException

getScriptLoader

public org.springframework.extensions.webscripts.ScriptLoader getScriptLoader()

getTemplateLoader

public freemarker.cache.TemplateLoader getTemplateLoader()

getBasePath

public String getBasePath()

getDocumentResources

protected org.springframework.core.io.Resource[] getDocumentResources(String documentPathPattern)
                                                               throws IOException

Gets resources that match a given location pattern. A resource in the returned array can live in the class path as either a class file or as an entry within one of the JAR files in the class path. This function is provided here as it is generally useful for implementation classes.

Parameters:

documentPathPattern - String

Returns:

Resource[]

Throws:

IOException