Package org.craftercms.core.store.impl
Class AbstractFileBasedContentStoreAdapter
java.lang.Object
org.craftercms.core.store.impl.AbstractCachedContentStoreAdapter
org.craftercms.core.store.impl.AbstractFileBasedContentStoreAdapter
- All Implemented Interfaces:
ContentStoreAdapter
- Direct Known Subclasses:
FileSystemContentStoreAdapter
public abstract class AbstractFileBasedContentStoreAdapter
extends AbstractCachedContentStoreAdapter
File-based content store adapter. Takes away common stuff from actual implementations, like handling metadata files
and loading descriptor DOMs.
- Author:
- Alfonso Vásquez
-
Field Summary
Modifier and TypeFieldDescriptionprotected String
static final String
protected String
protected String
protected org.springframework.validation.Validator
Fields inherited from class org.craftercms.core.store.impl.AbstractCachedContentStoreAdapter
cacheTemplate, CONST_KEY_ELEM_CONTENT, CONST_KEY_ELEM_EXISTS, CONST_KEY_ELEM_ITEM, CONST_KEY_ELEM_ITEMS, defaultCachingOptions
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected org.dom4j.io.SAXReader
Creates and configures an XML SAX reader.boolean
doExists
(Context context, CachingOptions cachingOptions, String path) protected Content
doFindContent
(Context context, CachingOptions cachingOptions, String path) protected Item
doFindItem
(Context context, CachingOptions cachingOptions, String path, boolean withDescriptor) doFindItems
(Context context, CachingOptions cachingOptions, String path) protected abstract File
findFile
(Context context, CachingOptions cachingOptions, String path) Returns theFile
at the given path, returning null if not found.getChildren
(Context context, CachingOptions cachingOptions, File dir) Returns the list of children of the given directory.protected abstract Content
getContent
(Context context, CachingOptions cachingOptions, File file) Returns theContent
for the given file.void
setCharset
(String charset) void
setDescriptorFileExtension
(String descriptorFileExtension) void
setMetadataFileExtension
(String metadataFileExtension) void
setPathValidator
(org.springframework.validation.Validator pathValidator) protected void
validatePath
(String path) Methods inherited from class org.craftercms.core.store.impl.AbstractCachedContentStoreAdapter
exists, findContent, findItem, findItems, setCacheTemplate, setDefaultCachingOptions
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.craftercms.core.store.ContentStoreAdapter
createContext, destroyContext, validate
-
Field Details
-
DEFAULT_CHARSET
- See Also:
-
pathValidator
protected org.springframework.validation.Validator pathValidator -
charset
-
descriptorFileExtension
-
metadataFileExtension
-
-
Constructor Details
-
AbstractFileBasedContentStoreAdapter
public AbstractFileBasedContentStoreAdapter()
-
-
Method Details
-
setCharset
-
setPathValidator
public void setPathValidator(org.springframework.validation.Validator pathValidator) -
setDescriptorFileExtension
-
setMetadataFileExtension
-
doExists
public boolean doExists(Context context, CachingOptions cachingOptions, String path) throws InvalidScopeException, StoreException - Specified by:
doExists
in classAbstractCachedContentStoreAdapter
- Throws:
InvalidScopeException
StoreException
-
doFindContent
protected Content doFindContent(Context context, CachingOptions cachingOptions, String path) throws InvalidContextException, StoreException - Specified by:
doFindContent
in classAbstractCachedContentStoreAdapter
- Throws:
InvalidContextException
StoreException
-
doFindItem
protected Item doFindItem(Context context, CachingOptions cachingOptions, String path, boolean withDescriptor) throws InvalidContextException, PathNotFoundException, XmlFileParseException, StoreException - Specified by:
doFindItem
in classAbstractCachedContentStoreAdapter
- Throws:
InvalidContextException
PathNotFoundException
XmlFileParseException
StoreException
-
doFindItems
protected List<Item> doFindItems(Context context, CachingOptions cachingOptions, String path) throws InvalidContextException, PathNotFoundException, XmlFileParseException, StoreException - Specified by:
doFindItems
in classAbstractCachedContentStoreAdapter
- Throws:
InvalidContextException
PathNotFoundException
XmlFileParseException
StoreException
-
createXmlReader
protected org.dom4j.io.SAXReader createXmlReader()Creates and configures an XML SAX reader. -
validatePath
- Throws:
StoreException
-
getContent
protected abstract Content getContent(Context context, CachingOptions cachingOptions, File file) throws InvalidContextException, StoreException Returns theContent
for the given file. -
findFile
protected abstract File findFile(Context context, CachingOptions cachingOptions, String path) throws InvalidContextException, StoreException Returns theFile
at the given path, returning null if not found. -
getChildren
protected abstract List<File> getChildren(Context context, CachingOptions cachingOptions, File dir) throws InvalidContextException, StoreException Returns the list of children of the given directory.
-