Skip navigation links

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09


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

Since:
9.0.0.0

Method Summary
abstract  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.
abstract  long getDowntimeHigh()
          Specifies the longest time, in seconds, that the remote endpoint has not been available since the last reset.
abstract  long getDowntimeTotal()
          Specifies the total time, in seconds, that the remote endpoint has not been available since the last reset.
abstract  String getEndpointType()
          Specifies if the remote endpoint is a JMS or Web Services (WSRM) destination.
abstract  Exception getLastException()
          Specifies the exception thrown when message forwarding failed.
abstract  Date getLastTimeConnected()
          Specifies the last time that the remote endpoint was connected.
abstract  Date getLastTimeFailedToConnect()
          Specifies the last time that the remote endpoint failed to be connected.
abstract  String getMessages(String selector, Integer timeout)
          Queries messages on the queue according to the message selector and returns a message cursor representing the result set.
abstract  String getOperationState()
          Specifies the state of the most recent ExireAll operation.
abstract  long getUptimeHigh()
          Specifies the longest time, in seconds, that the remote endpoint has been available since the last reset.
abstract  long getUptimeTotal()
          Specifies the total time, in seconds, that the remote endpoint has been available since the last reset.
abstract  String getURL()
          The URL of the remote endpoint.
abstract  boolean isPausedForForwarding()
          Indicates if the remote endpoint is currently not forwarding messages.
abstract  boolean isPausedForIncoming()
          Indicates if a remote endpoint is currently not accepting new messages.
abstract  void pauseForwarding()
          Pauses the forwarding of messages for a remote endpoint.
abstract  void pauseIncoming()
          Pauses a remote endpoint so that new messages are not accepted.
abstract  void purge()
          Destroys all conversations and purges all the pending messages for a remote destination.
abstract  void resumeForwarding()
          Resumes the forwarding of messages for the remote endpoint.
abstract  void resumeIncoming()
          Resumes a remote endpoint so that new messages are accepted.

 

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.runtime.RuntimeMBean
addPropertyChangeListener, removePropertyChangeListener

 

Methods inherited from interface weblogic.management.WebLogicMBean
getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent

 

Methods inherited from interface javax.management.DynamicMBean
getAttribute, getAttributes, invoke, setAttribute, setAttributes

 

Methods inherited from interface javax.management.MBeanRegistration
postDeregister, postRegister, preDeregister, preRegister

 

Methods inherited from interface javax.management.NotificationBroadcaster
addNotificationListener, getNotificationInfo, removeNotificationListener

 

Methods inherited from interface weblogic.management.runtime.SAFMessageCursorRuntimeMBean
sort

 

Methods inherited from interface weblogic.management.runtime.MessageCursorRuntimeMBean
getMessage, getMessage

 

Methods inherited from interface weblogic.management.runtime.CursorRuntimeMBean
closeCursor, getCursorEndPosition, getCursorSize, getCursorStartPosition, getItems, getNext, getPrevious

 

Methods inherited from interface weblogic.management.runtime.RuntimeMBean
addPropertyChangeListener, removePropertyChangeListener

 

Methods inherited from interface weblogic.management.WebLogicMBean
getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent

 

Methods inherited from interface javax.management.DynamicMBean
getAttribute, getAttributes, invoke, setAttribute, setAttributes

 

Methods inherited from interface javax.management.MBeanRegistration
postDeregister, postRegister, preDeregister, preRegister

 

Methods inherited from interface javax.management.NotificationBroadcaster
addNotificationListener, getNotificationInfo, removeNotificationListener

 

Method Detail

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

resumeIncoming

void resumeIncoming()
                    throws SAFException

Resumes a remote endpoint so that new messages are accepted.

Throws:
SAFException

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

resumeForwarding

void resumeForwarding()
                      throws SAFException

Resumes the forwarding of messages for the remote endpoint.

Throws:
SAFException

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.


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

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

Skip navigation links

Copyright 1996, 2015, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09