org.craftercms.core.service

Interface ContentStoreService

All Known Implementing Classes:

AbstractCachedContentStoreService, ContentStoreServiceImpl

public interface ContentStoreService

Main Crafter content access API. Besides providing an interface to a content store or repository, implementations of this service also should provide the following facilities:

• Merging:By using a certain merge strategy, the service is able to merge a collection of XML descriptor documents into a single XML document for an item.
• Processing:The service passes an item through one or multiple "processors" that can manipulate and change the item as they need. For example, there is a processor implementation that includes other descriptor documents into the item's descriptor document (see .impl.IncludeDescriptorsProcessor, an another one that processes element text of descriptor documents as templates (see TemplateProcessor).

Author:

Sumer Jabri, Alfonso Vásquez

See Also:

DescriptorMergeStrategy, DescriptorMergeStrategyResolver, DescriptorMerger, ItemProcessor, ItemProcessorResolver

Field Summary

Fields

Modifier and Type	Field and Description
static int	UNLIMITED_TREE_DEPTH Constant used to indicate that the depth of the tree should be unlimited.

Method Summary

Modifier and Type	Method and Description
Context	createContext(String storeType, String storeServerUrl, String username, String password, String rootFolderPath, boolean mergingOn, boolean cacheOn, int maxAllowedItemsInCache, boolean ignoreHiddenFiles) Returns a new context with the specified params, login in to a remote repository (if needed) and creating a new cache scope associated to the context.
boolean	destroyContext(Context context) Destroys the specified context, login out of any remote repository (if a login was issued) and destroying the cache scope associated to the context.
boolean	exists(Context context, String url) Returns true if the file or folder at the specified URL exists
List<Item>	findChildren(Context context, CachingOptions cachingOptions, String url, ItemFilter filter, ItemProcessor processor) Returns the children of the folder at the given url, returning null if the folder can't be found.
List<Item>	findChildren(Context context, String url) Returns the children of the folder at the given url, returning null if the folder can't be found.
Content	findContent(Context context, CachingOptions cachingOptions, String url) Returns the content of the file for the given url, returning null if not found.
Content	findContent(Context context, String url) Returns the content of the file for the given url, returning null if not found.
Item	findItem(Context context, CachingOptions cachingOptions, String url, ItemProcessor processor) Returns the content store item for the given url, returning null if not found.
Item	findItem(Context context, String url) Returns the content store item for the given url, returning null if not found.
Tree	findTree(Context context, CachingOptions cachingOptions, String url, int depth, ItemFilter filter, ItemProcessor processor) Returns the folder at the given url as a tree, or null if the folder wasn't found.
Tree	findTree(Context context, String url) Returns the folder at the given url as a tree, or null if the folder wasn't found.
Tree	findTree(Context context, String url, int depth) Returns the folder at the given url as a tree, or null if the folder wasn't found.
List<Item>	getChildren(Context context, CachingOptions cachingOptions, String url, ItemFilter filter, ItemProcessor processor) Returns the children of the folder at the given url.
List<Item>	getChildren(Context context, String url) Returns the children of the folder at the given url.
Content	getContent(Context context, CachingOptions cachingOptions, String url) Returns the content of the file for the given url.
Content	getContent(Context context, String url) Returns the content of the file for the given url.
Context	getContext(String contextId) Returns the open Context for the given ID, or null if no context found for the ID.
Item	getItem(Context context, CachingOptions cachingOptions, String url, ItemProcessor processor) Returns the content store item for the given url.
Item	getItem(Context context, String url) Returns the content store item for the given url.
Tree	getTree(Context context, CachingOptions cachingOptions, String url, int depth, ItemFilter filter, ItemProcessor processor) Returns the folder at the given url as a tree.
Tree	getTree(Context context, String url) Returns the folder at the given url as a tree.
Tree	getTree(Context context, String url, int depth) Returns the folder at the given url as a tree.
boolean	validate(Context context) Returns true if the specified context is still valid and usable.

Field Detail

UNLIMITED_TREE_DEPTH

static final int UNLIMITED_TREE_DEPTH

Constant used to indicate that the depth of the tree should be unlimited. This means that the tree will be built until the bottom of the folder hierarchy.

See Also:

Constant Field Values

Method Detail

getContext

Context getContext(String contextId)

Returns the open Context for the given ID, or null if no context found for the ID.

createContext

Context createContext(String storeType,
                      String storeServerUrl,
                      String username,
                      String password,
                      String rootFolderPath,
                      boolean mergingOn,
                      boolean cacheOn,
                      int maxAllowedItemsInCache,
                      boolean ignoreHiddenFiles)
               throws InvalidStoreTypeException,
                      RootFolderNotFoundException,
                      StoreException,
                      AuthenticationException

Returns a new context with the specified params, login in to a remote repository (if needed) and creating a new cache scope associated to the context. If a context with the same params was already created, an exception is thrown.

Throws:

InvalidStoreTypeException

RootFolderNotFoundException

StoreException

AuthenticationException

validate

boolean validate(Context context)
          throws StoreException,
                 AuthenticationException

Returns true if the specified context is still valid and usable.

Throws:

StoreException

AuthenticationException

destroyContext

boolean destroyContext(Context context)
                throws StoreException,
                       AuthenticationException

Destroys the specified context, login out of any remote repository (if a login was issued) and destroying the cache scope associated to the context.

Returns:

true if the context was successfully destroyed, false otherwise.

Throws:

StoreException

AuthenticationException

exists

boolean exists(Context context,
               String url)
        throws InvalidContextException,
               PathNotFoundException,
               StoreException

Returns true if the file or folder at the specified URL exists

Parameters:

context - the context with the store configuration (required)

url - the url of the file (required)

Returns:

true if the file or folder exists, false otherwise

Throws:

InvalidContextException - if the context is invalid

PathNotFoundException - if the file the url points to can't be found

StoreException - if an error occurred while accessing the content store

findContent

Content findContent(Context context,
                    String url)
             throws InvalidContextException,
                    StoreException

Returns the content of the file for the given url, returning null if not found.

Parameters:

context - the context with the store configuration (required)

url - the url of the file (required)

Returns:

the file content

Throws:

InvalidContextException - if the context is invalid

StoreException - if an error occurred while accessing the content store

getContent

Content getContent(Context context,
                   String url)
            throws InvalidContextException,
                   PathNotFoundException,
                   StoreException

Returns the content of the file for the given url.

Parameters:

context - the context with the store configuration (required)

url - the url of the file (required)

Returns:

the file content

Throws:

InvalidContextException - if the context is invalid

PathNotFoundException - if the file the url points to can't be found

StoreException - if an error occurred while accessing the content store

findContent

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

Returns the content of the file for the given url, returning null if not found.

Parameters:

context - the context with the store configuration (required)

cachingOptions - the caching options for any caching operation done inside this service call (optional)

url - the url of the file (required)

Returns:

the file content

Throws:

InvalidContextException - if the context is invalid

StoreException - if an error occurred while accessing the content store

getContent

Content getContent(Context context,
                   CachingOptions cachingOptions,
                   String url)
            throws InvalidContextException,
                   PathNotFoundException,
                   StoreException

Returns the content of the file for the given url.

Parameters:

context - the context with the store configuration (required)

cachingOptions - the caching options for any caching operation done inside this service call (optional)

url - the url of the file (required)

Returns:

the file content

Throws:

InvalidContextException - if the context is invalid

PathNotFoundException - if the file the url points to can't be found

StoreException - if an error occurred while accessing the content store

findItem

Item findItem(Context context,
              String url)
       throws InvalidContextException,
              XmlFileParseException,
              XmlMergeException,
              ItemProcessingException,
              StoreException

Returns the content store item for the given url, returning null if not found. See Item for the types of files an item can be.

Parameters:

context - the context with the store configuration (required)

url - the url of the item (required)

Returns:

the item

Throws:

InvalidContextException - if the context is invalid

XmlFileParseException - if there was an error while parsing the item's XML descriptor

XmlMergeException - if there was an error while attempting to do a merge of XML descriptors

ItemProcessingException - if there was an error while processing the item

StoreException - if an error occurred while accessing the content store

getItem

Item getItem(Context context,
             String url)
      throws InvalidContextException,
             PathNotFoundException,
             XmlFileParseException,
             XmlMergeException,
             ItemProcessingException,
             StoreException

Returns the content store item for the given url. See Item for the types of files an item can be.

Parameters:

context - the context with the store configuration (required)

url - the url of the item (required)

Returns:

the item

Throws:

InvalidContextException - if the context is invalid

PathNotFoundException - if the file the url points to can't be found

XmlFileParseException - if there was an error while parsing the item's XML descriptor

XmlMergeException - if there was an error while attempting to do a merge of XML descriptors

ItemProcessingException - if there was an error while processing the item

StoreException - if an error occurred while accessing the content store

findItem

Item findItem(Context context,
              CachingOptions cachingOptions,
              String url,
              ItemProcessor processor)
       throws InvalidContextException,
              XmlFileParseException,
              XmlMergeException,
              ItemProcessingException,
              StoreException

Returns the content store item for the given url, returning null if not found. See Item for the types of files an item can be.

Parameters:

context - the context to the content store (required)

cachingOptions - the caching options for any caching operation done inside this service call (optional)

url - the url of the item (optional, can be null)

processor - additional ItemProcessor (optional, can be null)

Returns:

the item

Throws:

InvalidContextException - if the context is invalid

XmlFileParseException - if there was an error while parsing the item's XML descriptor

XmlMergeException - if there was an error while attempting to do a merge of XML descriptors

ItemProcessingException - if there was an error while processing the item

StoreException - if an error occurred while accessing the content store

getItem

Item getItem(Context context,
             CachingOptions cachingOptions,
             String url,
             ItemProcessor processor)
      throws InvalidContextException,
             PathNotFoundException,
             XmlFileParseException,
             XmlMergeException,
             ItemProcessingException,
             StoreException

Returns the content store item for the given url. See Item for the types of files an item can be.

Parameters:

context - the context to the content store (required)

cachingOptions - the caching options for any caching operation done inside this service call (optional)

url - the url of the item (optional, can be null)

processor - additional ItemProcessor (optional, can be null)

Returns:

the item

Throws:

InvalidContextException - if the context is invalid

PathNotFoundException - if the file the url points to can't be found

XmlFileParseException - if there was an error while parsing the item's XML descriptor

XmlMergeException - if there was an error while attempting to do a merge of XML descriptors

ItemProcessingException - if there was an error while processing the item

StoreException - if an error occurred while accessing the content store

findChildren

List<Item> findChildren(Context context,
                        String url)
                 throws InvalidContextException,
                        XmlFileParseException,
                        XmlMergeException,
                        ItemProcessingException,
                        StoreException

Returns the children of the folder at the given url, returning null if the folder can't be found.

Parameters:

context - the context to the content store (required)

url - the url of the folder (required)

Returns:

the children of the folder

Throws:

InvalidContextException - if the context is invalid

XmlFileParseException - if there was an error while parsing a children's XML descriptor

XmlMergeException - if there was an error while attempting to do a merge of XML descriptors

ItemProcessingException - if there was an error while processing an item

StoreException - if an error occurred while accessing the content store

getChildren

List<Item> getChildren(Context context,
                       String url)
                throws InvalidContextException,
                       PathNotFoundException,
                       XmlFileParseException,
                       XmlMergeException,
                       ItemProcessingException,
                       StoreException

Returns the children of the folder at the given url.

Parameters:

context - the context to the content store (required)

url - the url of the folder (required)

Returns:

the children of the folder

Throws:

InvalidContextException - if the context is invalid

PathNotFoundException - if the folder the url points to can't be found

XmlFileParseException - if there was an error while parsing a children's XML descriptor

XmlMergeException - if there was an error while attempting to do a merge of XML descriptors

ItemProcessingException - if there was an error while processing an item

StoreException - if an error occurred while accessing the content store

findChildren

List<Item> findChildren(Context context,
                        CachingOptions cachingOptions,
                        String url,
                        ItemFilter filter,
                        ItemProcessor processor)
                 throws InvalidContextException,
                        XmlFileParseException,
                        XmlMergeException,
                        ItemProcessingException,
                        StoreException

Returns the children of the folder at the given url, returning null if the folder can't be found.

Parameters:

context - the context to the content store (required)

cachingOptions - the caching options for any caching operation done inside this service call (optional)

url - the url of the folder (required)

filter - an ItemFilter to filter out undesired children (optional, can be null)

processor - additional ItemProcessor for the children (optional, can be null)

Returns:

the children of the folder

Throws:

InvalidContextException - if the context is invalid

XmlFileParseException - if there was an error while parsing a children's XML descriptor

XmlMergeException - if there was an error while attempting to do a merge of XML descriptors

ItemProcessingException - if there was an error while processing an item

StoreException - if an error occurred while accessing the content store

getChildren

List<Item> getChildren(Context context,
                       CachingOptions cachingOptions,
                       String url,
                       ItemFilter filter,
                       ItemProcessor processor)
                throws InvalidContextException,
                       PathNotFoundException,
                       XmlFileParseException,
                       XmlMergeException,
                       ItemProcessingException,
                       StoreException

Returns the children of the folder at the given url.

Parameters:

context - the context to the content store (required)

cachingOptions - the caching options for any caching operation done inside this service call (optional)

url - the url of the folder (required)

filter - an ItemFilter to filter out undesired children (optional, can be null)

processor - additional ItemProcessor for the children (optional, can be null)

Returns:

the children of the folder

Throws:

InvalidContextException - if the context is invalid

PathNotFoundException - if the folder the url points to can't be found

XmlFileParseException - if there was an error while parsing a children's XML descriptor

XmlMergeException - if there was an error while attempting to do a merge of XML descriptors

ItemProcessingException - if there was an error while processing an item

StoreException - if an error occurred while accessing the content store

findTree

Tree findTree(Context context,
              String url)
       throws InvalidContextException,
              XmlFileParseException,
              XmlMergeException,
              ItemProcessingException,
              StoreException

Returns the folder at the given url as a tree, or null if the folder wasn't found. The tree children are returned as Items when they're files and as Trees when they're folders. The tree depth is UNLIMITED_TREE_DEPTH.

Parameters:

context - the context to the content store (required)

url - the url of the folder (required)

Returns:

the folder as a tree

Throws:

InvalidContextException - if the context is invalid

XmlFileParseException - if there was an error while parsing a children's XML descriptor

XmlMergeException - if there was an error while attempting to do a merge of XML descriptors

ItemProcessingException - if there was an error while processing an item

StoreException - if an error occurred while accessing the content store

getTree

Tree getTree(Context context,
             String url)
      throws InvalidContextException,
             PathNotFoundException,
             XmlFileParseException,
             XmlMergeException,
             ItemProcessingException,
             StoreException

Returns the folder at the given url as a tree. The tree children are returned as Items when they're files and as Trees when they're folders. The tree depth is UNLIMITED_TREE_DEPTH.

Parameters:

context - the context to the content store (required)

url - the url of the folder (required)

Returns:

the folder as a tree

Throws:

InvalidContextException - if the context is invalid

PathNotFoundException - if the folder the url points to can't be found

XmlFileParseException - if there was an error while parsing a children's XML descriptor

XmlMergeException - if there was an error while attempting to do a merge of XML descriptors

ItemProcessingException - if there was an error while processing an item

StoreException - if an error occurred while accessing the content store

findTree

Tree findTree(Context context,
              String url,
              int depth)
       throws InvalidContextException,
              XmlFileParseException,
              XmlMergeException,
              ItemProcessingException,
              StoreException

Returns the folder at the given url as a tree, or null if the folder wasn't found. The tree children are returned as Items when they're files and as Trees when they're folders.

Parameters:

context - the context to the content store (required)

url - the url of the folder (required)

depth - the number of levels the tree should have. Use #UNLIMITED_TREE_DEPTH when you want the tree to include all files/folder until the bottom of the folder hierarchy (required)

Returns:

the folder as a tree

Throws:

InvalidContextException - if the context is invalid

XmlFileParseException - if there was an error while parsing a children's XML descriptor

XmlMergeException - if there was an error while attempting to do a merge of XML descriptors

ItemProcessingException - if there was an error while processing an item

StoreException - if an error occurred while accessing the content store

getTree

Tree getTree(Context context,
             String url,
             int depth)
      throws InvalidContextException,
             PathNotFoundException,
             XmlFileParseException,
             XmlMergeException,
             ItemProcessingException,
             StoreException

Returns the folder at the given url as a tree. The tree children are returned as Items when they're files and as Trees when they're folders.

Parameters:

context - the context to the content store (required)

url - the url of the folder (required)

depth - the number of levels the tree should have. Use #UNLIMITED_TREE_DEPTH when you want the tree to include all files/folder until the bottom of the folder hierarchy (required)

Returns:

the folder as a tree

Throws:

InvalidContextException - if the context is invalid

PathNotFoundException - if the folder the url points to can't be found

XmlFileParseException - if there was an error while parsing a children's XML descriptor

XmlMergeException - if there was an error while attempting to do a merge of XML descriptors

ItemProcessingException - if there was an error while processing an item

StoreException - if an error occurred while accessing the content store

findTree

Tree findTree(Context context,
              CachingOptions cachingOptions,
              String url,
              int depth,
              ItemFilter filter,
              ItemProcessor processor)
       throws InvalidContextException,
              XmlFileParseException,
              XmlMergeException,
              ItemProcessingException,
              StoreException

Returns the folder at the given url as a tree, or null if the folder wasn't found. The tree children are returned as Items when they're files and as Trees when they're folders.

Parameters:

context - the context to the content store (required)

cachingOptions - the caching options for any caching operation done inside this service call (optional)

url - the url of the folder (required)

depth - the number of levels the tree should have. Use #UNLIMITED_TREE_DEPTH when you want the tree to include all files/folder until the bottom of the folder hierarchy (required)

filter - an ItemFilter to filter out undesired items in the tree (optional, can be null)

processor - additional ItemProcessor for the tree's items (optional, can be null)

Returns:

the folder as a tree

Throws:

InvalidContextException - if the context is invalid

XmlFileParseException - if there was an error while parsing a children's XML descriptor

XmlMergeException - if there was an error while attempting to do a merge of XML descriptors

ItemProcessingException - if there was an error while processing an item

StoreException - if an error occurred while accessing the content store

getTree

Tree getTree(Context context,
             CachingOptions cachingOptions,
             String url,
             int depth,
             ItemFilter filter,
             ItemProcessor processor)
      throws InvalidContextException,
             PathNotFoundException,
             XmlFileParseException,
             XmlMergeException,
             ItemProcessingException,
             StoreException

Returns the folder at the given url as a tree. The tree children are returned as Items when they're files and as Trees when they're folders.

Parameters:

context - the context to the content store (required)

cachingOptions - the caching options for any caching operation done inside this service call (optional)

url - the url of the folder (required)

depth - the number of levels the tree should have. Use #UNLIMITED_TREE_DEPTH when you want the tree to include all files/folder until the bottom of the folder hierarchy (required)

filter - an ItemFilter to filter out undesired items in the tree (optional, can be null)

processor - additional ItemProcessor for the tree's items (optional, can be null)

Returns:

the folder as a tree

Throws:

InvalidContextException - if the context is invalid

PathNotFoundException - if the folder the url points to can't be found

XmlFileParseException - if there was an error while parsing a children's XML descriptor

XmlMergeException - if there was an error while attempting to do a merge of XML descriptors

ItemProcessingException - if there was an error while processing an item

StoreException - if an error occurred while accessing the content store