Jump to

• Request
• Response

View This WS Reliable Delivery Policy

get

/management/weblogic/{version}/domainConfig/WSReliableDeliveryPolicies/{name}

View this WS reliable delivery policy.

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 this WS reliable delivery policy.

This method can return the following links:

• rel=JMSServer

  This resource's JMSServer reference to a JMS server resource.

Body ()

Root Schema : WS Reliable Delivery Policy

Type: object

Show Source

• defaultRetryCount(optional): integer(int32)
  Default Value: 10

  The default maximum number of times that the sender runtime should attempt to redeliver a message that the receiver WebLogic Server has not yet acknowledged.

  The default maximum number of times that the sender should attempt to redeliver a message that the receiver WebLogic Web service has not yet acknowledged.

• defaultRetryInterval(optional): integer(int32)
  Default Value: 6

  The default minimum number of seconds that the sender runtime should wait between retries if the receiver does not send an acknowledgement of receiving the message, or if the sender runtime detects a communications error while attempting to send a message.

  The default minimum number of seconds that the sender should wait between retries if the receiver does not send an acknowledgement of receiving the message, or if the sender detects a communications error while attempting to send a message.

• defaultTimeToLive(optional): integer(int32)
  Default Value: 360

  The default number of seconds that the receiver of the reliable message should persist the history of the reliable message in its store.

  The default minimum number of seconds that the receiver of the reliably sent message should persist the message in its storage.

  If the DefaultTimeToLive number of message have passed since the message was first sent, the sender should not resent a message with the same message id.

  If a sender cannot send a message successfully before the DefaultTimeToLive has passed, the sender should report a delivery failure. The receiver, after recovering from a crash, will not dispatch saved messages that have expired.

• dynamicallyCreated(optional): boolean
  Read Only: true

  Default Value: false

  Return whether the MBean was created dynamically or is persisted to config.xml

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

  Return the unique id of this MBean instance

• JMSServer(optional): array JMS Server Reference
  Title: JMS Server Reference

  Contains the JMS server reference.

  The JMS server used by WebLogic Server, in its role as a sender, to persist the reliable messages that it sends, or the JMS server used by the receiver WebLogic Server to persist the history of a reliable message sent by a sender.

  Constraints

  • restart required
• name(optional): string
  Read Only: true

  The user-specified name of this MBean instance.

  This name is included as one of the key properties in the MBean's javax.management.ObjectName

  Name=user-specified-name

  Constraints

  • legal null
• notes(optional): string

  Optional information that you can include to describe this configuration.

  WebLogic Server saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the xml entity <. Carriage returns/line feeds are preserved.

  Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

• tags(optional): array Items
  Title: Items

  Return all tags on this Configuration MBean

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable

{
    "type":"object",
    "properties":{
        "JMSServer":{
            "x-weblogic-restartRequired":true,
            "title":"JMS Server Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the JMS server reference. <p>The JMS server used by WebLogic Server, in its role as a sender, to persist the reliable messages that it sends, or the JMS server used by the receiver WebLogic Server to persist the history of a reliable message sent by a sender.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
        },
        "defaultRetryCount":{
            "default":10,
            "type":"integer",
            "format":"int32",
            "description":"<p>The default maximum number of times that the sender runtime should attempt to redeliver a message that the receiver WebLogic Server has not yet acknowledged.</p><p>The default maximum number of times that the sender should attempt to redeliver a message that the receiver WebLogic Web service has not yet acknowledged.</p>"
        },
        "defaultRetryInterval":{
            "default":6,
            "type":"integer",
            "format":"int32",
            "description":"<p>The default minimum number of seconds that the sender runtime should wait between retries if the receiver does not send an acknowledgement of receiving the message, or if the sender runtime detects a communications error while attempting to send a message.</p><p>The default minimum number of seconds that the sender should wait between retries if the receiver does not send an acknowledgement of receiving the message, or if the sender detects a communications error while attempting to send a message.</p>"
        },
        "defaultTimeToLive":{
            "default":360,
            "type":"integer",
            "format":"int32",
            "description":"<p>The default number of seconds that the receiver of the reliable message should persist the history of the reliable message in its store.</p><p>The default minimum number of seconds that the receiver of the reliably sent message should persist the message in its storage.</p><p>If the DefaultTimeToLive number of message have passed since the message was first sent, the sender should not resent a message with the same message id.</p><p>If a sender cannot send a message successfully before the DefaultTimeToLive has passed, the sender should report a delivery failure. The receiver, after recovering from a crash, will not dispatch saved messages that have expired.</p>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The user-specified name of this MBean instance.</p><p>This name is included as one of the key properties in the MBean's <code>javax.management.ObjectName</code></p><p><code>Name=<i>user-specified-name</i></code></p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "notes":{
            "type":"string",
            "description":"<p>Optional information that you can include to describe this configuration.</p><p>WebLogic Server saves this note in the domain's configuration file (<code>config.xml</code>) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <code>&lt;</code>. Carriage returns/line feeds are preserved.</p><p>Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.</p>"
        },
        "tags":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</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":""
}

Nested Schema : JMS Server Reference

Type: array

Title: JMS Server Reference

Contains the JMS server reference.

The JMS server used by WebLogic Server, in its role as a sender, to persist the reliable messages that it sends, or the JMS server used by the receiver WebLogic Server to persist the history of a reliable message sent by a sender.

Constraints

• restart required

Show Source

• Array of: string

{
    "x-weblogic-restartRequired":true,
    "title":"JMS Server Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the JMS server reference. <p>The JMS server used by WebLogic Server, in its role as a sender, to persist the reliable messages that it sends, or the JMS server used by the receiver WebLogic Server to persist the history of a reliable message sent by a sender.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
}

Nested Schema : Items

Type: array

Title: Items

Return all tags on this Configuration MBean

Show Source

• Array of: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Return all tags on this Configuration MBean</p>"
}

Back to Top