Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Load-balanced Endpoint distributes the messages (load) arriving at it among a set of listed endpoints or static members by evaluating the load balancing policy and any other relevant parameters.

...

Table of Contents
maxLevel3
minLevel3

...

styleborder:1
locationtop
typeflat
separatorpipe

...

XML Configuration

Info
titleNote

You can configure the Load-balance endpoint using XML. Click on the "Switch to source view" link in the "Load Balance Group" page.

Code Block

<session type="http|simpleClientSession"/>?
<loadBalance [policy="roundRobin"] [algorithm="impl of org.apache.synapse.endpoints.algorithms.LoadbalanceAlgorithm"]
        [failover="true|false"]>
    <endpoint .../>+
    <member hostName="host" [httpPort="port"] [httpsPort="port2"]>+
</loadBalance>

...

1. In the "Add Endpoint" list, click "Load Balance Group Endpoint" (See Adding an Endpoint). The "Load Balance Group Endpoint" page appears.

Image RemovedLoad Balance EndpointImage Added

The following fields are specific to the Load Balance Group Endpoint:

  • Endpoint Name - A unique name of the endpoint.
  • Algorithm - Either a default "Round-robin" or custom loaded algorithm of the group. See more information about this algorithm in the article.
  • Session Management- A session management method from the load balancing group. The possible values are:
    • None - Session management is not used.
    • Transport - Session management is done on the transport level using HTTP cookies.
    • SOAP - Session management is done using SOAP sessions.
    • Client ID - Session management is done using an ID sent by the client.
  • Session Timeout(ms) - Session timeout in milliseconds.
  • Load Balance Endpoint Properties - See Adding an Endpoint.

2. Click "Add Endpoint."

Image RemovedImage Added

3. A shortcut menu with the available endpoints appears.

Image RemovedImage Added

4. Click on the endpoint you want to add as a Load Balance Group Endpoint. A tab with the fields relevant to the selected endpoint appears.

Image RemovedImage Added

See the details of child endpoints in Address Endpoint, WSDL Endpoint, Failover Endpoint.

Info
titleTip

You can add as many endpoints as you need to the load balancing group.

Excerpt
hiddentrue

Description of the Load-balance Endpoint in WSO2 ESB.