Package weblogic.management.runtime

Interface JMSServerRuntimeMBean

All Superinterfaces:

CursorRuntimeMBean, javax.management.DynamicMBean, HealthFeedback, JMSMessageCursorRuntimeMBean, javax.management.MBeanRegistration, MessageCursorRuntimeMBean, javax.management.NotificationBroadcaster, RuntimeMBean, WebLogicMBean

public interface JMSServerRuntimeMBean
extends JMSMessageCursorRuntimeMBean, HealthFeedback

This class is used for monitoring a WebLogic JMS server.

Method Summary

Modifier and Type	Method	Description
TransactionVBean[]	currentTransactions()	Returns an array of TransactionVBean objects representing transactions that exist on this JMS server in any state.
java.lang.Void	forceCommit(java.lang.String xid)	Causes the work associated with the specified transaction branch to be committed.
java.lang.Void	forceRollback(java.lang.String xid)	Causes the work associated with the specified transaction branch to be rolled back.
long	getBytesCurrentCount()	The current number of bytes stored on this JMS server.
long	getBytesHighCount()	The peak number of bytes stored in the JMS server since the last reset.
long	getBytesPageableCurrentCount()	Return the total number of bytes in all the messages that are currently available to be paged out, but which have not yet been paged out.
long	getBytesPagedInTotalCount()	Return the total number of bytes that were read from the paging directory since the JMS server was started.
long	getBytesPagedOutTotalCount()	Return the total number of bytes that were written to the paging directory since the JMS server was started.
long	getBytesPendingCount()	The current number of bytes pending (unacknowledged or uncommitted) stored on this JMS server.
long	getBytesReceivedCount()	The number of bytes received on this JMS server since the last reset.
long	getBytesThresholdTime()	The amount of time in the threshold condition since the last reset.
java.lang.String	getConsumptionPausedState()	Returns the current consumption paused state of the JMSServer as string value.
JMSDestinationRuntimeMBean[]	getDestinations()	An array of destinations on this JMS server.
long	getDestinationsCurrentCount()	The current number of destinations for this JMS server.
long	getDestinationsHighCount()	The peak number of destinations on this JMS server since the last reset.
long	getDestinationsTotalCount()	The number of destinations instantiated on this JMS server since the last reset.
HealthState	getHealthState()	The health state of this JMS server.
java.lang.String	getInsertionPausedState()	Returns the current insertion paused state of the JMSServer as string value.
JMSMessagesVBean	getJMSMessagesByXid(java.lang.String xid, int max, java.lang.String[] sortOn, boolean[] ascending)	Returns a set of JMSMessageVBean objects that match the specified JMS message selector.
java.lang.String	getMessages(java.lang.String xid, java.lang.Integer timeoutSeconds)	Returns a set of messages that are associated with a JMS transaction branch.
long	getMessagesCurrentCount()	The current number of messages stored on this JMS server.
long	getMessagesHighCount()	The peak number of messages stored in the JMS server since the last reset.
int	getMessagesPageableCurrentCount()	Return the number of messages that are currently available for paging in this JMS server but have not yet been paged out.
int	getMessagesPagedInTotalCount()	Return the total number of messages that were read from the paging directory since the JMS server was started.
int	getMessagesPagedOutTotalCount()	Return the total number of messages that were written to the paging directory since the JMS server was started.
long	getMessagesPendingCount()	The current number of messages pending (unacknowledged or uncommitted) stored on this JMS server.
long	getMessagesReceivedCount()	The number of messages received on this destination since the last reset.
long	getMessagesThresholdTime()	The amount of time in the threshold condition since the last reset.
long	getPagingAllocatedIoBufferBytes()	See PersistentStoreRuntimeMBean.AllocatedIoBufferBytes
long	getPagingAllocatedWindowBufferBytes()	See PersistentStoreRuntimeMBean.AllocatedWindowBufferBytes
long	getPagingPhysicalWriteCount()	See PersistentStoreRuntimeMBean.PhysicalWriteCount
java.lang.String[]	getPendingTransactions()	Returns an array of Xids representing transaction branches that exist onthis JMS server in the pending state, i.e.
java.lang.String	getProductionPausedState()	Returns the current production paused state of the JMSServer as string value.
JMSSessionPoolRuntimeMBean[]	getSessionPoolRuntimes()	The session pools running on this JMS server.
long	getSessionPoolsCurrentCount()	The current number of session pools instantiated on this JMS server.
long	getSessionPoolsHighCount()	The peak number of session pools instantiated on this JMS server since the last reset.
long	getSessionPoolsTotalCount()	The number of session pools instantiated on this JMS server since the last reset.
java.lang.String[]	getTransactions()	Returns an array of Xids representing transaction branches that exist on this JMS server in any state.
java.lang.Integer	getTransactionStatus(java.lang.String xid)	Given an Xid this method returns the JTA status of the associated JMS transaction branch.
boolean	isConsumptionPaused()	Returns the current consumption paused state of the JMSServer as boolean value.
boolean	isInsertionPaused()	Returns the current insertion paused state of the JMSServer as boolean value.
boolean	isProductionPaused()	Returns the current production paused state of the JMSServer as boolean value.
void	pauseConsumption()	Pauses the consumption operation on all the destinations hosted by the JMSServer.
void	pauseInsertion()	Pauses the appearance of any messages on all the destinations of the JMSServer, that are result of the in-flight work completion on all the destinations hosted by this JMSServer.
void	pauseProduction()	Pauses the new message production on all the destinations hosted by the JMSServer.
void	resumeConsumption()	Resumes the consumption operation on all the destinations hosted by the JMSSever.
void	resumeInsertion()	Resumes the in-flight message production operation on all the destinations hosted by the JMSServer.
void	resumeProduction()	Resumes the new message production operation on all the destinations hosted by the JMSServer.

Methods inherited from interface weblogic.management.runtime.CursorRuntimeMBean

closeCursor, getCursorEndPosition, getCursorSize, getCursorStartPosition, getItems, getNext, getPrevious

Methods inherited from interface javax.management.DynamicMBean

getAttribute, getAttributes, invoke, setAttribute, setAttributes

Methods inherited from interface weblogic.management.runtime.JMSMessageCursorRuntimeMBean

sort

Methods inherited from interface javax.management.MBeanRegistration

postDeregister, postRegister, preRegister

Methods inherited from interface weblogic.management.runtime.MessageCursorRuntimeMBean

getMessage, getMessage

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Methods inherited from interface weblogic.management.runtime.RuntimeMBean

addPropertyChangeListener, removePropertyChangeListener

Methods inherited from interface weblogic.management.WebLogicMBean

getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent

Method Detail

getHealthState

HealthState getHealthState()

The health state of this JMS server.

Specified by:

getHealthState in interface HealthFeedback

Returns:

The healthState value

getSessionPoolRuntimes

JMSSessionPoolRuntimeMBean[] getSessionPoolRuntimes()

The session pools running on this JMS server.

Returns:

The sessionPoolRuntimes value

getSessionPoolsCurrentCount

long getSessionPoolsCurrentCount()

The current number of session pools instantiated on this JMS server.

Returns:

The sessionPoolsCurrentCount value

getSessionPoolsHighCount

long getSessionPoolsHighCount()

The peak number of session pools instantiated on this JMS server since the last reset.

Returns:

The sessionPoolsHighCount value

getSessionPoolsTotalCount

long getSessionPoolsTotalCount()

The number of session pools instantiated on this JMS server since the last reset.

Returns:

The sessionPoolsTotalCount value

getDestinations

JMSDestinationRuntimeMBean[] getDestinations()

An array of destinations on this JMS server.

Returns:

The destinations value

getDestinationsCurrentCount

long getDestinationsCurrentCount()

The current number of destinations for this JMS server.

Returns:

The destinationsCurrentCount value

getDestinationsHighCount

long getDestinationsHighCount()

The peak number of destinations on this JMS server since the last reset.

Returns:

The destinationsHighCount value

getDestinationsTotalCount

long getDestinationsTotalCount()

The number of destinations instantiated on this JMS server since the last reset.

Returns:

The destinationsTotalCount value

getMessagesCurrentCount

long getMessagesCurrentCount()

The current number of messages stored on this JMS server. This number does not include the pending messages.

Returns:

The messagesCurrentCount value

getMessagesPendingCount

long getMessagesPendingCount()

The current number of messages pending (unacknowledged or uncommitted) stored on this JMS server.

Pending messages are over and above the current number of messages.

Returns:

The messagesPendingCount value

getMessagesHighCount

long getMessagesHighCount()

The peak number of messages stored in the JMS server since the last reset.

Returns:

The messagesHighCount value

getMessagesReceivedCount

long getMessagesReceivedCount()

The number of messages received on this destination since the last reset.

Returns:

The messagesReceivedCount value

getMessagesThresholdTime

long getMessagesThresholdTime()

The amount of time in the threshold condition since the last reset.

Returns:

The messagesThresholdTime value

getBytesCurrentCount

long getBytesCurrentCount()

The current number of bytes stored on this JMS server.

This number does not include the pending bytes.

Returns:

The bytesCurrentCount value

getBytesPendingCount

long getBytesPendingCount()

The current number of bytes pending (unacknowledged or uncommitted) stored on this JMS server.

Pending bytes are over and above the current number of bytes.

Returns:

The bytesPendingCount value

getBytesHighCount

long getBytesHighCount()

The peak number of bytes stored in the JMS server since the last reset.

Returns:

The bytesHighCount value

getBytesReceivedCount

long getBytesReceivedCount()

The number of bytes received on this JMS server since the last reset.

Returns:

The bytesReceivedCount value

getBytesThresholdTime

long getBytesThresholdTime()

The amount of time in the threshold condition since the last reset.

Returns:

The bytesThresholdTime value

pauseProduction

void pauseProduction()
              throws javax.jms.JMSException

Pauses the new message production on all the destinations hosted by the JMSServer.

When the production paused, it would prevent any new produce operations from both new and existing producers attached to the destinations. When the destination is "resumed from production pause", all the new message production is allowed from both new and existing producers attached to that destination.

Throws:

javax.jms.JMSException - Thrown when an internal JMS error occurs while pausing the production.

See Also:

resumeProduction(), pauseInsertion(), pauseConsumption()

isProductionPaused

boolean isProductionPaused()

Returns the current production paused state of the JMSServer as boolean value.

Returns:

returns true if the JMSServer is currently paused for new message production, false otherwise.

getProductionPausedState

java.lang.String getProductionPausedState()

Returns the current production paused state of the JMSServer as string value.

Returns:

The possible values are:

• Production-Paused - indicates that the JMSServer and all of its destinations are currently paused for new message production.
• Production-Pausing - indicates that the JMSServer is in the process of pausing all the destinations for new message production.
• Production-Enabled - indicates that the JMSServer is not currently paused for new message prdoduction.

resumeProduction

void resumeProduction()
               throws javax.jms.JMSException

Resumes the new message production operation on all the destinations hosted by the JMSServer. The state of the JMSServer shall be marked as "production enabled" thus allowing all the new "producing" activity to continue normally. Invoking this API on a JMSServer that is currently not in "production paused" state has no effect.

Throws:

javax.jms.JMSException - Thrown when an internal JMS error occurs while resuming the production.

pauseInsertion

void pauseInsertion()
             throws javax.jms.JMSException

Pauses the appearance of any messages on all the destinations of the JMSServer, that are result of the in-flight work completion on all the destinations hosted by this JMSServer.

Definition of In-Flight work

The definitions below are based on the current implementation of WebLogic JMS subsystem.

• In-flight messages associated with Producers

  • UN-BORN MESSAGES

    Messages that are produced by the producer, with "birth time" (TimeToDeliver) set in future are called un-born messages and are counted as "pending" messages in the destination statistics and are not available for consumers yet.

  • UN-COMMITTED MESSAGES

    These are the messages that are produced by the producer as part of the transaction (using either user transaction or transacted session) and the transaction is still not committed or rolled back. These messages are also counted as "pending" messages in the destination statistics and are not available for consumption.

  • QUOTA BLOCKING SEND

    These are the messages that are produced by the producers but are not able reach the destination because of (either message or byte or both) quota limit on the destination and the producers are willing to block for a specific period of time for the quota to be available. These messages are invisible to the system and are not counted against any of the destination statistics.

• In-flight messages associated with Consumers

  • UN-ACKNOWLEDGED (CLIENT ACK PENDING) MESSAGES

    These are the messages that are successfully consumed by the clients using a "client acknowledge" session, and are awaiting acknowledgements from the clients. These are "pending messages" which will be removed from the destination/system when the acknowledgement is received.

  • UN-COMMITTED MESSAGES

    These are the messages that are consumed (received) by the clients within a transaction (using either user transaction or transacted session) and the transaction is still not committed or rolled back. When the clients successfully commit the transaction the messages get removed from the system.

  • ROLLED BACK MESSAGES

    These are the messages that are put back on the destination because of a successful rollback of transactional receive by the consumers. These messages might or might not be ready for consumption (re-delivered) to the clients immediately, depending on the redelivery parameters, RedeliveryDelay and/or RedeliveryDelayOverride and RedeliveryLimit configured on the associated JMSConnectionFactory and JMSDestination respectively.

    If there is a redelivery delay configured, then for that "delay" duration, the messages are not available for consumption and are counted as "pending" in the destination statistics and after the "delay" period, if the redelivery limit is not exceeded, then they are delivered (made available for consumption) on that destination and are counted as "current" messages in the destination statistics. If the redelivery limit exceeds, then those messages will be moved to the ErrorDestination, if one configured.

    Another parameter that controls the availability of the rolled back messages is RedeliveryLimit.

  • RECOVERED MESSAGES

    These messages are similar to ROLLED BACK MESSAGES except that these messages appear on the queue because of an explicit call to session "recover" by the client.

  • REDELIVERED MESSAGES

    These are again similar to ROLLED BACK MESSAGES except that these messages may re-appear on the destination because of an un-successful delivery attempt to the client (consumer crash, close etc.).

Throws:

javax.jms.JMSException - Thrown when an internal JMS error occurs while pausing the insertion.

See Also:

resumeInsertion(), pauseProduction(), pauseConsumption()

isInsertionPaused

boolean isInsertionPaused()

Returns the current insertion paused state of the JMSServer as boolean value.

Returns:

returns true if the JMSServer is currently paused for insertion of the in-flight messages, false otherwise.

getInsertionPausedState

java.lang.String getInsertionPausedState()

Returns the current insertion paused state of the JMSServer as string value.

Returns:

The possible values are:

• Insertion-Paused - indicates that the JMSServer and all of its destinations are currently paused for new message as in-flight message production.
• Insertion-Pausing - indicates that the JMSServer in the process of pausing all the destinations for new message as well as in-flight message production.
• Insertion-Enabled - indicates that the JMSServer is not currently paused for in-flight message production.

resumeInsertion

void resumeInsertion()
              throws javax.jms.JMSException

Resumes the in-flight message production operation on all the destinations hosted by the JMSServer. The state of the JMSServer shall be marked as "insertion enabled" thus allowing all the messages from in-flight work completion are alloed to appear on the destinations.

Invoking this API on a JMSServer that is currently not in "insertion paused" state has no effect.

Throws:

javax.jms.JMSException - Thrown when an internal JMS error occurs while resuming the insertion.

pauseConsumption

void pauseConsumption()
               throws javax.jms.JMSException

Pauses the consumption operation on all the destinations hosted by the JMSServer.

When the JMSServer is paused for consumption, all of its destination's state is marked as "consumption paused" and all the new synchronous receive operations will block until the destination is resumed and there are messages available for consumption. All the synchronous receive with blocking timeout will block until the timeout happens during the consumption paused state.

All the asynchronous consumers attached to that destination will not get any messages delivered to them while the destination in "consumption paused" state.

After a successful consumption "pause" operation, the user has to explicitly "resume" the destination to allow for any further consume operations on that destination

Throws:

javax.jms.JMSException

isConsumptionPaused

boolean isConsumptionPaused()

Returns the current consumption paused state of the JMSServer as boolean value.

Returns:

returns true if the JMSServer is currently paused for consumption of messages, false otherwise.

Throws:

javax.jms.JMSException - Thrown when an internal JMS error occurs while pausing the consumption.

getConsumptionPausedState

java.lang.String getConsumptionPausedState()

Returns the current consumption paused state of the JMSServer as string value.

Returns:

The possible values are:

• Consumption-Paused - indicates that the JMSServer and all of its destinations are currently paused for message consumption by the consumers. operation.
• Consumption-Pausing - indicates that the JMSServer in the process of pausing all the destinations for message consumption by the consumers.
• Consumption-Enabled - indicates that the JMSServer is not currently paused for message consumption by the consumers.

resumeConsumption

void resumeConsumption()
                throws javax.jms.JMSException

Resumes the consumption operation on all the destinations hosted by the JMSSever.

The state of the destinations shall be marked as "consumption enabled" thus allowing all the "consuming" activity to continue normally.

Invoking this API on a JMSServer that is currently not in "consumption paused" state has no effect.

Throws:

javax.jms.JMSException - Thrown when an internal JMS error occurs while resuming the consumption.

getTransactions

java.lang.String[] getTransactions()

Returns an array of Xids representing transaction branches that exist on this JMS server in any state.

Returns:

An array of Xids in string representation.

See Also:

Xid

getPendingTransactions

java.lang.String[] getPendingTransactions()

Returns an array of Xids representing transaction branches that exist onthis JMS server in the pending state, i.e. branches that have been prepared by the transaction manager but not yet committed or rolled back.

Returns:

An array of Xids in string representation.

See Also:

Xid

getTransactionStatus

java.lang.Integer getTransactionStatus(java.lang.String xid)

Given an Xid this method returns the JTA status of the associated JMS transaction branch.

Parameters:

xid - An Xid in string representation for a JMS transaction branch.

Returns:

An integer value representing a JTA transaction state.

See Also:

Xid, Status

getMessages

java.lang.String getMessages(java.lang.String xid,
                             java.lang.Integer timeoutSeconds)
                      throws ManagementException

Returns a set of messages that are associated with a JMS transaction branch. Note that the result set is returned to the caller in the form of a message cursor that may contain messages from several destinations on this JMS server.

The timeout parameter specifies the amount of time in seconds for which the cursor is valid. Upon timeout expiration the cursor is invalidated and the associated resources released.

Parameters:

xid - An Xid in string representation for a JMS transaction branch.

timeoutSeconds - The last access timeout for the cursor. The cursor resources will be reclaimed if it is not accessed within the specified time interval. A value of 0 indicates no timeout.

Returns:

A message cursor containing messages associated with the transaction branch, possibly from multiple destinations.

Throws:

javax.jms.JMSException - thrown when an error occurs while processing the request.

ManagementException

See Also:

Xid, JMSMessageCursorRuntimeMBean

currentTransactions

TransactionVBean[] currentTransactions()
                                throws ManagementException

Returns an array of TransactionVBean objects representing transactions that exist on this JMS server in any state.

Returns:

An array of TransactionVBean objects

Throws:

ManagementException - An error occurred

See Also:

TransactionVBean

getJMSMessagesByXid

JMSMessagesVBean getJMSMessagesByXid(java.lang.String xid,
                                     int max,
                                     java.lang.String[] sortOn,
                                     boolean[] ascending)
                              throws ManagementException

Returns a set of JMSMessageVBean objects that match the specified JMS message selector. When the sortOn parameter is specified the array is ordered by the message header field.

Parameters:

xid - An Xid in string representation

max - The maximum number of messages to return

sortOn - The JMS header fields to sort on. Values can include message attributes JMSMessageID, JMSTimestamp, JMSDeliveryTime, JMSType, JMSCorrelationID, JMSExpiration, JMSRedelivered, JMSPriority, JMS_BEA_Size, JMS_BEA_UnitOfOrder, JMS_BEA_Xid, JMS_BEA_State, JMS_BEA_SequenceNumber, and arbitrary message property names.

ascending - Indicates whether sort order is ascending or descending

Returns:

An array of JMSMessageVBean objects that are associated with the specified Xid

Throws:

ManagementException - An error occurred processing the query.

See Also:

JMSMessagesVBean

forceCommit

java.lang.Void forceCommit(java.lang.String xid)
                    throws ManagementException

Causes the work associated with the specified transaction branch to be committed.

Parameters:

xid - An xid in string representation for a JMS transaction branch.

Throws:

javax.jms.JMSException - thrown when an error occurs while processing the request.

ManagementException

forceRollback

java.lang.Void forceRollback(java.lang.String xid)
                      throws ManagementException

Causes the work associated with the specified transaction branch to be rolled back.

Parameters:

xid - An xid in string representation for a JMS transaction branch.

Throws:

javax.jms.JMSException - thrown when an error occurs while processing the request.

ManagementException

getMessagesPageableCurrentCount

int getMessagesPageableCurrentCount()

Return the number of messages that are currently available for paging in this JMS server but have not yet been paged out. Note that due to internal implementation details, this count may be zero even if "PageableByteCurrentCount" is zero.

getBytesPageableCurrentCount

long getBytesPageableCurrentCount()

Return the total number of bytes in all the messages that are currently available to be paged out, but which have not yet been paged out. The JMS server attempts to keep this number smaller than the "MessageBufferSize" parameter.

getMessagesPagedOutTotalCount

int getMessagesPagedOutTotalCount()

Return the total number of messages that were written to the paging directory since the JMS server was started.

getMessagesPagedInTotalCount

int getMessagesPagedInTotalCount()

Return the total number of messages that were read from the paging directory since the JMS server was started.

getBytesPagedOutTotalCount

long getBytesPagedOutTotalCount()

Return the total number of bytes that were written to the paging directory since the JMS server was started.

getBytesPagedInTotalCount

long getBytesPagedInTotalCount()

Return the total number of bytes that were read from the paging directory since the JMS server was started.

getPagingAllocatedWindowBufferBytes

long getPagingAllocatedWindowBufferBytes()

See PersistentStoreRuntimeMBean.AllocatedWindowBufferBytes

getPagingAllocatedIoBufferBytes

long getPagingAllocatedIoBufferBytes()

See PersistentStoreRuntimeMBean.AllocatedIoBufferBytes

getPagingPhysicalWriteCount

long getPagingPhysicalWriteCount()

See PersistentStoreRuntimeMBean.PhysicalWriteCount