View This JMS Durable Subscriber Runtime
/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/JMSRuntime/JMSServers/{name}/destinations/{name}/durableSubscribers/{name}
View this JMS durable subscriber runtime.
Request
-
name: string
The name property of the instance in the collection.
-
version: string
The version of the WebLogic REST interface.
-
excludeFields(optional): string
The 'excludeFields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields whose name is not on the list will be returned. If not present, all fields are returned (unless the 'fields' query parameter is specified). Note: 'fields' must not be specified if 'excludeFields' is specified.
-
excludeLinks(optional): string
The 'excludeLinks' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links whose relationship name is not on the list will be returned. If not present, all links are returned (unless the 'links' query parameter is specified). Note: 'links' must not be specified if 'excludeLinks' is specified.
-
fields(optional): string
The 'fields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields with matching names are returned. If not present, all fields are returned (unless the 'excludeFields' query parameter is specified). Note: 'excludeFields' must not be specified if 'fields' is specified.
-
links(optional): string
The 'links' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links with matching relationship names are returned. If not present, all links are returned (unless the 'excludeLinks' query parameter is specified). Note: 'excludeLinks' must not be specified if 'links' is specified.
-
Admin: basic
Type:
basicDescription:A user in the Admin security role. -
Deployer: basic
Type:
basicDescription:A user in the Deployer security role. -
Monitor: basic
Type:
basicDescription:A user in the Monitor security role. -
Operator: basic
Type:
basicDescription:A user in the Operator security role.
Response
- application/json
200 Response
Returns this JMS durable subscriber runtime.
This method can return the following links:
- rel=action title=closeCursor uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/JMSRuntime/JMSServers/{name}/destinations/{name}/durableSubscribers/{name}/closeCursor
This resource's closeCursor action resource.
- rel=action title=deleteMessages uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/JMSRuntime/JMSServers/{name}/destinations/{name}/durableSubscribers/{name}/deleteMessages
This resource's deleteMessages action resource.
- rel=action title=getCursorEndPosition uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/JMSRuntime/JMSServers/{name}/destinations/{name}/durableSubscribers/{name}/getCursorEndPosition
This resource's getCursorEndPosition action resource.
- rel=action title=getCursorSize uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/JMSRuntime/JMSServers/{name}/destinations/{name}/durableSubscribers/{name}/getCursorSize
This resource's getCursorSize action resource.
- rel=action title=getCursorStartPosition uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/JMSRuntime/JMSServers/{name}/destinations/{name}/durableSubscribers/{name}/getCursorStartPosition
This resource's getCursorStartPosition action resource.
- rel=action title=getMessages uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/JMSRuntime/JMSServers/{name}/destinations/{name}/durableSubscribers/{name}/getMessages
This resource's getMessages action resource.
- rel=action title=sort uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/JMSRuntime/JMSServers/{name}/destinations/{name}/durableSubscribers/{name}/sort
This resource's sort action resource.
- rel=destinationRuntime uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/JMSRuntime/JMSServers/{name}/destinations/{name}/durableSubscribers/{name}/destinationRuntime
This resource's destinationRuntime singleton resource.
object-
active(optional):
boolean
Read Only:
trueIndicates whether this subscription is being used by a durable subscriber.
-
bytesCurrentCount(optional):
integer(int64)
Read Only:
trueThe number of bytes received by this durable subscriber.
-
bytesPendingCount(optional):
integer(int64)
Read Only:
trueThe number of bytes pending by this durable subscriber.
-
clientID(optional):
string
Read Only:
trueA unique client identifier for this durable subscriber.
Note: The client ID is not necessarily equivalent to the WebLogic Server username; that is, a name used to authenticate a user in the WebLogic security realm. You can set the client ID to the WebLogic Server username if it is appropriate for your JMS application.
-
clientIDPolicy(optional):
string
Read Only:
trueThe policy for the client identifier for this durable subscriber.
Note: The client ID policy is either
RestrictedorUnrestricted. -
lastMessagesReceivedTime(optional):
integer(int64)
Read Only:
trueThe time when the last time a subscriber received a message from the subscription. The returned value is a standard java absolute time, which is measured in milliseconds since midnight, January 1, 1970 UTC
This returns the JMS durable subscription boot time if there were no messages that were successfully delivered to any subscriber on this subscription since the subscription was booted. We define the boot time of a durable subscription to be the time the subscription is originally created or recovered during a server reboot or jms migration, which ever is latest.
-
messagesCurrentCount(optional):
integer(int64)
Read Only:
trueThe number of messages still available by this durable subscriber.
-
messagesDeletedCurrentCount(optional):
integer(int64)
Read Only:
trueReturns the number of messages that have been deleted from the destination.
-
messagesHighCount(optional):
integer(int64)
Read Only:
trueThe peak number of messages for the durable subscriber since the last reset.
-
messagesMovedCurrentCount(optional):
integer(int64)
Read Only:
trueReturns the number of messages that have been moved from the destination.
-
messagesPendingCount(optional):
integer(int64)
Read Only:
trueThe number of messages pending (uncommitted and unacknowledged) by this durable subscriber.
-
messagesReceivedCount(optional):
integer(int64)
Read Only:
trueThe number of messages received by the durable subscriber since that reset.
-
name(optional):
string
Read Only:
trueThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Constraints
- unharvestable
-
noLocal(optional):
boolean
Read Only:
trueSpecifies whether this durable subscriber receives local messages that it has published.
To prevent this, set the
noLocalparameter totrue -
selector(optional):
string
Read Only:
trueThe message selector defined for this durable subscriber.
-
subscribersCurrentCount(optional):
integer(int32)
Read Only:
trueDefault Value:0The number of subscribers that currently share this subscription.
-
subscribersHighCount(optional):
integer(int32)
Read Only:
trueDefault Value:0The highest number of subscribers that have shared this subscription at the same time since the creation or the last reboot of the subscription, which ever is later.
-
subscribersTotalCount(optional):
integer(int32)
Read Only:
trueDefault Value:0The total number of subscribers that have accessed this subscription since the creation or the last reboot of the subscription, whichever is later.
-
subscriptionLimitDeletedCount(optional):
integer(int64)
Read Only:
trueThe number of messages deleted because of a subscription limit.
-
subscriptionName(optional):
string
Read Only:
trueThe subscription name for this durable subscriber. This name must be unique for each client ID.
Valid durable subscription names cannot include the following characters: comma ",", equals "=", colon ":", asterisk "*", percent "%", or question mark"?".
-
subscriptionSharingPolicy(optional):
string
Read Only:
trueDefault Value:ExclusiveThe SubscriptionSharingPolicy on this subscriber.
-
type(optional):
string
Read Only:
trueReturns the type of the MBean.
Constraints
- unharvestable