IBM WebSphere Application ServerTM
Release 7

com.ibm.websphere.sib.admin
Interface SIBQueuedMessageDetail

All Superinterfaces:
SIBQueuedMessage

public interface SIBQueuedMessageDetail
extends SIBQueuedMessage

This class wrappers the detailed state of a SIB message stored on a message point.


Method Summary
 java.lang.String getApiCorrelationId()
          Returns the API correlation id.
 java.lang.String getApiFormat()
          Returns the API format (JMS:bytes, JMS:text, JMS:object, JMS:stream, JMS:map)
 java.lang.String getApiMessageId()
          Returns the API message id.
 java.lang.String getApiUserid()
          Returns the API user id.
 java.lang.String getBusDiscriminator()
          Returns the discriminator used by the message.
 java.lang.Integer getBusPriority()
          Returns the priority of the message 0-9.
 java.lang.String getBusReliability()
          Returns the message reliability (BestEffortNonPersistent, ExpressNonPersistent, ReliableNonPersistent, ReliablePersistent, AssuredPersistent).
 java.lang.String getBusReplyDiscriminator()
          Returns the reply discriminator.
 java.lang.Integer getBusReplyPriority()
          Returns the reply priority of the message 0-9.
 java.lang.String getBusReplyReliability()
          Returns the reply message reliability (BestEffortNonPersistent, ExpressNonPersistent, ReliableNonPersistent, ReliablePersistent, AssuredPersistent).
 java.lang.Long getBusReplyTimeToLive()
          Returns the time to live in milliseconds of the reply message.
 java.lang.String getBusSystemMessageId()
          Returns the system message id as assigned by the messaging engine.
 java.lang.Long getBusTimeToLive()
          Returns the time to live in milliseconds.
 java.lang.String getExceptionMessage()
          Returns the message text associated with the exceptioning of the message. when the message was exceptioned.
 java.lang.Long getExceptionTimestamp()
          Returns the timestamp in milliseconds since 1 Jan 1970 of when the message was exceptioned.
 java.lang.String getJmsDeliveryMode()
          Returns the JMS delivery mode (PERSISTENT, NON_PERSISTENT).
 java.lang.String getJmsDestination()
          Returns the JMS destination name.
 java.lang.Long getJmsExpiration()
          Returns the JMS expriation time in milliseconds.
 java.lang.Boolean getJmsRedelivered()
          Returns whether the JMS message has been redelivered.
 java.lang.String getJmsReplyTo()
          Returns the JMS reply to destination name.
 java.lang.String getJmsType()
          Returns the JMS message type (TEXT, BYTES, OBJECT, STREAM, MAP).
 java.lang.String getJmsxAppId()
          Returns the JMS AppId
 int getJmsxDeliveryCount()
          Returns the JMS redelivery count.
 byte[] getJsApiMessageIdAsBytes()
          Returns the API message id.
 int getJsApproximateLength()
          Returns the approximate length of the queued message.
 byte[] getJsCorrelationIdAsBytes()
          Returns the correlation id.
 java.lang.Long getJsCurrentMEArrivalTimestamp()
          Returns the time in milliseconds since the message arrived at this messaging engine.
 java.lang.String getJsMessageType()
          Returns the SIB message type (JMS, TRM, SUBSCRIPTION, SDO, UNKNOWN).
 java.lang.Long getJsMessageWaitTime()
          Returns the time in milliseconds that the message has been waiting on this message point.
 java.lang.String getJsProducerType()
          Returns type of the producer of this message (MP, TRM, API, PSB, UNKNOWN).
 java.lang.Integer getJsRedeliveredCount()
          Returns the number of attempts to deliver this message.
 java.lang.String getJsSecurityUserid()
          Returns Security userid associated with this message.
 java.lang.Long getJsTimestamp()
          Returns the timestamp in milliseconds since 1 Jan 1970 of when the message was originally sent.
 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

java.lang.String getType()
Returns the specific message type.

Specified by:
getType in interface SIBQueuedMessage
Returns:
String The specific type of message.

getBusDiscriminator

java.lang.String getBusDiscriminator()
Returns the discriminator used by the message.

Returns:
String The discrimnator.

getBusPriority

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

Returns:
Integer message priority.

getBusReliability

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

Returns:
String message reliability

getBusTimeToLive

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

Returns:
Long message time to live.

getBusReplyDiscriminator

java.lang.String getBusReplyDiscriminator()
Returns the reply discriminator.

Returns:
String The message reply discriminator.

getBusReplyPriority

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

Returns:
Integer Reply message priority.

getBusReplyReliability

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

Returns:
String Reply message reliability

getBusReplyTimeToLive

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

Returns:
Long Reply message time to live.

getBusSystemMessageId

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

Returns:
String The system message id.

getExceptionTimestamp

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

Returns:
Long Exception timestamp.

getExceptionMessage

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.

getJsMessageType

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

Returns:
String SIB message type.

getJsApproximateLength

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

Returns:
int Approximate length of the message.

getJsTimestamp

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

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

Returns:
Long Wait time.

getJsCurrentMEArrivalTimestamp

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

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

Returns:
Integer Number of delivery attempts.

getJsSecurityUserid

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

Returns:
String Userid

getJsProducerType

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

Returns:
String Producer type.

getJsApiMessageIdAsBytes

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

Returns:
String API message id.

getJsCorrelationIdAsBytes

byte[] getJsCorrelationIdAsBytes()
Returns the correlation id.

Returns:
String Correlation id.

getApiMessageId

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

Returns:
String API message id.

getApiCorrelationId

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

Returns:
String API correlation id.

getApiUserid

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

Returns:
String API user id.

getApiFormat

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

Returns:
String API format.

getJmsDeliveryMode

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

Returns:
String JMS delivery mode.

getJmsExpiration

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

Returns:
Long JMS expiration time.

getJmsDestination

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

Returns:
String JMS destination name.

getJmsReplyTo

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

Returns:
String JMS reply to destination name.

getJmsRedelivered

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

Returns:
Boolean JMS redelivered.

getJmsType

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

Returns:
String JMS message type.

getJmsxDeliveryCount

int getJmsxDeliveryCount()
Returns the JMS redelivery count.

Returns:
int JMS redelivery count.

getJmsxAppId

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

Returns:
String JMS AppId.

IBM WebSphere Application ServerTM
Release 7