com.adaptris.core.services.cache.translators

Class ObjectMetadataCacheValueTranslator

java.lang.Object

com.adaptris.core.services.cache.translators.ObjectMetadataCacheValueTranslator

All Implemented Interfaces:

CacheValueTranslator<java.lang.Object>

public class ObjectMetadataCacheValueTranslator
extends java.lang.Object
implements CacheValueTranslator<java.lang.Object>

Implementation of CacheValueTranslator that retrieves and sets the arbitrary object metadata of a message.

This can only be used with caches that allow insertion of non-Serializable objects as the objects are not guaranteed to be serializable. This is considered a generic replacement for JmsReplyToCacheValueTranslator which already uses object metadata.

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

Constructor Summary

Constructors

Constructor and Description
ObjectMetadataCacheValueTranslator()
ObjectMetadataCacheValueTranslator(java.lang.String key)

Method Summary

Modifier and Type	Method and Description
void	addValueToMessage(AdaptrisMessage msg, java.lang.Object value) Injects the supplied Object value into the message,
java.lang.String	getMetadataKey()
java.lang.Object	getValueFromMessage(AdaptrisMessage msg) Retrieves a value from a message
void	setMetadataKey(java.lang.String s) The key in object metadata.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectMetadataCacheValueTranslator

public ObjectMetadataCacheValueTranslator()

ObjectMetadataCacheValueTranslator

public ObjectMetadataCacheValueTranslator(java.lang.String key)

Method Detail

getValueFromMessage

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

Description copied from interface: CacheValueTranslator

Retrieves a value from a message

Specified by:

getValueFromMessage in interface CacheValueTranslator<java.lang.Object>

Throws:

CoreException

addValueToMessage

public void addValueToMessage(AdaptrisMessage msg,
                              java.lang.Object value)
                       throws CoreException

Description copied from interface: CacheValueTranslator

Injects the supplied Object value into the message,

Specified by:

addValueToMessage in interface CacheValueTranslator<java.lang.Object>

Throws:

CoreException

getMetadataKey

public java.lang.String getMetadataKey()

setMetadataKey

public void setMetadataKey(java.lang.String s)

The key in object metadata.

Parameters:

s - the key

See Also:

AdaptrisMessage.getObjectMetadata()