info.magnolia.module.cache.cachekey

Class DefaultCacheKeyGenerator

java.lang.Object

info.magnolia.module.cache.cachekey.DefaultCacheKeyGenerator

All Implemented Interfaces:

CacheKeyGenerator<DefaultCacheKey>

public class DefaultCacheKeyGenerator
extends Object
implements CacheKeyGenerator<DefaultCacheKey>

Default cache key implementation. Key is based on the URI, server name, parameters and request headers. Since the server name is likely to change from server to server, copying cached items around will most likely not help to avoid generating cache entries.

Constructor Summary

Constructors

Constructor and Description
DefaultCacheKeyGenerator()

Method Summary

Modifier and Type	Method and Description
protected DefaultCacheKey	createKey(info.magnolia.cms.core.AggregationState aggregationState, String uri, String serverName, String locale, String channel, String method, Map<String,String> params, Boolean isSecure, SortedMap<String,Serializable> additionalAttributes)
DefaultCacheKey	generateKey(info.magnolia.cms.core.AggregationState aggregationState)
boolean	isUseLocale()
boolean	isUseRequestGetSecure()
boolean	isUseRequestMethod()
boolean	isUseRequestParameters()
boolean	isUseRequestServerName()
boolean	isUseRequestUri()
boolean	isUseUserName()
void	setUseLocale(boolean useLocale)
void	setUseRequestGetSecure(boolean useRequestGetSecure)
void	setUseRequestMethod(boolean useRequestMethod)
void	setUseRequestParameters(boolean useRequestParameters)
void	setUseRequestServerName(boolean useRequestServerName)
void	setUseRequestUri(boolean useRequestUri)
void	setUseUserName(boolean useUserName)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCacheKeyGenerator

public DefaultCacheKeyGenerator()

Method Detail

generateKey

public DefaultCacheKey generateKey(info.magnolia.cms.core.AggregationState aggregationState)

Specified by:

generateKey in interface CacheKeyGenerator<DefaultCacheKey>

createKey

protected DefaultCacheKey createKey(info.magnolia.cms.core.AggregationState aggregationState,
                                    String uri,
                                    String serverName,
                                    String locale,
                                    String channel,
                                    String method,
                                    Map<String,String> params,
                                    Boolean isSecure,
                                    SortedMap<String,Serializable> additionalAttributes)

isUseLocale

public boolean isUseLocale()

setUseLocale

public void setUseLocale(boolean useLocale)

isUseRequestMethod

public boolean isUseRequestMethod()

setUseRequestMethod

public void setUseRequestMethod(boolean useRequestMethod)

isUseRequestParameters

public boolean isUseRequestParameters()

setUseRequestParameters

public void setUseRequestParameters(boolean useRequestParameters)

isUseRequestUri

public boolean isUseRequestUri()

setUseRequestUri

public void setUseRequestUri(boolean useRequestUri)

isUseRequestGetSecure

public boolean isUseRequestGetSecure()

setUseRequestGetSecure

public void setUseRequestGetSecure(boolean useRequestGetSecure)

isUseRequestServerName

public boolean isUseRequestServerName()

setUseRequestServerName

public void setUseRequestServerName(boolean useRequestServerName)

isUseUserName

public boolean isUseUserName()

setUseUserName

public void setUseUserName(boolean useUserName)