# SAFAgentRuntimeMBean

Overview | Related MBeans | Attributes | Operations

## Overview

This class is used for monitoring a WebLogic SAF agent.

Since | 9.0.0.0
Fully Qualified Interface Name | If you use the `getMBeanInfo` operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name: `weblogic.management.runtime.SAFAgentRuntimeMBean`
Factory Methods | No factory methods. Instances of this MBean are created automatically.
Access Points | You can access this MBean from the following MBean attributes:
SAFRuntimeMBean.Agents |

## Related MBeans

This section describes attributes that provide access to other MBeans. For more information about the MBean hierarchy, refer to WebLogic Server MBean Data Model.

Conversations RemoteEndpoints |

### Conversations

A list of SAFConversationRuntimeMBean instances

Factory Methods | No explicit creator method. The child shares the lifecycle of its parent.
Privileges | Read only
Type | SAFConversationRuntimeMBean[]
Relationship type: | Containment.

### RemoteEndpoints

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

Factory Methods | No explicit creator method. The child shares the lifecycle of its parent.
Privileges | Read only
Type | SAFRemoteEndpointRuntimeMBean[]
Relationship type: | Containment.

## Attributes

This section describes the following attributes:

BytesCurrentCount BytesHighCount BytesPendingCount BytesReceivedCount BytesThresholdTime ConversationsCurrentCount ConversationsHighCount ConversationsTotalCount FailedMessagesTotal HealthState MessagesCurrentCount MessagesHighCount MessagesPendingCount | MessagesReceivedCount MessagesThresholdTime Name Parent PausedForForwarding PausedForIncoming PausedForReceiving RemoteEndpointsCurrentCount RemoteEndpointsHighCount RemoteEndpointsTotalCount Type

### BytesCurrentCount

Returns the current number of bytes. This number does not include the pending bytes.

Privileges | Read only
Type | long

### BytesHighCount

Returns the peak number of bytes since the last reset.

Privileges | Read only
Type | long

### BytesPendingCount

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

Privileges | Read only
Type | long

### BytesReceivedCount

The number of bytes received since the last reset.

Privileges | Read only
Type | long

### BytesThresholdTime

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

Privileges | Read only
Type | long

### ConversationsCurrentCount

Returns the current number of conversations

Privileges | Read only
Type | long

### ConversationsHighCount

The peak number of conversations since the last reset.

Privileges | Read only
Type | long

### ConversationsTotalCount

The total number of conversations since the last reset.

Privileges | Read only
Type | long

### FailedMessagesTotal

Returns the total number of messages that have failed to be forwarded since the last reset.

Privileges | Read only
Type | long

### HealthState

The health state of this JMS server.

Privileges | Read only
Type | weblogic.health.HealthState

### MessagesCurrentCount

Returns the current number of messages. This number includes the pending messages.

Privileges | Read only
Type | long

### MessagesHighCount

Returns the peak number of messages since the last reset.

Privileges | Read only
Type | long

### MessagesPendingCount

Returns the number of pending messages. Pending messages are over and above the current number of messages. A pending message is one that has either been sent in a transaction and not committed, or been forwarded but has not been acknowledged.

Privileges | Read only
Type | long

### MessagesReceivedCount

The number of messages received since the last reset.

Privileges | Read only
Type | long

### MessagesThresholdTime

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

Privileges | Read only
Type | long

### Name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Privileges | Read only
Type | java.lang.String

### Parent

Return the immediate parent for this MBean

Privileges | Read/Write
Type |

### PausedForForwarding

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

Privileges | Read only
Type | boolean

### PausedForIncoming

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

Privileges | Read only
Type | boolean

### PausedForReceiving

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

Privileges | Read only
Type | boolean

### RemoteEndpointsCurrentCount

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

Privileges | Read only
Type | long

### RemoteEndpointsHighCount

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

Privileges | Read only
Type | long

### RemoteEndpointsTotalCount

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

Privileges | Read only
Type | long

### Type

Returns the type of the MBean.

Privileges | Read only
Type | java.lang.String

## Operations

This section describes the following operations:

pauseForwarding pauseIncoming pauseReceiving resumeForwarding | resumeIncoming resumeReceiving

### pauseForwarding

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

Operation Name | `"pauseForwarding"`
Parameters | `null`
Signature | `null`
Returns | `void`
Exceptions | `weblogic.messaging.saf.SAFException`
Security roles | Only the following roles can invoke this operation: Operator

### pauseIncoming

Pauses the sending agent on accepting new messages.

Operation Name | `"pauseIncoming"`
Parameters | `null`
Signature | `null`
Returns | `void`
Exceptions | `weblogic.messaging.saf.SAFException`
Security roles | Only the following roles can invoke this operation: Operator

### pauseReceiving

Pauses the receiving agent on receiving messages.

Operation Name | `"pauseReceiving"`
Parameters | `null`
Signature | `null`
Returns | `void`
Exceptions | `weblogic.messaging.saf.SAFException`
Security roles | Only the following roles can invoke this operation: Operator

### resumeForwarding

Resumes the sending agent for forwarding messages.

Operation Name | `"resumeForwarding"`
Parameters | `null`
Signature | `null`
Returns | `void`
Exceptions | `weblogic.messaging.saf.SAFException`
Security roles | Only the following roles can invoke this operation: Operator

### resumeIncoming

Resumes the sending agent for accepting new messages.

Operation Name | `"resumeIncoming"`
Parameters | `null`
Signature | `null`
Returns | `void`
Exceptions | `weblogic.messaging.saf.SAFException`
Security roles | Only the following roles can invoke this operation: Operator

### resumeReceiving

Resumes the receiving agent for receiving messages.

Operation Name | `"resumeReceiving"`
Parameters | `null`
Signature | `null`
Returns | `void`
Exceptions | `weblogic.messaging.saf.SAFException`
Security roles | Only the following roles can invoke this operation: Operator