Package weblogic.management.runtime

Interface SAFRemoteEndpointRuntimeMBean

All Superinterfaces:

CursorRuntimeMBean, javax.management.DynamicMBean, javax.management.MBeanRegistration, MessageCursorRuntimeMBean, javax.management.NotificationBroadcaster, RuntimeMBean, SAFMessageCursorRuntimeMBean, SAFStatisticsCommonMBean, WebLogicMBean

All Known Subinterfaces:

JMSRemoteEndpointRuntimeMBean, WSRMRemoteEndpointRuntimeMBean

public interface SAFRemoteEndpointRuntimeMBean
extends SAFStatisticsCommonMBean, SAFMessageCursorRuntimeMBean

This class is used for monitoring a WebLogic SAF remote endpoint

Method Summary

Modifier and Type	Method	Description
void	expireAll()	All pending messages for a remote destination are processed according to the policy specified by the associated Error Handling configuration and then removed.
long	getDowntimeHigh()	Specifies the longest time, in seconds, that the remote endpoint has not been available since the last reset.
long	getDowntimeTotal()	Specifies the total time, in seconds, that the remote endpoint has not been available since the last reset.
java.lang.String	getEndpointType()	Specifies if the remote endpoint is a JMS or Web Services (WSRM) destination.
JMSMessageVBean	getJMSMessage(java.lang.String messageID)	Given a JMS message ID this method returns the corresponding message from the queue.
JMSMessagesVBean	getJMSMessages(java.lang.String selector, int max, java.lang.String[] sortOn, java.lang.Boolean[] ascending)	Returns an array of JMSMessageVBean objects that match the specified JMS message selector.
JMSTextMessageVBean	getJMSTextMessage(java.lang.String messageID)	Returns the JMS TextMessage (with body) that corresponds to the specified message ID.
java.lang.Exception	getLastException()	Specifies the exception thrown when message forwarding failed.
java.util.Date	getLastTimeConnected()	Specifies the last time that the remote endpoint was connected.
java.util.Date	getLastTimeFailedToConnect()	Specifies the last time that the remote endpoint failed to be connected.
java.lang.String	getMessages(java.lang.String selector, java.lang.Integer timeout)	Queries messages on the queue according to the message selector and returns a message cursor representing the result set.
java.lang.String	getOperationState()	Specifies the state of the most recent ExireAll operation.
long	getUptimeHigh()	Specifies the longest time, in seconds, that the remote endpoint has been available since the last reset.
long	getUptimeTotal()	Specifies the total time, in seconds, that the remote endpoint has been available since the last reset.
java.lang.String	getURL()	The URL of the remote endpoint.
boolean	isPausedForForwarding()	Indicates if the remote endpoint is currently not forwarding messages.
boolean	isPausedForIncoming()	Indicates if a remote endpoint is currently not accepting new messages.
void	pauseForwarding()	Pauses the forwarding of messages for a remote endpoint.
void	pauseIncoming()	Pauses a remote endpoint so that new messages are not accepted.
void	purge()	Destroys all conversations and purges all the pending messages for a remote destination.
void	resumeForwarding()	Resumes the forwarding of messages for the remote endpoint.
void	resumeIncoming()	Resumes a remote endpoint so that new messages are accepted.

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 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.runtime.SAFMessageCursorRuntimeMBean

sort

Methods inherited from interface weblogic.management.runtime.SAFStatisticsCommonMBean

getBytesCurrentCount, getBytesHighCount, getBytesPendingCount, getBytesReceivedCount, getBytesThresholdTime, getFailedMessagesTotal, getMessagesCurrentCount, getMessagesHighCount, getMessagesPendingCount, getMessagesReceivedCount, getMessagesThresholdTime

Methods inherited from interface weblogic.management.WebLogicMBean

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

Method Detail

getURL

java.lang.String getURL()

The URL of the remote endpoint.

Returns:

the url value.

getEndpointType

java.lang.String getEndpointType()

Specifies if the remote endpoint is a JMS or Web Services (WSRM) destination. The possible values are: weblogic.management.runtime.SAFConstants.JMS_ENDPOINT or weblogic.management.runtime.SAFConstants.WS_ENDPOINT.

Returns:

weblogic.management.runtime.SAFConstants.JMS_ENDPOINT or weblogic.management.runtime.SAFConstants.WS_ENDPOINT

pauseIncoming

void pauseIncoming()
            throws SAFException

Pauses a remote endpoint so that new messages are not accepted.

Throws:

SAFException

Access limited to the following security roles:

Operator

resumeIncoming

void resumeIncoming()
             throws SAFException

Resumes a remote endpoint so that new messages are accepted.

Throws:

SAFException

Access limited to the following security roles:

Operator

isPausedForIncoming

boolean isPausedForIncoming()

Indicates if a remote endpoint is currently not accepting new messages.

pauseForwarding

void pauseForwarding()
              throws SAFException

Pauses the forwarding of messages for a remote endpoint. The agent accepts new messages but does not forward them.

Throws:

SAFException

Access limited to the following security roles:

Operator

resumeForwarding

void resumeForwarding()
               throws SAFException

Resumes the forwarding of messages for the remote endpoint.

Throws:

SAFException

Access limited to the following security roles:

Operator

isPausedForForwarding

boolean isPausedForForwarding()

Indicates if the remote endpoint is currently not forwarding messages.

expireAll

void expireAll()

All pending messages for a remote destination are processed according to the policy specified by the associated Error Handling configuration and then removed.

• When selected, expireAll is performed asynchronously by the server.

• Oracle recommends that the remote endpoint is paused for incoming messages prior to expiring messages. When all pending messages are processed and removed, the remote endpoint can be set to resume and accept new messages.

• The state of the expireAll operation can be determined by the getOperationState method.

purge

void purge()
    throws SAFException

Destroys all conversations and purges all the pending messages for a remote destination.

Throws:

SAFException

getMessages

java.lang.String getMessages(java.lang.String selector,
                             java.lang.Integer timeout)
                      throws ManagementException

Queries messages on the queue according to the message selector and returns a message cursor representing the result set. The timeout parameter specifies the amount of time in seconds for which the cursor is valid. If the cursor expires, the associated resources are released.

Parameters:

selector - A valid JMS message selector or SAF message selector.

timeout - Specifies the amount of time the message cursor is valid. A value of 0 indicates the cursor does not expire.

Throws:

SAFException - Thrown when an error occurs while performing the query.

ManagementException

See Also:

SAFMessageCursorRuntimeMBean

Access limited to the following security roles:

Operator, Monitor

getDowntimeHigh

long getDowntimeHigh()

Specifies the longest time, in seconds, that the remote endpoint has not been available since the last reset.

Returns:

The downtimeHigh value

getDowntimeTotal

long getDowntimeTotal()

Specifies the total time, in seconds, that the remote endpoint has not been available since the last reset.

Returns:

The downtimeTotal value

getUptimeHigh

long getUptimeHigh()

Specifies the longest time, in seconds, that the remote endpoint has been available since the last reset.

Returns:

The uptimeHigh value

getUptimeTotal

long getUptimeTotal()

Specifies the total time, in seconds, that the remote endpoint has been available since the last reset.

Returns:

The uptimeTotal value

getLastTimeConnected

java.util.Date getLastTimeConnected()

Specifies the last time that the remote endpoint was connected.

Returns:

The lastTimeConnected value

getLastTimeFailedToConnect

java.util.Date getLastTimeFailedToConnect()

Specifies the last time that the remote endpoint failed to be connected.

Returns:

The lastTimeFailedToConnect value

getLastException

java.lang.Exception getLastException()

Specifies the exception thrown when message forwarding failed.

Returns:

the exception.

getOperationState

java.lang.String getOperationState()

Specifies the state of the most recent ExireAll operation.

Returns:

RUNNNG, STOPPED, or COMPLETED

getJMSMessages

JMSMessagesVBean getJMSMessages(java.lang.String selector,
                                int max,
                                java.lang.String[] sortOn,
                                java.lang.Boolean[] ascending)
                         throws ManagementException

Returns an array 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:

selector - The JMS message selector

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 JMSMessageVBean object that contains messages matching the specified selector

Throws:

ManagementException - An error occurred processing the query.

getJMSMessage

JMSMessageVBean getJMSMessage(java.lang.String messageID)
                       throws ManagementException

Given a JMS message ID this method returns the corresponding message from the queue. If no message with the specified message ID exists on the destination, a null value is returned.

Parameters:

messageID - The JMS message ID of the requested message.

Returns:

The message corresponding to the specified message ID or null if one does not exist.

Throws:

ManagementException - Thrown when an error occurs while performing the query.

getJMSTextMessage

JMSTextMessageVBean getJMSTextMessage(java.lang.String messageID)
                               throws ManagementException

Returns the JMS TextMessage (with body) that corresponds to the specified message ID.

Parameters:

messageID - The JMS message ID of the requested message.

Returns:

The JMS TextMessage (with body) that corresponds to the specified message ID, or null.

Throws:

ManagementException - An error occurred.