org.springframework.extensions.webscripts

Class LocalFileSystemStore

java.lang.Object

org.springframework.extensions.webscripts.AbstractStore

org.springframework.extensions.webscripts.LocalFileSystemStore

All Implemented Interfaces:

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

public class LocalFileSystemStore
extends org.springframework.extensions.webscripts.AbstractStore
implements org.springframework.web.context.ServletContextAware

Simple implementation of a local store file system. This is extremely light weight and is used as a base case for comparing other store performance vs. the local file system.

Author:

muzquiano

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	LocalFileSystemStore.LocalFileSystemStoreScriptLoader Local File System Store implementation of a Script Loader

Field Summary

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

DESC_PATH_PATTERN

Constructor Summary

Constructors

Constructor and Description
LocalFileSystemStore()

Method Summary

Methods

Modifier and Type	Method and Description
void	createDocument(String documentPath, String content)
boolean	exists()
protected void	gatherAbsolutePaths(String absPath, List<String> list)
String[]	getAllDocumentPaths()
String	getBasePath()
String[]	getDescriptionDocumentPaths()
InputStream	getDocument(String documentPath)
String[]	getDocumentPaths(String path, boolean includedSubPaths, String documentPattern)
protected String[]	getDocumentPathsByRegEx(String path, String regexPattern, boolean traverseChildren) Performs a pattern filter look up using a regex and starting from a given path.
String	getPath()
String	getRealPath(String path) Helper function for converting a web application path to a real system path.
String	getRoot()
protected File	getRootDir()
String[]	getScriptDocumentPaths(org.springframework.extensions.webscripts.WebScript script)
org.springframework.extensions.webscripts.ScriptLoader	getScriptLoader()
javax.servlet.ServletContext	getServletContext()
freemarker.cache.TemplateLoader	getTemplateLoader()
boolean	hasDocument(String documentPath)
void	init()
boolean	isSecure()
long	lastModified(String documentPath)
boolean	removeDocument(String documentPath)
void	setPath(String path)
void	setRoot(String root)
void	setServletContext(javax.servlet.ServletContext servletContext)
protected String	toAbsolutePath(String documentPath) Returns the absolute path relative to the root of the store given a particular document path.
String	toString()
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, wait, wait, wait

Constructor Detail

LocalFileSystemStore

public LocalFileSystemStore()

Method Detail

setServletContext

public void setServletContext(javax.servlet.ServletContext servletContext)

Specified by:

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

getServletContext

public javax.servlet.ServletContext getServletContext()

getRootDir

protected File getRootDir()

setRoot

public void setRoot(String root)

Parameters:

root - the root path

getRoot

public String getRoot()

setPath

public void setPath(String path)

Parameters:

path - the relative path to set

getPath

public String getPath()

init

public void init()

Specified by:

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

isSecure

public boolean isSecure()

Specified by:

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

exists

public boolean exists()

Specified by:

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

hasDocument

public boolean hasDocument(String documentPath)

Specified by:

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

lastModified

public long lastModified(String documentPath)
                  throws IOException

Specified by:

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

Throws:

IOException

updateDocument

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

Specified by:

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

Throws:

IOException

removeDocument

public boolean removeDocument(String documentPath)
                       throws IOException

Specified by:

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

Throws:

IOException

createDocument

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

Specified by:

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

Throws:

IOException

getDocument

public InputStream getDocument(String documentPath)
                        throws IOException

Specified by:

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

Throws:

IOException

getAllDocumentPaths

public String[] getAllDocumentPaths()

Specified by:

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

getDocumentPaths

public String[] getDocumentPaths(String path,
                        boolean includedSubPaths,
                        String documentPattern)

Specified by:

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

getDocumentPathsByRegEx

protected String[] getDocumentPathsByRegEx(String path,
                               String regexPattern,
                               boolean traverseChildren)

Performs a pattern filter look up using a regex and starting from a given path. Returns an array of valid document paths

Parameters:

path - String

regexPattern - String

traverseChildren - boolean

Returns:

document paths

getDescriptionDocumentPaths

public String[] getDescriptionDocumentPaths()

Specified by:

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

getScriptDocumentPaths

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

Specified by:

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

getScriptLoader

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

Specified by:

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

getTemplateLoader

public freemarker.cache.TemplateLoader getTemplateLoader()

Specified by:

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

getBasePath

public String getBasePath()

Specified by:

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

getRealPath

public String getRealPath(String path)

Helper function for converting a web application path to a real system path. The input path might be /products/product.xml and the generated real path would be the full system path to the file in the servlet container's web application. For example, d:/tomcat/webapps/surf/products/product.xml

Parameters:

path - the relative path

Returns:

the system path

toAbsolutePath

protected String toAbsolutePath(String documentPath)

Returns the absolute path relative to the root of the store given a particular document path.

Parameters:

documentPath - String

Returns:

String

gatherAbsolutePaths

protected void gatherAbsolutePaths(String absPath,
                       List<String> list)

toString

public String toString()

Overrides:

toString in class Object