com.atlassian.vcache.internal.core

Class ExternalCacheKeyGenerator

java.lang.Object

com.atlassian.vcache.internal.core.ExternalCacheKeyGenerator

Direct Known Subclasses:

PlainExternalCacheKeyGenerator, Sha1ExternalCacheKeyGenerator

public abstract class ExternalCacheKeyGenerator
extends Object

Represents the ability to generate the keys used with an external cache.

Constructor Summary

Constructors

Constructor and Description
ExternalCacheKeyGenerator(String productIdentifier)

Method Summary

Modifier and Type	Method and Description
String	cacheVersionKey(String partition, String cacheName) Generates the key used to hold the cache version number.
protected abstract String	encode(String plain) Responsible for encoding the plain key using the appropriate algorithm.
String	entryKey(String partition, String cacheName, long cacheVersion, String entryKey) Generates the key for an individual entry.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalCacheKeyGenerator

public ExternalCacheKeyGenerator(String productIdentifier)

Method Detail

entryKey

@Nonnull
public String entryKey(String partition,
                                String cacheName,
                                long cacheVersion,
                                String entryKey)

Generates the key for an individual entry.

cacheVersionKey

@Nonnull
public String cacheVersionKey(String partition,
                                       String cacheName)

Generates the key used to hold the cache version number.

encode

@Nonnull
protected abstract String encode(String plain)

Responsible for encoding the plain key using the appropriate algorithm.

Parameters:

plain - the plain key to be encoded

Returns:

the key encoded