Jump to

• Request
• Response

View This SAF Imported Destinations

get

/management/weblogic/{version}/domainConfig/JMSInteropModules/{name}/JMSResource/SAFImportedDestinations/{name}

View this SAF imported destinations.

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 imported destinations.

This method can return the following links:

• rel=SAFErrorHandling

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

• rel=SAFQueues uri=/management/weblogic/{version}/domainConfig/JMSInteropModules/{name}/JMSResource/SAFImportedDestinations/{name}/SAFQueues

  This resource's SAFQueues collection resource.

• rel=SAFRemoteContext

  This resource's SAFRemoteContext reference to a SAF remote context resource.

• rel=SAFTopics uri=/management/weblogic/{version}/domainConfig/JMSInteropModules/{name}/JMSResource/SAFImportedDestinations/{name}/SAFTopics

  This resource's SAFTopics collection resource.

• rel=messageLoggingParams uri=/management/weblogic/{version}/domainConfig/JMSInteropModules/{name}/JMSResource/SAFImportedDestinations/{name}/messageLoggingParams

  This resource's messageLoggingParams singleton resource.

Body ()

Root Schema : SAF Imported Destinations

Type: object

Show Source

• defaultTargetingEnabled(optional): boolean
  Default Value: false

  Specifies whether this JMS resource defaults to the parent module's targeting or uses the subdeployment targeting mechanism.

  When set to true, this resource implicitly inherits the targeting of its parent module. When set to false, this resource gets targeted based its subdeployment's targets, if one is specified.

• exactlyOnceLoadBalancingPolicy(optional): string
  Default Value: Per-Member

  Allowed Values: [ "Per-Member", "Per-JVM" ]

  Controls the load balancing behavior when the SAF service forwards messages to a distributed destination with the Exactly-Once quality of service (QOS).

  The valid values are:

  • Per-Member - The default value. All active members of the target distributed destination (DD) will be the candidates for load balancing. If there are multiple members of the same DD running on a WebLogic server JVM, these members will all receive forwarded messages.

  • Per-JVM - On each WebLogic server JVM, only one of the active members of the target distributed destination(DD) will be the candidate for load balancing. When the DD has members associated with the instances of a cluster-targeted JMS server, the load balancing algorithm will bias to the "preferred member", which has natural affinity or preference to a particular JVM. Otherwise, the algorithm will bias to the member whose name is lexicographically smallest among all candidate members on the same JVM.

  Notes:

  • When each JVM hosts only one member of a DD, the two options behave the same.

  • You can override the Exactly Once Load Balancing Policy on SAF Imported Destinations Beans defined in all JMS modules or a particular JMS module by specifying the system properties weblogic.jms.saf.ExactlyOnceLoadBalancingPolicy or weblogic.jms.saf.ExactlyOnceLoadBalancingPolicy.MODULENAME on every WebLogic Server in a cluster (the latter property takes precedence over the former). If a SAF Imported Destinations is overridden by one of these system properties, then the host WebLogic Server will log an Info message BEA-281034 with the name of the SAF Imported Destinations, the system property, and the system property value once the first SAF message is forwarded.

  • The setting does not apply to the SAF configurations that use the At-Last-Once or At-Most-Once QOS. Neither does it apply to forwarding messages to a "standalone" destination, or forwarding unit-of-order messages.

  • The setting is honored in both server store-and-forward and client store-and-forward.

  • For a similar setting that controls the load balancing of messages on a local distributed Imported Destination, see the Producer Load Balancing Policy attribute on Connection Factory Load Balancing Params Bean.

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

  Return the unique identifier of this bean instance.

• JNDIPrefix(optional): string

  Specifies the string that will prefix the local JNDI name of a remote destination.

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

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

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

  Contains the SAF error handling reference.

  Specifies the error handling configuration used for the imported destinations.

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

  Constraints

  • restart required
• SAFRemoteContext(optional): array SAF Remote Context Reference
  Title: SAF Remote Context Reference

  Contains the SAF remote context reference.

  Specifies the remote context used for the imported destinations.

  Changing the remote context name affects both stored messages and incoming messages.

• subDeploymentName(optional): string

  Gets the name of the sub-deployment to use when targeting this entity

  Entities are targeted using a sub-deployment with this name. The targets of the sub-deployment will be the targets of this entity.

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

  Default Value: 3600000

  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
  Default Value: Hash

  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 message producers use the hash code of a message Unit-of-Order to find a SAF agent.

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

• useSAFTimeToLiveDefault(optional): boolean
  Default Value: false

  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":{
        "JNDIPrefix":{
            "type":"string",
            "description":"<p>Specifies the string that will prefix the local JNDI name of a remote destination.</p><p>Any change to this prefix affects only incoming messages; stored messages are not affected.</p>"
        },
        "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 for the imported destinations.</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>"
        },
        "SAFRemoteContext":{
            "title":"SAF Remote Context Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the SAF remote context reference. <p>Specifies the remote context used for the imported destinations.</p><p>Changing the remote context name affects both stored messages and incoming messages.</p>"
        },
        "defaultTargetingEnabled":{
            "default":false,
            "type":"boolean",
            "description":"<p>Specifies whether this JMS resource defaults to the parent module's targeting or uses the subdeployment targeting mechanism.</p><p>When set to true, this resource implicitly inherits the targeting of its parent module. When set to false, this resource gets targeted based its subdeployment's targets, if one is specified. </p>"
        },
        "exactlyOnceLoadBalancingPolicy":{
            "default":"Per-Member",
            "enum":[
                "Per-Member",
                "Per-JVM"
            ],
            "type":"string",
            "description":"<p>Controls the load balancing behavior when the SAF service forwards messages to a distributed destination with the <code>Exactly-Once</code> quality of service (QOS).</p><p> The valid values are: </p><ul><li><p><code>Per-Member</code> - The default value. All active members of the target distributed destination (DD) will be the candidates for load balancing. If there are multiple members of the same DD running on a WebLogic server JVM, these members will all receive forwarded messages.</p></li><li><p><code>Per-JVM</code> - On each WebLogic server JVM, only one of the active members of the target distributed destination(DD) will be the candidate for load balancing. When the DD has members associated with the instances of a cluster-targeted JMS server, the load balancing algorithm will bias to the \"preferred member\", which has natural affinity or preference to a particular JVM. Otherwise, the algorithm will bias to the member whose name is lexicographically smallest among all candidate members on the same JVM. </p></li></ul><p>Notes:</p><ul><li><p> When each JVM hosts only one member of a DD, the two options behave the same. </p></li><li><p> You can override the <code>Exactly Once Load Balancing Policy</code> on SAF Imported Destinations Beans defined in all JMS modules or a particular JMS module by specifying the system properties <code>weblogic.jms.saf.ExactlyOnceLoadBalancingPolicy</code> or <code>weblogic.jms.saf.ExactlyOnceLoadBalancingPolicy.MODULENAME</code> on every WebLogic Server in a cluster (the latter property takes precedence over the former). If a  SAF Imported Destinations is overridden by one of these system properties, then the host WebLogic Server will log an Info message BEA-281034 with the name of the SAF Imported Destinations, the system property, and the system property value once the first SAF message is forwarded.</p></li><li><p> The setting does not apply to the SAF configurations that use the <code>At-Last-Once</code> or <code>At-Most-Once</code> QOS. Neither does it apply to forwarding messages to a \"standalone\" destination, or forwarding unit-of-order messages. </p></li><li><p> The setting is honored in both server store-and-forward and client store-and-forward. </p></li><li><p> For a similar setting that controls the load balancing of messages on a local distributed Imported Destination, see the Producer Load Balancing Policy attribute on Connection Factory Load Balancing Params Bean. </p></li></ul>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p> Return the unique identifier of this bean instance.</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>"
        },
        "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>"
        },
        "subDeploymentName":{
            "type":"string",
            "description":"<p>Gets the name of the sub-deployment to use when targeting this entity</p><p> Entities are targeted using a sub-deployment with this name.  The targets of the sub-deployment will be the targets of this entity. </p>"
        },
        "timeToLiveDefault":{
            "default":3600000,
            "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":{
            "default":"Hash",
            "enum":[
                "Hash",
                "PathService"
            ],
            "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 message 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 message producers use the Path Service to find a SAF agent.</p></li></ul>"
        },
        "useSAFTimeToLiveDefault":{
            "default":false,
            "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 for the imported destinations.

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 for the imported destinations.</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>"
}

Nested Schema : SAF Remote Context Reference

Type: array

Title: SAF Remote Context Reference

Contains the SAF remote context reference.

Specifies the remote context used for the imported destinations.

Changing the remote context name affects both stored messages and incoming messages.

Show Source

• Array of: string

{
    "title":"SAF Remote Context Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the SAF remote context reference. <p>Specifies the remote context used for the imported destinations.</p><p>Changing the remote context name affects both stored messages and incoming messages.</p>"
}

Back to Top