Jump to

• Request
• Response

View This SAF Queue

get

/management/weblogic/{version}/domainConfig/resourceGroups/{name}/JMSSystemResources/{name}/JMSResource/SAFImportedDestinations/{name}/SAFQueues/{name}

View this SAF queue.

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 SAF queue.

This method can return the following links:

• rel=SAFErrorHandling

  This resource's SAFErrorHandling reference to a SAF error handling resource.

• rel=messageLoggingParams uri=/management/weblogic/{version}/domainConfig/resourceGroups/{name}/JMSSystemResources/{name}/JMSResource/SAFImportedDestinations/{name}/SAFQueues/{name}/messageLoggingParams

  This resource's messageLoggingParams singleton resource.

Body ()

Root Schema : SAF Queue

Type: object

Show Source

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

  Return the unique identifier of this bean instance.

• localJNDIName(optional): string

  The local JNDI name of the remote destination.

• name(optional): string
  Read Only: true

  The name of this entity, represented in XML as an attribute.

  Many of the elements within the JMS module are named entities. All of the named entities encased by a type in the XML file must be unique. This is the identifier used to delineate a particular entity within the JMS module.

  This attribute cannot be modified externally from the module (for example, with a deployment plan) because it may be used inside the module referentially.

  Constraints

  • legal null
• nonPersistentQos(optional): string
  Default Value: At-Least-Once

  Allowed Values: [ "At-Most-Once", "At-Least-Once", "Exactly-Once" ]

  Specifies the quality-of-service for non-persistent messages.

  • Exactly-Once indicates that messages will be forwarded to the remote side once and only once except for any occurrence of server crashes.

  • At-Least-Once indicates that messages will be forwarded to the remote side at least once. No message will be lost except for any occurrence of server crashes. However, messages may appear in the remote endpoint more than once.

  • At-Most-Once indicates that messages will be forwarded to the remote side atmost once. No message will appear in the remote endpoint more than once. However, messages may get lost.

  Any change to this parameter affects only incoming messages; stored messages are not affected.

  Constraints

  • legal null
• notes(optional): string

  Optional information that you can include to describe this named JMS descriptor bean.

  JMS module saves this note in the JMS descriptor file 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.

• persistentQos(optional): string
  Default Value: Exactly-Once

  Allowed Values: [ "At-Most-Once", "At-Least-Once", "Exactly-Once" ]

  Specifies the quality-of-service for persistent messages.

  • Exactly-Once indicates that messages will be forwarded to the remote side once and only once

  • At-Least-Once indicates that messages will be forwarded to the remote side at least once. Messages may appear in the remote endpoint more than once.

  • At-Most-Once indicates that messages will be forwarded to the remote side atmost once. No message will appear in the remote endpoint more than once. However, messages may get lost.

  Any change to this parameter affects only incoming messages; stored messages are not affected.

  Constraints

  • legal null
• remoteJNDIName(optional): string

  The remote JNDI name of the remote destination.

• SAFErrorHandling(optional): array SAF Error Handling Reference
  Title: SAF Error Handling Reference

  Contains the SAF error handling reference.

  Specifies the error handling configuration used by this SAF destination.

  Any change to this parameter affects only incoming messages; stored messages are not affected.

  Constraints

  • restart required
• timeToLiveDefault(optional): integer(int64)
  Minimum Value: -1

  Specifies the default Time-to-Live value (expiration time), in milliseconds, for imported JMS messages. The expiration time set on JMS messages will override this value unless the SAF Default Time-to-Live Enabled field is switched on, which then overrides the expiration time in JMS messages on imported destinations.

  Any change to this value affects only incoming messages; stored messages are not affected.

• unitOfOrderRouting(optional): string
  Allowed Values: [ "Hash", "PathService" ]

  Specifies the type of routing used to find a SAF agent when using the message Unit-of-Order feature.

  • Hash indicates that producers use the hash code of a message Unit-of-Order to find a SAF agent.

  • PathService indicates that producers use the Path Service to find a SAF agent.

  Constraints

  • legal null
• useSAFTimeToLiveDefault(optional): boolean

  Controls whether the Time-to-Live (expiration time) value set on imported JMS messages will be overridden by the value specified in the SAF Default Time-to-Live field.

  Any change to this parameter affects only incoming messages; stored messages are not affected.

{
    "type":"object",
    "properties":{
        "SAFErrorHandling":{
            "x-weblogic-restartRequired":true,
            "title":"SAF Error Handling Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the SAF error handling reference. <p>Specifies the error handling configuration used by this SAF destination.</p><p>Any change to this parameter affects only incoming messages; stored messages are not affected.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p> Return the unique identifier of this bean instance.</p>"
        },
        "localJNDIName":{
            "type":"string",
            "description":"<p>The local JNDI name of the remote destination.</p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The name of this entity, represented in XML as an attribute.</p><p> Many of the elements within the JMS module are named entities.  All of the named entities encased by a type in the XML file must be unique.  This is the identifier used to delineate a particular entity within the JMS module. </p><p> This attribute cannot be modified externally from the module (for example, with a deployment plan) because it may be used inside the module referentially. </p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "nonPersistentQos":{
            "default":"At-Least-Once",
            "enum":[
                "At-Most-Once",
                "At-Least-Once",
                "Exactly-Once"
            ],
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>Specifies the quality-of-service for non-persistent messages.</p><ul><li><p><code>Exactly-Once</code> indicates that messages will be forwarded to the remote side once and only once except for any occurrence of server crashes.</p></li><li><p><code>At-Least-Once</code> indicates that messages will be forwarded to the remote side at least once. No message will be lost except for any occurrence of server crashes. However, messages may appear in the remote endpoint more than once.</p></li><li><p><code>At-Most-Once</code> indicates that messages will be forwarded to the remote side atmost once. No message will appear in the remote endpoint more than once. However, messages may get lost.</p></li></ul><p>Any change to this parameter affects only incoming messages; stored messages are not affected.</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 named JMS descriptor bean.</p><p>JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity <code>&lt;</code>. Carriage returns/line feeds are preserved.</p><dl><dt>Note:</dt><dd><p>If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.</p></dd></dl>"
        },
        "persistentQos":{
            "default":"Exactly-Once",
            "enum":[
                "At-Most-Once",
                "At-Least-Once",
                "Exactly-Once"
            ],
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>Specifies the quality-of-service for persistent messages.</p><ul><li><p><code>Exactly-Once</code> indicates that messages will be forwarded to the remote side once and only once</p></li><li><p><code>At-Least-Once</code> indicates that messages will be forwarded to the remote side at least once. Messages may appear in the remote endpoint more than once.</p></li><li><p><code>At-Most-Once</code> indicates that messages will be forwarded to the remote side atmost once. No message will appear in the remote endpoint more than once. However, messages may get lost.</p></li></ul><p>Any change to this parameter affects only incoming messages; stored messages are not affected.</p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "remoteJNDIName":{
            "type":"string",
            "description":"<p>The remote JNDI name of the remote destination.</p>"
        },
        "timeToLiveDefault":{
            "minimum":-1,
            "type":"integer",
            "format":"int64",
            "description":"<p>Specifies the default Time-to-Live value (expiration time), in milliseconds, for imported JMS messages. The expiration time set on JMS messages will override this value unless the <code>SAF Default Time-to-Live Enabled</code> field is switched on, which then overrides the expiration time in JMS messages on imported destinations.</p><p>Any change to this value affects only incoming messages; stored messages are not affected.</p>"
        },
        "unitOfOrderRouting":{
            "enum":[
                "Hash",
                "PathService"
            ],
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>Specifies the type of routing used to find a SAF agent when using the message Unit-of-Order feature.</p><ul><li><p><code>Hash</code> indicates that producers use the hash code of a message Unit-of-Order to find a SAF agent.</p></li><li><p><code>PathService</code> indicates that producers use the Path Service to find a SAF agent.</p></li></ul><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "useSAFTimeToLiveDefault":{
            "type":"boolean",
            "description":"<p>Controls whether the Time-to-Live (expiration time) value set on imported JMS messages will be overridden by the value specified in the <code>SAF Default Time-to-Live</code> field.</p><p>Any change to this parameter affects only incoming messages; stored messages are not affected.</p>"
        }
    },
    "description":""
}

Nested Schema : SAF Error Handling Reference

Type: array

Title: SAF Error Handling Reference

Contains the SAF error handling reference.

Specifies the error handling configuration used by this SAF destination.

Any change to this parameter affects only incoming messages; stored messages are not affected.

Constraints

• restart required

Show Source

• Array of: string

{
    "x-weblogic-restartRequired":true,
    "title":"SAF Error Handling Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the SAF error handling reference. <p>Specifies the error handling configuration used by this SAF destination.</p><p>Any change to this parameter affects only incoming messages; stored messages are not affected.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
}

Back to Top