com.adaptris.core.jcsmp.solace

Class SolaceJcsmpBytesMessageTranslator

java.lang.Object

com.adaptris.core.jcsmp.solace.SolaceJcsmpBytesMessageTranslator

All Implemented Interfaces:

SolaceJcsmpMessageTranslator

@ComponentProfile(summary="A Solace native JCSMP message translator.",
                  tag="solace,jcsmp,translator",
                  since="3.9.3")
public class SolaceJcsmpBytesMessageTranslator
extends java.lang.Object
implements SolaceJcsmpMessageTranslator

Once a message has been consumed from Solace, this translator will generate an AdaptrisMessage from the payload and headers of the consumed message.

Reverse translation when producing a message to a Solace end-point will create a Solace BytesXmlMessage again from the payload and metadata of the AdaptrisMessage

The payload mapping is straight forward, but the metadata and header mapping does require a little configuration. Most of the header values on a Solace BytesXmlMessage are strings and in fact we assume every mapping will be a String, unless you configure the data-type for any mapping to be anything else.

An example of the XML configuration for a producer (therefore translating the AdaptrisMessage to a Solace message) with a simple mapping might be;

   
     PERSISTENT
     
       
         MessageId
         message-id
       
       
         Priority
         message-priority
         Integer
       
     
   
 

The above example will use the AdaptrisMessage metadata value from the key named "message-id" call the setter method "setMessageId()" on the Solace message.
The second mapping will use the AdaptrisMessage metadata value, turn it into an integer value and call the setter "setPriority()" on the Solace message.

In the adapter configuration file this class is aliased as solace-jcsmp-bytes-message-translator which is the preferred alternative to the fully qualified classname when building your configuration.

Constructor Summary

Constructors

Constructor and Description
SolaceJcsmpBytesMessageTranslator()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDeliveryMode()
java.util.List<SolaceJcsmpMetadataMapping>	getMappings()
AdaptrisMessageFactory	getMessageFactory()
void	setDeliveryMode(java.lang.String deliveryMode) The mode of delivery; "PERSISTENT / NONPERSISTENT"
void	setMappings(java.util.List<SolaceJcsmpMetadataMapping> mappings) A list of mappings between Adaptris message metadata and Solace headers.
void	setMessageFactory(AdaptrisMessageFactory messageFactory) Defaults to the standard DefaultMessageFactory.
com.solacesystems.jcsmp.BytesXMLMessage	translate(AdaptrisMessage message)
AdaptrisMessage	translate(com.solacesystems.jcsmp.BytesXMLMessage message)

Methods inherited from class java.lang.Object

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

Constructor Detail

SolaceJcsmpBytesMessageTranslator

public SolaceJcsmpBytesMessageTranslator()

Method Detail

translate

public AdaptrisMessage translate(com.solacesystems.jcsmp.BytesXMLMessage message)
                          throws java.lang.Exception

Specified by:

translate in interface SolaceJcsmpMessageTranslator

Throws:

java.lang.Exception

translate

public com.solacesystems.jcsmp.BytesXMLMessage translate(AdaptrisMessage message)
                                                  throws java.lang.Exception

Specified by:

translate in interface SolaceJcsmpMessageTranslator

Throws:

java.lang.Exception

getMessageFactory

public AdaptrisMessageFactory getMessageFactory()

setMessageFactory

public void setMessageFactory(AdaptrisMessageFactory messageFactory)

Defaults to the standard DefaultMessageFactory.

Parameters:

messageFactory -

getDeliveryMode

public java.lang.String getDeliveryMode()

setDeliveryMode

public void setDeliveryMode(java.lang.String deliveryMode)

The mode of delivery; "PERSISTENT / NONPERSISTENT"

Parameters:

deliveryMode -

getMappings

public java.util.List<SolaceJcsmpMetadataMapping> getMappings()

setMappings

public void setMappings(java.util.List<SolaceJcsmpMetadataMapping> mappings)

A list of mappings between Adaptris message metadata and Solace headers.

Parameters:

mappings -