com.ibm.websphere.sib.admin

Interface SIBQueuedMessageDetail

All Superinterfaces:
SIBQueuedMessage

  1. public interface SIBQueuedMessageDetail
  2. extends SIBQueuedMessage
This class wrappers the detailed state of a SIB message stored on a message point.

Method Summary

Modifier and Type Method and Description
  1. java.lang.String
getApiCorrelationId()
Returns the API correlation id.
  1. java.lang.String
getApiFormat()
Returns the API format (JMS:bytes, JMS:text, JMS:object, JMS:stream, JMS:map)
  1. java.lang.String
getApiMessageId()
Returns the API message id.
  1. java.lang.String
getApiUserid()
Returns the API user id.
  1. java.lang.String
getBusDiscriminator()
Returns the discriminator used by the message.
  1. java.lang.Integer
getBusPriority()
Returns the priority of the message 0-9.
  1. java.lang.String
getBusReliability()
Returns the message reliability (BestEffortNonPersistent, ExpressNonPersistent, ReliableNonPersistent, ReliablePersistent, AssuredPersistent).
  1. java.lang.String
getBusReplyDiscriminator()
Returns the reply discriminator.
  1. java.lang.Integer
getBusReplyPriority()
Returns the reply priority of the message 0-9.
  1. java.lang.String
getBusReplyReliability()
Returns the reply message reliability (BestEffortNonPersistent, ExpressNonPersistent, ReliableNonPersistent, ReliablePersistent, AssuredPersistent).
  1. java.lang.Long
getBusReplyTimeToLive()
Returns the time to live in milliseconds of the reply message.
  1. java.lang.String
getBusSystemMessageId()
Returns the system message id as assigned by the messaging engine.
  1. java.lang.Long
getBusTimeToLive()
Returns the time to live in milliseconds.
  1. java.lang.String
getExceptionMessage()
Returns the message text associated with the exceptioning of the message. when the message was exceptioned.
  1. java.lang.String
getExceptionProblemDestination()
Returns the name of the destination where the problem occurred that caused this message to be exceptioned.
  1. java.lang.String
getExceptionProblemSubscription()
Returns the name of the subscription that the message was intended for before being exceptioned.
  1. java.lang.Long
getExceptionTimestamp()
Returns the timestamp in milliseconds since 1 Jan 1970 of when the message was exceptioned.
  1. java.lang.String
getJmsDeliveryMode()
Returns the JMS delivery mode (PERSISTENT, NON_PERSISTENT).
  1. java.lang.String
getJmsDestination()
Returns the JMS destination name.
  1. java.lang.Long
getJmsExpiration()
Returns the JMS expriation time in milliseconds.
  1. java.lang.Boolean
getJmsRedelivered()
Returns whether the JMS message has been redelivered.
  1. java.lang.String
getJmsReplyTo()
Returns the JMS reply to destination name.
  1. java.lang.String
getJmsType()
Returns the JMS message type (TEXT, BYTES, OBJECT, STREAM, MAP).
  1. java.lang.String
getJmsxAppId()
Returns the JMS AppId
  1. int
getJmsxDeliveryCount()
Returns the JMS redelivery count.
  1. byte[]
getJsApiMessageIdAsBytes()
Returns the API message id.
  1. int
getJsApproximateLength()
Returns the approximate length of the queued message.
  1. byte[]
getJsCorrelationIdAsBytes()
Returns the correlation id.
  1. java.lang.Long
getJsCurrentMEArrivalTimestamp()
Returns the time in milliseconds since the message arrived at this messaging engine.
  1. java.lang.String
getJsMessageType()
Returns the SIB message type (JMS, TRM, SUBSCRIPTION, SDO, UNKNOWN).
  1. java.lang.Long
getJsMessageWaitTime()
Returns the time in milliseconds that the message has been waiting on this message point.
  1. java.lang.String
getJsProducerType()
Returns type of the producer of this message (MP, TRM, API, PSB, UNKNOWN).
  1. java.lang.Integer
getJsRedeliveredCount()
Returns the number of attempts to deliver this message.
  1. java.lang.String
getJsSecurityUserid()
Returns Security userid associated with this message.
  1. java.lang.Long
getJsTimestamp()
Returns the timestamp in milliseconds since 1 Jan 1970 of when the message was originally sent.
  1. java.lang.String
getType()
Returns the specific message type.
Methods inherited from interface com.ibm.websphere.sib.admin.SIBQueuedMessage
getApproximateLength, getId, getName, getState, getSystemMessageId, getTransactionId

Method Detail

getType

  1. java.lang.String getType()
Returns the specific message type.
Specified by:
getType in interface SIBQueuedMessage
Returns:
String The specific type of message.

getBusDiscriminator

  1. java.lang.String getBusDiscriminator( )
Returns the discriminator used by the message.
Returns:
String The discrimnator.

getBusPriority

  1. java.lang.Integer getBusPriority( )
Returns the priority of the message 0-9.
Returns:
Integer message priority.

getBusReliability

  1. java.lang.String getBusReliability( )
Returns the message reliability (BestEffortNonPersistent, ExpressNonPersistent, ReliableNonPersistent, ReliablePersistent, AssuredPersistent).
Returns:
String message reliability

getBusTimeToLive

  1. java.lang.Long getBusTimeToLive( )
Returns the time to live in milliseconds.
Returns:
Long message time to live.

getBusReplyDiscriminator

  1. java.lang.String getBusReplyDiscriminator( )
Returns the reply discriminator.
Returns:
String The message reply discriminator.

getBusReplyPriority

  1. java.lang.Integer getBusReplyPriority( )
Returns the reply priority of the message 0-9.
Returns:
Integer Reply message priority.

getBusReplyReliability

  1. java.lang.String getBusReplyReliability( )
Returns the reply message reliability (BestEffortNonPersistent, ExpressNonPersistent, ReliableNonPersistent, ReliablePersistent, AssuredPersistent).
Returns:
String Reply message reliability

getBusReplyTimeToLive

  1. java.lang.Long getBusReplyTimeToLive( )
Returns the time to live in milliseconds of the reply message.
Returns:
Long Reply message time to live.

getBusSystemMessageId

  1. java.lang.String getBusSystemMessageId( )
Returns the system message id as assigned by the messaging engine.
Returns:
String The system message id.

getExceptionTimestamp

  1. java.lang.Long getExceptionTimestamp( )
Returns the timestamp in milliseconds since 1 Jan 1970 of when the message was exceptioned.
Returns:
Long Exception timestamp.

getExceptionMessage

  1. java.lang.String getExceptionMessage( )
Returns the message text associated with the exceptioning of the message. when the message was exceptioned.
Returns:
String Exception message text.

getExceptionProblemSubscription

  1. java.lang.String getExceptionProblemSubscription( )
Returns the name of the subscription that the message was intended for before being exceptioned.
Returns:
String Problem subscription name

getExceptionProblemDestination

  1. java.lang.String getExceptionProblemDestination( )
Returns the name of the destination where the problem occurred that caused this message to be exceptioned.
Returns:
String Problem destination name.

getJsMessageType

  1. java.lang.String getJsMessageType( )
Returns the SIB message type (JMS, TRM, SUBSCRIPTION, SDO, UNKNOWN).
Returns:
String SIB message type.

getJsApproximateLength

  1. int getJsApproximateLength()
Returns the approximate length of the queued message.
Returns:
int Approximate length of the message.

getJsTimestamp

  1. java.lang.Long getJsTimestamp()
Returns the timestamp in milliseconds since 1 Jan 1970 of when the message was originally sent.
Returns:
Long Sending timestamp.

getJsMessageWaitTime

  1. java.lang.Long getJsMessageWaitTime( )
Returns the time in milliseconds that the message has been waiting on this message point.
Returns:
Long Wait time.

getJsCurrentMEArrivalTimestamp

  1. java.lang.Long getJsCurrentMEArrivalTimestamp( )
Returns the time in milliseconds since the message arrived at this messaging engine.
Returns:
Long Time since messaging engine arrival.

getJsRedeliveredCount

  1. java.lang.Integer getJsRedeliveredCount( )
Returns the number of attempts to deliver this message.
Returns:
Integer Number of delivery attempts.

getJsSecurityUserid

  1. java.lang.String getJsSecurityUserid( )
Returns Security userid associated with this message.
Returns:
String Userid

getJsProducerType

  1. java.lang.String getJsProducerType( )
Returns type of the producer of this message (MP, TRM, API, PSB, UNKNOWN).
Returns:
String Producer type.

getJsApiMessageIdAsBytes

  1. byte[] getJsApiMessageIdAsBytes( )
Returns the API message id.
Returns:
String API message id.

getJsCorrelationIdAsBytes

  1. byte[] getJsCorrelationIdAsBytes( )
Returns the correlation id.
Returns:
String Correlation id.

getApiMessageId

  1. java.lang.String getApiMessageId( )
Returns the API message id.
Returns:
String API message id.

getApiCorrelationId

  1. java.lang.String getApiCorrelationId( )
Returns the API correlation id.
Returns:
String API correlation id.

getApiUserid

  1. java.lang.String getApiUserid()
Returns the API user id.
Returns:
String API user id.

getApiFormat

  1. java.lang.String getApiFormat()
Returns the API format (JMS:bytes, JMS:text, JMS:object, JMS:stream, JMS:map)
Returns:
String API format.

getJmsDeliveryMode

  1. java.lang.String getJmsDeliveryMode( )
Returns the JMS delivery mode (PERSISTENT, NON_PERSISTENT).
Returns:
String JMS delivery mode.

getJmsExpiration

  1. java.lang.Long getJmsExpiration( )
Returns the JMS expriation time in milliseconds.
Returns:
Long JMS expiration time.

getJmsDestination

  1. java.lang.String getJmsDestination( )
Returns the JMS destination name.
Returns:
String JMS destination name.

getJmsReplyTo

  1. java.lang.String getJmsReplyTo( )
Returns the JMS reply to destination name.
Returns:
String JMS reply to destination name.

getJmsRedelivered

  1. java.lang.Boolean getJmsRedelivered( )
Returns whether the JMS message has been redelivered.
Returns:
Boolean JMS redelivered.

getJmsType

  1. java.lang.String getJmsType()
Returns the JMS message type (TEXT, BYTES, OBJECT, STREAM, MAP).
Returns:
String JMS message type.

getJmsxDeliveryCount

  1. int getJmsxDeliveryCount()
Returns the JMS redelivery count.
Returns:
int JMS redelivery count.

getJmsxAppId

  1. java.lang.String getJmsxAppId()
Returns the JMS AppId
Returns:
String JMS AppId.