com.ibm.websphere.webmsg.publisher.jndijms

Class JmsWebMsg

  • java.lang.Object
    • com.ibm.websphere.webmsg.publisher.jndijms.JmsWebMsg
  • All Implemented Interfaces:
    WebMessage
    Direct Known Subclasses:
    JmsWebObjectMsg, JmsWebTextMsg


    public abstract class JmsWebMsg
    extends java.lang.Object
    implements WebMessage
    Abstract JMS implementation of a Web Message. For use with WebSphere Service Integration Bus.
    • Constructor Summary

      Constructors 
      Constructor and Description
      JmsWebMsg(java.lang.String type, java.lang.String target)
      Constructor
      JmsWebMsg(java.lang.String type, java.lang.String destination, java.lang.String target)
      Constructor
      JmsWebMsg(java.lang.String type, java.lang.String destination, java.lang.String target, long messageID)
      Constructor
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      abstract java.lang.Object getData()
      Get data as Object
      java.lang.String getDestination()
      Get destination
      int getJmsDeliveryMode()
      Gets the JMS DeliveryMode constant for this event.
      abstract javax.jms.Message getJmsMessage(javax.jms.Session session)
      Given a JMS session, return new JMS message for this web message.
      int getJmsPriority()
      Gets the JMS Priority constant for this event, in the range 0-9.
      long getJmsTimeToLive()
      Gets the JMS Time To Live value for this event in milliseconds.
      long getMessageID()
      Get message ID.
      java.lang.String getMessageType()
      Get message type.
      java.lang.String getTarget()
      Get message target.
      void setDestination(java.lang.String dest)
      Set destination (SIBus specific)
      void setJmsDeliveryMode(int jmsDeliveryMode)
      Sets the JMS DeliveryMode constant for this event.
      void setJmsPriority(int jmsPriority)
      Sets the JMS Priority constant for this event, in the range 0-9.
      void setJmsTimeToLive(long jmsTimeToLive)
      Sets the JMS Time To Live value for this event in milliseconds.
      void setTarget(java.lang.String tar)
      set target
      • Methods inherited from class java.lang.Object

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

      • JmsWebMsg

        public JmsWebMsg(java.lang.String type,
                 java.lang.String target)
        Constructor
        Parameters:
        type - Type of message
        target - Target for message
      • JmsWebMsg

        public JmsWebMsg(java.lang.String type,
                 java.lang.String destination,
                 java.lang.String target)
        Constructor
        Parameters:
        type - Type of message
        destination - Destination where message should be sent. (SIBus specific)
        target - Target for message.
      • JmsWebMsg

        public JmsWebMsg(java.lang.String type,
                 java.lang.String destination,
                 java.lang.String target,
                 long messageID)
        Constructor
        Parameters:
        type - Type of message
        destination - Destination where message should be sent. (SIBus specific)
        target - Target for message
        messageID - Message ID
    • Method Detail

      • getData

        public abstract java.lang.Object getData()
        Get data as Object
        Specified by:
        getData in interface WebMessage
        Returns:
        the data attached to the message as a Java Object.
      • getJmsMessage

        public abstract javax.jms.Message getJmsMessage(javax.jms.Session session)
                                                 throws javax.jms.JMSException
        Given a JMS session, return new JMS message for this web message.
        Parameters:
        session - Existing JMS session.
        Returns:
        JMS Message
        Throws:
        javax.jms.JMSException - If error creating message.
      • getMessageID

        public long getMessageID()
        Get message ID.
        Specified by:
        getMessageID in interface WebMessage
        Returns:
        Returns the messageID.
      • getMessageType

        public java.lang.String getMessageType()
        Get message type.
        Specified by:
        getMessageType in interface WebMessage
        Returns:
        Message type.
      • getTarget

        public java.lang.String getTarget()
        Get message target.
        Specified by:
        getTarget in interface WebMessage
        Returns:
        Returns the topic.
      • getDestination

        public java.lang.String getDestination()
        Get destination
        Returns:
      • setDestination

        public void setDestination(java.lang.String dest)
        Set destination (SIBus specific)
        Parameters:
        dest -
      • setTarget

        public void setTarget(java.lang.String tar)
        set target
        Parameters:
        tar -
      • getJmsDeliveryMode

        public int getJmsDeliveryMode()
        Gets the JMS DeliveryMode constant for this event.
        See Also:
        DeliveryMode.PERSISTENT, DeliveryMode.NON_PERSISTENT, Message.DEFAULT_DELIVERY_MODE
      • setJmsDeliveryMode

        public void setJmsDeliveryMode(int jmsDeliveryMode)
        Sets the JMS DeliveryMode constant for this event.
        See Also:
        DeliveryMode.PERSISTENT, DeliveryMode.NON_PERSISTENT, Message.DEFAULT_DELIVERY_MODE
      • getJmsPriority

        public int getJmsPriority()
        Gets the JMS Priority constant for this event, in the range 0-9.
        See Also:
        Message.DEFAULT_PRIORITY
      • setJmsPriority

        public void setJmsPriority(int jmsPriority)
        Sets the JMS Priority constant for this event, in the range 0-9.
        See Also:
        Message.DEFAULT_PRIORITY
      • getJmsTimeToLive

        public long getJmsTimeToLive()
        Gets the JMS Time To Live value for this event in milliseconds.
        See Also:
        Message.DEFAULT_TIME_TO_LIVE
      • setJmsTimeToLive

        public void setJmsTimeToLive(long jmsTimeToLive)
        Sets the JMS Time To Live value for this event in milliseconds.
        See Also:
        Message.DEFAULT_TIME_TO_LIVE
IBM WebSphere Application Server [webmsg.publisher]