Configuration Reference Home
OpenDS - Failover Load Balancing Algorithm

Failover Load Balancing Algorithm

The Failover Load Balancing Algorithm is a fail-over load balancing algorithm.

A fail-over load balancing algorithm sends all the requests to one route. Each load balancing route is assigned a priority. A priority is an integer value where 0 is the top priority. The algorithm chooses the route with the highest priority and sends all the requests to that route. When the route is down, the algorithm chooses another route with the highest priority and sends all the requests to that new route. When the first route is back on-line, the algorithm does not switch back to the first route, unless the flag "switch-back" has been set to true. In case two routes have the same priority, the algorithm chooses one and the election is not deterministic.

Parent Component

The Failover Load Balancing Algorithm component inherits from the Load Balancing Algorithm




This page describes the Failover Load Balancing Algorithm:


Properties

A description of each property follows.


Basic Properties: Advanced Properties:
 None ↓ java-class
↓ switch-back

Advanced Properties

java-class

Description
Specifies the fully-qualified name of the Java class that provides the Failover Load Balancing Algorithm implementation.
Default Value
com.sun.dps.server.workflowelement.loadbalancing.FailoverLoadBalancingAlgorithm
Allowed Values
A java class that implements or extends the class(es) :
com.sun.dps.server.workflowelement.loadbalancing.AbstractLoadBalancingAlgorithm
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
Yes
Read-only
No

switch-back

Description
This flag tells what to do when a route is back on-line. Assuming the algorithm is using a route R2, if another route R1 is back on-line and R1 has a higher priority than R2 then the algorithm will not switch back to R1, unless the flag "switch-back" has been set to true.
Default Value
false
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No


LDAP Mapping

Each configuration property can be mapped to a specific LDAP attribute under the "cn=config" entry. The mappings that follow are provided for information only. In general, you should avoid changing the server configuration by manipulating the LDAP attributes directly.

Base DN
cn=algorithm
objectclass name
ds-cfg-fail-over-load-balancing-algorithm
objectclass superior
ds-cfg-load-balancing-algorithm

Property
LDAP attribute
java-class
ds-cfg-java-class
switch-back
ds-cfg-fail-over-load-balancing-switch-back