Class SolaceJcsmpPerMessageProperties


  • public class SolaceJcsmpPerMessageProperties
    extends java.lang.Object
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void applyPerMessageProperties​(AdaptrisMessage destMessage, com.solacesystems.jcsmp.XMLMessage sourceMessage)  
      void applyPerMessageProperties​(com.solacesystems.jcsmp.XMLMessage destMessage, AdaptrisMessage sourceMessage)  
      java.lang.String getAckImmediately()
      Set the ACK Immediately message property.
      java.lang.String getApplicationMessageId()
      Sets the message ID (a string for an application-specific message identifier).
      java.lang.String getAsReplyMessage()
      Sets the reply field of the message.
      java.lang.String getClassOfService()
      Sets the Class of Service (CoS) value for this message.
      java.lang.String getCorrelationId()
      Sets the correlation ID.
      java.lang.String getCorrelationKey()
      Sets the correlation key.
      java.lang.String getDeliveryMode()
      Sets the delivery mode of the message.
      java.lang.String getDmqEligible()
      Set the message to be eligible to be moved to a Dead Message Queue.
      java.lang.String getElidingEligible()
      Sets whether the message is eligible for eliding.
      java.lang.String getExpiration()
      The UTC time (in milliseconds, from midnight, January 1, 1970 UTC) when the message is supposed to expire.
      java.lang.String getHttpContentEncoding()
      Sets the HTTP content type encoding value for interaction with an HTTP client.
      java.lang.String getHttpContentType()
      Sets the HTTP content type value for interaction with an HTTP client.
      java.lang.String getPriority()
      A message can optionally have priority set.
      java.lang.String getReplyToQueue()
      Sets the replyTo destination (queue) for the message.
      java.lang.String getReplyToSuffix()
      Appends a String to the session's default ReplyTo base topic and creates a ReplyTo Topic Destination.
      java.lang.String getReplyToTopic()
      Sets the replyTo destination (topic) for the message.
      java.lang.String getSenderId()
      Sets the Sender ID for the message.
      java.lang.String getSenderTimestamp()
      Allows the application to set the send timestamp, if so the API will not generate a value.
      java.lang.String getSequenceNumber()
      Sets the sequence number.
      java.lang.String getTimeToLive()
      The number of milliseconds before the message is discarded or moved to a Dead Message Queue.
      KeyValuePairList getUserProperties()
      Set the user data through name/values pairs
      void setAckImmediately​(java.lang.String ackImmediately)
      Set the ACK Immediately message property.
      void setApplicationMessageId​(java.lang.String applicationMessageId)
      Sets the message ID (a string for an application-specific message identifier).
      void setAsReplyMessage​(java.lang.String asReplyMessage)
      Sets the reply field of the message.
      void setClassOfService​(java.lang.String classOfService)
      Sets the Class of Service (CoS) value for this message.
      void setCorrelationId​(java.lang.String correlationId)
      Sets the correlation ID.
      void setCorrelationKey​(java.lang.String correlationKey)
      Sets the correlation key.
      void setDeliveryMode​(java.lang.String deliveryMode)
      Sets the delivery mode of the message.
      void setDmqEligible​(java.lang.String dmqEligible)
      Set the message to be eligible to be moved to a Dead Message Queue.
      void setElidingEligible​(java.lang.String elidingEligible)
      Sets whether the message is eligible for eliding.
      void setExpiration​(java.lang.String expiration)
      The UTC time (in milliseconds, from midnight, January 1, 1970 UTC) when the message is supposed to expire.
      void setHttpContentEncoding​(java.lang.String httpContentEncoding)
      Sets the HTTP content type encoding value for interaction with an HTTP client.
      void setHttpContentType​(java.lang.String httpContentType)
      Sets the HTTP content type value for interaction with an HTTP client.
      void setPriority​(java.lang.String priority)
      A message can optionally have priority set.
      void setReplyToQueue​(java.lang.String replyToQueue)
      Sets the replyTo destination (queue) for the message.
      void setReplyToSuffix​(java.lang.String replyToSuffix)
      Appends a String to the session's default ReplyTo base topic and creates a ReplyTo Topic Destination.
      void setReplyToTopic​(java.lang.String replyToTopic)
      Sets the replyTo destination (topic) for the message.
      void setSenderId​(java.lang.String senderId)
      Sets the Sender ID for the message.
      void setSenderTimestamp​(java.lang.String senderTimestamp)
      Allows the application to set the send timestamp, if so the API will not generate a value.
      void setSequenceNumber​(java.lang.String sequenceNumber)
      Sets the sequence number.
      void setTimeToLive​(java.lang.String timeToLive)
      The number of milliseconds before the message is discarded or moved to a Dead Message Queue.
      void setUserProperties​(KeyValuePairList userProperties)
      Set the user data through name/values pairs
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • SolaceJcsmpPerMessageProperties

        public SolaceJcsmpPerMessageProperties()
    • Method Detail

      • applyPerMessageProperties

        public void applyPerMessageProperties​(AdaptrisMessage destMessage,
                                              com.solacesystems.jcsmp.XMLMessage sourceMessage)
                                       throws com.solacesystems.jcsmp.SDTException
        Throws:
        com.solacesystems.jcsmp.SDTException
      • applyPerMessageProperties

        public void applyPerMessageProperties​(com.solacesystems.jcsmp.XMLMessage destMessage,
                                              AdaptrisMessage sourceMessage)
                                       throws com.solacesystems.jcsmp.SDTException
        Throws:
        com.solacesystems.jcsmp.SDTException
      • getUserProperties

        public KeyValuePairList getUserProperties()
        Set the user data through name/values pairs
      • setUserProperties

        public void setUserProperties​(KeyValuePairList userProperties)
        Set the user data through name/values pairs
      • getAckImmediately

        public java.lang.String getAckImmediately()
        Set the ACK Immediately message property.
      • setAckImmediately

        public void setAckImmediately​(java.lang.String ackImmediately)
        Set the ACK Immediately message property.
      • getApplicationMessageId

        public java.lang.String getApplicationMessageId()
        Sets the message ID (a string for an application-specific message identifier).
      • setApplicationMessageId

        public void setApplicationMessageId​(java.lang.String applicationMessageId)
        Sets the message ID (a string for an application-specific message identifier).
      • getAsReplyMessage

        public java.lang.String getAsReplyMessage()
        Sets the reply field of the message.
      • setAsReplyMessage

        public void setAsReplyMessage​(java.lang.String asReplyMessage)
        Sets the reply field of the message.
      • getCorrelationId

        public java.lang.String getCorrelationId()
        Sets the correlation ID.
      • setCorrelationId

        public void setCorrelationId​(java.lang.String correlationId)
        Sets the correlation ID.
      • getCorrelationKey

        public java.lang.String getCorrelationKey()
        Sets the correlation key.
      • setCorrelationKey

        public void setCorrelationKey​(java.lang.String correlationKey)
        Sets the correlation key.
      • getClassOfService

        public java.lang.String getClassOfService()
        Sets the Class of Service (CoS) value for this message. 1 being the lowest class of service and 3 being the highest.
      • setClassOfService

        public void setClassOfService​(java.lang.String classOfService)
        Sets the Class of Service (CoS) value for this message. 1 being the lowest class of service and 3 being the highest.
      • getDeliveryMode

        public java.lang.String getDeliveryMode()
        Sets the delivery mode of the message. Should be one of the following; DIRECT|NON_PERSISTENT|PERSISTENT
      • setDeliveryMode

        public void setDeliveryMode​(java.lang.String deliveryMode)
        Sets the delivery mode of the message. Should be one of the following; DIRECT|NON_PERSISTENT|PERSISTENT
      • getDmqEligible

        public java.lang.String getDmqEligible()
        Set the message to be eligible to be moved to a Dead Message Queue.
      • setDmqEligible

        public void setDmqEligible​(java.lang.String dmqEligible)
        Set the message to be eligible to be moved to a Dead Message Queue.
      • getElidingEligible

        public java.lang.String getElidingEligible()
        Sets whether the message is eligible for eliding.
      • setElidingEligible

        public void setElidingEligible​(java.lang.String elidingEligible)
        Sets whether the message is eligible for eliding.
      • getExpiration

        public java.lang.String getExpiration()
        The UTC time (in milliseconds, from midnight, January 1, 1970 UTC) when the message is supposed to expire.
      • setExpiration

        public void setExpiration​(java.lang.String expiration)
        The UTC time (in milliseconds, from midnight, January 1, 1970 UTC) when the message is supposed to expire.
      • getHttpContentEncoding

        public java.lang.String getHttpContentEncoding()
        Sets the HTTP content type encoding value for interaction with an HTTP client.
      • setHttpContentEncoding

        public void setHttpContentEncoding​(java.lang.String httpContentEncoding)
        Sets the HTTP content type encoding value for interaction with an HTTP client.
      • getHttpContentType

        public java.lang.String getHttpContentType()
        Sets the HTTP content type value for interaction with an HTTP client.
      • setHttpContentType

        public void setHttpContentType​(java.lang.String httpContentType)
        Sets the HTTP content type value for interaction with an HTTP client.
      • getPriority

        public java.lang.String getPriority()
        A message can optionally have priority set.
      • setPriority

        public void setPriority​(java.lang.String priority)
        A message can optionally have priority set.
      • getReplyToQueue

        public java.lang.String getReplyToQueue()
        Sets the replyTo destination (queue) for the message.
      • setReplyToQueue

        public void setReplyToQueue​(java.lang.String replyToQueue)
        Sets the replyTo destination (queue) for the message.
      • getReplyToTopic

        public java.lang.String getReplyToTopic()
        Sets the replyTo destination (topic) for the message.
      • setReplyToTopic

        public void setReplyToTopic​(java.lang.String replyToTopic)
        Sets the replyTo destination (topic) for the message.
      • getReplyToSuffix

        public java.lang.String getReplyToSuffix()
        Appends a String to the session's default ReplyTo base topic and creates a ReplyTo Topic Destination.
      • setReplyToSuffix

        public void setReplyToSuffix​(java.lang.String replyToSuffix)
        Appends a String to the session's default ReplyTo base topic and creates a ReplyTo Topic Destination.
      • getSenderId

        public java.lang.String getSenderId()
        Sets the Sender ID for the message.
      • setSenderId

        public void setSenderId​(java.lang.String senderId)
        Sets the Sender ID for the message.
      • getSenderTimestamp

        public java.lang.String getSenderTimestamp()
        Allows the application to set the send timestamp, if so the API will not generate a value.
      • setSenderTimestamp

        public void setSenderTimestamp​(java.lang.String senderTimestamp)
        Allows the application to set the send timestamp, if so the API will not generate a value.
      • getSequenceNumber

        public java.lang.String getSequenceNumber()
        Sets the sequence number.
      • setSequenceNumber

        public void setSequenceNumber​(java.lang.String sequenceNumber)
        Sets the sequence number.
      • getTimeToLive

        public java.lang.String getTimeToLive()
        The number of milliseconds before the message is discarded or moved to a Dead Message Queue.
      • setTimeToLive

        public void setTimeToLive​(java.lang.String timeToLive)
        The number of milliseconds before the message is discarded or moved to a Dead Message Queue.