org.apache.camel.impl

Class DeferProducer

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DeferProducer

All Implemented Interfaces:

AsyncProcessor, EndpointAware, IsSingleton, Processor, Producer, Service, ShutdownableService, StatefulService, SuspendableService

public class DeferProducer
extends ServiceSupport
implements Producer, AsyncProcessor

A Producer that defers being started, until CamelContext has been started, this ensures that the producer is able to adapt to changes that may otherwise occur during starting CamelContext. If we do not defer starting the producer it may not adapt to those changes, and send messages to wrong endpoints.

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
DeferProducer(Endpoint endpoint)

Method Summary

Modifier and Type	Method and Description
Exchange	createExchange() Creates a new exchange to send to this endpoint
Exchange	createExchange(Exchange exchange) Deprecated.
Exchange	createExchange(ExchangePattern pattern) Creates a new exchange of the given pattern to send to this endpoint
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
Endpoint	getEndpoint() Gets the endpoint associated with an object.
boolean	isSingleton() Whether this class supports being singleton or not.
void	process(Exchange exchange) Processes the message exchange
boolean	process(Exchange exchange, AsyncCallback callback) Processes the message exchange.
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

Constructor Detail

DeferProducer

public DeferProducer(Endpoint endpoint)

Method Detail

createExchange

public Exchange createExchange()

Description copied from interface: Producer

Creates a new exchange to send to this endpoint

Specified by:

createExchange in interface Producer

Returns:

a newly created exchange

createExchange

public Exchange createExchange(ExchangePattern pattern)

Description copied from interface: Producer

Creates a new exchange of the given pattern to send to this endpoint

Specified by:

createExchange in interface Producer

Parameters:

pattern - the exchange pattern

Returns:

a newly created exchange

createExchange

@Deprecated
public Exchange createExchange(Exchange exchange)

Deprecated.

Description copied from interface: Producer

Creates a new exchange for communicating with this exchange using the given exchange to pre-populate the values of the headers and messages

Specified by:

createExchange in interface Producer

Parameters:

exchange - the existing exchange

Returns:

the created exchange

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.

process

public boolean process(Exchange exchange,
                       AsyncCallback callback)

Description copied from interface: AsyncProcessor

Processes the message exchange. Similar to Processor.process(org.apache.camel.Exchange), but the caller supports having the exchange asynchronously processed.

If there was a failure processing then the caused Exception would be set on the Exchange.

Specified by:

process in interface AsyncProcessor

Parameters:

exchange - the message exchange

callback - the AsyncCallback will be invoked when the processing of the exchange is completed. If the exchange is completed synchronously, then the callback is also invoked synchronously. The callback should therefore be careful of starting recursive loop.

Returns:

(doneSync) true to continue execute synchronously, false to continue being executed asynchronously

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

isSingleton

public boolean isSingleton()

Description copied from interface: IsSingleton

Whether this class supports being singleton or not.

Specified by:

isSingleton in interface IsSingleton

Returns:

true to be a single shared instance, false to create new instances.

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

toString

public String toString()

Overrides:

toString in class Object