Jump to

• Request
• Response

View This JMS Consumer Runtime Collection

get

/management/weblogic/{version}/serverRuntime/JMSRuntime/connections/{name}/sessions/{name}/consumers

View this JMS consumer runtime collection.

Request

Path Parameters

• name: string
  The name property of the instance in the collection.
• version: string
  The version of the WebLogic REST interface.

Query Parameters

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

Security

• Admin: basic
  Type: basic

  Description: A user in the Admin security role.
• Deployer: basic
  Type: basic

  Description: A user in the Deployer security role.
• Monitor: basic
  Type: basic

  Description: A user in the Monitor security role.
• Operator: basic
  Type: basic

  Description: A user in the Operator security role.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns a list of JMS consumer runtime entities.

Body ()

Root Schema : Items

Type: array

Title: Items

Show Source

• Array of: object JMS Consumer Runtime

{
    "title":"Items",
    "type":"array",
    "items":{
        "$ref":"#/definitions/JMS Consumer Runtime"
    },
    "description":""
}

Nested Schema : JMS Consumer Runtime

Type: object

Show Source

• active(optional): boolean
  Read Only: true

  Indicates whether the consumer active. A consumer is active if it has a message listener set up or a synchronous receive in progress.

• bytesPendingCount(optional): integer(int64)
  Read Only: true

  The number of bytes pending (uncommitted and unacknowledged) by this consumer.

• bytesReceivedCount(optional): integer(int64)
  Read Only: true

  The number of bytes received by this consumer since the last reset.

• clientID(optional): string
  Read Only: true

  The client ID for this connection.

• clientIDPolicy(optional): string
  Read Only: true

  The ClientIDPolicy on this connection or durable subscriber.

  Valid values are:

  • weblogic.management.configuration.JMSConstants.CLIENT_ID_POLICY_RESTRICTED: Only one connection that uses this policy exists in a cluster at any given time for a particular ClientID

  • weblogic.management.configuration.JMSConstants.CLIENT_ID_POLICY_UNRESTRICTED: Connections created using this policy can specify any ClientID, even when other restricted or unrestricted connections already use the same ClientID

• destinationName(optional): string
  Read Only: true

  The name of the destination for this consumer. In case of a distributed destination, it is the name of the distributed destination, instead of the member destination.

• durable(optional): boolean
  Read Only: true

  Indicates whether the consumer is durable.

• memberDestinationName(optional): string
  Read Only: true

  The name of the destination for this consumer. In case of a distributed destination, it is the name of the member destination.

• messagesPendingCount(optional): integer(int64)
  Read Only: true

  The number of messages pending (uncommitted and unacknowledged) by this consumer.

• messagesReceivedCount(optional): integer(int64)
  Read Only: true

  The number of messages received by this consumer since the last reset.

• name(optional): string
  Read Only: true

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

  Constraints

  • unharvestable
• selector(optional): string
  Read Only: true

  The selector associated with this consumer, if any.

• subscriptionSharingPolicy(optional): string
  Read Only: true

  The Subscription Sharing Policy on this subscriber.

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable

{
    "type":"object",
    "properties":{
        "active":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates whether the consumer active. A consumer is active if it has a message listener set up or a synchronous receive in progress.</p>"
        },
        "bytesPendingCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of bytes pending (uncommitted and unacknowledged) by this consumer.</p>"
        },
        "bytesReceivedCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of bytes received by this consumer since the last reset.</p>"
        },
        "clientID":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The client ID for this connection.</p>"
        },
        "clientIDPolicy":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The ClientIDPolicy on this connection or durable subscriber.</p><p> Valid values are: </p><ul><li><p><code>weblogic.management.configuration.JMSConstants.CLIENT_ID_POLICY_RESTRICTED</code>: Only one connection that uses this policy exists in a cluster at any given time for a particular <code>ClientID</code></p></li><li><p><code>weblogic.management.configuration.JMSConstants.CLIENT_ID_POLICY_UNRESTRICTED</code>:  Connections created using this policy can specify any <code>ClientID</code>, even when other restricted or unrestricted connections already use the same <code>ClientID</code></p></li></ul>"
        },
        "destinationName":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The name of the destination for this consumer. In case of a distributed destination, it is the name of the distributed destination, instead of the member destination.</p>"
        },
        "durable":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates whether the consumer is durable.</p>"
        },
        "memberDestinationName":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The name of the destination for this consumer. In case of a distributed destination, it is the name of the member destination.</p>"
        },
        "messagesPendingCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of messages pending (uncommitted and unacknowledged) by this consumer.</p>"
        },
        "messagesReceivedCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of messages received by this consumer since the last reset.</p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "selector":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The selector associated with this consumer, if any.</p>"
        },
        "subscriptionSharingPolicy":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The Subscription Sharing Policy on this subscriber.</p>"
        },
        "type":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Returns the type of the MBean.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        }
    },
    "description":""
}

Back to Top