Jump to

• Request
• Response

View This Load Balancing Params

get

/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/JMSSystemResources/{name}/JMSResource/connectionFactories/{name}/loadBalancingParams

View this load balancing params.

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 load balancing params.

Body ()

Root Schema : Load Balancing Params

Type: object

Show Source

• loadBalancingEnabled(optional): boolean
  Default Value: true

  Specifies whether non-anonymous producers created through a connection factory are load balanced within a distributed destination on a per-call basis.

  • If enabled, the associated message producers are load balanced on every send() or publish()

  • If disabled, the associated message producers are load balanced on the first send() or publish()

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

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

  The Producer Load Balancing Policy restricts where a JMS Message Producer can load balance its messages among members of a distributed destination (DD).

  The valid values are:

  • Per-Member - The default value. All running members are candidates.

  • Per-JVM - Only one member per JVM is a candidate.

  Notes:

  • Unit of Order and Unit of Work messages are not affected by this setting.

  • If every WebLogic Server JVM is running a single member of the DD, then Per-JVM and Per-Member yield equivalent behavior.

  • There can be at most one Per-JVM candidate member of a particular DD per WebLogic Server JVM.

  • The Per-JVM load balance candidates will either be (a) members of a DD hosted on a cluster targeted JMS Server or SAF Agent that are running on their preferred server (for example, members that have not failed over or migrated), OR (b) the lexicographically least member name on the same JVM where the DD member is not hosted on a cluster targeted JMS Server or SAF Agent. A member in (a) takes precedence over a member in (b). If two members satisfy (a), then the lexicographically least member name is chosen.

  • If the DD is a Replicated Distributed Topic or if Load Balance Enabled is set to false, then MessageProducers are 'pinned' to a single member and therefore only load balance on initial creation or after a failure. If a MessageProducer is already pinned to a particular DD member on a particular JVM, and the DD is not hosted on JMS Servers or SAF Agents that are targeted to a cluster, and a new member of the DD starts on the same JVM, then the MessageProducer's future messages stay pinned to its original member regardless of whether the member is still a Per-JVM load balance candidate.

  • You can override the Producer Load Balancing Policy on a custom Connection Factory by specifying the system properties weblogic.jms.ProducerLoadBalancingPolicy or weblogic.jms.ProducerLoadBalancingPolicy.MODULENAME on every WebLogic Server in a cluster (the latter property takes precedence over the former). If a Connection Factory is overridden by one of these system properties, then the host WebLogic Server will log an Info message BEA-040538 with the name of the Connection Factory, the system property, and the system property value once the first MessageProducer uses the connection factory.

  • For a similar setting that controls the load balancing of messages forwarded Exactly-Once via a Store-and-Forward Agent (SAF Agent), see the Exactly Once Load Balancing Policy attribute on a SAF Imported Destinations bean.

  This attribute is dynamic and can be changed at any time. However, changing the value does not affect existing connections. It only affects new connections made with this connection factory.

• serverAffinityEnabled(optional): boolean
  Default Value: true

  Specifies whether a server instance that is load balancing consumers or producers across multiple members destinations of a distributed destination, will first attempt to load balance across any other physical destinations that are also running on the same server instance.

{
    "type":"object",
    "properties":{
        "loadBalancingEnabled":{
            "default":true,
            "type":"boolean",
            "description":"<p>Specifies whether non-anonymous producers created through a connection factory are load balanced within a distributed destination on a per-call basis.</p><ul><li><p>If enabled, the associated message producers are load balanced on every <code>send()</code> or <code>publish() </code></p></li><li><p>If disabled, the associated message producers are load balanced on the first <code>send()</code> or <code> publish()</code></p></li></ul>"
        },
        "producerLoadBalancingPolicy":{
            "default":"Per-Member",
            "enum":[
                "Per-Member",
                "Per-JVM"
            ],
            "type":"string",
            "description":"<p>The <code>Producer Load Balancing Policy</code> restricts where a JMS Message Producer can load balance its messages among members of a distributed destination (DD).</p><p>The valid values are:</p><ul><li><p><code>Per-Member</code> - The default value. All running members are candidates.</p></li><li><p><code>Per-JVM</code> - Only one member per JVM is a candidate.</p></li></ul><p>Notes:</p><ul><li><p> Unit of Order and Unit of Work messages are not affected by this setting.</p></li><li><p> If every WebLogic Server JVM is running a single member of the DD, then <code>Per-JVM</code> and <code>Per-Member</code> yield equivalent behavior.</p></li><li><p> There can be at most one <code>Per-JVM</code> candidate member of a particular DD per WebLogic Server JVM.</p></li><li><p>The <code>Per-JVM</code> load balance candidates will either be (a) members of a DD hosted on a cluster targeted JMS Server or SAF Agent that are running on their preferred server (for example, members that have not failed over or migrated), OR (b) the lexicographically least member name on the same JVM where the DD member is not hosted on a cluster targeted JMS Server or SAF Agent. A member in (a) takes precedence over a member in (b). If two members satisfy (a), then the lexicographically least member name is chosen.</p></li><li><p> If the DD is a <code>Replicated Distributed Topic</code> or if <code>Load Balance Enabled</code> is set to <code>false</code>, then MessageProducers are 'pinned' to a single member and therefore only load balance on initial creation or after a failure. If a MessageProducer is already pinned to a particular DD member on a particular JVM, and the DD is not hosted on JMS Servers or SAF Agents that are targeted to a cluster, and a new member of the DD starts on the same JVM, then the MessageProducer's future messages stay pinned to its original member regardless of whether the member is still a <code>Per-JVM</code> load balance candidate.</p></li><li><p> You can override the <code>Producer Load Balancing Policy</code> on a custom Connection Factory by specifying the system properties <code>weblogic.jms.ProducerLoadBalancingPolicy</code> or <code>weblogic.jms.ProducerLoadBalancingPolicy.MODULENAME</code> on every WebLogic Server in a cluster (the latter property takes precedence over the former). If a Connection Factory is overridden by one of these system properties, then the host WebLogic Server will log an Info message BEA-040538 with the name of the Connection Factory, the system property, and the system property value once the first MessageProducer uses the connection factory.</p></li><li><p> For a similar setting that controls the load balancing of messages forwarded Exactly-Once via a Store-and-Forward Agent (SAF Agent), see the Exactly Once Load Balancing Policy attribute on a SAF Imported Destinations bean.</p></li></ul><p>This attribute is dynamic and can be changed at any time. However, changing the value does not affect existing connections. It only affects new connections made with this connection factory.</p>"
        },
        "serverAffinityEnabled":{
            "default":true,
            "type":"boolean",
            "description":"<p>Specifies whether a server instance that is load balancing consumers or producers across multiple members destinations of a distributed destination, will first attempt to load balance across any other physical destinations that are also running on the same server instance. </p>"
        }
    },
    "description":""
}

Back to Top