com.adaptris.core.jms

Class MetadataCorrelationIdSource

java.lang.Object

com.adaptris.core.jms.MetadataCorrelationIdSource

All Implemented Interfaces:

CorrelationIdSource

public class MetadataCorrelationIdSource
extends java.lang.Object
implements CorrelationIdSource

Implementation of CorrelationIdSource which uses the value stored against a configureable metadata key as the JMSCorrelationId .

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMetadataKey() Returns the metadata key that should be used to obtain the JMSCorrelationId.
void	processCorrelationId(AdaptrisMessage src, javax.jms.Message dest) If no metadata key is configured or if no value is stored against the configured key a message is logged to this effect and no Exception is thrown.
void	processCorrelationId(javax.jms.Message src, AdaptrisMessage dest) Provides a JMSCorrelationId for the javax.jms.Message.
void	setMetadataKey(java.lang.String s) Sets the metadata key that should be used to obtain the JMSCorrelationId.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataCorrelationIdSource

public MetadataCorrelationIdSource()

MetadataCorrelationIdSource

public MetadataCorrelationIdSource(java.lang.String key)

Method Detail

processCorrelationId

public void processCorrelationId(AdaptrisMessage src,
                                 javax.jms.Message dest)
                          throws javax.jms.JMSException

If no metadata key is configured or if no value is stored against the configured key a message is logged to this effect and no Exception is thrown.

Specified by:

processCorrelationId in interface CorrelationIdSource

Parameters:

src - the AdaptrisMessage being processed

dest - the javax.jms.Message to send

Throws:

javax.jms.JMSException - if encoutered setting JMSCorrelationId

See Also:

(com.adaptris.core.AdaptrisMessage, javax.jms.Message)

processCorrelationId

public void processCorrelationId(javax.jms.Message src,
                                 AdaptrisMessage dest)
                          throws javax.jms.JMSException

Description copied from interface: CorrelationIdSource

Provides a JMSCorrelationId for the javax.jms.Message.

Specified by:

processCorrelationId in interface CorrelationIdSource

Parameters:

src - the javax.jms.Message that has been received

dest - the AdaptrisMessage to be processed

Throws:

javax.jms.JMSException - if encoutered setting JMSCorrelationId

getMetadataKey

public java.lang.String getMetadataKey()

Returns the metadata key that should be used to obtain the JMSCorrelationId.

Returns:

metadataKey the metadata key that should be used to obtain the JMSCorrelationId

setMetadataKey

public void setMetadataKey(java.lang.String s)

Sets the metadata key that should be used to obtain the JMSCorrelationId.

Parameters:

s - the metadata key that should be used to obtain the JMSCorrelationId