com.adaptris.core.msmq

Class MetadataMapper

java.lang.Object

com.adaptris.core.msmq.PropertyMapper

com.adaptris.core.msmq.MetadataMapper

public class MetadataMapper
extends PropertyMapper

Copy AdaptrisMessage metadata values to and from MSMQMessage fields.

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

Field Summary

Fields inherited from class com.adaptris.core.msmq.PropertyMapper

logR

Constructor Summary

Constructors

Constructor and Description
MetadataMapper()
MetadataMapper(java.lang.String field, java.lang.String metadataKey)
MetadataMapper(java.lang.String field, java.lang.String metadataKey, ByteTranslator bt)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMetadataKey()
void	map(AdaptrisMessage msg, Message msmq) Copy information from the AdaptrisMessage object into the MQMessage object.
void	map(Message msmq, AdaptrisMessage msg) Copy information from the MQMessage object into the AdaptrisMessage object.
void	setMetadataKey(java.lang.String metadataKey)

Methods inherited from class com.adaptris.core.msmq.PropertyMapper

createProperty, getByteTranslator, getConvertNull, getPropertyName, setByteTranslator, setConvertNull, setPropertyName

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataMapper

public MetadataMapper()

MetadataMapper

public MetadataMapper(java.lang.String field,
                      java.lang.String metadataKey)

Parameters:

field - The Field name

metadataKey - the adaptris metadata key.

MetadataMapper

public MetadataMapper(java.lang.String field,
                      java.lang.String metadataKey,
                      ByteTranslator bt)

Parameters:

field - the Field name

metadataKey - the adaptris metadata key

bt - the byte translator.

Method Detail

map

public void map(AdaptrisMessage msg,
                Message msmq)
         throws MSMQException,
                CoreException

Description copied from class: PropertyMapper

Copy information from the AdaptrisMessage object into the MQMessage object.

Specified by:

map in class PropertyMapper

Parameters:

msg - the AdaptrisMessage Object.

msmq - the MQMessage object.

Throws:

MSMQException - for any MSMQ related Exceptions

CoreException - for any framework related exceptions

map

public void map(Message msmq,
                AdaptrisMessage msg)
         throws MSMQException,
                CoreException

Description copied from class: PropertyMapper

Copy information from the MQMessage object into the AdaptrisMessage object.

Specified by:

map in class PropertyMapper

Parameters:

msmq - the MQMessage object.

msg - the AdaptrisMessage Object.

Throws:

MSMQException - for any MSMQ related Exceptions

CoreException - for any framework related exceptions

getMetadataKey

public java.lang.String getMetadataKey()

Returns:

the metadataKey

setMetadataKey

public void setMetadataKey(java.lang.String metadataKey)

Parameters:

metadataKey - the metadataKey from which corresponds to the MSMQ Field value.