This documentation is for WSO2 Enterprise Service Bus version 4.9.0 . View documentation for the latest release.

All docs This doc

Versions Compared

Key

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

The Load-balanced EndpointGroup 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.

The syntax of the load balance endpoint is as follows.

Code Block
languagehtml/xml
<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>

...

  • The failover attribute mentioned above is not applicable for session affinity based endpoints and it is always considered as set to false. If it is required to have failover behavior in session affinity based load balance endpoints, list failover endpoints as the target endpoints.

UI Configuration

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

Load Balance EndpointImage Removed

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

...

The following page is opened by clicking Load-balance Endpoint in the Add Endpoint tab of the Manage Endpoints page.

Image Added

The parameters available to configure a load-balance endpoint are as follows.

Parameter NameDescription
Endpoint NameThis parameter is used to enter a unique name for the endpoint.
AlgorithmThe algorithm on which the load balancing is based. Round Robin is the default algorithm. You can also load a custom algorithm. Instructions for creating a custom algorithm are included in this article.
Session Management

A session management method from the load balancing group. The possible values are

...

as follows.

  • None

...

  •  - If this is selected, session management is not used.
  • Transport

...

  •  - If this is selected, session management is done on the transport level using HTTP cookies.
  • SOAP

...

  •  - If this is selected, session management is done using SOAP sessions.
  • Client ID

...

  •  - If this is selected, session management is done using an ID sent by the client.
Session Timeout (

...

2. Click "Add Endpoint."

Image Removed

3. A shortcut menu with the available endpoints appears.

Image Removed

...

Mills)The number of milliseconds after which the session would time out.
Add ChildClick this link to add a child endpoint. The required endpoint type can be selected from the list and a section displaying parameters relevant to the selected endpoint

...

Image Removed

type will appear. You can add as many endpoints as required to the load-balance group. See the details of child endpoints

...

...

titleTip
Add PropertyClick this link to add properties to the load-balance endpoint. See Properties Reference for details of the available properties.
Excerpt
hiddentrue

Description of the Load-balance Endpoint in WSO2 ESB.