org.apache.camel.processor.loadbalancer

Class LoadBalancerSupport

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.processor.loadbalancer.LoadBalancerSupport

All Implemented Interfaces:

AsyncProcessor, Navigate<Processor>, Processor, LoadBalancer, Service, ShutdownableService, HasId, IdAware, StatefulService, SuspendableService

Direct Known Subclasses:

CircuitBreakerLoadBalancer, FailOverLoadBalancer, QueueLoadBalancer, SimpleLoadBalancerSupport, TopicLoadBalancer

public abstract class LoadBalancerSupport
extends ServiceSupport
implements LoadBalancer, Navigate<Processor>, IdAware

A default base class for a LoadBalancer implementation.

This implementation is dedicated for asynchronous load balancers.

Consider using the SimpleLoadBalancerSupport if your load balancer does not by nature support asynchronous routing.

Version:

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	log

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
LoadBalancerSupport()

Method Summary

Modifier and Type	Method and Description
void	addProcessor(Processor processor) Adds a new processor to the load balancer
protected void	doShutdown() Implementations override this method to perform customized shutdown.
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
String	getId() Returns the id
List<Processor>	getProcessors() Returns the current processors available to this load balancer
boolean	hasNext() Are there more outputs? Important only invoke this once, as this method do not carry state, and is not intended to be used in a while loop, but used by a if statement instead.
List<Processor>	next() Next group of outputs Important only invoke this once, as this method do not carry state, and is not intended to be used in a while loop, but used by a if statement instead.
void	process(Exchange exchange) Processes the message exchange
void	removeProcessor(Processor processor) Removes the given processor from the load balancer
void	setId(String id) Sets the id

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.camel.AsyncProcessor

process

Field Detail

log

protected final org.slf4j.Logger log

Constructor Detail

LoadBalancerSupport

public LoadBalancerSupport()

Method Detail

addProcessor

public void addProcessor(Processor processor)

Description copied from interface: LoadBalancer

Adds a new processor to the load balancer

Specified by:

addProcessor in interface LoadBalancer

Parameters:

processor - the processor to be added to the load balancer

removeProcessor

public void removeProcessor(Processor processor)

Description copied from interface: LoadBalancer

Removes the given processor from the load balancer

Specified by:

removeProcessor in interface LoadBalancer

Parameters:

processor - the processor to be removed from the load balancer

getProcessors

public List<Processor> getProcessors()

Description copied from interface: LoadBalancer

Returns the current processors available to this load balancer

Specified by:

getProcessors in interface LoadBalancer

Returns:

the processors available

next

public List<Processor> next()

Description copied from interface: Navigate

Next group of outputs

Important only invoke this once, as this method do not carry state, and is not intended to be used in a while loop, but used by a if statement instead.

Specified by:

next in interface Navigate<Processor>

Returns:

next group or null if no more outputs

hasNext

public boolean hasNext()

Description copied from interface: Navigate

Are there more outputs?

Important only invoke this once, as this method do not carry state, and is not intended to be used in a while loop, but used by a if statement instead.

Specified by:

hasNext in interface Navigate<Processor>

Returns:

true if more outputs

getId

public String getId()

Description copied from interface: HasId

Returns the id

Specified by:

getId in interface HasId

Returns:

the id

setId

public void setId(String id)

Description copied from interface: IdAware

Sets the id

Specified by:

setId in interface IdAware

Parameters:

id - the id

doStart

protected void doStart()
                throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: See ServiceSupport.doStop() for more details.

Specified by:

doStart in class ServiceSupport

Throws:

Exception

See Also:

ServiceSupport.doStop()

doStop

protected void doStop()
               throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: Camel will invoke this ServiceSupport.doStop() method when the service is being stopped. This method will also be invoked if the service is still in uninitialized state (eg has not been started). The method is always called to allow the service to do custom logic when the service is being stopped, such as when CamelContext is shutting down.

Specified by:

doStop in class ServiceSupport

Throws:

Exception

See Also:

ServiceSupport.doStart()

doShutdown

protected void doShutdown()
                   throws Exception

Description copied from class: ServiceSupport

Implementations override this method to perform customized shutdown.

Overrides:

doShutdown in class ServiceSupport

Throws:

Exception

process

public void process(Exchange exchange)
             throws Exception

Description copied from interface: Processor

Processes the message exchange

Specified by:

process in interface Processor

Parameters:

exchange - the message exchange

Throws:

Exception - if an internal processing error has occurred.