org.craftercms.engine.service

Class ContentStoreServiceImpl

java.lang.Object

org.craftercms.core.service.impl.AbstractCachedContentStoreService

org.craftercms.core.service.impl.ContentStoreServiceImpl

org.craftercms.engine.service.ContentStoreServiceImpl

All Implemented Interfaces:

org.craftercms.core.service.ContentStoreService

public class ContentStoreServiceImpl
extends org.craftercms.core.service.impl.ContentStoreServiceImpl

Override ContentStoreServiceImpl with fallback site logic. For example, the fallback site of 'test-fr' is 'test'.

Author:

Russ Danner, Michael Chen

Field Summary

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

cacheTemplate, CONST_KEY_ELEM_CHILDREN, CONST_KEY_ELEM_ITEM, CONST_KEY_ELEM_TREE

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

UNLIMITED_TREE_DEPTH

Constructor Summary

Constructors

Constructor and Description
ContentStoreServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	createContextId(String storeType, String storeServerUrl, String username, String password, String rootFolderPath, boolean cacheOn, int maxAllowedItemsInCache, boolean ignoreHiddenFiles)
protected List<org.craftercms.core.service.Item>	doGetChildren(org.craftercms.core.service.Context context, org.craftercms.core.service.CachingOptions cachingOptions, String url, Integer depth, org.craftercms.core.service.ItemFilter filter, org.craftercms.core.processors.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 org.craftercms.core.service.Item	doGetItem(org.craftercms.core.service.Context context, org.craftercms.core.service.CachingOptions cachingOptions, String url, org.craftercms.core.processors.ItemProcessor processor) Returns the content store item for the given url.
org.craftercms.core.service.Content	getContent(org.craftercms.core.service.Context context, org.craftercms.core.service.CachingOptions cachingOptions, String url)
void	setMacroResolver(MacroResolver macroResolver)
void	setSitePathPrefix(String sitePathPrefix)

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

createContext, destroyContext, doFilter, doGetChildren, doGetTree, doMerging, doProcessing, getContent, getContext, setMerger, setMergeStrategyResolver, setProcessorResolver, setStoreAdapterRegistry

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

getChildren, getChildren, getChildren, getChildren, getChildren, getChildren, getChildren, getChildren, getItem, getItem, getItem, getItem, getTree, getTree, getTree, getTree, getTree, getTree, getTree, getTree, getTree, getTree, getTree, getTree, getTree, getTree, getTree, getTree, setCacheTemplate

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentStoreServiceImpl

public ContentStoreServiceImpl()

Method Detail

setMacroResolver

public void setMacroResolver(MacroResolver macroResolver)

setSitePathPrefix

public void setSitePathPrefix(String sitePathPrefix)

doGetItem

protected org.craftercms.core.service.Item doGetItem(org.craftercms.core.service.Context context,
                                         org.craftercms.core.service.CachingOptions cachingOptions,
                                         String url,
                                         org.craftercms.core.processors.ItemProcessor processor)
                                              throws org.craftercms.core.exception.InvalidContextException,
                                                     org.craftercms.core.exception.PathNotFoundException,
                                                     org.craftercms.core.exception.XmlFileParseException,
                                                     org.craftercms.core.exception.XmlMergeException,
                                                     org.craftercms.core.exception.ItemProcessingException,
                                                     org.craftercms.core.exception.StoreException

Returns the content store item for the given url.

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.

Overrides:

doGetItem in class org.craftercms.core.service.impl.ContentStoreServiceImpl

Throws:

org.craftercms.core.exception.InvalidContextException

org.craftercms.core.exception.PathNotFoundException

org.craftercms.core.exception.XmlFileParseException

org.craftercms.core.exception.XmlMergeException

org.craftercms.core.exception.ItemProcessingException

org.craftercms.core.exception.StoreException

getContent

public org.craftercms.core.service.Content getContent(org.craftercms.core.service.Context context,
                                             org.craftercms.core.service.CachingOptions cachingOptions,
                                             String url)
                                               throws org.craftercms.core.exception.InvalidScopeException,
                                                      org.craftercms.core.exception.PathNotFoundException,
                                                      org.craftercms.core.exception.StoreException

Specified by:

getContent in interface org.craftercms.core.service.ContentStoreService

Overrides:

getContent in class org.craftercms.core.service.impl.ContentStoreServiceImpl

Throws:

org.craftercms.core.exception.InvalidScopeException

org.craftercms.core.exception.PathNotFoundException

org.craftercms.core.exception.StoreException

doGetChildren

protected List<org.craftercms.core.service.Item> doGetChildren(org.craftercms.core.service.Context context,
                                                   org.craftercms.core.service.CachingOptions cachingOptions,
                                                   String url,
                                                   Integer depth,
                                                   org.craftercms.core.service.ItemFilter filter,
                                                   org.craftercms.core.processors.ItemProcessor processor)
                                                        throws org.craftercms.core.exception.InvalidContextException,
                                                               org.craftercms.core.exception.PathNotFoundException,
                                                               org.craftercms.core.exception.XmlFileParseException,
                                                               org.craftercms.core.exception.XmlMergeException,
                                                               org.craftercms.core.exception.ItemProcessingException,
                                                               org.craftercms.core.exception.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.

Overrides:

doGetChildren in class org.craftercms.core.service.impl.ContentStoreServiceImpl

Throws:

org.craftercms.core.exception.InvalidContextException

org.craftercms.core.exception.PathNotFoundException

org.craftercms.core.exception.XmlFileParseException

org.craftercms.core.exception.XmlMergeException

org.craftercms.core.exception.ItemProcessingException

org.craftercms.core.exception.StoreException

createContextId

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

Overrides:

createContextId in class org.craftercms.core.service.impl.ContentStoreServiceImpl