com.ibm.websphere.sib.admin

Interface SIBQueuedMessage

  • All Known Subinterfaces:
    SIBQueuedMessageDetail


    public interface SIBQueuedMessage
    This class wrappers the overall state of a SIB message stored on a message point.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      int getApproximateLength()
      Returns the approximate length of the queued message.
      java.lang.String getId()
      Returns the internal unique id assigned to this message by the message processing component.
      java.lang.String getName()
      Returns the name of the message as assigned by the messaging engine.
      java.lang.String getState()
      Returns a String representing the current state of the queued message.
      java.lang.String getSystemMessageId()
      Returns the system message id as assigned by the messaging engine.
      java.lang.String getTransactionId()
      Returns the transactionId of the transaction that this message is enrolled in, if one exists.
      java.lang.String getType()
      Returns the specific message type.
    • Method Detail

      • getId

        java.lang.String getId()
        Returns the internal unique id assigned to this message by the message processing component.
        Returns:
        String Unique internal message id
      • getName

        java.lang.String getName()
        Returns the name of the message as assigned by the messaging engine.
        Returns:
        String Name of message
      • getApproximateLength

        int getApproximateLength()
                                 throws java.lang.Exception
        Returns the approximate length of the queued message.
        Returns:
        int Approximate length of the message.
        Throws:
        java.lang.Exception
      • getState

        java.lang.String getState()
        Returns a String representing the current state of the queued message. A message can have the following states:

        UNLOCKED
        The message is available for consumption

        LOCKED
        The message is currently unavailable. The message will temporarily be in this state possible due to being consumed by a non-transacted consumer.

        REMOTE_LOCKED
        The message is currently locked to a consumer attached to another, remote, messaging engine in the bus. The message will remain locked until the remote messaging engine responds with a decision on the message. If the remote messaging engine is stopped the message will remain locked until the messaging engine is re-started. A corresponding message request will identify the remote Messaging Engine.

        REMOVING
        The message is currently being removed under a transaction. The message will be in this state until the transaction commits or rolls back, if this state persists investigate the state of the transaction returned from getTransactionId()

        COMMMITTING
        The message is currently being added under a transaction. The message will be in this state until the transaction commits or rolls back, if this state persists investigate the state of the transaction returned from getTransactionId()

        PENDING_RETRY
        The message is currently unavailable before being eligible for a retry. This may be due to an Message Driven Bean being configured to delay failing message retries.

        BLOCKED
        This message is currently unavailable due to the message point being blocked by the first message on the queue that has reached its maximum failed delivery limit but no exception destination is configured. Identify the first message and resolve the reason that is is failing to be consumed.

        Returns:
        String The message processing state.
      • getTransactionId

        java.lang.String getTransactionId()
        Returns the transactionId of the transaction that this message is enrolled in, if one exists.
        Returns:
        String The transactionId.
      • getType

        java.lang.String getType()
                                 throws java.lang.Exception
        Returns the specific message type.
        Returns:
        String The specific type of message.
        Throws:
        java.lang.Exception
      • getSystemMessageId

        java.lang.String getSystemMessageId()
        Returns the system message id as assigned by the messaging engine.
        Returns:
        String The system message id.
IBM WebSphere Application ServerTM
Release 9.0