A B C D E F G H I L M N O P R S T U V W X 

A

AbstractCacheListener - Class in info.magnolia.module.cache.listeners
.
AbstractCacheListener() - Constructor for class info.magnolia.module.cache.listeners.AbstractCacheListener
 
AbstractCacheModule - Class in info.magnolia.module.cache
The base class for cache modules.
AbstractCacheModule(CacheMonitor) - Constructor for class info.magnolia.module.cache.AbstractCacheModule
 
AbstractExecutor - Class in info.magnolia.module.cache.executor
The cache configuration is passed to the executor.
AbstractExecutor() - Constructor for class info.magnolia.module.cache.executor.AbstractExecutor
 
AbstractListeningCacheWrapper - Class in info.magnolia.module.cache.listeners
Cache wrapper which is responsible for calling of cache listeners.
AbstractListeningCacheWrapper(CacheModule) - Constructor for class info.magnolia.module.cache.listeners.AbstractListeningCacheWrapper
 
AbstractListeningFlushPolicy - Class in info.magnolia.module.cache
Implemenation of the FlushPolicy providing functionality for triggering flush operation based on changes in observed workspaces.
AbstractListeningFlushPolicy() - Constructor for class info.magnolia.module.cache.AbstractListeningFlushPolicy
AbstractListeningFlushPolicy(CacheModule, RepositoryManager) - Constructor for class info.magnolia.module.cache.AbstractListeningFlushPolicy
 
AbstractListeningFlushPolicy.CacheCleaner - Class in info.magnolia.module.cache
Event listener triggering the cleanup of the cache.
AbstractListeningFlushPolicy.CacheCleaner(Cache, String) - Constructor for class info.magnolia.module.cache.AbstractListeningFlushPolicy.CacheCleaner
 
AbstractVoterBased - Class in info.magnolia.module.cache.browsercachepolicy
Uses a VoterSet to decided if the file should be cached in the browser.
AbstractVoterBased() - Constructor for class info.magnolia.module.cache.browsercachepolicy.AbstractVoterBased
 
addCache(String) - Method in class info.magnolia.module.cache.mbean.CacheMonitor
 
addConfiguration(String, CacheConfiguration) - Method in class info.magnolia.module.cache.CacheModule
addDateHeader(String, long) - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
addExecutor(String, CachePolicyExecutor) - Method in class info.magnolia.module.cache.ContentCachingConfiguration
 
addExecutor(CachePolicyExecutor) - Method in class info.magnolia.module.cache.executor.CompositeExecutor
 
addHeader(String, String) - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
addHeader(String, Object) - Method in class info.magnolia.module.cache.filter.ResponseExpirationCalculator
 
addHeaders(boolean, HttpServletResponse) - Method in class info.magnolia.module.cache.filter.ContentCachedEntry
Sets headers in the response object.
addIntHeader(String, int) - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
addPolicy(FlushPolicy) - Method in class info.magnolia.module.cache.DelegateFlushPolicy
 
addRepository(String) - Method in class info.magnolia.module.cache.AbstractListeningFlushPolicy
Deprecated.
ATTRIBUTE_IN_MEMORY_THRESHOLD - Static variable in class info.magnolia.module.cache.filter.CacheResponseWrapper
Set this request attribute to an positive Integer if you want to raise CacheResponseWrapper.DEFAULT_THRESHOLD for time consuming resources.

B

bindContentFileToCurrentRequest(HttpServletRequest, File) - Method in class info.magnolia.module.cache.filter.DelegatingBlobCachedEntry
 
BlockingCache - Interface in info.magnolia.module.cache
Marker interface to expose the fact that this cache will block further calls to Cache.get(Object) until an entry is put into the cache.
BrowserCachePolicy - Interface in info.magnolia.module.cache
Used to determine if the expiration headers must be set.
BrowserCachePolicyResult - Class in info.magnolia.module.cache
Transports the expiration date.
BrowserCachePolicyResult(long) - Constructor for class info.magnolia.module.cache.BrowserCachePolicyResult
 
BrowserCachePolicySet - Class in info.magnolia.module.cache.browsercachepolicy
A collection of BrowserCachePolicy.
BrowserCachePolicySet() - Constructor for class info.magnolia.module.cache.browsercachepolicy.BrowserCachePolicySet
 
BrowserTtlVoter - Class in info.magnolia.module.cache.cachepolicy.voters
Returns TTL according to browser cache policy.
BrowserTtlVoter() - Constructor for class info.magnolia.module.cache.cachepolicy.voters.BrowserTtlVoter
 
bypass - Static variable in class info.magnolia.module.cache.CachePolicyResult
 
Bypass - Class in info.magnolia.module.cache.executor
Bypasses all caching functionality.
Bypass() - Constructor for class info.magnolia.module.cache.executor.Bypass
 
bypasses(HttpServletRequest) - Method in class info.magnolia.module.cache.filter.GZipFilter
 
bypasses(HttpServletRequest) - Method in class info.magnolia.module.cache.filter.StandaloneGZipFilter
 

C

Cache - Interface in info.magnolia.module.cache
A simple interface around 3rd party or custom cache libraries.
CACHE_CONFIGURATION_PATH - Static variable in class info.magnolia.module.cache.setup.ExcludeWorkspacesFromFlushCachePolicy
 
CACHE_NAME - Static variable in class info.magnolia.module.cache.commands.FlushNamedCacheCommand
 
CACHE_TEMP_FILE_PREFIX - Static variable in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
CacheConfiguration - Class in info.magnolia.module.cache
Deprecated. 
CacheConfiguration() - Constructor for class info.magnolia.module.cache.CacheConfiguration
Deprecated.
 
CacheConstants - Class in info.magnolia.cms.cache
Cache constants.
CacheConstants() - Constructor for class info.magnolia.cms.cache.CacheConstants
 
CachedEntry - Interface in info.magnolia.module.cache.filter
A cached entry used to store content produced by the filter chain.
CachedError - Class in info.magnolia.module.cache.filter
Contract for cached errors providing access to the error codes.
CachedError(int, String, int) - Constructor for class info.magnolia.module.cache.filter.CachedError
 
CachedRedirect - Class in info.magnolia.module.cache.filter
Cached redirect contract providing access to the status code and target location.
CachedRedirect(int, String, String, int) - Constructor for class info.magnolia.module.cache.filter.CachedRedirect
 
CacheFactory - Interface in info.magnolia.module.cache
Most caching libraries allow the creation of different caches ("zones") in a single application/vm.
CacheFactoryProvider - Class in info.magnolia.module.cache.inject
A simple Provider which provides the CacheFactory instance.
CacheFactoryProvider(Provider<CacheModule>) - Constructor for class info.magnolia.module.cache.inject.CacheFactoryProvider
 
CacheFilter - Class in info.magnolia.module.cache.filter
Uses the CachePolicy to determine the cache behavior.
CacheFilter(CacheModule, CacheMonitor) - Constructor for class info.magnolia.module.cache.filter.CacheFilter
 
CacheHeadersFilter - Class in info.magnolia.module.cache.filter
Deprecated.
since 5.4. Use SetExpirationHeaders instead.
CacheHeadersFilter() - Constructor for class info.magnolia.module.cache.filter.CacheHeadersFilter
Deprecated.
 
CacheKey - Interface in info.magnolia.module.cache.cachekey
Cache key interface.
CacheKeyGenerator<CK> - Interface in info.magnolia.module.cache.cachekey
Generator of CacheKeys.
CacheModule - Class in info.magnolia.module.cache
The CacheModule holds several named ContentCachingConfiguration instances and a CacheFactory.
CacheModule(CacheMonitor) - Constructor for class info.magnolia.module.cache.CacheModule
 
CacheModule(ModuleManager, CacheMonitor) - Constructor for class info.magnolia.module.cache.CacheModule
CacheModuleLifecycleListener - Interface in info.magnolia.module.cache
Implementations should register themselves in the appropriate CacheModule instances to get callbacks when the module is restarted.
CacheModuleVersionHandler - Class in info.magnolia.module.cache.setup
VersionHandler implementation for the cache module.
CacheModuleVersionHandler() - Constructor for class info.magnolia.module.cache.setup.CacheModuleVersionHandler
 
CacheMonitor - Class in info.magnolia.module.cache.mbean
MBean implementation for the cache status.
CacheMonitor(CommandsManager, CacheFactoryProvider, SystemContext) - Constructor for class info.magnolia.module.cache.mbean.CacheMonitor
 
CacheMonitor(CommandsManager, Provider<CacheModule>, SystemContext) - Constructor for class info.magnolia.module.cache.mbean.CacheMonitor
CacheMonitorMBean - Interface in info.magnolia.module.cache.mbean
MBean implemenation for monitoring and manipulation of the cache.
CachePolicy - Interface in info.magnolia.module.cache
The CachePolicy determines is a requested page should be cached, retrieved from the cache or not cached at all.
CachePolicyExecutor - Interface in info.magnolia.module.cache
Executes something based on the outcome of the CachePolicy (store, bypass, server, set expiration headers).
CachePolicyResult - Class in info.magnolia.module.cache
CachePolicy returns instances of this class - depending on the value of the behaviour property, the cacheKey and cachedEntry values might be set or not.
CachePolicyResult(CachePolicyResult.CachePolicyBehaviour, Object, Object) - Constructor for class info.magnolia.module.cache.CachePolicyResult
 
CachePolicyResult.CachePolicyBehaviour - Class in info.magnolia.module.cache
Descriptor of the cache policy behavior used by this cache policy result.
CacheResponseWrapper - Class in info.magnolia.module.cache.filter
A response wrapper which records the status, headers and content.
CacheResponseWrapper(HttpServletResponse, int, boolean) - Constructor for class info.magnolia.module.cache.filter.CacheResponseWrapper
 
CacheResponseWrapper(HttpServletResponse, int, boolean, AbstractThresholdingCacheOutputStream) - Constructor for class info.magnolia.module.cache.filter.CacheResponseWrapper
 
canCacheOnClient(CachePolicyResult) - Method in class info.magnolia.module.cache.browsercachepolicy.AbstractVoterBased
 
canCacheOnClient(CachePolicyResult) - Method in class info.magnolia.module.cache.browsercachepolicy.BrowserCachePolicySet
 
canCacheOnClient(CachePolicyResult) - Method in interface info.magnolia.module.cache.BrowserCachePolicy
 
canServeGzipContent() - Method in class info.magnolia.module.cache.filter.ContentCachedEntry
 
canServeGzipContent() - Method in class info.magnolia.module.cache.filter.DelegatingBlobCachedEntry
 
canServeGzipContent() - Method in class info.magnolia.module.cache.filter.InMemoryCachedEntry
 
cleanUp() - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
clear() - Method in interface info.magnolia.module.cache.Cache
 
clear() - Method in class info.magnolia.module.cache.listeners.AbstractCacheListener
 
clear() - Method in class info.magnolia.module.cache.listeners.AbstractListeningCacheWrapper
 
CompositeExecutor - Class in info.magnolia.module.cache.executor
A list of executors (for combining and ordering them).
CompositeExecutor() - Constructor for class info.magnolia.module.cache.executor.CompositeExecutor
 
CompositeExecutorTransformer - Class in info.magnolia.module.cache.executor
Omit the executors subnode.
CompositeExecutorTransformer() - Constructor for class info.magnolia.module.cache.executor.CompositeExecutorTransformer
 
CONFIGURATION_PATH - Static variable in class info.magnolia.module.cache.setup.CacheModuleVersionHandler
 
containsHeader(String) - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
CONTENT_FILE_ATTRIBUTE - Static variable in class info.magnolia.module.cache.filter.DelegatingBlobCachedEntry
 
ContentCachedEntry - Class in info.magnolia.module.cache.filter
Wraps a page response.
ContentCachedEntry(String, String, int, MultiMap, long, String, int) - Constructor for class info.magnolia.module.cache.filter.ContentCachedEntry
 
ContentCachingConfiguration - Class in info.magnolia.module.cache
Each ContentCachingConfiguration holds a CachePolicy, a FlushPolicy and a BrowserCachePolicy.
ContentCachingConfiguration() - Constructor for class info.magnolia.module.cache.ContentCachingConfiguration
ContentCachingConfiguration(CacheModule, RepositoryManager) - Constructor for class info.magnolia.module.cache.ContentCachingConfiguration
 
ContentCompression - Class in info.magnolia.module.cache
Content compression voter configuration bean.
ContentCompression() - Constructor for class info.magnolia.module.cache.ContentCompression
 
countFlush(String) - Method in class info.magnolia.module.cache.mbean.CacheMonitor
 
countStart() - Method in class info.magnolia.module.cache.mbean.CacheMonitor
 
createKey(AggregationState, String, String, String, String, String, Map<String, String>, Boolean, SortedMap<String, Serializable>) - Method in class info.magnolia.module.cache.cachekey.DefaultCacheKeyGenerator
 

D

Default - Class in info.magnolia.module.cache.cachepolicy
A basic CachePolicy driven by shouldBypassVoters.
Default() - Constructor for class info.magnolia.module.cache.cachepolicy.Default
Deprecated.
since 5.4. Use Default.Default(CacheModule) instead,
Default(CacheModule) - Constructor for class info.magnolia.module.cache.cachepolicy.Default
 
DEFAULT_CACHE_CONFIG - Static variable in class info.magnolia.module.cache.AbstractCacheModule
 
DEFAULT_CACHE_NAME - Static variable in interface info.magnolia.module.cache.CacheFactory
 
DEFAULT_CONTENT_CACHING_CONFIGURATION_NAME - Static variable in class info.magnolia.module.cache.filter.CacheFilter
 
DEFAULT_THRESHOLD - Static variable in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
DefaultCacheKey - Class in info.magnolia.module.cache.cachekey
Default cache key implementation.
DefaultCacheKey(String, String, String, String, String, Map<String, String>, Boolean, Map<String, Serializable>) - Constructor for class info.magnolia.module.cache.cachekey.DefaultCacheKey
 
DefaultCacheKey - Class in info.magnolia.module.cache
Deprecated.
since 5.4. Use {info.magnolia.module.cache.cachekey.DefaultCacheKey} instead.
DefaultCacheKey(String, String, String, String, Map<String, String>, Boolean) - Constructor for class info.magnolia.module.cache.DefaultCacheKey
Deprecated.
since 5.0.3 use info.magnolia.module.cache.DefaultCacheKey.DefaultCacheKey(String, String, String, String, Map, Boolean)
DefaultCacheKey(String, String, String, String, String, Map<String, String>, Boolean) - Constructor for class info.magnolia.module.cache.DefaultCacheKey
Deprecated.
 
DefaultCacheKeyGenerator - Class in info.magnolia.module.cache.cachekey
Default cache key implementation.
DefaultCacheKeyGenerator() - Constructor for class info.magnolia.module.cache.cachekey.DefaultCacheKeyGenerator
 
DelegateFlushPolicy - Class in info.magnolia.module.cache
Simple policy that delegates all the requests to any policies added in its policies list.
DelegateFlushPolicy() - Constructor for class info.magnolia.module.cache.DelegateFlushPolicy
 
DelegatingBlobCachedEntry - Class in info.magnolia.module.cache.filter
Used for large responses.
DelegatingBlobCachedEntry(long, String, String, int, MultiMap, long, String, int) - Constructor for class info.magnolia.module.cache.filter.DelegatingBlobCachedEntry
 
doExecute(InstallContext) - Method in class info.magnolia.module.cache.setup.ExcludeWorkspacesFromFlushCachePolicy
 
doFilter(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class info.magnolia.module.cache.filter.CacheFilter
 
doFilter(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class info.magnolia.module.cache.filter.CacheHeadersFilter
Deprecated.
 
doFilter(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class info.magnolia.module.cache.filter.GZipFilter
 

E

equals(Object) - Method in class info.magnolia.module.cache.cachekey.DefaultCacheKey
 
EXCLUDED_WORKSPACES - Static variable in class info.magnolia.module.cache.setup.MigrateFlushListeningPolicyTask
 
EXCLUDED_WORKSPACES_CONFIG_PATH - Static variable in class info.magnolia.module.cache.setup.ExcludeWorkspacesFromFlushCachePolicy
 
ExcludeWorkspacesFromFlushCachePolicy - Class in info.magnolia.module.cache.setup
Excludes passed workspaces from cache flush policy.
ExcludeWorkspacesFromFlushCachePolicy(String...) - Constructor for class info.magnolia.module.cache.setup.ExcludeWorkspacesFromFlushCachePolicy
 
execute(Context) - Method in class info.magnolia.module.cache.commands.FlushCachesCommand
 
execute(Context) - Method in class info.magnolia.module.cache.commands.FlushFromCachesByUUIDCommand
 
execute(Context) - Method in class info.magnolia.module.cache.commands.FlushNamedCacheCommand
 
execute(InstallContext) - Method in class info.magnolia.module.cache.RegisterWorkspaceForCacheFlushingTask
Deprecated.
 
execute(InstallContext) - Method in class info.magnolia.module.cache.setup.RemoveCacheTempFilesTask
 

F

FixedDuration - Class in info.magnolia.module.cache.browsercachepolicy
Uses a fix expiration time (in minutes).
FixedDuration() - Constructor for class info.magnolia.module.cache.browsercachepolicy.FixedDuration
 
flush() - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
flushAll() - Method in class info.magnolia.module.cache.mbean.CacheMonitor
 
flushAll() - Method in interface info.magnolia.module.cache.mbean.CacheMonitorMBean
Will flush all entries from all configured caches.
FlushAllListeningPolicy - Class in info.magnolia.module.cache
Simple flush policy that will empty whole cache in case of updates.
FlushAllListeningPolicy() - Constructor for class info.magnolia.module.cache.FlushAllListeningPolicy
FlushAllListeningPolicy(CacheModule, RepositoryManager) - Constructor for class info.magnolia.module.cache.FlushAllListeningPolicy
 
flushBuffer() - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
flushByUUID(String, String, Cache) - Method in class info.magnolia.module.cache.AbstractListeningFlushPolicy
Flushes all content related to given uuid&repository combination from provided cache.
flushByUUID(String, String) - Method in class info.magnolia.module.cache.mbean.CacheMonitor
 
flushByUUID(String, String) - Method in interface info.magnolia.module.cache.mbean.CacheMonitorMBean
Will flush all entries with key bound to given uuid from all configured caches.
FlushCachesCommand - Class in info.magnolia.module.cache.commands
Command to completely flush all available caches.
FlushCachesCommand() - Constructor for class info.magnolia.module.cache.commands.FlushCachesCommand
FlushCachesCommand(CacheFactoryProvider) - Constructor for class info.magnolia.module.cache.commands.FlushCachesCommand
 
FlushFromCachesByUUIDCommand - Class in info.magnolia.module.cache.commands
Command to completely flush all entries related to given uuid from all available caches.
FlushFromCachesByUUIDCommand() - Constructor for class info.magnolia.module.cache.commands.FlushFromCachesByUUIDCommand
FlushFromCachesByUUIDCommand(CacheModule) - Constructor for class info.magnolia.module.cache.commands.FlushFromCachesByUUIDCommand
 
FlushNamedCacheCommand - Class in info.magnolia.module.cache.commands
Command to flush a cache by name.
FlushNamedCacheCommand() - Constructor for class info.magnolia.module.cache.commands.FlushNamedCacheCommand
FlushNamedCacheCommand(CacheFactoryProvider) - Constructor for class info.magnolia.module.cache.commands.FlushNamedCacheCommand
 
FlushPolicy - Interface in info.magnolia.module.cache
Implementations determine when and how to flush their cache.

G

generateKey(AggregationState) - Method in interface info.magnolia.module.cache.cachekey.CacheKeyGenerator
 
generateKey(AggregationState) - Method in class info.magnolia.module.cache.cachekey.DefaultCacheKeyGenerator
 
get(Object) - Method in interface info.magnolia.module.cache.Cache
 
get() - Method in class info.magnolia.module.cache.inject.CacheFactoryProvider
 
get(Object) - Method in class info.magnolia.module.cache.listeners.AbstractCacheListener
 
get(Object) - Method in class info.magnolia.module.cache.listeners.AbstractListeningCacheWrapper
 
getAdditionalAttributes() - Method in class info.magnolia.module.cache.cachekey.DefaultCacheKey
 
getAll() - Method in class info.magnolia.module.cache.mbean.CacheMonitor
 
getAll() - Method in interface info.magnolia.module.cache.mbean.CacheMonitorMBean
 
getBehaviour() - Method in class info.magnolia.module.cache.CachePolicyResult
 
getBlockingTimeout() - Method in interface info.magnolia.module.cache.BlockingCache
If the timeout is reached an exception is thrown to unlock the blocked thread (in milliseconds).
getBrowserCachePolicy() - Method in class info.magnolia.module.cache.ContentCachingConfiguration
 
getBufferedContent() - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
getBypasses() - Method in class info.magnolia.module.cache.mbean.CacheMonitor
 
getBypasses() - Method in interface info.magnolia.module.cache.mbean.CacheMonitorMBean
Gets number of times since the last server restart the caching policy decided to bypass cache and serve request out of repository (i.e.
getCache(String) - Method in interface info.magnolia.module.cache.CacheFactory
Retrieves a named cache.
getCacheConfigurationName() - Method in class info.magnolia.module.cache.filter.CacheFilter
getCachedEntry() - Method in class info.magnolia.module.cache.CachePolicyResult
 
getCachedKeysCount() - Method in class info.magnolia.module.cache.mbean.CacheMonitor
 
getCachedKeysCount() - Method in interface info.magnolia.module.cache.mbean.CacheMonitorMBean
Gets number of entries in all known caches even if those entries have been generated from content with same uuid (e.g.
getCachedUUIDsCount() - Method in class info.magnolia.module.cache.mbean.CacheMonitor
 
getCachedUUIDsCount() - Method in interface info.magnolia.module.cache.mbean.CacheMonitorMBean
Gets number of content uuids that are held in all known caches.
getCacheFactory() - Method in class info.magnolia.module.cache.AbstractCacheModule
 
getCacheFactory() - Method in class info.magnolia.module.cache.CacheModule
Inject CacheFactoryProvider} instead.
getCacheKey() - Method in class info.magnolia.module.cache.CachePolicyResult
 
getCacheKeyGenerator() - Method in class info.magnolia.module.cache.cachepolicy.Default
 
getCacheMonitor() - Method in class info.magnolia.module.cache.AbstractCacheModule
 
getCacheName() - Method in class info.magnolia.module.cache.commands.FlushNamedCacheCommand
 
getCacheName() - Method in class info.magnolia.module.cache.ContentCachingConfiguration
 
getCacheNames() - Method in interface info.magnolia.module.cache.CacheFactory
 
getCachePolicy() - Method in class info.magnolia.module.cache.ContentCachingConfiguration
 
getCachePolicy(Cache) - Method in class info.magnolia.module.cache.executor.Store
 
getChannel() - Method in class info.magnolia.module.cache.cachekey.DefaultCacheKey
 
getCharacterEncoding() - Method in class info.magnolia.module.cache.filter.ContentCachedEntry
 
getCompression() - Method in class info.magnolia.module.cache.CacheModule
 
getConfiguration(String) - Method in class info.magnolia.module.cache.CacheModule
Deprecated.
getContentCaching(String) - Method in class info.magnolia.module.cache.AbstractCacheModule
 
getContentCaching() - Method in class info.magnolia.module.cache.CacheModule
 
getContentCaching(String) - Method in class info.magnolia.module.cache.CacheModule
 
getContentCachingConfiguration() - Method in class info.magnolia.module.cache.executor.AbstractExecutor
 
getContentFile() - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
getContentLength() - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
getContentType() - Method in class info.magnolia.module.cache.filter.ContentCachedEntry
 
getCurrent() - Static method in class info.magnolia.module.cache.CachePolicyResult
Returns the current CachePolicyResult which was set by the CacheFilter.
getCurrentPageCache() - Method in class info.magnolia.module.cache.filter.CacheFilter
 
getDefaultContentCachingConfigurationName() - Method in class info.magnolia.module.cache.filter.CacheFilter
 
getDomain() - Method in class info.magnolia.module.cache.cachekey.DefaultCacheKey
 
getDomainAccesses() - Method in class info.magnolia.module.cache.mbean.CacheMonitor
 
getDomainAccesses() - Method in interface info.magnolia.module.cache.mbean.CacheMonitorMBean
Gets number of times the requests have been served for each configured domain since the last server restart.
getExcludedWorkspaces() - Method in class info.magnolia.module.cache.AbstractListeningFlushPolicy
The workspaces to which the listener is NOT attached.
getExecutor(CachePolicyResult.CachePolicyBehaviour) - Method in class info.magnolia.module.cache.ContentCachingConfiguration
 
getExecutors() - Method in class info.magnolia.module.cache.ContentCachingConfiguration
 
getExecutors() - Method in class info.magnolia.module.cache.executor.CompositeExecutor
 
getExpirationDate() - Method in class info.magnolia.module.cache.BrowserCachePolicyResult
 
getExpirationMinutes() - Method in class info.magnolia.module.cache.browsercachepolicy.FixedDuration
 
getExtraInstallTasks(InstallContext) - Method in class info.magnolia.module.cache.setup.CacheModuleVersionHandler
 
getFlushes() - Method in class info.magnolia.module.cache.mbean.CacheMonitor
 
getFlushes() - Method in interface info.magnolia.module.cache.mbean.CacheMonitorMBean
Gets number of times each configured cache have been flushed since the last server restart.
getFlushPolicy() - Method in class info.magnolia.module.cache.ContentCachingConfiguration
 
getGzippedContent() - Method in class info.magnolia.module.cache.filter.InMemoryCachedEntry
 
getHeaders() - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
getHeaders() - Method in class info.magnolia.module.cache.filter.ContentCachedEntry
 
getHits() - Method in class info.magnolia.module.cache.mbean.CacheMonitor
 
getHits() - Method in interface info.magnolia.module.cache.mbean.CacheMonitorMBean
Gets number of times since the last server restart the cache found and served the entry requested by client.
getIsSecured() - Method in class info.magnolia.module.cache.cachekey.DefaultCacheKey
 
getKeyGenerator() - Method in class info.magnolia.module.cache.cachepolicy.XMagnoliaCacheAttribute
 
getKeys() - Method in interface info.magnolia.module.cache.Cache
 
getLastModificationTime() - Method in class info.magnolia.module.cache.entry.SingleReplayCacheEntryWrapper
 
getLastModificationTime() - Method in interface info.magnolia.module.cache.filter.CachedEntry
Produce last modification date of the cache entry.
getLastModificationTime() - Method in class info.magnolia.module.cache.filter.CachedError
 
getLastModificationTime() - Method in class info.magnolia.module.cache.filter.CachedRedirect
 
getLastModificationTime() - Method in class info.magnolia.module.cache.filter.ContentCachedEntry
 
getLastModified() - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
getListener(String) - Method in class info.magnolia.module.cache.ContentCachingConfiguration
 
getListeners() - Method in class info.magnolia.module.cache.ContentCachingConfiguration
 
getLocale() - Method in class info.magnolia.module.cache.cachekey.DefaultCacheKey
 
getLocation() - Method in class info.magnolia.module.cache.filter.CachedRedirect
 
getMaxAgeInSeconds() - Method in class info.magnolia.module.cache.filter.ResponseExpirationCalculator
Returns the number of seconds the response can be cached where 0 means that the its already expired and must not be cached and -1 means that there's no information on how long it can be cached.
getMethod() - Method in class info.magnolia.module.cache.cachekey.DefaultCacheKey
 
getModule() - Method in class info.magnolia.module.cache.filter.CacheFilter
 
getName() - Method in interface info.magnolia.module.cache.Cache
 
getName() - Method in class info.magnolia.module.cache.CachePolicyResult.CachePolicyBehaviour
 
getName() - Method in class info.magnolia.module.cache.ContentCachingConfiguration
 
getName() - Method in class info.magnolia.module.cache.listeners.AbstractCacheListener
 
getName() - Method in class info.magnolia.module.cache.listeners.AbstractListeningCacheWrapper
 
getOriginalURL() - Method in class info.magnolia.module.cache.entry.SingleReplayCacheEntryWrapper
 
getOriginalURL() - Method in interface info.magnolia.module.cache.filter.CachedEntry
Entry might be required to produce url used to create it in the first place.
getOriginalURL() - Method in class info.magnolia.module.cache.filter.CachedError
 
getOriginalURL() - Method in class info.magnolia.module.cache.filter.CachedRedirect
 
getOriginalURL() - Method in class info.magnolia.module.cache.filter.ContentCachedEntry
 
getOutputStream() - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
getParams() - Method in class info.magnolia.module.cache.cachekey.DefaultCacheKey
 
getPath(Cache) - Method in class info.magnolia.module.cache.AbstractListeningFlushPolicy
 
getPlainContent() - Method in class info.magnolia.module.cache.filter.InMemoryCachedEntry
 
getPolicies() - Method in class info.magnolia.module.cache.browsercachepolicy.BrowserCachePolicySet
 
getPolicies() - Method in class info.magnolia.module.cache.DelegateFlushPolicy
 
getPositiveVoteResult(CachePolicyResult) - Method in class info.magnolia.module.cache.browsercachepolicy.AbstractVoterBased
 
getPositiveVoteResult(CachePolicyResult) - Method in class info.magnolia.module.cache.browsercachepolicy.FixedDuration
 
getPositiveVoteResult(CachePolicyResult) - Method in class info.magnolia.module.cache.browsercachepolicy.Never
 
getPuts() - Method in class info.magnolia.module.cache.mbean.CacheMonitor
 
getPuts() - Method in interface info.magnolia.module.cache.mbean.CacheMonitorMBean
Gets number of times since the last server restart the cached entry for the request didn't exist and was put in the cache.
getQuiet(Object) - Method in interface info.magnolia.module.cache.Cache
 
getQuiet(Object) - Method in class info.magnolia.module.cache.listeners.AbstractCacheListener
 
getQuiet(Object) - Method in class info.magnolia.module.cache.listeners.AbstractListeningCacheWrapper
 
getRedirectionLocation() - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
getRepositories() - Method in class info.magnolia.module.cache.AbstractListeningFlushPolicy
Deprecated.
getServerName() - Method in class info.magnolia.module.cache.cachekey.DefaultCacheKey
 
getShouldBypassVoters() - Method in class info.magnolia.module.cache.cachepolicy.Default
 
getSize() - Method in interface info.magnolia.module.cache.Cache
 
getSize() - Method in class info.magnolia.module.cache.listeners.AbstractListeningCacheWrapper
 
getStartCalls() - Method in class info.magnolia.module.cache.mbean.CacheMonitor
 
getStartCalls() - Method in interface info.magnolia.module.cache.mbean.CacheMonitorMBean
Gets number of times Cache Module was started since the last server restart.
getStartupTasks(InstallContext) - Method in class info.magnolia.module.cache.setup.CacheModuleVersionHandler
 
getStatus() - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
getStatusCode() - Method in class info.magnolia.module.cache.filter.CachedError
 
getStatusCode() - Method in class info.magnolia.module.cache.filter.CachedRedirect
 
getStatusCode() - Method in class info.magnolia.module.cache.filter.ContentCachedEntry
 
getStopCalls() - Method in class info.magnolia.module.cache.mbean.CacheMonitor
 
getStopCalls() - Method in interface info.magnolia.module.cache.mbean.CacheMonitorMBean
Gets number of times Cache Module was stopped since the last server restart.
getThresholdingOutputStream() - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
getTimeToLive(CacheResponseWrapper, Cache) - Method in class info.magnolia.module.cache.executor.Store
 
getTimeToLive(HttpServletRequest, CacheResponseWrapper) - Method in class info.magnolia.module.cache.executor.Store
getTimeToLiveInSeconds() - Method in class info.magnolia.module.cache.entry.SingleReplayCacheEntryWrapper
 
getTimeToLiveInSeconds() - Method in interface info.magnolia.module.cache.filter.CachedEntry
 
getTimeToLiveInSeconds() - Method in class info.magnolia.module.cache.filter.CachedError
 
getTimeToLiveInSeconds() - Method in class info.magnolia.module.cache.filter.CachedRedirect
 
getTimeToLiveInSeconds() - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
Returns the number of seconds the response can be cached, where 0 means that it must not be cached and -1 means that it there is no indication on how long it can be cached for.
getTimeToLiveInSeconds() - Method in class info.magnolia.module.cache.filter.ContentCachedEntry
 
getTtl() - Method in class info.magnolia.module.cache.cachepolicy.XMagnoliaCacheAttribute
 
getTtlVoters() - Method in class info.magnolia.module.cache.cachepolicy.Default
 
getTtlVoters() - Method in interface info.magnolia.module.cache.CachePolicy
 
getTtlVoters() - Method in class info.magnolia.module.cache.cachepolicy.Never
 
getUri() - Method in class info.magnolia.module.cache.cachekey.DefaultCacheKey
 
getUuid() - Method in class info.magnolia.module.cache.commands.FlushFromCachesByUUIDCommand
 
getVoters() - Method in class info.magnolia.module.cache.browsercachepolicy.AbstractVoterBased
 
getVoters() - Method in class info.magnolia.module.cache.cachepolicy.Default
Deprecated.
since 5.4. Use Default.getShouldBypassVoters() instead.
getVoters() - Method in class info.magnolia.module.cache.ContentCompression
 
getWorkspace() - Method in class info.magnolia.module.cache.commands.FlushFromCachesByUUIDCommand
 
getWorkspaces() - Method in class info.magnolia.module.cache.AbstractListeningFlushPolicy
The workspaces to which the listener is attached - upon any event on these, the cache is cleared.
getWriter() - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
gzip(byte[]) - Static method in class info.magnolia.module.cache.util.GZipUtil
 
GZipFilter - Class in info.magnolia.module.cache.filter
This GZipFilter does not take care of the Accept-Encoding request header.
GZipFilter() - Constructor for class info.magnolia.module.cache.filter.GZipFilter
 
GZipUtil - Class in info.magnolia.module.cache.util
Provide useful methods for working with gzip'd byte[].
GZipUtil() - Constructor for class info.magnolia.module.cache.util.GZipUtil
 

H

handleSingleEvent(Cache, String, Event) - Method in class info.magnolia.module.cache.AbstractListeningFlushPolicy
Implement this method to react on each and every event on a given cache and repository, even if multiple where buffered.
handleSingleEvent(Cache, String, Event) - Method in class info.magnolia.module.cache.FlushAllListeningPolicy
 
hasElement(Object) - Method in interface info.magnolia.module.cache.Cache
 
hashCode() - Method in class info.magnolia.module.cache.cachekey.DefaultCacheKey
 
HEADER_CACHE_CONTROL - Static variable in class info.magnolia.cms.cache.CacheConstants
 
HEADER_CACHE_CONTROL_VALUE_DISABLE_CACHE - Static variable in class info.magnolia.cms.cache.CacheConstants
 
HEADER_EXPIRES - Static variable in class info.magnolia.cms.cache.CacheConstants
 
HEADER_PRAGMA - Static variable in class info.magnolia.cms.cache.CacheConstants
 
HEADER_VALUE_MAX_AGE - Static variable in class info.magnolia.cms.cache.CacheConstants
 
HEADER_VALUE_MUST_REVALIDATE - Static variable in class info.magnolia.cms.cache.CacheConstants
 
HEADER_VALUE_NO_CACHE - Static variable in class info.magnolia.cms.cache.CacheConstants
 
HEADER_VALUE_NO_STORE - Static variable in class info.magnolia.cms.cache.CacheConstants
 
HEADER_VALUE_PRIVATE - Static variable in class info.magnolia.cms.cache.CacheConstants
 
HEADER_VALUE_PUBLIC - Static variable in class info.magnolia.cms.cache.CacheConstants
 
HEADER_VALUE_S_MAXAGE - Static variable in class info.magnolia.cms.cache.CacheConstants
 
HEADER_VALUE_TTL - Static variable in class info.magnolia.cms.cache.CacheConstants
 
HEADER_VALUE_X_MAGNOLIA_TTL - Static variable in class info.magnolia.cms.cache.CacheConstants
 
HEADER_X_MAGNOLIA_CACHE - Static variable in class info.magnolia.cms.cache.CacheConstants
 

I

ifModifiedSince(HttpServletRequest, long) - Method in class info.magnolia.module.cache.executor.AbstractExecutor
Checks if server cache is newer than the client cache.
info.magnolia.cms.cache - package info.magnolia.cms.cache
 
info.magnolia.module.cache - package info.magnolia.module.cache
 
info.magnolia.module.cache.browsercachepolicy - package info.magnolia.module.cache.browsercachepolicy
 
info.magnolia.module.cache.cachekey - package info.magnolia.module.cache.cachekey
 
info.magnolia.module.cache.cachepolicy - package info.magnolia.module.cache.cachepolicy
 
info.magnolia.module.cache.cachepolicy.voters - package info.magnolia.module.cache.cachepolicy.voters
 
info.magnolia.module.cache.commands - package info.magnolia.module.cache.commands
 
info.magnolia.module.cache.entry - package info.magnolia.module.cache.entry
 
info.magnolia.module.cache.exception - package info.magnolia.module.cache.exception
 
info.magnolia.module.cache.executor - package info.magnolia.module.cache.executor
 
info.magnolia.module.cache.filter - package info.magnolia.module.cache.filter
 
info.magnolia.module.cache.inject - package info.magnolia.module.cache.inject
 
info.magnolia.module.cache.listeners - package info.magnolia.module.cache.listeners
 
info.magnolia.module.cache.mbean - package info.magnolia.module.cache.mbean
 
info.magnolia.module.cache.setup - package info.magnolia.module.cache.setup
 
info.magnolia.module.cache.util - package info.magnolia.module.cache.util
 
init(FilterConfig) - Method in class info.magnolia.module.cache.filter.CacheFilter
 
InMemoryCachedEntry - Class in info.magnolia.module.cache.filter
Cache entry keeping the content in memory.
InMemoryCachedEntry(byte[], String, String, int, MultiMap, long, String, int) - Constructor for class info.magnolia.module.cache.filter.InMemoryCachedEntry
 
isAcceptsGzip(HttpServletRequest) - Method in class info.magnolia.module.cache.filter.ContentCachedEntry
 
isAcceptsGzip(HttpServletRequest) - Static method in class info.magnolia.module.cache.util.GZipUtil
True if the response should be gzipped.
isEnabled() - Method in class info.magnolia.module.cache.listeners.AbstractCacheListener
 
isError() - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
isGZipMimeType(String) - Static method in class info.magnolia.module.cache.util.GZipUtil
 
isGZipped(byte[]) - Static method in class info.magnolia.module.cache.util.GZipUtil
Checks the first two bytes of the candidate byte array for the magic number 0x677a.
isRefreshOnNoCacheRequests() - Method in class info.magnolia.module.cache.cachepolicy.Default
 
isThresholdExceeded() - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
isUseLocale() - Method in class info.magnolia.module.cache.cachekey.DefaultCacheKeyGenerator
 
isUseRequestGetSecure() - Method in class info.magnolia.module.cache.cachekey.DefaultCacheKeyGenerator
 
isUseRequestMethod() - Method in class info.magnolia.module.cache.cachekey.DefaultCacheKeyGenerator
 
isUseRequestParameters() - Method in class info.magnolia.module.cache.cachekey.DefaultCacheKeyGenerator
 
isUseRequestServerName() - Method in class info.magnolia.module.cache.cachekey.DefaultCacheKeyGenerator
 
isUseRequestUri() - Method in class info.magnolia.module.cache.cachekey.DefaultCacheKeyGenerator
 
isUseUserName() - Method in class info.magnolia.module.cache.cachekey.DefaultCacheKeyGenerator
 

L

logAccess(Object) - Method in class info.magnolia.module.cache.mbean.CacheMonitor
 
logBehavior(String) - Method in class info.magnolia.module.cache.mbean.CacheMonitor
 

M

makeCachedEntry(HttpServletRequest, CacheResponseWrapper, Cache, CachePolicyResult) - Method in class info.magnolia.module.cache.executor.Store
 
MgnlLockTimeoutException - Exception in info.magnolia.module.cache.exception
Indicates that a timeout has occured while attempting to obtain a lock.
MgnlLockTimeoutException(String) - Constructor for exception info.magnolia.module.cache.exception.MgnlLockTimeoutException
 
MgnlLockTimeoutException(Throwable) - Constructor for exception info.magnolia.module.cache.exception.MgnlLockTimeoutException
 
MgnlLockTimeoutException(String, Throwable) - Constructor for exception info.magnolia.module.cache.exception.MgnlLockTimeoutException
 
MigrateFlushListeningPolicyTask - Class in info.magnolia.module.cache.setup
Migrates configuration of FlushAllListeningPolicy.
MigrateFlushListeningPolicyTask(String, Class<? extends AbstractListeningFlushPolicy>) - Constructor for class info.magnolia.module.cache.setup.MigrateFlushListeningPolicyTask
 

N

NAME - Static variable in class info.magnolia.module.cache.cachepolicy.XMagnoliaCacheAttribute
 
Never - Class in info.magnolia.module.cache.browsercachepolicy
The pages are sent by using no cache headers.
Never() - Constructor for class info.magnolia.module.cache.browsercachepolicy.Never
 
Never - Class in info.magnolia.module.cache.cachepolicy
Cache policy instructing cache not to store the generated content.
Never() - Constructor for class info.magnolia.module.cache.cachepolicy.Never
 
NO_CACHE - Static variable in class info.magnolia.module.cache.BrowserCachePolicyResult
 
nodeMatches(Node) - Method in class info.magnolia.module.cache.setup.MigrateFlushListeningPolicyTask
 

O

OBSOLETE_COMPRESSIBLE_CONFIGURATION_PATH - Static variable in class info.magnolia.module.cache.setup.CacheModuleVersionHandler
 
OBSOLETE_DEFAULT_CONFIGURATION_PATH - Static variable in class info.magnolia.module.cache.setup.CacheModuleVersionHandler
 
onCacheModuleStart() - Method in interface info.magnolia.module.cache.CacheModuleLifecycleListener
 
onCacheModuleStart() - Method in class info.magnolia.module.cache.filter.CacheFilter
 
onEvent(EventIterator) - Method in class info.magnolia.module.cache.AbstractListeningFlushPolicy.CacheCleaner
 
operateOnNode(InstallContext, Node) - Method in class info.magnolia.module.cache.setup.MigrateFlushListeningPolicyTask
 

P

persistCacheKey(String, String, Object) - Method in class info.magnolia.module.cache.cachepolicy.Default
 
persistCacheKey(String, String, Object) - Method in class info.magnolia.module.cache.cachepolicy.Never
 
persistCacheKey(String, String, Object) - Method in interface info.magnolia.module.cache.CachePolicy
Persists mapping between uuid and cache key in case the given cache policy implementation cares about such details.
postHandleEvents(Cache, String) - Method in class info.magnolia.module.cache.AbstractListeningFlushPolicy
Implement this method to wrap up flushing process after all single events have been processed.
postHandleEvents(Cache, String) - Method in class info.magnolia.module.cache.FlushAllListeningPolicy
 
preHandleEvents(Cache, String) - Method in class info.magnolia.module.cache.AbstractListeningFlushPolicy
Implement this method to react on buffered events on a given cache and repository.
preHandleEvents(Cache, String) - Method in class info.magnolia.module.cache.FlushAllListeningPolicy
 
processCachedEntry(CachedEntry, HttpServletRequest, HttpServletResponse, FilterChain) - Method in class info.magnolia.module.cache.executor.UseCache
 
processCacheRequest(HttpServletRequest, HttpServletResponse, FilterChain, Cache, CachePolicyResult) - Method in interface info.magnolia.module.cache.CachePolicyExecutor
 
processCacheRequest(HttpServletRequest, HttpServletResponse, FilterChain, Cache, CachePolicyResult) - Method in class info.magnolia.module.cache.executor.Bypass
 
processCacheRequest(HttpServletRequest, HttpServletResponse, FilterChain, Cache, CachePolicyResult) - Method in class info.magnolia.module.cache.executor.CompositeExecutor
 
processCacheRequest(HttpServletRequest, HttpServletResponse, FilterChain, Cache, CachePolicyResult) - Method in class info.magnolia.module.cache.executor.SetExpirationHeaders
 
processCacheRequest(HttpServletRequest, HttpServletResponse, FilterChain, Cache, CachePolicyResult) - Method in class info.magnolia.module.cache.executor.Store
 
processCacheRequest(HttpServletRequest, HttpServletResponse, FilterChain, Cache, CachePolicyResult) - Method in class info.magnolia.module.cache.executor.UseCache
 
put(Object, Object) - Method in interface info.magnolia.module.cache.Cache
 
put(Object, Object, int) - Method in interface info.magnolia.module.cache.Cache
 
put(Object, Object) - Method in class info.magnolia.module.cache.listeners.AbstractCacheListener
 
put(Object, Object, int) - Method in class info.magnolia.module.cache.listeners.AbstractCacheListener
 
put(Object, Object) - Method in class info.magnolia.module.cache.listeners.AbstractListeningCacheWrapper
 
put(Object, Object, int) - Method in class info.magnolia.module.cache.listeners.AbstractListeningCacheWrapper
 

R

register(CacheModuleLifecycleListener) - Method in class info.magnolia.module.cache.CacheModule
 
RegisterWorkspaceForCacheFlushingTask - Class in info.magnolia.module.cache
Deprecated.
since 5.4. All workspaces are registered by default.
RegisterWorkspaceForCacheFlushingTask(String) - Constructor for class info.magnolia.module.cache.RegisterWorkspaceForCacheFlushingTask
Deprecated.
 
remove(Object) - Method in interface info.magnolia.module.cache.Cache
 
remove(Object) - Method in class info.magnolia.module.cache.listeners.AbstractCacheListener
 
remove(Object) - Method in class info.magnolia.module.cache.listeners.AbstractListeningCacheWrapper
 
removeCacheKeys(String, String) - Method in class info.magnolia.module.cache.cachepolicy.Default
 
removeCacheKeys(String, String) - Method in class info.magnolia.module.cache.cachepolicy.Never
 
removeCacheKeys(String, String) - Method in interface info.magnolia.module.cache.CachePolicy
Returns cache keys for the given item or null if such keys can't be obtained or policy doesn't want to share it.
RemoveCacheTempFilesTask - Class in info.magnolia.module.cache.setup
This task removes all cache temp files from the temp directory.
RemoveCacheTempFilesTask() - Constructor for class info.magnolia.module.cache.setup.RemoveCacheTempFilesTask
 
replay(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class info.magnolia.module.cache.entry.SingleReplayCacheEntryWrapper
 
replay(HttpServletRequest, HttpServletResponse, FilterChain) - Method in interface info.magnolia.module.cache.filter.CachedEntry
 
replay(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class info.magnolia.module.cache.filter.CachedError
 
replay(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class info.magnolia.module.cache.filter.CachedRedirect
 
replay(HttpServletResponse) - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
replay(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class info.magnolia.module.cache.filter.ContentCachedEntry
 
replay(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class info.magnolia.module.cache.filter.DelegatingBlobCachedEntry
 
replayContent(HttpServletResponse, boolean) - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
replayHeadersAndStatus(HttpServletResponse) - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
REPOSITORIES - Static variable in class info.magnolia.module.cache.setup.MigrateFlushListeningPolicyTask
 
reset() - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
resetBuffer() - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
ResponseExpirationCalculator - Class in info.magnolia.module.cache.filter
Calculates how long a shared cache may hold a response based on its response headers.
ResponseExpirationCalculator() - Constructor for class info.magnolia.module.cache.filter.ResponseExpirationCalculator
 
retrieveCacheKey(AggregationState) - Method in class info.magnolia.module.cache.cachepolicy.Default
 
retrieveCacheKey(AggregationState) - Method in class info.magnolia.module.cache.cachepolicy.Never
 
retrieveCacheKey(AggregationState) - Method in interface info.magnolia.module.cache.CachePolicy
Returns cache key for the given item or null if such key can't be obtained or policy doesn't want to share it.
retrieveCacheKeys(String, String) - Method in class info.magnolia.module.cache.cachepolicy.Default
 
retrieveCacheKeys(String, String) - Method in class info.magnolia.module.cache.cachepolicy.Never
 
retrieveCacheKeys(String, String) - Method in interface info.magnolia.module.cache.CachePolicy
Returns cache keys for the given item or null if such keys can't be obtained or policy doesn't want to share it.

S

sendError(int, String) - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
sendError(int) - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
sendRedirect(String) - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
ServerTtlVoter - Class in info.magnolia.module.cache.cachepolicy.voters
Returns TTL according to XMagnoliaCacheAttribute.getTtl() if not null.
ServerTtlVoter() - Constructor for class info.magnolia.module.cache.cachepolicy.voters.ServerTtlVoter
 
setBrowserCachePolicy(BrowserCachePolicy) - Method in class info.magnolia.module.cache.ContentCachingConfiguration
 
setCacheConfiguration(CacheConfiguration) - Method in interface info.magnolia.module.cache.CachePolicyExecutor
setCacheConfiguration(CacheConfiguration) - Method in class info.magnolia.module.cache.executor.AbstractExecutor
Deprecated.
setCacheConfiguration(CacheConfiguration) - Method in class info.magnolia.module.cache.executor.CompositeExecutor
Deprecated.
setCacheConfigurationName(String) - Method in class info.magnolia.module.cache.filter.CacheFilter
setCachedEntry(Object) - Method in class info.magnolia.module.cache.CachePolicyResult
 
setCacheFactory(CacheFactory) - Method in class info.magnolia.module.cache.CacheModule
 
setCacheKeyGenerator(CacheKeyGenerator<?>) - Method in class info.magnolia.module.cache.cachepolicy.Default
 
setCacheName(String) - Method in class info.magnolia.module.cache.commands.FlushNamedCacheCommand
 
setCacheName(String) - Method in class info.magnolia.module.cache.ContentCachingConfiguration
 
setCachePolicy(CachePolicy) - Method in class info.magnolia.module.cache.ContentCachingConfiguration
 
setCompression(ContentCompression) - Method in class info.magnolia.module.cache.CacheModule
 
setContentCaching(Map<String, ContentCachingConfiguration>) - Method in class info.magnolia.module.cache.CacheModule
 
setContentCachingConfiguration(ContentCachingConfiguration) - Method in interface info.magnolia.module.cache.CachePolicyExecutor
 
setContentCachingConfiguration(ContentCachingConfiguration) - Method in class info.magnolia.module.cache.executor.AbstractExecutor
 
setContentCachingConfiguration(ContentCachingConfiguration) - Method in class info.magnolia.module.cache.executor.CompositeExecutor
 
setContentLength(int) - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
setCurrent(CachePolicyResult) - Static method in class info.magnolia.module.cache.CachePolicyResult
Saves the result in the context and makes it available by CachePolicyResult.getCurrent().
setDateHeader(String, long) - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
setDefaultContentCachingConfigurationName(String) - Method in class info.magnolia.module.cache.filter.CacheFilter
 
setEnabled(boolean) - Method in class info.magnolia.module.cache.listeners.AbstractCacheListener
 
setExcludedWorkspaces(List<String>) - Method in class info.magnolia.module.cache.AbstractListeningFlushPolicy
 
setExecutors(Map<String, CachePolicyExecutor>) - Method in class info.magnolia.module.cache.ContentCachingConfiguration
 
setExecutors(CachePolicyExecutor[]) - Method in class info.magnolia.module.cache.executor.CompositeExecutor
 
SetExpirationHeaders - Class in info.magnolia.module.cache.executor
Executor for setting expiration headers to response.
SetExpirationHeaders() - Constructor for class info.magnolia.module.cache.executor.SetExpirationHeaders
 
setExpirationMinutes(int) - Method in class info.magnolia.module.cache.browsercachepolicy.FixedDuration
 
setExpirationMinutes(long) - Method in class info.magnolia.module.cache.filter.CacheHeadersFilter
Deprecated.
Sets the expirationMinutes.
setFlushPolicy(FlushPolicy) - Method in class info.magnolia.module.cache.ContentCachingConfiguration
 
setHeader(String, String) - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
setIntHeader(String, int) - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
setListeners(List<AbstractCacheListener>) - Method in class info.magnolia.module.cache.ContentCachingConfiguration
 
setName(String) - Method in class info.magnolia.module.cache.ContentCachingConfiguration
 
setName(String) - Method in class info.magnolia.module.cache.listeners.AbstractCacheListener
 
setNocache(boolean) - Method in class info.magnolia.module.cache.filter.CacheHeadersFilter
Deprecated.
Sets the nocache.
setPolicies(Collection<BrowserCachePolicy>) - Method in class info.magnolia.module.cache.browsercachepolicy.BrowserCachePolicySet
 
setPolicies(List<FlushPolicy>) - Method in class info.magnolia.module.cache.DelegateFlushPolicy
 
setRefreshOnNoCacheRequests(boolean) - Method in class info.magnolia.module.cache.cachepolicy.Default
 
setRepositories(List<String>) - Method in class info.magnolia.module.cache.AbstractListeningFlushPolicy
Deprecated.
setResponseExpirationDetectionEnabled() - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
Enables expiration detection, response headers are then intercepted and suppressed from the response and used internally to calculate when the response expires (its time to live value).
setShouldBypassVoters(VoterSet) - Method in class info.magnolia.module.cache.cachepolicy.Default
 
setStatus(int) - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
setStatus(int, String) - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
setTtlVoters(VoterSet<CacheResponseWrapper>) - Method in class info.magnolia.module.cache.cachepolicy.Default
 
setUseLocale(boolean) - Method in class info.magnolia.module.cache.cachekey.DefaultCacheKeyGenerator
 
setUseRequestGetSecure(boolean) - Method in class info.magnolia.module.cache.cachekey.DefaultCacheKeyGenerator
 
setUseRequestMethod(boolean) - Method in class info.magnolia.module.cache.cachekey.DefaultCacheKeyGenerator
 
setUseRequestParameters(boolean) - Method in class info.magnolia.module.cache.cachekey.DefaultCacheKeyGenerator
 
setUseRequestServerName(boolean) - Method in class info.magnolia.module.cache.cachekey.DefaultCacheKeyGenerator
 
setUseRequestUri(boolean) - Method in class info.magnolia.module.cache.cachekey.DefaultCacheKeyGenerator
 
setUseUserName(boolean) - Method in class info.magnolia.module.cache.cachekey.DefaultCacheKeyGenerator
 
setUuid(String) - Method in class info.magnolia.module.cache.commands.FlushFromCachesByUUIDCommand
 
setVoters(VoterSet) - Method in class info.magnolia.module.cache.browsercachepolicy.AbstractVoterBased
 
setVoters(VoterSet) - Method in class info.magnolia.module.cache.cachepolicy.Default
setVoters(VoterSet) - Method in class info.magnolia.module.cache.ContentCompression
 
setWorkspace(String) - Method in class info.magnolia.module.cache.commands.FlushFromCachesByUUIDCommand
 
setWorkspaces(List<String>) - Method in class info.magnolia.module.cache.AbstractListeningFlushPolicy
 
shouldBypass(AggregationState, Object) - Method in class info.magnolia.module.cache.cachepolicy.Default
 
shouldCache(Cache, AggregationState, FlushPolicy) - Method in class info.magnolia.module.cache.cachepolicy.Default
 
shouldCache(Cache, AggregationState, FlushPolicy) - Method in class info.magnolia.module.cache.cachepolicy.Never
 
shouldCache(Cache, AggregationState, FlushPolicy) - Method in interface info.magnolia.module.cache.CachePolicy
Implementations can chose whether to cache or not - but note that the aggregationState might not be completely populated.
shouldRefresh(AggregationState, Object) - Method in class info.magnolia.module.cache.cachepolicy.Default
Checks whether requested content should be served from cache or refreshed instead.
SimpleServletOutputStream - Class in info.magnolia.module.cache.filter
Servlet output stream implementation.
SimpleServletOutputStream(OutputStream) - Constructor for class info.magnolia.module.cache.filter.SimpleServletOutputStream
 
SingleReplayCacheEntryWrapper - Class in info.magnolia.module.cache.entry
An implementation of CachedEntry which simply delegates once and only once to the "super" cachedEntry, for the sake of calling replay() after the entry was added.
SingleReplayCacheEntryWrapper(CachedEntry) - Constructor for class info.magnolia.module.cache.entry.SingleReplayCacheEntryWrapper
 
StandaloneGZipFilter - Class in info.magnolia.module.cache.filter
This subclass of GZipFilter is meant to be used when no CacheFilter is present: it checks if the client accepts gzip'd responses.
StandaloneGZipFilter() - Constructor for class info.magnolia.module.cache.filter.StandaloneGZipFilter
 
start(Cache) - Method in class info.magnolia.module.cache.AbstractListeningFlushPolicy
 
start(boolean) - Method in interface info.magnolia.module.cache.CacheFactory
 
start(ModuleLifecycleContext) - Method in class info.magnolia.module.cache.CacheModule
 
start(Cache) - Method in class info.magnolia.module.cache.DelegateFlushPolicy
 
start(Cache) - Method in interface info.magnolia.module.cache.FlushPolicy
 
startCache(String) - Method in class info.magnolia.module.cache.AbstractCacheModule
 
stop(Cache) - Method in class info.magnolia.module.cache.AbstractListeningFlushPolicy
 
stop(boolean) - Method in interface info.magnolia.module.cache.CacheFactory
 
stop(ModuleLifecycleContext) - Method in class info.magnolia.module.cache.CacheModule
 
stop(Cache) - Method in class info.magnolia.module.cache.DelegateFlushPolicy
 
stop(Cache) - Method in interface info.magnolia.module.cache.FlushPolicy
 
stop() - Method in class info.magnolia.module.cache.mbean.CacheMonitor
 
stopCache(String) - Method in class info.magnolia.module.cache.AbstractCacheModule
 
store - Static variable in class info.magnolia.module.cache.CachePolicyResult
 
Store - Class in info.magnolia.module.cache.executor
Wraps the response and stores the content in a cache Entry.
Store() - Constructor for class info.magnolia.module.cache.executor.Store
Deprecated.
since 5.2.3. Use Store.Store(CacheModule) instead.
Store(CacheModule) - Constructor for class info.magnolia.module.cache.executor.Store
 

T

thresholdReached(OutputStream) - Method in class info.magnolia.module.cache.filter.CacheResponseWrapper
 
toString() - Method in class info.magnolia.module.cache.cachekey.DefaultCacheKey
 
toString() - Method in class info.magnolia.module.cache.CachePolicyResult.CachePolicyBehaviour
 
toString() - Method in class info.magnolia.module.cache.CachePolicyResult
 
toString() - Method in class info.magnolia.module.cache.filter.ContentCachedEntry
 
TtlVoting - Class in info.magnolia.module.cache.cachepolicy.voters
The lowest TTL wins.
TtlVoting() - Constructor for class info.magnolia.module.cache.cachepolicy.voters.TtlVoting
 

U

UncacheableEntry - Class in info.magnolia.module.cache.filter
An implementation of CachedEntry which simply indicates the cache should be bypassed.
UncacheableEntry(CachedEntry) - Constructor for class info.magnolia.module.cache.filter.UncacheableEntry
 
ungzip(byte[]) - Static method in class info.magnolia.module.cache.util.GZipUtil
 
unlock(Object) - Method in interface info.magnolia.module.cache.BlockingCache
Will unlock the key.
useCache - Static variable in class info.magnolia.module.cache.CachePolicyResult
 
UseCache - Class in info.magnolia.module.cache.executor
Serves the content from the cache.
UseCache() - Constructor for class info.magnolia.module.cache.executor.UseCache
 
UUID - Static variable in class info.magnolia.module.cache.commands.FlushFromCachesByUUIDCommand
 
UUID_KEY_MAP_KEY - Static variable in class info.magnolia.module.cache.cachepolicy.Default
 

V

vote(CacheResponseWrapper) - Method in class info.magnolia.module.cache.cachepolicy.voters.BrowserTtlVoter
 
vote(CacheResponseWrapper) - Method in class info.magnolia.module.cache.cachepolicy.voters.ServerTtlVoter
 
vote(Voter<CacheResponseWrapper>[], CacheResponseWrapper) - Method in class info.magnolia.module.cache.cachepolicy.voters.TtlVoting
 

W

WORKSPACE - Static variable in class info.magnolia.module.cache.commands.FlushFromCachesByUUIDCommand
 
write(int) - Method in class info.magnolia.module.cache.filter.SimpleServletOutputStream
 
write(byte[]) - Method in class info.magnolia.module.cache.filter.SimpleServletOutputStream
 
write(byte[], int, int) - Method in class info.magnolia.module.cache.filter.SimpleServletOutputStream
 
writeContent(HttpServletRequest, HttpServletResponse, FilterChain, boolean) - Method in class info.magnolia.module.cache.filter.ContentCachedEntry
 
writeContent(HttpServletRequest, HttpServletResponse, FilterChain, boolean) - Method in class info.magnolia.module.cache.filter.DelegatingBlobCachedEntry
 
writeContent(HttpServletRequest, HttpServletResponse, FilterChain, boolean) - Method in class info.magnolia.module.cache.filter.InMemoryCachedEntry
 

X

XMagnoliaCacheAttribute - Class in info.magnolia.module.cache.cachepolicy
Request attribute with additional cache informations retrieved from CacheConstants.HEADER_X_MAGNOLIA_CACHE.
XMagnoliaCacheAttribute(HttpServletRequest) - Constructor for class info.magnolia.module.cache.cachepolicy.XMagnoliaCacheAttribute
 
A B C D E F G H I L M N O P R S T U V W X 

Copyright © 2015 Magnolia International Ltd.. All rights reserved.