Package com.adaptris.core.jcsmp.solace

Class SolaceJcsmpMetadataMapping

  • @ComponentProfile(summary="Used with the message translator to map Solace headers to Interlok metadata and the reverse.",
                  tag="solace,jcsmp",
                  since="3.9.3")
public class SolaceJcsmpMetadataMapping
extends java.lang.Object

    Used with the message translator to move headers and metedata between the Solace and Adaptris messages.

    When translating from Solace to Adaptris messages, the header keys will be used to generate a getter call. For example, if we set the headerKey to "MessageId" and the metadataKey to "message-id" then Interlok will call the getter getMessageId(), the value for which will be copied into the Adaptris Message metadata item with the key "message-id".

    When translating from Adaptris to Solace messages, the header keys will be used to generate a setter call. For example, if we set the headerKey to "MessageId" and the metadataKey to "message-id" then Interlok will call the setter setMessageId(value), the value for which will come from the Adaptris Message metadata item with the kay "message-id".

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDataType()
      If left null, it is assumed that the Solace property value is a String, otherwise specify "Integer / Boolean / Long"
      java.lang.String getHeaderKey()
      Set the key of the Solace message header item.
      java.lang.String getMetadataKey()
      Set the key of the Adaptris message metadata item.
      void setDataType​(java.lang.String dataType)
      If left null, it is assumed that the Solace property value is a String, otherwise specify "Integer / Boolean / Long"
      void setHeaderKey​(java.lang.String headerKey)
      Set the key of the Solace message header item.
      void setMetadataKey​(java.lang.String metadataKey)
      Set the key of the Adaptris message metadata item.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • SolaceJcsmpMetadataMapping

        public SolaceJcsmpMetadataMapping()

      • SolaceJcsmpMetadataMapping

        public SolaceJcsmpMetadataMapping​(java.lang.String metadataKey,
                                  java.lang.String headerKey)

      • SolaceJcsmpMetadataMapping

        public SolaceJcsmpMetadataMapping​(java.lang.String metadataKey,
                                  java.lang.String headerKey,
                                  java.lang.String dataType)

    • Method Detail

      • getMetadataKey

        public java.lang.String getMetadataKey()
        Set the key of the Adaptris message metadata item.

      • setMetadataKey

        public void setMetadataKey​(java.lang.String metadataKey)
        Set the key of the Adaptris message metadata item.
        Parameters:
        metadataKey -

      • getHeaderKey

        public java.lang.String getHeaderKey()
        Set the key of the Solace message header item. This will match the getter/setter of the property name of the Solace BytesXmlMessage.

      • setHeaderKey

        public void setHeaderKey​(java.lang.String headerKey)
        Set the key of the Solace message header item. This will match the getter/setter of the property name of the Solace BytesXmlMessage.
        Parameters:
        headerKey -

      • getDataType

        public java.lang.String getDataType()
        If left null, it is assumed that the Solace property value is a String, otherwise specify "Integer / Boolean / Long"

      • setDataType

        public void setDataType​(java.lang.String dataType)
        If left null, it is assumed that the Solace property value is a String, otherwise specify "Integer / Boolean / Long"
        Parameters:
        dataType -