# WSRMRemoteEndpointRuntimeMBean

Overview | Related MBeans | Attributes | Operations

## Overview

This class is used for monitoring a WebLogic SAF remote endpoint for WebServices Reliable Messaging.

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.WSRMRemoteEndpointRuntimeMBean`
Factory Methods | No factory methods. Instances of this MBean are created automatically.
Access Points Inherited from SAFRemoteEndpointRuntimeMBean | Because this MBean extends or implements SAFRemoteEndpointRuntimeMBean, you can also access this MBean by retrieving SAFRemoteEndpointRuntimeMBeans. The following attributes contain SAFRemoteEndpointRuntimeMBeans and its subtypes:
SAFAgentRuntimeMBean.RemoteEndpoints |

## 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 |

### Conversations

Returns the 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.

## Attributes

This section describes the following attributes:

BytesCurrentCount BytesHighCount BytesPendingCount BytesReceivedCount BytesThresholdTime ConversationsCurrentCount ConversationsHighCount ConversationsTotalCount DowntimeHigh DowntimeTotal EndpointType FailedMessagesTotal LastException LastTimeConnected LastTimeFailedToConnect | MessagesCurrentCount MessagesHighCount MessagesPendingCount MessagesReceivedCount MessagesThresholdTime Name OperationState Parent PausedForForwarding PausedForIncoming Type UptimeHigh UptimeTotal URL

### 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

Returns the peak number of conversations since the last reset.

Privileges | Read only
Type | long

### ConversationsTotalCount

Returns the total number of conversations since the last reset.

Privileges | Read only
Type | long

### DowntimeHigh

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

Privileges | Read only
Type | long

### DowntimeTotal

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

Privileges | Read only
Type | long

### EndpointType

Specifies if the remote endpoint is a JMS or WSRM destination.

Privileges | Read only
Type | java.lang.String

### FailedMessagesTotal

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

Privileges | Read only
Type | long

### LastException

Specifies the exception thrown when message forwarding failed.

Privileges | Read only
Type | java.lang.Exception

### LastTimeConnected

Specifies the last time that the remote endpoint was connected.

Privileges | Read only
Type | java.util.Date

### LastTimeFailedToConnect

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

Privileges | Read only
Type | java.util.Date

### 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

### OperationState

Specifies the state of the most recent `ExireAll` operation.

Privileges | Read only
Type | java.lang.String

### Parent

Return the immediate parent for this MBean

Privileges | Read/Write
Type |

### PausedForForwarding

Indicates if the remote endpoint is currently not forwarding messages.

Privileges | Read only
Type | boolean

### PausedForIncoming

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

Privileges | Read only
Type | boolean

### Type

Returns the type of the MBean.

Privileges | Read only
Type | java.lang.String

### UptimeHigh

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

Privileges | Read only
Type | long

### UptimeTotal

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

Privileges | Read only
Type | long

### URL

The URL of the remote endpoint.

Privileges | Read only
Type | java.lang.String

## Operations

This section describes the following operations:

closeConversations closeCursor expireAll getCursorEndPosition getCursorSize getCursorStartPosition getItems getMessage getMessage getMessages | getNext getPrevious pauseForwarding pauseIncoming purge resumeForwarding resumeIncoming sort

### closeConversations

Forcefully closes all outstanding conversations whose name contains the given name.

Operation Name | `"closeConversations"`
Parameters | `Object [] { }` where:
Signature | `String [] { "java.lang.String" }`
Returns | `void`
Exceptions | `weblogic.messaging.saf.SAFException`

### closeCursor

Releases the server-side resources associated with the cursor and removes the runtime MBean instance.

Operation Name | `"closeCursor"`
Parameters | `Object [] { cursorHandle }` where: `cursorHandle` is an object of type `java.lang.String` that specifies: The cursor handle.
Signature | `String [] { "java.lang.String" }`
Returns | `Void`
Exceptions | `weblogic.management.ManagementException`

### 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.

- BEA 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.

Operation Name | `"expireAll"`
Parameters | `null`
Signature | `null`
Returns | `void`

### getCursorEndPosition

Returns the cursor end position in the result set.

Operation Name | `"getCursorEndPosition"`
Parameters | `Object [] { cursorHandle }` where: `cursorHandle` is an object of type `java.lang.String` that specifies: The cursor handle.
Signature | `String [] { "java.lang.String" }`
Returns | `Long`
Exceptions | `weblogic.management.ManagementException`

### getCursorSize

Returns the number of items in the result set.

Operation Name | `"getCursorSize"`
Parameters | `Object [] { cursorHandle }` where: `cursorHandle` is an object of type `java.lang.String` that specifies: The cursor handle.
Signature | `String [] { "java.lang.String" }`
Returns | `Long`
Exceptions | `weblogic.management.ManagementException`

### getCursorStartPosition

Returns the cursor start position in the result set.

Operation Name | `"getCursorStartPosition"`
Parameters | `Object [] { cursorHandle }` where: `cursorHandle` is an object of type `java.lang.String` that specifies: The cursor handle.
Signature | `String [] { "java.lang.String" }`
Returns | `Long`
Exceptions | `weblogic.management.ManagementException`

### getItems

Returns an array of items from the specified cursor location. The new cursor start position will be the location after the old cursor end position. The size of the array returned is determined by the count argument. An array smaller than the "count" value is returned if there are fewer items from the specified start position to the end of the result set. A null value is returned if the size of the return array is zero. In this case, the cursor position will not change.

For more information, see:

- CompositeData

Operation Name | `"getItems"`
Parameters | `Object [] { cursorHandle, start, count }` where: `cursorHandle` is an object of type `java.lang.String` that specifies: The cursor handle. `start` is an object of type `java.lang.Long` that specifies: The new cursor start location. `count` is an object of type `java.lang.Integer` that specifies: The maximum number of items to return.
Signature | `String [] { "java.lang.String", "java.lang.Long", "java.lang.Integer" }`
Returns | `class`
Exceptions | `weblogic.management.ManagementException`

### getMessage

Returns the message associated with the specified cursor handle.

For more information, see:

- CompositeData

Operation Name | `"getMessage"`
Parameters | `Object [] { cursorHandle, messageHandle }` where: `cursorHandle` is an object of type `java.lang.String` that specifies: The handle of the cursor. `messageHandle` is an object of type `java.lang.Long` that specifies: The handle of the message within the cursor.
Signature | `String [] { "java.lang.String", "java.lang.Long" }`
Returns | `CompositeData`
Exceptions | `weblogic.management.ManagementException` ManagementException Thrown when an error occurs while performing the operation.

### getMessage

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.

For more information, see:

- CompositeData

Operation Name | `"getMessage"`
Parameters | `Object [] { cursorHandle, messageID }` where: `cursorHandle` is an object of type `java.lang.String` that specifies: The handle of the cursor. `messageID` is an object of type `java.lang.String` that specifies: The JMS message ID of the requested message.
Signature | `String [] { "java.lang.String", "java.lang.String" }`
Returns | `CompositeData`
Exceptions | `weblogic.management.ManagementException`

### getMessages

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.

For more information, see:

- SAFMessageCursorRuntimeMBean

Operation Name | `"getMessages"`
Parameters | `Object [] { selector, timeout }` where: `selector` is an object of type `java.lang.String` that specifies: A valid JMS message selector or SAF message selector. `timeout` is an object of type `java.lang.Integer` that specifies: Specifies the amount of time the message cursor is valid. A value of 0 indicates the cursor does not expire.
Signature | `String [] { "java.lang.String", "java.lang.Integer" }`
Returns | `String`
Exceptions | `weblogic.management.ManagementException`
Security roles | Only the following roles can invoke this operation: Operator Monitor

### getNext

Returns an array of items starting from the current cursor end position. The new cursor start position is set to be the location of the first item returned to the caller. The new cursor end position is set according to the size of the array returned, which is determined by the count argument. An array smaller than the "count" value is returned if there are fewer items from the specified start position to the end of the result set. A null value is returned if the size of the array is zero. In this case, the cursor position will not change.

For more information, see:

- CompositeData

Operation Name | `"getNext"`
Parameters | `Object [] { cursorHandle, count }` where: `cursorHandle` is an object of type `java.lang.String` that specifies: The cursor handle. `count` is an object of type `java.lang.Integer` that specifies: The maximum number of items to return.
Signature | `String [] { "java.lang.String", "java.lang.Integer" }`
Returns | `class`
Exceptions | `weblogic.management.ManagementException`

### getPrevious

Returns an array of items up to the current cursor start position. The new start position will be placed at the location of the first item in the set returned to the caller. The new cursor end position will be placed at the location after the last item in the set that is returned.

For more information, see:

- CompositeData

Operation Name | `"getPrevious"`
Parameters | `Object [] { cursorHandle, count }` where: `cursorHandle` is an object of type `java.lang.String` that specifies: The cursor handle. `count` is an object of type `java.lang.Integer` that specifies: The maximum number of item to return.
Signature | `String [] { "java.lang.String", "java.lang.Integer" }`
Returns | `class`
Exceptions | `weblogic.management.ManagementException`

### pauseForwarding

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

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 a remote endpoint so that new messages are not accepted.

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

### purge

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

Operation Name | `"purge"`
Parameters | `null`
Signature | `null`
Returns | `void`
Exceptions | `weblogic.messaging.saf.SAFException`

### resumeForwarding

Resumes the forwarding of messages for the remote endpoint.

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 a remote endpoint so that new messages are accepted.

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

### sort

Sorts the entire message result set managed by the cursor according to the SAF header attributes specified. The cursor position is set to the new position of the message corresponding to the "start" location before the sort is performed. The method returns the new cursor position.

Operation Name | `"sort"`
Parameters | `Object [] { cursorHandle, start, fields, ascending }` where: `cursorHandle` is an object of type `java.lang.String` that specifies: The handle of the cursor on which to perform the sort operation `start` is an object of type `java.lang.Long` that specifies: The location of the message before the sort that will be the first message returned after the sort. A value of -1 will place the cursor start position at the head of the new sort order. `fields` is an object of type `[Ljava.lang.String;` that specifies: The SAF header attributes on which to sort. `ascending` is an object of type `[Ljava.lang.Boolean;` that specifies: Determines whether the sort of the corresponding fields element is in ascending or descending order.
Signature | `String [] { "java.lang.String", "java.lang.Long", "[Ljava.lang.String;", "[Ljava.lang.Boolean;" }`
Returns | `Long`
Exceptions | `weblogic.management.ManagementException` ManagementException Thrown when an internal error occurs while processing the request.
Security roles | Only the following roles can invoke this operation: Operator Monitor