|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Store
Store for holding Web Script Definitions and Implementations
Method Summary | |
---|---|
void |
createDocument(String documentPath,
String content)
Creates a document. |
boolean |
exists()
Determines whether the store actually exists |
String[] |
getAllDocumentPaths()
Gets the paths of all documents in this store |
String |
getBasePath()
Gets the base path of the store |
String[] |
getDescriptionDocumentPaths()
Gets the paths of all Web Script description documents in this store |
InputStream |
getDocument(String documentPath)
Gets a document |
String[] |
getDocumentPaths(String path,
boolean includeSubPaths,
String documentPattern)
Gets the paths of given document pattern within given path/sub-paths in this store |
String[] |
getDocumentPaths(String path,
String filePathPattern)
Gets the paths matching a given file path pattern in this store. |
String[] |
getScriptDocumentPaths(WebScript script)
Gets the paths of all implementation files for a given Web Script |
ScriptLoader |
getScriptLoader()
Gets the script loader for this store |
freemarker.cache.TemplateLoader |
getTemplateLoader()
Gets the template loader for this store |
boolean |
hasDocument(String documentPath)
Determines if the document exists. |
void |
init()
Initialise Store (called once) |
boolean |
isSecure()
Returns true if this store is considered secure - i.e. |
long |
lastModified(String documentPath)
Gets the last modified timestamp for the document. |
boolean |
removeDocument(String documentPath)
Removes an existing document. |
void |
updateDocument(String documentPath,
String content)
Updates an existing document. |
Method Detail |
---|
void init()
boolean exists()
String getBasePath()
boolean isSecure()
String[] getDocumentPaths(String path, boolean includeSubPaths, String documentPattern) throws IOException
path
- start pathincludeSubPaths
- if true, include sub-pathsdocumentPattern
- document name, allows wildcards, eg. *.ftl or my*.ftl
IOException
String[] getDocumentPaths(String path, String filePathPattern) throws IOException
path
- start pathfilePathPattern
- file path pattern string, allows wildcards, eg. *.ftl or my*.ftl or *\/a\/*.xml
IOException
String[] getDescriptionDocumentPaths() throws IOException
IOException
String[] getScriptDocumentPaths(WebScript script) throws IOException
script
- web script
IOException
String[] getAllDocumentPaths()
long lastModified(String documentPath) throws IOException
documentPath
- document path to an existing document
IOException
- if the document does not exist in the storeboolean hasDocument(String documentPath) throws IOException
documentPath
- document path
IOException
- Signals that an I/O exception has occurred.InputStream getDocument(String documentPath) throws IOException
documentPath
- document path
IOException
- if the document does not exist in the storevoid createDocument(String documentPath, String content) throws IOException
documentPath
- document pathcontent
- content of the document to write
IOException
- if the document already exists or the create failsvoid updateDocument(String documentPath, String content) throws IOException
documentPath
- document pathcontent
- content to update the document with
IOException
- if the document does not exist or the update failsboolean removeDocument(String documentPath) throws IOException
documentPath
- document path
IOException
- if the document does not exist or the remove failsfreemarker.cache.TemplateLoader getTemplateLoader()
ScriptLoader getScriptLoader()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |