com.adaptris.core.services.jmx

Class MetadataValueTranslator

java.lang.Object

com.adaptris.core.services.jmx.ValueTranslatorImp

com.adaptris.core.services.jmx.MetadataValueTranslator

All Implemented Interfaces:

ValueTranslator

public class MetadataValueTranslator
extends ValueTranslatorImp

This implementation of ValueTranslator will pull a metadata value from the AdaptrisMessage to be used as a Jmx operation parameter. Conversely we can also take a string result from a Jmx operation call and create a new/overwrite an existing metadata item with the new value.

If your Jmx operation requires a different type of data other than String, simply set the type to the fully qualified name of the required type. A conversion will then take place which will require your your desired class to have a string constructor, or be a Date, where the value is the milliseconds.

Since:

3.0.3

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

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	log

Fields inherited from interface com.adaptris.core.services.jmx.ValueTranslator

DEFAULT_PARAMETER_TYPE

Constructor Summary

Constructors

Constructor and Description
MetadataValueTranslator()
MetadataValueTranslator(java.lang.String key, java.lang.String type)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMetadataKey()
java.lang.Object	getValue(AdaptrisMessage message) Returns the object instance used as a parameter for a JMX operation call.
void	setMetadataKey(java.lang.String metadataKey)
void	setValue(AdaptrisMessage message, java.lang.Object value) Will set the given object value back into the AdaptrisMessage.

Methods inherited from class com.adaptris.core.services.jmx.ValueTranslatorImp

getType, setType

Methods inherited from class java.lang.Object

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

Field Detail

log

protected transient org.slf4j.Logger log

Constructor Detail

MetadataValueTranslator

public MetadataValueTranslator()

MetadataValueTranslator

public MetadataValueTranslator(java.lang.String key,
                               java.lang.String type)

Method Detail

getValue

public java.lang.Object getValue(AdaptrisMessage message)
                          throws CoreException

Description copied from interface: ValueTranslator

Returns the object instance used as a parameter for a JMX operation call.

Returns:

the object

Throws:

CoreException

setValue

public void setValue(AdaptrisMessage message,
                     java.lang.Object value)

Description copied from interface: ValueTranslator

Will set the given object value back into the AdaptrisMessage.

getMetadataKey

public java.lang.String getMetadataKey()

setMetadataKey

public void setMetadataKey(java.lang.String metadataKey)