This class is used for monitoring a WebLogic SAF remote endpoint
| 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.SAFRemoteEndpointRuntimeMBean
|
||
| Factory Methods | No factory methods. Instances of this MBean are created automatically. | ||
| Subtypes |
The following MBeans extend or implement this MBean type:
|
This section describes the following attributes:
Returns the current number of bytes. This number does not include the pending bytes.
| Privileges | Read only |
| Type | long |
Returns the peak number of bytes since the last reset.
| Privileges | Read only |
| Type | long |
Returns the number of pending bytes. Pending bytes are over and above the current number of bytes.
| Privileges | Read only |
| Type | long |
The number of bytes received since the last reset.
| Privileges | Read only |
| Type | long |
Returns the amount of time in the threshold condition since the last reset.
| Privileges | Read only |
| Type | long |
Private property that disables caching in proxies.
| Privileges | Read only |
| Type | boolean |
Specifies the longest time, in seconds, that the remote endpoint has not been available since the last reset.
| Privileges | Read only |
| Type | long |
Specifies the total time, in seconds, that the remote endpoint has not been available since the last reset.
| Privileges | Read only |
| Type | long |
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.
| Privileges | Read only |
| Type | java.lang.String |
Returns the total number of messages that have failed to be forwarded since the last reset.
| Privileges | Read only |
| Type | long |
Specifies the exception thrown when message forwarding failed.
| Privileges | Read only |
| Type | java.lang.Exception |
Specifies the last time that the remote endpoint was connected.
| Privileges | Read only |
| Type | java.util.Date |
Specifies the last time that the remote endpoint failed to be connected.
| Privileges | Read only |
| Type | java.util.Date |
Returns the MBean info for this MBean.
Deprecated.
| Privileges | Read only |
| Type | javax.management.MBeanInfo |
Returns the current number of messages. This number includes the pending messages.
| Privileges | Read only |
| Type | long |
Returns the peak number of messages since the last reset.
| Privileges | Read only |
| Type | long |
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 |
The number of messages received since the last reset.
| Privileges | Read only |
| Type | long |
Returns the amount of time in the threshold condition since the last reset.
| Privileges | Read only |
| Type | long |
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
| Privileges | Read only |
| Type | java.lang.String |
Returns the ObjectName under which this MBean is registered in the MBean server.
Deprecated.
| Privileges | Read only |
| Type | weblogic.management.WebLogicObjectName |
Specifies the state of the most recent ExireAll
operation.
| Privileges | Read only |
| Type | java.lang.String |
Return the immediate parent for this MBean
| Privileges | Read/Write |
| Type |
Indicates if the remote endpoint is currently not forwarding messages.
| Privileges | Read only |
| Type | boolean |
Indicates if a remote endpoint is currently not accepting new messages.
| Privileges | Read only |
| Type | boolean |
Returns false if the MBean represented by this object has been unregistered.
Deprecated.
| Privileges | Read only |
| Type | boolean |
Returns the type of the MBean.
| Privileges | Read only |
| Type | java.lang.String |
Specifies the longest time, in seconds, that the remote endpoint has been available since the last reset.
| Privileges | Read only |
| Type | long |
Specifies the total time, in seconds, that the remote endpoint has been available since the last reset.
| Privileges | Read only |
| Type | long |
The URL of the remote endpoint.
| Privileges | Read only |
| Type | java.lang.String |
This section describes the following operations:
Releases the server-side resources associated with the cursor and removes the runtime MBean instance.
| Operation Name | "closeCursor" |
| Parameters | Object [] { cursorHandle }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | Void
|
| Exceptions |
|
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.
| Operation Name | "expireAll" |
| Parameters | null |
| Signature | null |
| Returns |
void
|
Returns the cursor end position in the result set.
| Operation Name | "getCursorEndPosition" |
| Parameters | Object [] { cursorHandle }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | Long
|
| Exceptions |
|
Returns the number of items in the result set.
| Operation Name | "getCursorSize" |
| Parameters | Object [] { cursorHandle }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | Long
|
| Exceptions |
|
Returns the cursor start position in the result set.
| Operation Name | "getCursorStartPosition" |
| Parameters | Object [] { cursorHandle }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | Long
|
| Exceptions |
|
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:
| Operation Name | "getItems" |
| Parameters | Object [] { cursorHandle, start, count }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.Long",
"java.lang.Integer" } |
| Returns |
class |
| Exceptions |
|
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:
| Operation Name | "getMessage" |
| Parameters | Object [] { cursorHandle, messageID }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String" } |
| Returns | CompositeData |
| Exceptions |
|
Returns the message associated with the specified cursor handle.
For more information, see:
| Operation Name | "getMessage" |
| Parameters | Object [] { cursorHandle, messageHandle }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.Long" } |
| Returns | CompositeData |
| Exceptions |
|
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:
| Operation Name | "getMessages" |
| Parameters | Object [] { selector, timeout }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.Integer" } |
| Returns | String
|
| Exceptions |
|
| Security roles |
Only the following roles can invoke this operation:
|
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:
| Operation Name | "getNext" |
| Parameters | Object [] { cursorHandle, count }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.Integer" } |
| Returns |
class |
| Exceptions |
|
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:
| Operation Name | "getPrevious" |
| Parameters | Object [] { cursorHandle, count }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.Integer" } |
| Returns |
class |
| Exceptions |
|
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 |
|
| Security roles |
Only the following roles can invoke this operation:
|
Pauses a remote endpoint so that new messages are not accepted.
| Operation Name | "pauseIncoming" |
| Parameters | null |
| Signature | null |
| Returns |
void
|
| Exceptions |
|
| Security roles |
Only the following roles can invoke this operation:
|
| Operation Name | "preDeregister" |
| Parameters | null |
| Signature | null |
| Returns |
void
|
| Exceptions |
|
Destroys all conversations and purges all the pending messages for a remote destination.
| Operation Name | "purge" |
| Parameters | null |
| Signature | null |
| Returns |
void
|
| Exceptions |
|
Resumes the forwarding of messages for the remote endpoint.
| Operation Name | "resumeForwarding" |
| Parameters | null |
| Signature | null |
| Returns |
void
|
| Exceptions |
|
| Security roles |
Only the following roles can invoke this operation:
|
Resumes a remote endpoint so that new messages are accepted.
| Operation Name | "resumeIncoming" |
| Parameters | null |
| Signature | null |
| Returns |
void
|
| Exceptions |
|
| Security roles |
Only the following roles can invoke this operation:
|
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:
|
| Signature | String [] {
"java.lang.String",
"java.lang.Long",
"[Ljava.lang.String;",
"[Ljava.lang.Boolean;" } |
| Returns | Long
|
| Exceptions |
|
| Security roles |
Only the following roles can invoke this operation:
|