Package org.craftercms.core.store

Interface ContentStoreAdapter

All Known Implementing Classes:

AbstractCachedContentStoreAdapter, AbstractFileBasedContentStoreAdapter, FileSystemContentStoreAdapter

public interface ContentStoreAdapter

Adapter that provides path based access to a repository of some type.

Author:

Sumer Jabri, Michiel Verkaik, Alfonso Vásquez

Method Summary

Modifier and Type	Method	Description
Context	createContext(String id, String rootFolderPath, boolean mergingOn, boolean cacheOn, int maxAllowedItemsInCache, boolean ignoreHiddenFiles, Map<String,String> configurationVariables)
void	destroyContext(Context context)
boolean	exists(Context context, CachingOptions cachingOptions, String path)
Content	findContent(Context context, CachingOptions cachingOptions, String path)
Item	findItem(Context context, CachingOptions cachingOptions, String path, boolean withDescriptor)
List<Item>	findItems(Context context, CachingOptions cachingOptions, String path)
boolean	validate(Context context)

Method Details

createContext

Context createContext(String id,
 String rootFolderPath,
 boolean mergingOn,
 boolean cacheOn,
 int maxAllowedItemsInCache,
 boolean ignoreHiddenFiles,
 Map<String,String> configurationVariables)
               throws RootFolderNotFoundException,
StoreException,
AuthenticationException

Throws:

RootFolderNotFoundException

StoreException

AuthenticationException

validate

boolean validate(Context context)
          throws StoreException,
AuthenticationException

Throws:

StoreException

AuthenticationException

destroyContext

void destroyContext(Context context)
             throws StoreException,
AuthenticationException

Throws:

StoreException

AuthenticationException

exists

boolean exists(Context context,
 CachingOptions cachingOptions,
 String path)
        throws InvalidContextException,
StoreException

Throws:

InvalidContextException

StoreException

findContent

Content findContent(Context context,
 CachingOptions cachingOptions,
 String path)
             throws InvalidContextException,
StoreException

Throws:

InvalidContextException

StoreException

findItem

Item findItem(Context context,
 CachingOptions cachingOptions,
 String path,
 boolean withDescriptor)
       throws InvalidContextException,
XmlFileParseException,
StoreException

Throws:

InvalidContextException

XmlFileParseException

StoreException

findItems

List<Item> findItems(Context context,
 CachingOptions cachingOptions,
 String path)
              throws InvalidContextException,
XmlFileParseException,
StoreException

Throws:

InvalidContextException

XmlFileParseException

StoreException