com.adobe.acs.commons.httpcache.config.impl.keys

Class ResourcePathCacheKey

java.lang.Object

com.adobe.acs.commons.httpcache.keys.AbstractCacheKey

com.adobe.acs.commons.httpcache.config.impl.keys.ResourcePathCacheKey

All Implemented Interfaces:

CacheKey, Serializable

public class ResourcePathCacheKey
extends AbstractCacheKey
implements CacheKey, Serializable

Cachekey that differentiates based on:

Resource path

Authentication requirement

See Also:

Serialized Form

Field Summary

Fields inherited from class com.adobe.acs.commons.httpcache.keys.AbstractCacheKey

authenticationRequirement, customExpiryTime, expiryForAccessTime, expiryForUpdateTime, hierarchyResourcePath, resourcePath, uri

Constructor Summary

Constructors

Constructor and Description
ResourcePathCacheKey(org.apache.sling.api.SlingHttpServletRequest request, HttpCacheConfig cacheConfig)
ResourcePathCacheKey(String uri, HttpCacheConfig cacheConfig)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) The equals method used to match up request-derived cache keys with keys in the httpcache.
String	getUri() Get URI.
int	hashCode() The hashCode for the cache key.
String	toString() The useful string representation of this cache key.

Methods inherited from class com.adobe.acs.commons.httpcache.keys.AbstractCacheKey

getAuthenticationRequirement, getExpiryForAccess, getExpiryForCreation, getExpiryForUpdate, getHierarchyResourcePath, getResourcePath, isInvalidatedBy, makeHierarchyResourcePath, parentReadObject, parentWriteObject

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.adobe.acs.commons.httpcache.keys.CacheKey

getExpiryForAccess, getExpiryForCreation, getExpiryForUpdate, getHierarchyResourcePath, isInvalidatedBy

Constructor Detail

ResourcePathCacheKey

public ResourcePathCacheKey(org.apache.sling.api.SlingHttpServletRequest request,
                            HttpCacheConfig cacheConfig)

ResourcePathCacheKey

public ResourcePathCacheKey(String uri,
                            HttpCacheConfig cacheConfig)

Method Detail

equals

public boolean equals(Object o)

Description copied from interface: CacheKey

The equals method used to match up request-derived cache keys with keys in the httpcache.

Specified by:

equals in interface CacheKey

Overrides:

equals in class AbstractCacheKey

Parameters:

o - the object to evaluate this against.

Returns:

true if the objects represent the same cache item, false otherwise.

hashCode

public int hashCode()

Description copied from interface: CacheKey

The hashCode for the cache key.

Specified by:

hashCode in interface CacheKey

Overrides:

hashCode in class AbstractCacheKey

Returns:

the hash code.

toString

public String toString()

Description copied from interface: CacheKey

The useful string representation of this cache key. This should be generally unique as it drives display in the mbean.

Specified by:

toString in interface CacheKey

Overrides:

toString in class Object

Returns:

the string representing the cache key for human consumption.

getUri

public String getUri()

Description copied from interface: CacheKey

Get URI.

Specified by:

getUri in interface CacheKey

Overrides:

getUri in class AbstractCacheKey

Returns:

the universal resource id. This can be a RequestURI or a Resource path based on the context of the key.