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

Part Number E27170-01

weblogic.management.runtime
Interface SAFAgentRuntimeMBean

All Superinterfaces:
DynamicMBean, HealthFeedback, MBeanRegistration, NotificationBroadcaster, RuntimeMBean, SAFStatisticsCommonMBean, WebLogicMBean

public interface SAFAgentRuntimeMBean
extends SAFStatisticsCommonMBean, HealthFeedback

This class is used for monitoring a WebLogic SAF agent.


Method Summary
 SAFConversationRuntimeMBean[] getConversations()
          A list of SAFConversationRuntimeMBean instances
 long getConversationsCurrentCount()
          Returns the current number of conversations
 long getConversationsHighCount()
          The peak number of conversations since the last reset.
 long getConversationsTotalCount()
          The total number of conversations since the last reset.
 HealthState getHealthState()
          The health state of this JMS server.
 SAFRemoteEndpointRuntimeMBean[] getRemoteEndpoints()
          The remote endpoints to which this SAF agent has been storing and forwarding messages.
 long getRemoteEndpointsCurrentCount()
          The current number of remote endpoints to which this SAF agent has been storing and forwarding messages.
 long getRemoteEndpointsHighCount()
          The peak number of remote endpoints to which this SAF agent has been storing and forwarding messages since last reset.
 long getRemoteEndpointsTotalCount()
          The number of remote endpoints to which this SAF agent has been storing and forwarding messages since last reset.
 boolean isPausedForForwarding()
          Indicates whether or not the sending agent is paused for forwarding at the current time.
 boolean isPausedForIncoming()
          Indicates whether or not the sending agent is paused for incoming messages at the current time.
 boolean isPausedForReceiving()
          Indicates whether or not the receiving agent is paused for receiving at the current time.
 void pauseForwarding()
          Pauses the sending agent on forwarding messages so that the agent will not forward messages but will accept new messages.
 void pauseIncoming()
          Pauses the sending agent on accepting new messages.
 void pauseReceiving()
          Pauses the receiving agent on receiving messages.
 void resumeForwarding()
          Resumes the sending agent for forwarding messages.
 void resumeIncoming()
          Resumes the sending agent for accepting new messages.
 void resumeReceiving()
          Resumes the receiving agent for receiving messages.
 
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
getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, 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

getHealthState

HealthState getHealthState()

The health state of this JMS server.

Specified by:
getHealthState in interface HealthFeedback
Returns:
The healthState value

getRemoteEndpoints

SAFRemoteEndpointRuntimeMBean[] getRemoteEndpoints()

The remote endpoints to which this SAF agent has been storing and forwarding messages.

Returns:
The remoteEndpoints value

getRemoteEndpointsCurrentCount

long getRemoteEndpointsCurrentCount()

The current number of remote endpoints to which this SAF agent has been storing and forwarding messages.

Returns:
The remoteEndpointsCurrentCount value

getRemoteEndpointsHighCount

long getRemoteEndpointsHighCount()

The peak number of remote endpoints to which this SAF agent has been storing and forwarding messages since last reset.

Returns:
The remoteEndpointsHighCount value

getRemoteEndpointsTotalCount

long getRemoteEndpointsTotalCount()

The number of remote endpoints to which this SAF agent has been storing and forwarding messages since last reset.

Returns:
The remoteEndpointsTotalCount value

pauseIncoming

void pauseIncoming()
                   throws SAFException

Pauses the sending agent on accepting new messages.

Throws:
SAFException
Access limited to the following security roles:
Operator

resumeIncoming

void resumeIncoming()
                    throws SAFException

Resumes the sending agent for accepting new messages.

Throws:
SAFException
Access limited to the following security roles:
Operator

isPausedForIncoming

boolean isPausedForIncoming()

Indicates whether or not the sending agent is paused for incoming messages at the current time.


pauseForwarding

void pauseForwarding()
                     throws SAFException

Pauses the sending agent on forwarding messages so that the agent will not forward messages but will accept new messages.

Throws:
SAFException
Access limited to the following security roles:
Operator

resumeForwarding

void resumeForwarding()
                      throws SAFException

Resumes the sending agent for forwarding messages.

Throws:
SAFException
Access limited to the following security roles:
Operator

isPausedForForwarding

boolean isPausedForForwarding()

Indicates whether or not the sending agent is paused for forwarding at the current time.


pauseReceiving

void pauseReceiving()
                    throws SAFException

Pauses the receiving agent on receiving messages.

Throws:
SAFException
Access limited to the following security roles:
Operator

resumeReceiving

void resumeReceiving()
                     throws SAFException

Resumes the receiving agent for receiving messages.

Throws:
SAFException
Access limited to the following security roles:
Operator

isPausedForReceiving

boolean isPausedForReceiving()

Indicates whether or not the receiving agent is paused for receiving at the current time.


getConversations

SAFConversationRuntimeMBean[] getConversations()

A list of SAFConversationRuntimeMBean instances

Returns:
The conversations value

getConversationsCurrentCount

long getConversationsCurrentCount()

Returns the current number of conversations

Returns:
The conversationsCurrentCount value

getConversationsHighCount

long getConversationsHighCount()

The peak number of conversations since the last reset.

Returns:
The conversationsHighCount value

getConversationsTotalCount

long getConversationsTotalCount()

The total number of conversations since the last reset.

Returns:
The conversationsTotalCount value

Copyright 1996, 2013, 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.1.2)

Part Number E27170-01