weblogic.management.runtime
Interface SAFRemoteEndpointRuntimeMBean

All Superinterfaces:

CursorRuntimeMBean, DynamicMBean, MBeanRegistration, MessageCursorRuntimeMBean, 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

getURL

String getURL()

The URL of the remote endpoint.

Returns:

the url value.

getEndpointType

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

String getMessages(String selector,
                   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

Date getLastTimeConnected()

Specifies the last time that the remote endpoint was connected.

Returns:

The lastTimeConnected value

getLastTimeFailedToConnect

Date getLastTimeFailedToConnect()

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

Returns:

The lastTimeFailedToConnect value

getLastException

Exception getLastException()

Specifies the exception thrown when message forwarding failed.

Returns:

the exception.

getOperationState

String getOperationState()

Specifies the state of the most recent ExireAll operation.

Returns:

RUNNNG, STOPPED, or COMPLETED