org.apache.camel.impl

Class DefaultConsumer

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultConsumer

All Implemented Interfaces:

Consumer, EndpointAware, RouteAware, Service, ShutdownableService, StatefulService, SuspendableService

Direct Known Subclasses:

DataSetConsumer, DirectConsumer, DirectVmConsumer, LoadBalancerConsumer, ScheduledPollConsumer, TimerConsumer

public class DefaultConsumer
extends ServiceSupport
implements Consumer, RouteAware

A default consumer useful for implementation inheritance.

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
DefaultConsumer(Endpoint endpoint, Processor processor)

Method Summary

Modifier and Type	Method and Description
UnitOfWork	createUoW(Exchange exchange) If the consumer needs to defer done the UnitOfWork on the processed Exchange then this method should be use to create and start the UnitOfWork on the exchange.
void	doneUoW(Exchange exchange) If the consumer needs to defer done the UnitOfWork on the processed Exchange then this method should be executed when the consumer is finished processing the message.
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
AsyncProcessor	getAsyncProcessor() Provides an AsyncProcessor interface to the configured processor on the consumer.
Endpoint	getEndpoint() Gets the endpoint associated with an object.
ExceptionHandler	getExceptionHandler()
Processor	getProcessor()
Route	getRoute() Gets the Route
protected void	handleException(String message, Throwable t) Handles the given exception using the getExceptionHandler()
protected void	handleException(Throwable t) Handles the given exception using the getExceptionHandler()
void	setExceptionHandler(ExceptionHandler exceptionHandler)
void	setRoute(Route route) Injects the Route
String	toString()

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

doResume, doShutdown, 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, wait, wait, wait

Methods inherited from interface org.apache.camel.Service

start, stop

Field Detail

log

protected final org.slf4j.Logger log

Constructor Detail

DefaultConsumer

public DefaultConsumer(Endpoint endpoint,
                       Processor processor)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getRoute

public Route getRoute()

Description copied from interface: RouteAware

Gets the Route

Specified by:

getRoute in interface RouteAware

Returns:

the route, or null if no route has been set.

setRoute

public void setRoute(Route route)

Description copied from interface: RouteAware

Injects the Route

Specified by:

setRoute in interface RouteAware

Parameters:

route - the route

createUoW

public UnitOfWork createUoW(Exchange exchange)
                     throws Exception

If the consumer needs to defer done the UnitOfWork on the processed Exchange then this method should be use to create and start the UnitOfWork on the exchange.

Parameters:

exchange - the exchange

Returns:

the created and started unit of work

Throws:

Exception - is thrown if error starting the unit of work

See Also:

doneUoW(org.apache.camel.Exchange)

doneUoW

public void doneUoW(Exchange exchange)

If the consumer needs to defer done the UnitOfWork on the processed Exchange then this method should be executed when the consumer is finished processing the message.

Parameters:

exchange - the exchange

See Also:

createUoW(org.apache.camel.Exchange)

getEndpoint

public Endpoint getEndpoint()

Description copied from interface: EndpointAware

Gets the endpoint associated with an object. It's the endpoint for sending to for components like Producer or for consuming from for components like Consumer or Route

Specified by:

getEndpoint in interface EndpointAware

Returns:

the endpoint

getProcessor

public Processor getProcessor()

getAsyncProcessor

public AsyncProcessor getAsyncProcessor()

Provides an AsyncProcessor interface to the configured processor on the consumer. If the processor does not implement the interface, it will be adapted so that it does.

getExceptionHandler

public ExceptionHandler getExceptionHandler()

setExceptionHandler

public void setExceptionHandler(ExceptionHandler exceptionHandler)

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()

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()

handleException

protected void handleException(Throwable t)

Handles the given exception using the getExceptionHandler()

Parameters:

t - the exception to handle

handleException

protected void handleException(String message,
                               Throwable t)

Handles the given exception using the getExceptionHandler()

Parameters:

message - additional message about the exception

t - the exception to handle