Package com.webmethods.jms.impl

Class WmClusterMessageImpl

  • All Implemented Interfaces:
    WmMessage, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, javax.jms.Message
    public class WmClusterMessageImpl
extends WmMessageImpl
    See Also:
    Serialized Form

    • Field Detail

      • _logApi

        protected boolean _logApi

    • Constructor Detail

      • WmClusterMessageImpl

        public WmClusterMessageImpl()
                     throws javax.jms.JMSException
        Throws:
        javax.jms.JMSException

    • Method Detail

      • acknowledge

        public void acknowledge()
                 throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Acknowledges all consumed messages of the session of this consumed message.

        All consumed JMS messages support the acknowledge method for use when a client has specified that its JMS session's consumed messages are to be explicitly acknowledged. By invoking acknowledge on a consumed message, a client acknowledges all messages consumed by the session that the message was delivered to.

        Calls to acknowledge are ignored for both transacted sessions and sessions specified to use implicit acknowledgement modes.

        A client may individually acknowledge each message as it is consumed, or it may choose to acknowledge messages as an application-defined group (which is done by calling acknowledge on the last received message of the group, thereby acknowledging all messages consumed by the session.)

        Messages that have been received but not acknowledged may be redelivered.

        Specified by:
        acknowledge in interface javax.jms.Message
        Overrides:
        acknowledge in class WmMessageImpl
        Throws:
        javax.jms.JMSException - if the JMS provider fails to acknowledge the messages due to some internal error.
        javax.jms.IllegalStateException - if this method is called on a closed session.

      • clearBody

        public void clearBody()
               throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Clears out the message body. Clearing a message's body does not clear its header values or property entries.

        If this message body was read-only, calling this method leaves the message body in the same state as an empty body in a newly created message.

        Specified by:
        clearBody in interface javax.jms.Message
        Overrides:
        clearBody in class WmMessageImpl
        Throws:
        javax.jms.JMSException - if the JMS provider fails to clear the message body due to some internal error.

      • clearProperties

        public void clearProperties()
                     throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Clears a message's properties.

        The message's header fields and body are not cleared.

        Specified by:
        clearProperties in interface javax.jms.Message
        Overrides:
        clearProperties in class WmMessageImpl
        Throws:
        javax.jms.JMSException - if the JMS provider fails to clear the message properties due to some internal error.

      • equals

        public boolean equals​(java.lang.Object obj)
        Description copied from class: WmMessageImpl
        Checks if two Messages are equal
        Overrides:
        equals in class WmMessageImpl
        See Also:
        Object.equals(Object)

      • explicitAcknowledge

        public void explicitAcknowledge()
                         throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Explicitly acknowledges this and only this consumed message.

        Calls to explicitAcknowledge are ignored for both transacted sessions and sessions specified to use implicit acknowledgement modes.

        Messages that have been received but not acknowledged may be redelivered.

        Specified by:
        explicitAcknowledge in interface WmMessage
        Overrides:
        explicitAcknowledge in class WmMessageImpl
        Throws:
        javax.jms.JMSException - if the JMS provider fails to acknowledge the message due to some internal error.
        See Also:
        Session.CLIENT_ACKNOWLEDGE

      • getAccessLabel

        public short[] getAccessLabel()
                       throws javax.jms.JMSException
        Overrides:
        getAccessLabel in class WmMessageImpl
        Throws:
        javax.jms.JMSException

      • getBooleanProperty

        public boolean getBooleanProperty​(java.lang.String name)
                           throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Returns the value of the boolean property with the specified name.
        Specified by:
        getBooleanProperty in interface javax.jms.Message
        Overrides:
        getBooleanProperty in class WmMessageImpl
        Parameters:
        name - the name of the boolean property
        Returns:
        the boolean property value for the specified name
        Throws:
        javax.jms.JMSException - if the JMS provider fails to get the property value due to some internal error.
        javax.jms.MessageFormatException - if this type conversion is invalid.

      • getByteProperty

        public byte getByteProperty​(java.lang.String name)
                     throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Returns the value of the byte property with the specified name.
        Specified by:
        getByteProperty in interface javax.jms.Message
        Overrides:
        getByteProperty in class WmMessageImpl
        Parameters:
        name - the name of the byte property
        Returns:
        the byte property value for the specified name
        Throws:
        javax.jms.JMSException - if the JMS provider fails to get the property value due to some internal error.
        javax.jms.MessageFormatException - if this type conversion is invalid.

      • getCompression

        public boolean getCompression()
                       throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Get whether compression is enabled or disabled for this message.
        Specified by:
        getCompression in interface WmMessage
        Overrides:
        getCompression in class WmMessageImpl
        Returns:
        Whether compression is enabled or disabled for this message.
        Throws:
        javax.jms.JMSException - for any internal errors.

      • getCompressionLevel

        public int getCompressionLevel()
                        throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Get the compression level for this message.
        Specified by:
        getCompressionLevel in interface WmMessage
        Overrides:
        getCompressionLevel in class WmMessageImpl
        Returns:
        The compression level (0-9) as defined by java.util.zip.Deflater.
        Throws:
        javax.jms.JMSException - for any internal errors.

      • getCompressionRatio

        public int getCompressionRatio()
                        throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Get the compression ratio of a delivered message that has been compressed. The ratio is calculated as: 
         ratio = ((uncompressed_size - compressed_size) / uncompressed_size) * 100
        Specified by:
        getCompressionRatio in interface WmMessage
        Overrides:
        getCompressionRatio in class WmMessageImpl
        Returns:
        The compression ratio of a delivered message.
        Throws:
        javax.jms.JMSException - for any internal errors.

      • getDoubleProperty

        public double getDoubleProperty​(java.lang.String name)
                         throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Returns the value of the double property with the specified name.
        Specified by:
        getDoubleProperty in interface javax.jms.Message
        Overrides:
        getDoubleProperty in class WmMessageImpl
        Parameters:
        name - the name of the double property
        Returns:
        the double property value for the specified name
        Throws:
        javax.jms.JMSException - if the JMS provider fails to get the property value due to some internal error.
        javax.jms.MessageFormatException - if this type conversion is invalid.

      • getFloatProperty

        public float getFloatProperty​(java.lang.String name)
                       throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Returns the value of the float property with the specified name.
        Specified by:
        getFloatProperty in interface javax.jms.Message
        Overrides:
        getFloatProperty in class WmMessageImpl
        Parameters:
        name - the name of the float property
        Returns:
        the float property value for the specified name
        Throws:
        javax.jms.JMSException - if the JMS provider fails to get the property value due to some internal error.
        javax.jms.MessageFormatException - if this type conversion is invalid.

      • getIntProperty

        public int getIntProperty​(java.lang.String name)
                   throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Returns the value of the int property with the specified name.
        Specified by:
        getIntProperty in interface javax.jms.Message
        Overrides:
        getIntProperty in class WmMessageImpl
        Parameters:
        name - the name of the int property
        Returns:
        the int property value for the specified name
        Throws:
        javax.jms.JMSException - if the JMS provider fails to get the property value due to some internal error.
        javax.jms.MessageFormatException - if this type conversion is invalid.

      • getJMSCorrelationID

        public java.lang.String getJMSCorrelationID()
                                     throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Gets the correlation ID for the message.

        This method is used to return correlation ID values that are either provider-specific message IDs or application-specific String values.

        Specified by:
        getJMSCorrelationID in interface javax.jms.Message
        Overrides:
        getJMSCorrelationID in class WmMessageImpl
        Returns:
        the correlation ID of a message as a String
        Throws:
        javax.jms.JMSException - if the JMS provider fails to get the correlation ID due to some internal error.

      • getJMSCorrelationIDAsBytes

        public byte[] getJMSCorrelationIDAsBytes()
                                  throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Gets the correlation ID as an array of bytes for the message.

        The use of a byte[] value for JMSCorrelationID is non-portable.

        Specified by:
        getJMSCorrelationIDAsBytes in interface javax.jms.Message
        Overrides:
        getJMSCorrelationIDAsBytes in class WmMessageImpl
        Returns:
        the correlation ID of a message as an array of bytes
        Throws:
        javax.jms.JMSException - if the JMS provider fails to get the correlation ID due to some internal error.

      • getJMSDeliveryMode

        public int getJMSDeliveryMode()
                       throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Gets the DeliveryMode value specified for this message.
        Specified by:
        getJMSDeliveryMode in interface javax.jms.Message
        Overrides:
        getJMSDeliveryMode in class WmMessageImpl
        Returns:
        the delivery mode for this message
        Throws:
        javax.jms.JMSException - if the JMS provider fails to get the delivery mode due to some internal error.

      • getJMSDestination

        public javax.jms.Destination getJMSDestination()
                                        throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Gets the Destination object for this message.

        The JMSDestination header field contains the destination to which the message is being sent.

        When a message is sent, this field is ignored. After completion of the send or publish method, the field holds the destination specified by the method.

        When a message is received, its JMSDestination value must be equivalent to the value assigned when it was sent.

        Specified by:
        getJMSDestination in interface javax.jms.Message
        Overrides:
        getJMSDestination in class WmMessageImpl
        Returns:
        the destination of this message
        Throws:
        javax.jms.JMSException - if the JMS provider fails to get the destination due to some internal error.

      • getJMSExpiration

        public long getJMSExpiration()
                      throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Gets the message's expiration value.

        When a message is sent, the JMSExpiration header field is left unassigned. After completion of the send or publish method, it holds the expiration time of the message. This is the sum of the time-to-live value specified by the client and the GMT at the time of the send or publish.

        If the time-to-live is specified as zero, JMSExpiration is set to zero to indicate that the message does not expire.

        When a message's expiration time is reached, a provider should discard it. The JMS API does not define any form of notification of message expiration.

        Clients should not receive messages that have expired; however, the JMS API does not guarantee that this will not happen.

        Specified by:
        getJMSExpiration in interface javax.jms.Message
        Overrides:
        getJMSExpiration in class WmMessageImpl
        Returns:
        the time the message expires, which is the sum of the time-to-live value specified by the client and the GMT at the time of the send
        Throws:
        javax.jms.JMSException - if the JMS provider fails to get the message expiration due to some internal error.

      • getJMSMessageID

        public java.lang.String getJMSMessageID()
                                 throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Gets the message ID.

        The JMSMessageID header field contains a value that uniquely identifies each message sent by a provider.

        When a message is sent, JMSMessageID can be ignored. When the send or publish method returns, it contains a provider-assigned value.

        A JMSMessageID is a String value that should function as a unique key for identifying messages in a historical repository. The exact scope of uniqueness is provider-defined. It should at least cover all messages for a specific installation of a provider, where an installation is some connected set of message routers.

        All JMSMessageID values must start with the prefix 'ID:'. Uniqueness of message ID values across different providers is not required.

        Since message IDs take some effort to create and increase a message's size, some JMS providers may be able to optimize message overhead if they are given a hint that the message ID is not used by an application. By calling the MessageProducer.setDisableMessageID method, a JMS client enables this potential optimization for all messages sent by that message producer. If the JMS provider accepts this hint, these messages must have the message ID set to null; if the provider ignores the hint, the message ID must be set to its normal unique value.

        Specified by:
        getJMSMessageID in interface javax.jms.Message
        Overrides:
        getJMSMessageID in class WmMessageImpl
        Returns:
        the message ID
        Throws:
        javax.jms.JMSException - if the JMS provider fails to get the message ID due to some internal error.

      • getJMSPriority

        public int getJMSPriority()
                   throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Gets the message priority level.

        The JMS API defines ten levels of priority value, with 0 as the lowest priority and 9 as the highest. In addition, clients should consider priorities 0-4 as gradations of normal priority and priorities 5-9 as gradations of expedited priority.

        The JMS API does not require that a provider strictly implement priority ordering of messages; however, it should do its best to deliver expedited messages ahead of normal messages.

        Specified by:
        getJMSPriority in interface javax.jms.Message
        Overrides:
        getJMSPriority in class WmMessageImpl
        Returns:
        the default message priority
        Throws:
        javax.jms.JMSException - if the JMS provider fails to get the message priority due to some internal error.

      • getJMSRedelivered

        public boolean getJMSRedelivered()
                          throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Gets an indication of whether this message is being redelivered.

        If a client receives a message with the JMSRedelivered field set, it is likely, but not guaranteed, that this message was delivered earlier but that its receipt was not acknowledged at that time.

        Specified by:
        getJMSRedelivered in interface javax.jms.Message
        Overrides:
        getJMSRedelivered in class WmMessageImpl
        Returns:
        true if this message is being redelivered
        Throws:
        javax.jms.JMSException - if the JMS provider fails to get the redelivered state due to some internal error.

      • getJMSReplyTo

        public javax.jms.Destination getJMSReplyTo()
                                    throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Gets the Destination object to which a reply to this message should be sent.
        Specified by:
        getJMSReplyTo in interface javax.jms.Message
        Overrides:
        getJMSReplyTo in class WmMessageImpl
        Returns:
        Destination to which to send a response to this message
        Throws:
        javax.jms.JMSException - if the JMS provider fails to get the JMSReplyTo destination due to some internal error.

      • getJMSTimestamp

        public long getJMSTimestamp()
                     throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Gets the message timestamp.

        The JMSTimestamp header field contains the time a message was handed off to a provider to be sent. It is not the time the message was actually transmitted, because the actual send may occur later due to transactions or other client-side queueing of messages.

        When a message is sent, JMSTimestamp is ignored. When the send or publish method returns, it contains a time value somewhere in the interval between the call and the return. The value is in the format of a normal millis time value in the Java programming language.

        Since timestamps take some effort to create and increase a message's size, some JMS providers may be able to optimize message overhead if they are given a hint that the timestamp is not used by an application. By calling the MessageProducer.setDisableMessageTimestamp method, a JMS client enables this potential optimization for all messages sent by that message producer. If the JMS provider accepts this hint, these messages must have the timestamp set to zero; if the provider ignores the hint, the timestamp must be set to its normal value.

        Specified by:
        getJMSTimestamp in interface javax.jms.Message
        Overrides:
        getJMSTimestamp in class WmMessageImpl
        Returns:
        the message timestamp
        Throws:
        javax.jms.JMSException - if the JMS provider fails to get the timestamp due to some internal error.

      • getJMSType

        public java.lang.String getJMSType()
                            throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Gets the message type identifier supplied by the client when the message was sent.
        Specified by:
        getJMSType in interface javax.jms.Message
        Overrides:
        getJMSType in class WmMessageImpl
        Returns:
        the message type
        Throws:
        javax.jms.JMSException - if the JMS provider fails to get the message type due to some internal error.

      • getLongProperty

        public long getLongProperty​(java.lang.String name)
                     throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Returns the value of the long property with the specified name.
        Specified by:
        getLongProperty in interface javax.jms.Message
        Overrides:
        getLongProperty in class WmMessageImpl
        Parameters:
        name - the name of the long property
        Returns:
        the long property value for the specified name
        Throws:
        javax.jms.JMSException - if the JMS provider fails to get the property value due to some internal error.
        javax.jms.MessageFormatException - if this type conversion is invalid.

      • getObjectProperty

        public java.lang.Object getObjectProperty​(java.lang.String name)
                                   throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Returns the value of the Java object property with the specified name.

        This method can be used to return, in objectified format, an object that has been stored as a property in the message with the equivalent setObjectProperty method call, or its equivalent primitive settypeProperty method.

        Specified by:
        getObjectProperty in interface javax.jms.Message
        Overrides:
        getObjectProperty in class WmMessageImpl
        Parameters:
        name - the name of the Java object property
        Returns:
        the Java object property value with the specified name, in objectified format (for example, if the property was set as an int, an Integer is returned); if there is no property by this name, a null value is returned
        Throws:
        javax.jms.JMSException - if the JMS provider fails to get the property value due to some internal error.

      • getPreAcknowledgement

        public java.lang.String getPreAcknowledgement()
                                       throws javax.jms.JMSException
        Overrides:
        getPreAcknowledgement in class WmMessageImpl
        Throws:
        javax.jms.JMSException

      • getPropertyNames

        public java.util.Enumeration<java.lang.String> getPropertyNames()
                                                         throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Returns an Enumeration of all the property names.

        Note that JMS standard header fields are not considered properties and are not returned in this enumeration.

        Specified by:
        getPropertyNames in interface javax.jms.Message
        Overrides:
        getPropertyNames in class WmMessageImpl
        Returns:
        an enumeration of all the names of property values
        Throws:
        javax.jms.JMSException - if the JMS provider fails to get the property names due to some internal error.

      • getReceiveCount

        protected int getReceiveCount()
        Description copied from class: WmMessageImpl
        Internal method to get the message receive count.
        Overrides:
        getReceiveCount in class WmMessageImpl
        Returns:
        the message receive count

      • getSequenceNumber

        public long getSequenceNumber()
        Description copied from class: WmMessageImpl
        Internal method to get the sequence number of this message.
        Overrides:
        getSequenceNumber in class WmMessageImpl
        Returns:
        the message sequence number

      • getShortProperty

        public short getShortProperty​(java.lang.String name)
                       throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Returns the value of the short property with the specified name.
        Specified by:
        getShortProperty in interface javax.jms.Message
        Overrides:
        getShortProperty in class WmMessageImpl
        Parameters:
        name - the name of the short property
        Returns:
        the short property value for the specified name
        Throws:
        javax.jms.JMSException - if the JMS provider fails to get the property value due to some internal error.
        javax.jms.MessageFormatException - if this type conversion is invalid.

      • getSize

        public int getSize()
            throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Get the message size in bytes.
        Specified by:
        getSize in interface WmMessage
        Overrides:
        getSize in class WmMessageImpl
        Returns:
        The message size in bytes.
        Throws:
        javax.jms.JMSException - for any internal errors.

      • getStringProperty

        public java.lang.String getStringProperty​(java.lang.String name)
                                   throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Returns the value of the String property with the specified name.
        Specified by:
        getStringProperty in interface javax.jms.Message
        Overrides:
        getStringProperty in class WmMessageImpl
        Parameters:
        name - the name of the String property
        Returns:
        the String property value for the specified name; if there is no property by this name, a null value is returned
        Throws:
        javax.jms.JMSException - if the JMS provider fails to get the property value due to some internal error.
        javax.jms.MessageFormatException - if this type conversion is invalid.

      • getTopicName

        public java.lang.String getTopicName​(java.lang.String topicName)
        Overrides:
        getTopicName in class WmMessageImpl

      • getTransactionID

        public long getTransactionID()
        Description copied from class: WmMessageImpl
        Internal method to get the message's transaction ID.
        Overrides:
        getTransactionID in class WmMessageImpl
        Returns:
        the transaction ID of this message

      • getTransportData

        public byte[] getTransportData()
                        throws javax.jms.JMSException
        Overrides:
        getTransportData in class WmMessageImpl
        Throws:
        javax.jms.JMSException

      • getUUID

        public java.lang.String getUUID()
                         throws javax.jms.JMSException
        Overrides:
        getUUID in class WmMessageImpl
        Throws:
        javax.jms.JMSException

      • hashCode

        public int hashCode()
        Description copied from class: WmMessageImpl
        Calculates hash code for this object.
        Overrides:
        hashCode in class WmMessageImpl
        See Also:
        Object.hashCode()

      • isAcknowledged

        public boolean isAcknowledged()
        Description copied from class: WmMessageImpl
        Internal method to get the message acknowledge status.
        Overrides:
        isAcknowledged in class WmMessageImpl
        Returns:
        the message acknowledge status

      • negativeAcknowledge

        public void negativeAcknowledge()
                         throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Negatively acknowledges this consumed message causing it to be redelivered.

        Calls to negativeAcknowledge are ignored for both transacted sessions and sessions specified to use implicit acknowledgement modes.

        Specified by:
        negativeAcknowledge in interface WmMessage
        Overrides:
        negativeAcknowledge in class WmMessageImpl
        Throws:
        javax.jms.JMSException - if the JMS provider fails to negative acknowledge the message due to some internal error.
        See Also:
        Session.CLIENT_ACKNOWLEDGE

      • propertyExists

        public boolean propertyExists​(java.lang.String name)
                       throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Indicates whether a property value exists.
        Specified by:
        propertyExists in interface javax.jms.Message
        Overrides:
        propertyExists in class WmMessageImpl
        Parameters:
        name - the name of the property to test
        Returns:
        true if the property exists
        Throws:
        javax.jms.JMSException - if the JMS provider fails to determine if the property exists due to some internal error.

      • readExternal

        public void readExternal​(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
        Specified by:
        readExternal in interface java.io.Externalizable
        Overrides:
        readExternal in class WmMessageImpl
        Throws:
        java.io.IOException
        java.lang.ClassNotFoundException
        See Also:
        Externalizable.readExternal(java.io.ObjectInput)

      • setAccessLabel

        public void setAccessLabel​(short[] label)
                    throws javax.jms.JMSException
        Description copied from interface: WmMessage
        Set access label to message envelope
        Specified by:
        setAccessLabel in interface WmMessage
        Overrides:
        setAccessLabel in class WmMessageImpl
        Throws:
        javax.jms.JMSException

      • setAcknowledged

        public void setAcknowledged​(boolean acknowledged)
        Description copied from class: WmMessageImpl
        Internal method to set the message acknowledge status.
        Overrides:
        setAcknowledged in class WmMessageImpl
        Parameters:
        acknowledged - the message acknowledge status

      • setBooleanProperty

        public void setBooleanProperty​(java.lang.String name,
                               boolean value)
                        throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Sets a boolean property value with the specified name into the message.
        Specified by:
        setBooleanProperty in interface javax.jms.Message
        Overrides:
        setBooleanProperty in class WmMessageImpl
        Parameters:
        name - the name of the boolean property
        value - the boolean property value to set
        Throws:
        javax.jms.JMSException - if the JMS provider fails to set the property due to some internal error.
        javax.jms.MessageNotWriteableException - if properties are read-only

      • setByteProperty

        public void setByteProperty​(java.lang.String name,
                            byte value)
                     throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Sets a byte property value with the specified name into the message.
        Specified by:
        setByteProperty in interface javax.jms.Message
        Overrides:
        setByteProperty in class WmMessageImpl
        Parameters:
        name - the name of the byte property
        value - the byte property value to set
        Throws:
        javax.jms.JMSException - if the JMS provider fails to set the property due to some internal error.
        javax.jms.MessageNotWriteableException - if properties are read-only

      • setCompression

        public void setCompression​(boolean compress)
                    throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Enable or disable compression for this message. When enabled, the message body will be compressed just prior to being delivered.
        Specified by:
        setCompression in interface WmMessage
        Overrides:
        setCompression in class WmMessageImpl
        Parameters:
        compress - true to enable compression for this message.
        Throws:
        javax.jms.JMSException - for any internal errors.

      • setCompressionLevel

        public void setCompressionLevel​(int level)
                         throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Set the compression level for this message.
        Specified by:
        setCompressionLevel in interface WmMessage
        Overrides:
        setCompressionLevel in class WmMessageImpl
        Parameters:
        level - The compression level (0-9) as defined by java.util.zip.Deflater.
        Throws:
        javax.jms.JMSException - for any internal errors.

      • setDeliveryMode

        protected void setDeliveryMode​(int deliveryMode)
        Description copied from class: WmMessageImpl
        Internal method to set the real delivery mode for the message. The JMS specification allows the JMS client to call setJMSDeliveryMode but that is to be overridden by the JMS provider when the message is sent. However, until the message is sent, the value set by the JMS client must be returned.
        Overrides:
        setDeliveryMode in class WmMessageImpl

      • setDestination

        protected void setDestination​(WmDestinationImpl destination)
                       throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Method setDestination Internal method to set the real destination for the message. The JMS specification allows the JMS client to call setJMSDestination but that is to be overridden by the JMS provider when the message is sent. However, until the message is sent, the value set by the JMS client must be returned.
        Overrides:
        setDestination in class WmMessageImpl
        Parameters:
        destination - the real destination
        Throws:
        javax.jms.JMSException

      • setDoubleProperty

        public void setDoubleProperty​(java.lang.String name,
                              double value)
                       throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Sets a double property value with the specified name into the message.
        Specified by:
        setDoubleProperty in interface javax.jms.Message
        Overrides:
        setDoubleProperty in class WmMessageImpl
        Parameters:
        name - the name of the double property
        value - the double property value to set
        Throws:
        javax.jms.JMSException - if the JMS provider fails to set the property due to some internal error.
        javax.jms.MessageNotWriteableException - if properties are read-only

      • setExpiration

        protected void setExpiration​(long expiration)
        Description copied from class: WmMessageImpl
        Internal method to set the real expiration for the message. The JMS specification allows the JMS client to call setJMSExpiration but that is to be overridden by the JMS provider when the message is sent. However, until the message is sent, the value set by the JMS client must be returned.
        Overrides:
        setExpiration in class WmMessageImpl

      • setFloatProperty

        public void setFloatProperty​(java.lang.String name,
                             float value)
                      throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Sets a float property value with the specified name into the message.
        Specified by:
        setFloatProperty in interface javax.jms.Message
        Overrides:
        setFloatProperty in class WmMessageImpl
        Parameters:
        name - the name of the float property
        value - the float property value to set
        Throws:
        javax.jms.JMSException - if the JMS provider fails to set the property due to some internal error.
        javax.jms.MessageNotWriteableException - if properties are read-only

      • setIntProperty

        public void setIntProperty​(java.lang.String name,
                           int value)
                    throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Sets an int property value with the specified name into the message.
        Specified by:
        setIntProperty in interface javax.jms.Message
        Overrides:
        setIntProperty in class WmMessageImpl
        Parameters:
        name - the name of the int property
        value - the int property value to set
        Throws:
        javax.jms.JMSException - if the JMS provider fails to set the property due to some internal error.
        javax.jms.MessageNotWriteableException - if properties are read-only

      • setJMSCorrelationID

        public void setJMSCorrelationID​(java.lang.String correlationID)
                         throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Sets the correlation ID for the message.

        A client can use the JMSCorrelationID header field to link one message with another. A typical use is to link a response message with its request message.

        JMSCorrelationID can hold one of the following:

        • A provider-specific message ID
        • An application-specific String
        • A provider-native byte[] value

        Since each message sent by a JMS provider is assigned a message ID value, it is convenient to link messages via message ID. All message ID values must start with the 'ID:' prefix.

        In some cases, an application (made up of several clients) needs to use an application-specific value for linking messages. For instance, an application may use JMSCorrelationID to hold a value referencing some external information. Application-specified values must not start with the 'ID:' prefix; this is reserved for provider-generated message ID values.

        If a provider supports the native concept of correlation ID, a JMS client may need to assign specific JMSCorrelationID values to match those expected by clients that do not use the JMS API. A byte[] value is used for this purpose. JMS providers without native correlation ID values are not required to support byte[] values. The use of a byte[] value for JMSCorrelationID is non-portable.

        Specified by:
        setJMSCorrelationID in interface javax.jms.Message
        Overrides:
        setJMSCorrelationID in class WmMessageImpl
        Parameters:
        correlationID - the message ID of a message being referred to
        Throws:
        javax.jms.JMSException - if the JMS provider fails to set the correlation ID due to some internal error.

      • setJMSCorrelationIDAsBytes

        public void setJMSCorrelationIDAsBytes​(byte[] correlationID)
                                throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Sets the correlation ID as an array of bytes for the message.

        The array is copied before the method returns, so future modifications to the array will not alter this message header.

        If a provider supports the native concept of correlation ID, a JMS client may need to assign specific JMSCorrelationID values to match those expected by native messaging clients. JMS providers without native correlation ID values are not required to support this method and its corresponding get method; their implementation may throw a java.lang.UnsupportedOperationException.

        The use of a byte[] value for JMSCorrelationID is non-portable.

        Specified by:
        setJMSCorrelationIDAsBytes in interface javax.jms.Message
        Overrides:
        setJMSCorrelationIDAsBytes in class WmMessageImpl
        Parameters:
        correlationID - the correlation ID value as an array of bytes
        Throws:
        javax.jms.JMSException - if the JMS provider fails to set the correlation ID due to some internal error.

      • setJMSDeliveryMode

        public void setJMSDeliveryMode​(int deliveryMode)
                        throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Sets the DeliveryMode value for this message.

        JMS providers set this field when a message is sent. This method can be used to change the value for a message that has been received.

        Specified by:
        setJMSDeliveryMode in interface javax.jms.Message
        Overrides:
        setJMSDeliveryMode in class WmMessageImpl
        Parameters:
        deliveryMode - the delivery mode for this message
        Throws:
        javax.jms.JMSException - if the JMS provider fails to set the delivery mode due to some internal error.

      • setJMSDestination

        public void setJMSDestination​(javax.jms.Destination destination)
                       throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Sets the Destination object for this message.

        JMS providers set this field when a message is sent. This method can be used to change the value for a message that has been received.

        Specified by:
        setJMSDestination in interface javax.jms.Message
        Overrides:
        setJMSDestination in class WmMessageImpl
        Parameters:
        destination - the destination for this message
        Throws:
        javax.jms.JMSException - if the JMS provider fails to set the destination due to some internal error.

      • setJMSExpiration

        public void setJMSExpiration​(long expiration)
                      throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Sets the message's expiration value.

        JMS providers set this field when a message is sent. This method can be used to change the value for a message that has been received.

        Specified by:
        setJMSExpiration in interface javax.jms.Message
        Overrides:
        setJMSExpiration in class WmMessageImpl
        Parameters:
        expiration - the message's expiration time
        Throws:
        javax.jms.JMSException - if the JMS provider fails to set the message expiration due to some internal error.

      • setJMSMessageID

        public void setJMSMessageID​(java.lang.String id)
                     throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Sets the message ID.

        JMS providers set this field when a message is sent. This method can be used to change the value for a message that has been received.

        Specified by:
        setJMSMessageID in interface javax.jms.Message
        Overrides:
        setJMSMessageID in class WmMessageImpl
        Parameters:
        id - the ID of the message
        Throws:
        javax.jms.JMSException - if the JMS provider fails to set the message ID due to some internal error.

      • setJMSPriority

        public void setJMSPriority​(int priority)
                    throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Sets the priority level for this message.

        JMS providers set this field when a message is sent. This method can be used to change the value for a message that has been received.

        Specified by:
        setJMSPriority in interface javax.jms.Message
        Overrides:
        setJMSPriority in class WmMessageImpl
        Parameters:
        priority - the priority of this message
        Throws:
        javax.jms.JMSException - if the JMS provider fails to set the message priority due to some internal error.

      • setJMSRedelivered

        public void setJMSRedelivered​(boolean redelivered)
                       throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Specifies whether this message is being redelivered.

        This field is set at the time the message is delivered. This method can be used to change the value for a message that has been received.

        Specified by:
        setJMSRedelivered in interface javax.jms.Message
        Overrides:
        setJMSRedelivered in class WmMessageImpl
        Parameters:
        redelivered - an indication of whether this message is being redelivered
        Throws:
        javax.jms.JMSException - if the JMS provider fails to set the redelivered state due to some internal error.

      • setJMSReplyTo

        public void setJMSReplyTo​(javax.jms.Destination replyTo)
                   throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Sets the Destination object to which a reply to this message should be sent.

        The JMSReplyTo header field contains the destination where a reply to the current message should be sent. If it is null, no reply is expected. The destination may be either a Queue object or a Topic object.

        Messages sent with a null JMSReplyTo value may be a notification of some event, or they may just be some data the sender thinks is of interest.

        Messages with a JMSReplyTo value typically expect a response. A response is optional; it is up to the client to decide. These messages are called requests. A message sent in response to a request is called a reply.

        In some cases a client may wish to match a request it sent earlier with a reply it has just received. The client can use the JMSCorrelationID header field for this purpose.

        Specified by:
        setJMSReplyTo in interface javax.jms.Message
        Overrides:
        setJMSReplyTo in class WmMessageImpl
        Parameters:
        replyTo - Destination to which to send a response to this message
        Throws:
        javax.jms.JMSException - if the JMS provider fails to set the JMSReplyTo destination due to some internal error.

      • setJMSTimestamp

        public void setJMSTimestamp​(long timestamp)
                     throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Sets the message timestamp.

        JMS providers set this field when a message is sent. This method can be used to change the value for a message that has been received.

        Specified by:
        setJMSTimestamp in interface javax.jms.Message
        Overrides:
        setJMSTimestamp in class WmMessageImpl
        Parameters:
        timestamp - the timestamp for this message
        Throws:
        javax.jms.JMSException - if the JMS provider fails to set the timestamp due to some internal error.

      • setJMSType

        public void setJMSType​(java.lang.String type)
                throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Sets the message type.

        Some JMS providers use a message repository that contains the definitions of messages sent by applications. The JMSType header field may reference a message's definition in the provider's repository.

        The JMS API does not define a standard message definition repository, nor does it define a naming policy for the definitions it contains.

        Some messaging systems require that a message type definition for each application message be created and that each message specify its type. In order to work with such JMS providers, JMS clients should assign a value to JMSType, whether the application makes use of it or not. This ensures that the field is properly set for those providers that require it.

        To ensure portability, JMS clients should use symbolic values for JMSType that can be configured at installation time to the values defined in the current provider's message repository. If string literals are used, they may not be valid type names for some JMS providers.

        Specified by:
        setJMSType in interface javax.jms.Message
        Overrides:
        setJMSType in class WmMessageImpl
        Parameters:
        type - the message type
        Throws:
        javax.jms.JMSException - if the JMS provider fails to set the message type due to some internal error.

      • setLongProperty

        public void setLongProperty​(java.lang.String name,
                            long value)
                     throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Sets a long property value with the specified name into the message.
        Specified by:
        setLongProperty in interface javax.jms.Message
        Overrides:
        setLongProperty in class WmMessageImpl
        Parameters:
        name - the name of the long property
        value - the long property value to set
        Throws:
        javax.jms.JMSException - if the JMS provider fails to set the property due to some internal error.
        javax.jms.MessageNotWriteableException - if properties are read-only

      • setMessageID

        protected void setMessageID​(java.lang.String id)
        Description copied from class: WmMessageImpl
        Internal method to set the real id for the message. The JMS specification allows the JMS client to call setJMSMessageID but that is to be overridden by the JMS provider when the message is sent. However, until the message is sent, the value set by the JMS client must be returned.
        Overrides:
        setMessageID in class WmMessageImpl
        Parameters:
        id - the real message id

      • setObjectProperty

        public void setObjectProperty​(java.lang.String name,
                              java.lang.Object value)
                       throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Sets a Java object property value with the specified name into the message.

        Note that this method works only for the objectified primitive object types (Integer, Double, Long ...) and String objects.

        Specified by:
        setObjectProperty in interface javax.jms.Message
        Overrides:
        setObjectProperty in class WmMessageImpl
        Parameters:
        name - the name of the Java object property
        value - the Java object property value to set
        Throws:
        javax.jms.JMSException - if the JMS provider fails to set the property due to some internal error.
        javax.jms.MessageFormatException - if the object is invalid
        javax.jms.MessageNotWriteableException - if properties are read-only

      • setPreAcknowledgement

        public void setPreAcknowledgement​(java.lang.String preack)
                           throws javax.jms.JMSException
        Overrides:
        setPreAcknowledgement in class WmMessageImpl
        Throws:
        javax.jms.JMSException

      • setPriority

        protected void setPriority​(int priority)
        Description copied from class: WmMessageImpl
        Internal method to set the real priority for the message. The JMS specification allows the JMS client to call setJMSPriority but that is to be overridden by the JMS provider when the message is sent. However, until the message is sent, the value set by the JMS client must be returned.
        Overrides:
        setPriority in class WmMessageImpl

      • setReceiveCount

        protected void setReceiveCount​(int receiveCount)
        Description copied from class: WmMessageImpl
        Internal method to set the message receive count.
        Overrides:
        setReceiveCount in class WmMessageImpl
        Parameters:
        receiveCount - the message receive count

      • setShortProperty

        public void setShortProperty​(java.lang.String name,
                             short value)
                      throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Sets a short property value with the specified name into the message.
        Specified by:
        setShortProperty in interface javax.jms.Message
        Overrides:
        setShortProperty in class WmMessageImpl
        Parameters:
        name - the name of the short property
        value - the short property value to set
        Throws:
        javax.jms.JMSException - if the JMS provider fails to set the property due to some internal error.
        javax.jms.MessageNotWriteableException - if properties are read-only

      • setStringProperty

        public void setStringProperty​(java.lang.String name,
                              java.lang.String value)
                       throws javax.jms.JMSException
        Description copied from class: WmMessageImpl
        Sets a String property value with the specified name into the message.
        Specified by:
        setStringProperty in interface javax.jms.Message
        Overrides:
        setStringProperty in class WmMessageImpl
        Parameters:
        name - the name of the String property
        value - the String property value to set
        Throws:
        javax.jms.JMSException - if the JMS provider fails to set the property due to some internal error.
        javax.jms.MessageNotWriteableException - if properties are read-only

      • setTimestamp

        protected void setTimestamp​(long timestamp)
        Description copied from class: WmMessageImpl
        Internal method to set the real timestamp for the message. The JMS specification allows the JMS client to call setJMSTimestamp but that is to be overridden by the JMS provider when the message is sent. However, until the message is sent, the value set by the JMS client must be returned.
        Overrides:
        setTimestamp in class WmMessageImpl

      • setTransactionID

        protected void setTransactionID​(long transactionID)
        Description copied from class: WmMessageImpl
        Internal method to set the message's transaction ID.
        Overrides:
        setTransactionID in class WmMessageImpl
        Parameters:
        transactionID - the transaction ID of this message

      • setUUID

        public void setUUID​(java.lang.String uuid)
             throws javax.jms.JMSException
        Overrides:
        setUUID in class WmMessageImpl
        Throws:
        javax.jms.JMSException

      • writeExternal

        public void writeExternal​(java.io.ObjectOutput out)
                   throws java.io.IOException
        Specified by:
        writeExternal in interface java.io.Externalizable
        Overrides:
        writeExternal in class WmMessageImpl
        Throws:
        java.io.IOException
        See Also:
        Externalizable.writeExternal(java.io.ObjectOutput)