2. Enterprise Integration Patterns

balancer

Performs load-balancing between several nodes. Nodes sharing session state may be bundled into a cluster.

Explanation:

May only be used as interceptor in a serviceProxy or api.

Can be used in:

serviceProxy, api, global, chainDef, for, stompProxy, if, registration, wsStompReassembler, internal, interceptor, chain, bean, transport and soapProxy

Syntax

<api port="9000">
  <balancer>
     <clusters>
        <cluster name="<<Name>>">
          <node host="<<Hostname>>" port="<<Port>>" /> *
        <cluster> *
     </clusters>
     [strategy] *
  </balancer>
</api>

Sample

<api port="2000">
   <balancer>
	  <clusters>
	    <cluster name="PROD">
	      <node host="node1.predic8.com" port="8080" />
	      <node host="node2.predic8.com" port="8090" />
	      <node host="node3.predic8.com" port="8100" />
	    <cluster>
	  </clusters>
   </balancer>
</api>

Attributes

NameRequiredDefaultDescriptionExamples
name false Default
 Uniquely identifies this load balancer, if there is more than one. Used in the web administration interface and lbclient to manage nodes.
balancer1
sessionTimeout false 3600000
 Time in milliseconds after which sessions time out. (If a session extractor is used.) Default is 1 hour, 0 means never.
600000 (10min)

Child Elements

ElementsDescriptionCardinality
xmlSessionIdExtractor Sets the strategy used to extract a session ID from incoming HTTP requests. 0..1
jSessionIdExtractor Sets the strategy used to extract a session ID from incoming HTTP requests. 0..1
sessionIdExtractor Sets the strategy used to extract a session ID from incoming HTTP requests. 0..1
clusters Specifies a list of clusters. 0..*
byThreadStrategy Sets the strategy used to choose the backend nodes. 0..1
priorityStrategy Sets the strategy used to choose the backend nodes. 0..1
faultMonitoringStrategy Sets the strategy used to choose the backend nodes. 0..1
roundRobinStrategy Sets the strategy used to choose the backend nodes. 0..1