com.adobe.acs.commons.httpcache.keys

Interface CacheKeyFactory

public interface CacheKeyFactory

CacheKeyFactory is a OSGi Service interface that allows for consumers to generate their own CacheKey's based on their out use-cases. This project will provide a GroupBased CacheKey factory.

Method Summary

Modifier and Type	Method and Description
CacheKey	build(org.apache.sling.api.SlingHttpServletRequest request, HttpCacheConfig cacheConfig) Build a cache key.
CacheKey	build(String resourcePath, HttpCacheConfig cacheConfig) Build a cache key.
boolean	doesKeyMatchConfig(CacheKey key, HttpCacheConfig cacheConfig) Does the Cache Key matches the Http Cache Config.

Method Detail

build

CacheKey build(org.apache.sling.api.SlingHttpServletRequest request,
               HttpCacheConfig cacheConfig)
        throws HttpCacheKeyCreationException

Build a cache key.

Parameters:

request -

cacheConfig -

Returns:

Throws:

HttpCacheKeyCreationException

build

CacheKey build(String resourcePath,
               HttpCacheConfig cacheConfig)
        throws HttpCacheKeyCreationException

Build a cache key.

Parameters:

resourcePath -

cacheConfig -

Returns:

Throws:

HttpCacheKeyCreationException

doesKeyMatchConfig

boolean doesKeyMatchConfig(CacheKey key,
                           HttpCacheConfig cacheConfig)
                    throws HttpCacheKeyCreationException

Does the Cache Key matches the Http Cache Config.

Parameters:

key -

cacheConfig -

Returns:

True if key and config match.

Throws:

HttpCacheKeyCreationException