This documentation is for WSO2 ESB version 4.5.1. View documentation for the latest release.

Dynamic Load-balance Endpoint

The Dynamic Load-balance Endpoint distributes the messages (load) arriving at it among application members by evaluating the load balancing policy and any other relevant parameters. These application members will be discovered using the membershipHandler class. Generally this class will use a group communication mechanism to discover the application members. The class attribute of the membershipHandler element should be an implementation of org.apache.synapse.core.LoadBalanceMembershipHandler.

membershipHandler specific properties can be specified using the property elements.

The policy attribute of the dynamicLoadbalance element specifies the load balance policy (algorithm) to be used for selecting the next member to which the message has to be forwarded to.

Tip

Currently only the roundRobin policy is supported.

The failover attribute determines if the next member should be selected once the currently selected member has failed and defaults to true.

Dynamic Load-balance Endpoint Configuration

Currently the Dynamic Load-balance Endpoint does not support configuring it using a UI. However, you can configure it using its XML source code in the Source View. ClickSource View in the Manage menu under the Service Bus menu of WSO2 ESB Management Console, to configure the the Dynamic Load-balance Endpoint as shown below.

<dynamicLoadbalance [policy="roundRobin"] [failover="true|false"]>
    <membershipHandler class="impl of org.apache.synapse.core.LoadBalanceMembershipHandler">
      <property name="name" value="value"/>
    </membershipHandler>
  </dynamicLoadbalance>