org.apache.camel.component.rest

Class RestProducer

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultProducer

org.apache.camel.impl.DefaultAsyncProducer

org.apache.camel.component.rest.RestProducer

All Implemented Interfaces:

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

public class RestProducer
extends DefaultAsyncProducer

Rest producer for calling remote REST services.

Field Summary

Fields inherited from class org.apache.camel.impl.DefaultProducer

log

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

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

Constructor Summary

Constructors

Constructor and Description
RestProducer(Endpoint endpoint, Producer producer, RestConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
protected AsyncProcessor	createBindingProcessor()
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
RestBindingMode	getBindingMode()
RestEndpoint	getEndpoint() Gets the endpoint associated with an object.
String	getOutType()
Boolean	getSkipBindingOnErrorCode()
String	getType()
boolean	isPrepareUriTemplate()
protected void	prepareExchange(Exchange exchange)
boolean	process(Exchange exchange, AsyncCallback callback) Processes the message exchange.
void	setBindingMode(RestBindingMode bindingMode)
void	setOutType(String outType)
void	setPrepareUriTemplate(boolean prepareUriTemplate) Whether to prepare the uri template and replace {key} with values from the exchange, and set as Exchange.HTTP_URI header with the resolved uri to use instead of uri from endpoint.
void	setSkipBindingOnErrorCode(Boolean skipBindingOnErrorCode)
void	setType(String type)

Methods inherited from class org.apache.camel.impl.DefaultAsyncProducer

process

Methods inherited from class org.apache.camel.impl.DefaultProducer

createExchange, createExchange, createExchange, isSingleton, 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

RestProducer

public RestProducer(Endpoint endpoint,
                    Producer producer,
                    RestConfiguration configuration)

Method Detail

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.

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

getEndpoint

public RestEndpoint 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

Overrides:

getEndpoint in class DefaultProducer

Returns:

the endpoint

isPrepareUriTemplate

public boolean isPrepareUriTemplate()

setPrepareUriTemplate

public void setPrepareUriTemplate(boolean prepareUriTemplate)

Whether to prepare the uri template and replace {key} with values from the exchange, and set as Exchange.HTTP_URI header with the resolved uri to use instead of uri from endpoint.

getBindingMode

public RestBindingMode getBindingMode()

setBindingMode

public void setBindingMode(RestBindingMode bindingMode)

getSkipBindingOnErrorCode

public Boolean getSkipBindingOnErrorCode()

setSkipBindingOnErrorCode

public void setSkipBindingOnErrorCode(Boolean skipBindingOnErrorCode)

getType

public String getType()

setType

public void setType(String type)

getOutType

public String getOutType()

setOutType

public void setOutType(String outType)

prepareExchange

protected void prepareExchange(Exchange exchange)
                        throws Exception

Throws:

Exception

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.

Overrides:

doStart in class DefaultProducer

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.

Overrides:

doStop in class DefaultProducer

Throws:

Exception

See Also:

ServiceSupport.doStart()

createBindingProcessor

protected AsyncProcessor createBindingProcessor()
                                         throws Exception

Throws:

Exception