Name
Load Balance — Balances message processing among a number of nodes
Usage
The load balance pattern uses a specified algorithm for balancing the processing load among a number of processors.
The filter pattern can appear anywhere in the body of a route. It should be connected to one or more identical processors accross which processing can be spread.
Properties
Table 3.6 describes the properties you can specify using the properties editor.
Table 3.6. Load Balance Properties
Name | Description |
---|---|
Ref | Deprecated Specifies a reference to the bean implementing the load balancing strategy. |
Load Balancer Type |
Specifies and configures the load balancing strategy. Selections include:
|
Inherit Error Handler | Specifies if the node should use the error handler configured for the route. |
Id | Specifies a unique identifier for the endpoint. The Id can be used to refer to the endpoint in the Apache Camel configuration file. |
Description | Specifies a text description of the bean. The description is included in the generated XML file. |
Failover configuration
Table 3.7 describes the properties needed to configure a failover load balancer.
Table 3.7. Failover Load Balance Properties
Name | Description |
---|---|
Exceptions | Specifies the exceptions that cause a failover. All other exceptions will cause a failure. |
Maximum Failover Attempts | Specifies the maximum number of attempts before giving up.
-1 specifies unlimited attempts. |
Custom configuration
Table 3.8 describes the properties needed to configure a custom load balancer.
Table 3.8. Custom Load Balance Properties
Name | Description |
---|---|
Ref | Specifies a reference to the bean implementing the load balancing strategy. |
Sticky configuration
Table 3.9 describes the properties needed to configure a sticky load balancer.
Table 3.9. Sticky Load Balance Properties
Name | Description |
---|---|
Correlation Expression | Specifies the expression used to generate the correlation key used by the load blancer. |
Weighted configuration
Table 3.10 describes the properties needed to configure a Weighted load balancer.
Table 3.10. Weighted Load Balance Properties
Name | Description |
---|---|
Distribution Ratio | Specifies a delimited list of positive integers determining the relative weight for each endpoint. The number of entries in the list must match the number of endpoints available for load balancing. |
Distribution Ratio Delimiter | Specifies the character used to delimit the entries in the distribution ratio list. |