com.adaptris.core.services.cache.translators

Class StaticCacheValueTranslator

java.lang.Object

com.adaptris.core.services.cache.translators.StaticCacheValueTranslator

All Implemented Interfaces:

CacheKeyTranslator, CacheValueTranslator<java.lang.String>

public class StaticCacheValueTranslator
extends java.lang.Object
implements CacheValueTranslator<java.lang.String>, CacheKeyTranslator

Implementation of CacheValueTranslator that could be useful for resolving the key when checking or retrieving from a cache.

In the adapter configuration file this class is aliased as static-cache-value-translator which is the preferred alternative to the fully qualified classname when building your configuration.

Constructor Summary

Constructors

Constructor and Description
StaticCacheValueTranslator()
StaticCacheValueTranslator(java.lang.String s)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getKeyFromMessage(AdaptrisMessage msg)
java.lang.String	getValue()
java.lang.String	getValueFromMessage(AdaptrisMessage msg) Retrieves a value from a message
void	setValue(java.lang.String s) Sets the static value.
StaticCacheValueTranslator	withValue(java.lang.String s)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.core.services.cache.CacheValueTranslator

addValueToMessage

Constructor Detail

StaticCacheValueTranslator

public StaticCacheValueTranslator()

StaticCacheValueTranslator

public StaticCacheValueTranslator(java.lang.String s)

Method Detail

getValueFromMessage

public java.lang.String getValueFromMessage(AdaptrisMessage msg)
                                     throws CoreException

Description copied from interface: CacheValueTranslator

Retrieves a value from a message

Specified by:

getValueFromMessage in interface CacheValueTranslator<java.lang.String>

Returns:

the configured value in setValue(String)

Throws:

CoreException

setValue

public void setValue(java.lang.String s)

Sets the static value.

Parameters:

s - the value, which supports the %message{} syntax to resolve metadata.

getValue

public java.lang.String getValue()

withValue

public StaticCacheValueTranslator withValue(java.lang.String s)

getKeyFromMessage

public java.lang.String getKeyFromMessage(AdaptrisMessage msg)
                                   throws CoreException

Specified by:

getKeyFromMessage in interface CacheKeyTranslator

Throws:

CoreException