org.craftercms.core.service.impl

Class ContentStoreServiceImpl

java.lang.Object

org.craftercms.core.service.impl.AbstractCachedContentStoreService

org.craftercms.core.service.impl.ContentStoreServiceImpl

All Implemented Interfaces:

ContentStoreService

public class ContentStoreServiceImpl
extends AbstractCachedContentStoreService

Default implementation of ContentStoreService. Extends from AbstractCachedContentStoreService to use caching.

Author:

Alfonso Vásquez

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Context>	contexts Map of open Contexts
protected DescriptorMerger	merger Merges a bunch of descriptors
protected DescriptorMergeStrategyResolver	mergeStrategyResolver Resolves the DescriptorMergeStrategy to use for a particular descriptor.
protected ItemProcessorResolver	processorResolver Resolves the ItemProcessor to use for a particular Item.
protected ContentStoreAdapterRegistry	storeAdapterRegistry Registry of ContentStoreAdapters.

Fields inherited from class org.craftercms.core.service.impl.AbstractCachedContentStoreService

cacheTemplate, CONST_KEY_ELEM_CHILDREN, CONST_KEY_ELEM_ITEM, CONST_KEY_ELEM_TREE, defaultCachingOptions

Fields inherited from interface org.craftercms.core.service.ContentStoreService

UNLIMITED_TREE_DEPTH

Constructor Summary

Constructors

Constructor and Description
ContentStoreServiceImpl() Default constructor.

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.
protected String	createContextId(String storeType, String storeServerUrl, String username, String password, String rootFolderPath, boolean cacheOn, int maxAllowedItemsInCache, boolean ignoreHiddenFiles)
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.
protected List<Item>	doFilter(List<Item> items, ItemFilter filter, boolean runningBeforeProcessing) Filters the given list of items by using the specified filter.
protected List<Item>	doFindChildren(Context context, CachingOptions cachingOptions, String url, Integer depth, ItemFilter filter, ItemProcessor processor) Does the following: Retrieves the children from the underlying repository (without their descriptors). Filters the returned list if ItemFilter.runBeforeProcessing() returns true. Calls AbstractCachedContentStoreService.getTree(Context, String) or AbstractCachedContentStoreService.getItem(Context, String) for each item in the list (depending on whether the item is a folder or not, and if depth is not null), to obtain the merged and processed version of each item. Filters the processed list if ItemFilter.runAfterProcessing() returns true. Returns the final list of processed items.
protected List<Item>	doFindChildren(Context context, CachingOptions cachingOptions, String url, ItemFilter filter, ItemProcessor processor)
protected Item	doFindItem(Context context, CachingOptions cachingOptions, String url, ItemProcessor processor) Returns the content store item for the given url, returning null if not found.
protected Tree	doFindTree(Context context, CachingOptions cachingOptions, String url, int depth, ItemFilter filter, ItemProcessor processor)
protected Item	doMerging(Context context, CachingOptions cachingOptions, Item item) Executes merging for the specified Item: Gets the DescriptorMergeStrategy for the item's descriptor from the DescriptorMergeStrategyResolver. Gets the actual descriptors to merge from the returned merge strategy. Retrieves the descriptor documents from the underlying repository. Merges the descriptor documents. Returns the item with the merged descriptor document.
protected Item	doProcessing(Context context, CachingOptions cachingOptions, Item item, ItemProcessor additionalProcessor) Executes processing for the specified Item: Gets the main ItemProcessor for the item from the ItemProcessorResolver. Calls the main processor's process method to process the item. If an additional processor was passed to this method, the additional processor is also called. Returns the processed item.
boolean	exists(Context context, String url) Returns true if the file or folder at the specified URL exists
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.
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.
void	setMerger(DescriptorMerger merger) Sets the DescriptorMerger, which merges the primary descriptor with a list of other descriptors, according to the merge strategy.
void	setMergeStrategyResolver(DescriptorMergeStrategyResolver mergeStrategyResolver) Sets the DescriptorMergeStrategyResolver, which resolves the .DescriptorMergeStrategy to use for a particular descriptor.
void	setProcessorResolver(ItemProcessorResolver processorResolver) Sets the ItemProcessorResolver, which resolves the .ItemProcessor to use for a particular Item.
void	setStoreAdapterRegistry(ContentStoreAdapterRegistry storeAdapterRegistry) Registry of ContentStoreAdapters.
boolean	validate(Context context) Returns true if the specified context is still valid and usable.

Methods inherited from class org.craftercms.core.service.impl.AbstractCachedContentStoreService

findChildren, findChildren, findItem, findItem, findTree, findTree, findTree, getChildren, getChildren, getItem, getItem, getTree, getTree, getTree, setCacheTemplate, setDefaultCachingOptions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

storeAdapterRegistry

protected ContentStoreAdapterRegistry storeAdapterRegistry

Registry of ContentStoreAdapters.

mergeStrategyResolver

protected DescriptorMergeStrategyResolver mergeStrategyResolver

Resolves the DescriptorMergeStrategy to use for a particular descriptor.

merger

protected DescriptorMerger merger

Merges a bunch of descriptors

processorResolver

protected ItemProcessorResolver processorResolver

Resolves the ItemProcessor to use for a particular Item.

contexts

protected Map<String,Context> contexts

Map of open Contexts

Constructor Detail

ContentStoreServiceImpl

public ContentStoreServiceImpl()

Default constructor. Creates the map of open Contexts.

Method Detail

setStoreAdapterRegistry

public void setStoreAdapterRegistry(ContentStoreAdapterRegistry storeAdapterRegistry)

Registry of ContentStoreAdapters.

setMergeStrategyResolver

public void setMergeStrategyResolver(DescriptorMergeStrategyResolver mergeStrategyResolver)

Sets the DescriptorMergeStrategyResolver, which resolves the .DescriptorMergeStrategy to use for a particular descriptor.

setMerger

public void setMerger(DescriptorMerger merger)

Sets the DescriptorMerger, which merges the primary descriptor with a list of other descriptors, according to the merge strategy.

setProcessorResolver

public void setProcessorResolver(ItemProcessorResolver processorResolver)

Sets the ItemProcessorResolver, which resolves the .ItemProcessor to use for a particular Item.

getContext

public Context getContext(String contextId)

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

createContext

public 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

public boolean validate(Context context)
                 throws StoreException,
                        AuthenticationException

Description copied from interface: ContentStoreService

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

Throws:

StoreException

AuthenticationException

destroyContext

public boolean destroyContext(Context context)
                       throws InvalidContextException,
                              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:

InvalidContextException

StoreException

AuthenticationException

exists

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

Description copied from interface: ContentStoreService

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

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

Description copied from interface: ContentStoreService

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

findContent

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

Description copied from interface: ContentStoreService

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

public Content getContent(Context context,
                          String url)
                   throws InvalidScopeException,
                          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:

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

StoreException - if an error occurred while accessing the content store

InvalidScopeException

getContent

public Content getContent(Context context,
                          CachingOptions cachingOptions,
                          String url)
                   throws InvalidScopeException,
                          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:

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

StoreException - if an error occurred while accessing the content store

InvalidScopeException

doFindItem

protected Item doFindItem(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.

After acquiring the item from the ContentStoreAdapter, the item's descriptor is merged (according to its DescriptorMergeStrategy) with related descriptors, and the final item is then processed.

Specified by:

doFindItem in class AbstractCachedContentStoreService

Throws:

InvalidContextException

XmlFileParseException

XmlMergeException

ItemProcessingException

StoreException

doFindChildren

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

Specified by:

doFindChildren in class AbstractCachedContentStoreService

Throws:

InvalidContextException

XmlFileParseException

XmlMergeException

ItemProcessingException

StoreException

doFindTree

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

Specified by:

doFindTree in class AbstractCachedContentStoreService

Throws:

InvalidContextException

XmlFileParseException

XmlMergeException

ItemProcessingException

StoreException

doFindChildren

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

Does the following:

1. Retrieves the children from the underlying repository (without their descriptors).
2. Filters the returned list if ItemFilter.runBeforeProcessing() returns true.
3. Calls AbstractCachedContentStoreService.getTree(Context, String) or AbstractCachedContentStoreService.getItem(Context, String) for each item in the list (depending on whether the item is a folder or not, and if depth is not null), to obtain the merged and processed version of each item.
4. Filters the processed list if ItemFilter.runAfterProcessing() returns true.
5. Returns the final list of processed items.

Throws:

InvalidContextException

XmlFileParseException

XmlMergeException

ItemProcessingException

StoreException

doMerging

protected Item doMerging(Context context,
                         CachingOptions cachingOptions,
                         Item item)
                  throws CrafterException

Executes merging for the specified Item:

1. Gets the DescriptorMergeStrategy for the item's descriptor from the DescriptorMergeStrategyResolver.
2. Gets the actual descriptors to merge from the returned merge strategy.
3. Retrieves the descriptor documents from the underlying repository.
4. Merges the descriptor documents.
5. Returns the item with the merged descriptor document.

Throws:

CrafterException

doProcessing

protected Item doProcessing(Context context,
                            CachingOptions cachingOptions,
                            Item item,
                            ItemProcessor additionalProcessor)
                     throws ItemProcessingException

Executes processing for the specified Item:

1. Gets the main ItemProcessor for the item from the ItemProcessorResolver.
2. Calls the main processor's process method to process the item.
3. If an additional processor was passed to this method, the additional processor is also called.
4. Returns the processed item.

Throws:

ItemProcessingException

doFilter

protected List<Item> doFilter(List<Item> items,
                              ItemFilter filter,
                              boolean runningBeforeProcessing)

Filters the given list of items by using the specified filter. The runningBeforeProcessing flag is passed to indicated the filter in which phase it is being executed (after or before processing).

createContextId

protected String createContextId(String storeType,
                                 String storeServerUrl,
                                 String username,
                                 String password,
                                 String rootFolderPath,
                                 boolean cacheOn,
                                 int maxAllowedItemsInCache,
                                 boolean ignoreHiddenFiles)