Uses of Class
org.craftercms.core.service.CachingOptions

Packages that use CachingOptions

Package	Description
org.craftercms.core.processors
org.craftercms.core.processors.impl
org.craftercms.core.processors.impl.template
org.craftercms.core.service
org.craftercms.core.service.impl
org.craftercms.core.store
org.craftercms.core.store.impl
org.craftercms.core.store.impl.filesystem
org.craftercms.core.url
org.craftercms.core.url.impl
org.craftercms.core.util.cache
org.craftercms.core.util.cache.impl
org.craftercms.core.xml.mergers
org.craftercms.core.xml.mergers.impl.strategies

Uses of CachingOptions in org.craftercms.core.processors

Methods in org.craftercms.core.processors with parameters of type CachingOptions

Modifier and Type	Method	Description
Item	ItemProcessor.process(Context context, CachingOptions cachingOptions, Item item)	Processes an Item.

Uses of CachingOptions in org.craftercms.core.processors.impl

Methods in org.craftercms.core.processors.impl with parameters of type CachingOptions

Modifier and Type	Method	Description
protected Item	IncludeDescriptorsProcessor.getItemToInclude(Context context, CachingOptions cachingOptions, String includeSrcPath)
protected void	IncludeDescriptorsProcessor.includeDescriptors(Context context, CachingOptions cachingOptions, Item item)
Item	AbstractTaggingProcessor.process(Context context, CachingOptions cachingOptions, Item item)
Item	AttributeAddingProcessor.process(Context context, CachingOptions cachingOptions, Item item)
Item	FieldRenamingProcessor.process(Context context, CachingOptions cachingOptions, Item item)
Item	IncludeDescriptorsProcessor.process(Context context, CachingOptions cachingOptions, Item item)	Replaces special include tags found in a descriptor document with the document tree of descriptors specified in these include tags.
Item	ItemProcessorPipeline.process(Context context, CachingOptions cachingOptions, Item item)	Processes the given Item, by calling a pipeline of processors.
Item	ItemUrlTransformingProcessor.process(Context context, CachingOptions cachingOptions, Item item)
Item	SkipAllItemProcessor.process(Context context, CachingOptions cachingOptions, Item item)
Item	TextMetaDataCollectionExtractingProcessor.process(Context context, CachingOptions cachingOptions, Item item)	For every XPath query provided in metaDataNodesXPathQueries, a list of nodes is selected and for each one of these nodes its text value is extracted and added to a list that is later put in the item's properties.
Item	TextMetaDataExtractingProcessor.process(Context context, CachingOptions cachingOptions, Item item)	For every XPath query provided in metaDataNodesXPathQueries, a single node is selected and its text value is extracted and put in the item's properties.

Uses of CachingOptions in org.craftercms.core.processors.impl.template

Methods in org.craftercms.core.processors.impl.template with parameters of type CachingOptions

Modifier and Type	Method	Description
Item	TemplateProcessor.process(Context context, CachingOptions cachingOptions, Item item)	Processes the content of certain nodes (found by the NodeScanner in the item's descriptor as templates, by compiling the node text templates through the templateCompiler and then processing the compiled template with a model returned by modelFactory.

Uses of CachingOptions in org.craftercms.core.service

Fields in org.craftercms.core.service declared as CachingOptions

Modifier and Type	Field	Description
static final CachingOptions	CachingOptions.CACHE_OFF_CACHING_OPTIONS
static final CachingOptions	CachingOptions.DEFAULT_CACHING_OPTIONS

Methods in org.craftercms.core.service with parameters of type CachingOptions

Modifier and Type	Method	Description
boolean	ContentStoreService.exists(Context context, CachingOptions cachingOptions, String url)	Returns true if the file or folder at the specified URL exists
default List<Item>	ContentStoreService.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>	ContentStoreService.findChildren(Context context, CachingOptions cachingOptions, String url, ItemFilter filter, ItemProcessor processor, boolean flatten)	Returns the children of the folder at the given url, returning null if the folder can't be found.
Content	ContentStoreService.findContent(Context context, CachingOptions cachingOptions, String url)	Returns the content of the file for the given url, returning null if not found.
default Item	ContentStoreService.findItem(Context context, CachingOptions cachingOptions, String url, ItemProcessor processor)	Returns the content store item for the given url, returning null if not found.
Item	ContentStoreService.findItem(Context context, CachingOptions cachingOptions, String url, ItemProcessor processor, boolean flatten)	Returns the content store item for the given url, returning null if not found.
default Tree	ContentStoreService.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	ContentStoreService.findTree(Context context, CachingOptions cachingOptions, String url, int depth, ItemFilter filter, ItemProcessor processor, boolean flatten)	Returns the folder at the given url as a tree, or null if the folder wasn't found.
default List<Item>	ContentStoreService.getChildren(Context context, CachingOptions cachingOptions, String url, ItemFilter filter, ItemProcessor processor)	Returns the children of the folder at the given url.
List<Item>	ContentStoreService.getChildren(Context context, CachingOptions cachingOptions, String url, ItemFilter filter, ItemProcessor processor, boolean flatten)	Returns the children of the folder at the given url.
Content	ContentStoreService.getContent(Context context, CachingOptions cachingOptions, String url)	Returns the content of the file for the given url.
default Item	ContentStoreService.getItem(Context context, CachingOptions cachingOptions, String url, ItemProcessor processor)	Returns the content store item for the given url.
Item	ContentStoreService.getItem(Context context, CachingOptions cachingOptions, String url, ItemProcessor processor, boolean flatten)	Returns the content store item for the given url.
default Tree	ContentStoreService.getTree(Context context, CachingOptions cachingOptions, String url, int depth, ItemFilter filter, ItemProcessor processor)	Returns the folder at the given url as a tree.
Tree	ContentStoreService.getTree(Context context, CachingOptions cachingOptions, String url, int depth, ItemFilter filter, ItemProcessor processor, boolean flatten)	Returns the folder at the given url as a tree.
void	CacheService.put(Context context, Object key, Object value, CachingOptions cachingOptions, CacheLoader loader, Object... loaderParams)	Puts and item in the scope of the given context.

Uses of CachingOptions in org.craftercms.core.service.impl

Fields in org.craftercms.core.service.impl declared as CachingOptions

Modifier and Type	Field	Description
protected CachingOptions	AbstractCachedContentStoreService.defaultCachingOptions	The default caching options to use when none are specified in the method.

Methods in org.craftercms.core.service.impl with parameters of type CachingOptions

Modifier and Type	Method	Description
protected abstract boolean	AbstractCachedContentStoreService.doExists(Context context, CachingOptions cachingOptions, String url)
boolean	ContentStoreServiceImpl.doExists(Context context, CachingOptions cachingOptions, String url)
protected abstract List<Item>	AbstractCachedContentStoreService.doFindChildren(Context context, CachingOptions cachingOptions, String url, ItemFilter filter, ItemProcessor processor, boolean flatten)
protected List<Item>	ContentStoreServiceImpl.doFindChildren(Context context, CachingOptions cachingOptions, String url, Integer depth, ItemFilter filter, ItemProcessor processor, boolean flatten)	Does the following: Retrieves the children from the underlying repository (without their descriptors). Filters the returned list if ItemFilter.runBeforeProcessing() returns true. Calls ContentStoreService.getTree(Context, String) or ContentStoreService.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>	ContentStoreServiceImpl.doFindChildren(Context context, CachingOptions cachingOptions, String url, ItemFilter filter, ItemProcessor processor, boolean flatten)
protected abstract Item	AbstractCachedContentStoreService.doFindItem(Context context, CachingOptions cachingOptions, String url, ItemProcessor processor)
protected Item	ContentStoreServiceImpl.doFindItem(Context context, CachingOptions cachingOptions, String url, ItemProcessor processor)	Returns the content store item for the given url, returning null if not found.
protected abstract Tree	AbstractCachedContentStoreService.doFindTree(Context context, CachingOptions cachingOptions, String url, int depth, ItemFilter filter, ItemProcessor processor, boolean flatten)
protected Tree	ContentStoreServiceImpl.doFindTree(Context context, CachingOptions cachingOptions, String url, int depth, ItemFilter filter, ItemProcessor processor, boolean flatten)
protected Item	ContentStoreServiceImpl.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	ContentStoreServiceImpl.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	AbstractCachedContentStoreService.exists(Context context, CachingOptions cachingOptions, String url)
List<Item>	AbstractCachedContentStoreService.findChildren(Context context, CachingOptions cachingOptions, String url, ItemFilter filter, ItemProcessor processor, boolean flatten)
Content	ContentStoreServiceImpl.findContent(Context context, CachingOptions cachingOptions, String url)
Item	AbstractCachedContentStoreService.findItem(Context context, CachingOptions cachingOptions, String url, ItemProcessor processor, boolean flatten)
Tree	AbstractCachedContentStoreService.findTree(Context context, CachingOptions cachingOptions, String url, int depth, ItemFilter filter, ItemProcessor processor, boolean flatten)
List<Item>	AbstractCachedContentStoreService.getChildren(Context context, CachingOptions cachingOptions, String url, ItemFilter filter, ItemProcessor processor, boolean flatten)
protected List<Item>	ContentStoreServiceImpl.getChildrenInternal(Context context, CachingOptions cachingOptions, String url, ItemProcessor processor, boolean flatten)	This method is meant to be overridden when the children need to be further processed/filtered
Content	ContentStoreServiceImpl.getContent(Context context, CachingOptions cachingOptions, String url)	Returns the content of the file for the given url.
Item	AbstractCachedContentStoreService.getItem(Context context, CachingOptions cachingOptions, String url, ItemProcessor processor, boolean flatten)
Tree	AbstractCachedContentStoreService.getTree(Context context, CachingOptions cachingOptions, String url, int depth, ItemFilter filter, ItemProcessor processor, boolean flatten)
void	CacheServiceImpl.put(Context context, Object key, Object value, CachingOptions cachingOptions, CacheLoader loader, Object... loaderParams)
void	AbstractCachedContentStoreService.setDefaultCachingOptions(CachingOptions defaultCachingOptions)	Sets the default caching options to use when none are specified in the method.

Uses of CachingOptions in org.craftercms.core.store

Methods in org.craftercms.core.store with parameters of type CachingOptions

Modifier and Type	Method	Description
boolean	ContentStoreAdapter.exists(Context context, CachingOptions cachingOptions, String path)
Content	ContentStoreAdapter.findContent(Context context, CachingOptions cachingOptions, String path)
Item	ContentStoreAdapter.findItem(Context context, CachingOptions cachingOptions, String path, boolean withDescriptor)
List<Item>	ContentStoreAdapter.findItems(Context context, CachingOptions cachingOptions, String path)

Uses of CachingOptions in org.craftercms.core.store.impl

Fields in org.craftercms.core.store.impl declared as CachingOptions

Modifier and Type	Field	Description
protected CachingOptions	AbstractCachedContentStoreAdapter.defaultCachingOptions

Methods in org.craftercms.core.store.impl with parameters of type CachingOptions

Modifier and Type	Method	Description
protected abstract boolean	AbstractCachedContentStoreAdapter.doExists(Context context, CachingOptions cachingOptions, String path)
boolean	AbstractFileBasedContentStoreAdapter.doExists(Context context, CachingOptions cachingOptions, String path)
protected abstract Content	AbstractCachedContentStoreAdapter.doFindContent(Context context, CachingOptions cachingOptions, String path)
protected Content	AbstractFileBasedContentStoreAdapter.doFindContent(Context context, CachingOptions cachingOptions, String path)
protected abstract Item	AbstractCachedContentStoreAdapter.doFindItem(Context context, CachingOptions cachingOptions, String path, boolean withDescriptor)
protected Item	AbstractFileBasedContentStoreAdapter.doFindItem(Context context, CachingOptions cachingOptions, String path, boolean withDescriptor)
protected abstract List<Item>	AbstractCachedContentStoreAdapter.doFindItems(Context context, CachingOptions cachingOptions, String path)
protected List<Item>	AbstractFileBasedContentStoreAdapter.doFindItems(Context context, CachingOptions cachingOptions, String path)
boolean	AbstractCachedContentStoreAdapter.exists(Context context, CachingOptions cachingOptions, String path)
Content	AbstractCachedContentStoreAdapter.findContent(Context context, CachingOptions cachingOptions, String path)
protected abstract File	AbstractFileBasedContentStoreAdapter.findFile(Context context, CachingOptions cachingOptions, String path)	Returns the File at the given path, returning null if not found.
Item	AbstractCachedContentStoreAdapter.findItem(Context context, CachingOptions cachingOptions, String path, boolean withDescriptor)
List<Item>	AbstractCachedContentStoreAdapter.findItems(Context context, CachingOptions cachingOptions, String path)
protected abstract List<File>	AbstractFileBasedContentStoreAdapter.getChildren(Context context, CachingOptions cachingOptions, File dir)	Returns the list of children of the given directory.
protected abstract Content	AbstractFileBasedContentStoreAdapter.getContent(Context context, CachingOptions cachingOptions, File file)	Returns the Content for the given file.
void	AbstractCachedContentStoreAdapter.setDefaultCachingOptions(CachingOptions defaultCachingOptions)

Uses of CachingOptions in org.craftercms.core.store.impl.filesystem

Methods in org.craftercms.core.store.impl.filesystem with parameters of type CachingOptions

Modifier and Type	Method	Description
protected File	FileSystemContentStoreAdapter.findFile(Context context, CachingOptions cachingOptions, String path)
protected List<File>	FileSystemContentStoreAdapter.getChildren(Context context, CachingOptions cachingOptions, File dir)
protected Content	FileSystemContentStoreAdapter.getContent(Context context, CachingOptions cachingOptions, File file)

Uses of CachingOptions in org.craftercms.core.url

Methods in org.craftercms.core.url with parameters of type CachingOptions

Modifier and Type	Method	Description
String	UrlTransformationEngine.transformUrl(Context context, CachingOptions cachingOptions, String transformerName, String url)
String	UrlTransformer.transformUrl(Context context, CachingOptions cachingOptions, String url)

Uses of CachingOptions in org.craftercms.core.url.impl

Methods in org.craftercms.core.url.impl with parameters of type CachingOptions

Modifier and Type	Method	Description
protected abstract String	AbstractCachedUrlTransformationEngine.doTransformUrl(Context context, CachingOptions cachingOptions, String transformerName, String url)
protected String	UrlTransformationEngineImpl.doTransformUrl(Context context, CachingOptions cachingOptions, String transformerName, String url)
protected String	ShortToLongUrlTransformer.getLongName(Context context, CachingOptions cachingOptions, String folderPath, String shortName)
protected String	ShortToLongUrlTransformer.getLongUrl(Context context, CachingOptions cachingOptions, String shortUrl, boolean useShortNameIfLongNameNotFound)
String	AbstractCachedUrlTransformationEngine.transformUrl(Context context, CachingOptions cachingOptions, String transformerName, String url)
String	AddContextPathUrlTransformer.transformUrl(Context context, CachingOptions cachingOptions, String url)
String	AddDebugParamUrlTransformer.transformUrl(Context context, CachingOptions cachingOptions, String url)
String	AddPrefixAndSuffixUrlTransformer.transformUrl(Context context, CachingOptions cachingOptions, String url)
String	AddSchemeAndDomainAndServerPortUrlTransformer.transformUrl(Context context, CachingOptions cachingOptions, String url)
String	AddServletPathUrlTransformer.transformUrl(Context context, CachingOptions cachingOptions, String url)
String	ContentBundleShortToLongUrlTransformer.transformUrl(Context context, CachingOptions cachingOptions, String url)
String	ExtractRequestAttributesUrlTransformer.transformUrl(Context context, CachingOptions cachingOptions, String url)
String	LongToShortUrlTransformer.transformUrl(Context context, CachingOptions cachingOptions, String url)
String	RemovePrefixAndSuffixUrlTransformer.transformUrl(Context context, CachingOptions cachingOptions, String url)
String	ReplacePatternAllUrlTransformer.transformUrl(Context context, CachingOptions cachingOptions, String url)
String	ReplaceSubstringUrlTransformer.transformUrl(Context context, CachingOptions cachingOptions, String url)
String	ShortToLongUrlTransformer.transformUrl(Context context, CachingOptions cachingOptions, String url)
String	UrlTransformerPipeline.transformUrl(Context context, CachingOptions cachingOptions, String url)

Uses of CachingOptions in org.craftercms.core.util.cache

Methods in org.craftercms.core.util.cache with parameters of type CachingOptions

Modifier and Type	Method	Description
<T> T	CacheTemplate.getObject(Context context, CachingOptions cachingOptions, org.craftercms.commons.lang.Callback<T> callback, Object... keyElements)	Executes the template, using the specified callback to load the object to cache, if it's not already in the cache.

Uses of CachingOptions in org.craftercms.core.util.cache.impl

Methods in org.craftercms.core.util.cache.impl with parameters of type CachingOptions

Modifier and Type	Method	Description
protected <T> T	DefaultCacheTemplate.doPut(Context context, CachingOptions cachingOptions, org.craftercms.commons.lang.Callback<T> callback, Object key, T obj)
<T> T	DefaultCacheTemplate.getObject(Context context, CachingOptions cachingOptions, org.craftercms.commons.lang.Callback<T> callback, Object... keyElements)
<T> T	NoopCacheTemplate.getObject(Context context, CachingOptions options, org.craftercms.commons.lang.Callback<T> callback, Object... keyElements)
protected <T> T	DefaultCacheTemplate.loadAndPutInCache(Context context, CachingOptions cachingOptions, org.craftercms.commons.lang.Callback<T> callback, Object key)
protected <T> T	NonLockingCacheTemplate.loadAndPutInCache(Context context, CachingOptions options, org.craftercms.commons.lang.Callback<T> callback, Object key)

Uses of CachingOptions in org.craftercms.core.xml.mergers

Methods in org.craftercms.core.xml.mergers with parameters of type CachingOptions

Modifier and Type	Method	Description
List<MergeableDescriptor>	DescriptorMergeStrategy.getDescriptors(Context context, CachingOptions cachingOptions, String mainDescriptorUrl, org.dom4j.Document mainDescriptorDom)	Returns the list of descriptors in the order they should be merged, given the URI of the primary descriptor.
List<MergeableDescriptor>	DescriptorMergeStrategy.getDescriptors(Context context, CachingOptions cachingOptions, String mainDescriptorUrl, org.dom4j.Document mainDescriptorDom, boolean mainDescriptorOptional)	Returns the list of descriptors in the order they should be merged, given the URI of the primary descriptor.

Uses of CachingOptions in org.craftercms.core.xml.mergers.impl.strategies

Methods in org.craftercms.core.xml.mergers.impl.strategies with parameters of type CachingOptions

Modifier and Type	Method	Description
protected abstract void	AbstractInheritFromHierarchyMergeStrategy.addInheritedDescriptorsInFolder(Context context, CachingOptions cachingOptions, List<MergeableDescriptor> inheritedDescriptors, String folder, String mainDescriptorUrl, org.dom4j.Document mainDescriptorDom)
protected void	CompositeInheritFromHierarchyMergeStrategy.addInheritedDescriptorsInFolder(Context context, CachingOptions cachingOptions, List<MergeableDescriptor> inheritedDescriptors, String folder, String mainDescriptorUrl, org.dom4j.Document mainDescriptorDom)
protected void	InheritLevelsMergeStrategy.addInheritedDescriptorsInFolder(Context context, CachingOptions cachingOptions, List<MergeableDescriptor> inheritedDescriptors, String folder, String mainDescriptorUrl, org.dom4j.Document mainDescriptorDom)
protected void	InheritVersionsMergeStrategy.addInheritedDescriptorsInFolder(Context context, CachingOptions cachingOptions, List<MergeableDescriptor> inheritedDescriptors, String folder, String mainDescriptorUrl, org.dom4j.Document mainDescriptorDom)
protected org.dom4j.Document	ContentBundleMergeStrategy.getDescriptorDom(Context context, CachingOptions cachingOptions, String url)
protected org.dom4j.Document	ExplicitParentMergeStrategy.getDescriptorDom(Context context, CachingOptions cachingOptions, String url)
List<MergeableDescriptor>	AbstractInheritFromHierarchyMergeStrategy.getDescriptors(Context context, CachingOptions cachingOptions, String mainDescriptorUrl, org.dom4j.Document mainDescriptorDom)
List<MergeableDescriptor>	AbstractInheritFromHierarchyMergeStrategy.getDescriptors(Context context, CachingOptions cachingOptions, String mainDescriptorUrl, org.dom4j.Document mainDescriptorDom, boolean mainDescriptorOptional)
List<MergeableDescriptor>	ContentBundleMergeStrategy.getDescriptors(Context context, CachingOptions cachingOptions, String mainDescriptorUrl, org.dom4j.Document mainDescriptorDom)
List<MergeableDescriptor>	ContentBundleMergeStrategy.getDescriptors(Context context, CachingOptions cachingOptions, String mainDescriptorUrl, org.dom4j.Document mainDescriptorDom, boolean mainDescriptorOptional)
List<MergeableDescriptor>	ExplicitParentMergeStrategy.getDescriptors(Context context, CachingOptions cachingOptions, String mainDescriptorUrl, org.dom4j.Document mainDescriptorDom)
List<MergeableDescriptor>	ExplicitParentMergeStrategy.getDescriptors(Context context, CachingOptions cachingOptions, String mainDescriptorUrl, org.dom4j.Document mainDescriptorDom, boolean mainDescriptorOptional)
List<MergeableDescriptor>	SingleFileMergeStrategy.getDescriptors(Context context, CachingOptions cachingOptions, String mainDescriptorUrl, org.dom4j.Document mainDescriptorDom)
List<MergeableDescriptor>	SingleFileMergeStrategy.getDescriptors(Context context, CachingOptions cachingOptions, String mainDescriptorUrl, org.dom4j.Document mainDescriptorDom, boolean mainDescriptorOptional)