Class Message

java.lang.Object
com.swiftmq.impl.streams.comp.message.Message
Direct Known Subclasses:
BytesMessage, MapMessage, ObjectMessage, StreamMessage, TextMessage
public class Message extends Object
Facade to wrap a javax.jms.Message.
Author:
IIT Software GmbH, Muenster/Germany, (c) 2016, All Rights Reserved

  • Method Details

    • getImpl

      public com.swiftmq.jms.MessageImpl getImpl()
      Internal use only.

    • copyProperties

      public Message copyProperties(Message source) throws javax.jms.JMSException
      Internal use only.
      Throws:
      javax.jms.JMSException

    • isSelected

      public boolean isSelected(com.swiftmq.ms.MessageSelector selector) throws javax.jms.JMSException
      Internal use only.
      Throws:
      javax.jms.JMSException

    • type

      public String type()
      return the type of this Message
      Returns:
      "message"

    • persistent

      public Message persistent() throws javax.jms.JMSException
      Marks this Message as persistent.
      Returns:
      Message
      Throws:
      javax.jms.JMSException

    • isPersistent

      public boolean isPersistent() throws javax.jms.JMSException
      Returns true if this Message is persistent.
      Returns:
      true/false
      Throws:
      javax.jms.JMSException

    • nonpersistent

      public Message nonpersistent() throws javax.jms.JMSException
      Marks this Message as non-persistent.
      Returns:
      Message
      Throws:
      javax.jms.JMSException

    • isNonpersistent

      public boolean isNonpersistent() throws javax.jms.JMSException
      Returns true if this Message is non-persistent.
      Returns:
      true/false
      Throws:
      javax.jms.JMSException

    • destination

      public String destination() throws javax.jms.JMSException
      Returns the Name of the JMSDestination.
      Returns:
      Name of the JMSDestination
      Throws:
      javax.jms.JMSException

    • size

      public long size()
      Returns the size (bytes) of the Message.
      Returns:
      size

    • messageId

      public Message messageId(String s) throws javax.jms.JMSException
      Sets the JMS message ID.
      Parameters:
      s - message id
      Returns:
      Message
      Throws:
      javax.jms.JMSException

    • messageId

      public String messageId() throws javax.jms.JMSException
      Returns the JMS message ID.
      Returns:
      message id
      Throws:
      javax.jms.JMSException

    • correlationId

      public Message correlationId(String s) throws javax.jms.JMSException
      Sets the JMS correlation ID.
      Parameters:
      s - correlation id
      Returns:
      Message
      Throws:
      javax.jms.JMSException

    • correlationId

      public String correlationId() throws javax.jms.JMSException
      Returns the JMS correlation ID.
      Returns:
      correlation id
      Throws:
      javax.jms.JMSException

    • priority

      public Message priority(int prio) throws javax.jms.JMSException
      Sets the JMS priority.
      Parameters:
      prio - priority
      Returns:
      Message
      Throws:
      javax.jms.JMSException

    • priority

      public int priority() throws javax.jms.JMSException
      Returns the JMS priority
      Returns:
      priority
      Throws:
      javax.jms.JMSException

    • expiration

      public Message expiration(long exp) throws javax.jms.JMSException
      Sets the JMS expiration
      Parameters:
      exp - expiration
      Returns:
      Message
      Throws:
      javax.jms.JMSException

    • expiration

      public long expiration() throws javax.jms.JMSException
      Returns the JMS expiration.
      Returns:
      expiration
      Throws:
      javax.jms.JMSException

    • timestamp

      public Message timestamp(long timestamp) throws javax.jms.JMSException
      Sets the JMS timestamp
      Parameters:
      timestamp - time stamp
      Returns:
      Message
      Throws:
      javax.jms.JMSException

    • timestamp

      public long timestamp() throws javax.jms.JMSException
      Returns the JMS timestamp.
      Returns:
      timestamp
      Throws:
      javax.jms.JMSException

    • replyTo

      public Message replyTo(javax.jms.Destination destination) throws javax.jms.JMSException
      Sets the replyTo address
      Parameters:
      destination -
      Returns:
      Message
      Throws:
      javax.jms.JMSException

    • replyTo

      public javax.jms.Destination replyTo() throws javax.jms.JMSException
      Returns the replyTo address
      Returns:
      replyTo Address
      Throws:
      javax.jms.JMSException

    • property

      public Property property(String name)
      Returns the Message property with that name. If the property does not exists in the message, the value of the returned property is set to null.
      Parameters:
      name - Property name
      Returns:
      Property

    • clearBody

      public Message clearBody()
      Clears the message body.
      Returns:
      this

    • properties

      public PropertySet properties() throws Exception
      Returns a PropertySet that contains all Message Properties of this Message
      Returns:
      PropertySet
      Throws:
      Exception

    • onMessageEnabled

      public Message onMessageEnabled(boolean onMessageEnabled)
      Can be set to false in an Input callback to disable calling the onMessage Callback with this Message.
      Parameters:
      onMessageEnabled - true/false
      Returns:
      this

    • isOnMessageEnabled

      public boolean isOnMessageEnabled()
      Internal use.

    • toString

      public String toString()
      Overrides:
      toString in class Object