Package org.apache.camel.component.rest

Class RestProducer

  • All Implemented Interfaces:
    AutoCloseable, org.apache.camel.AsyncProcessor, org.apache.camel.AsyncProducer, org.apache.camel.EndpointAware, org.apache.camel.IsSingleton, org.apache.camel.Processor, org.apache.camel.Producer, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.StatefulService, org.apache.camel.SuspendableService
    public class RestProducer
extends org.apache.camel.support.DefaultAsyncProducer
    Rest producer for calling remote REST services.

    • Field Summary

      • Fields inherited from class org.apache.camel.support.service.BaseService

        BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

    • Constructor Summary

      Constructors 
      Constructor Description
      RestProducer​(org.apache.camel.Endpoint endpoint, org.apache.camel.Producer producer, org.apache.camel.spi.RestConfiguration configuration)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected org.apache.camel.AsyncProcessor createBindingProcessor()  
      protected void doInit()  
      protected void doStart()  
      protected void doStop()  
      org.apache.camel.spi.RestConfiguration.RestBindingMode getBindingMode()  
      RestEndpoint getEndpoint()  
      String getOutType()  
      Boolean getSkipBindingOnErrorCode()  
      String getType()  
      boolean isPrepareUriTemplate()  
      protected void prepareExchange​(org.apache.camel.Exchange exchange)  
      boolean process​(org.apache.camel.Exchange exchange, org.apache.camel.AsyncCallback callback)  
      void setBindingMode​(org.apache.camel.spi.RestConfiguration.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.support.DefaultAsyncProducer

        process, processAsync

      • Methods inherited from class org.apache.camel.support.DefaultProducer

        createExchange, isSingleton, toString

      • Methods inherited from class org.apache.camel.support.service.BaseService

        build, doBuild, doFail, doLifecycleChange, doResume, doShutdown, doSuspend, fail, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

      • Methods inherited from interface org.apache.camel.IsSingleton

        isSingleton

      • Methods inherited from interface org.apache.camel.Service

        build, close, init, start, stop

      • Methods inherited from interface org.apache.camel.ShutdownableService

        shutdown

      • Methods inherited from interface org.apache.camel.StatefulService

        getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending

      • Methods inherited from interface org.apache.camel.SuspendableService

        isSuspended, resume, suspend

    • Constructor Detail

      • RestProducer

        public RestProducer​(org.apache.camel.Endpoint endpoint,
                    org.apache.camel.Producer producer,
                    org.apache.camel.spi.RestConfiguration configuration)

    • Method Detail

      • process

        public boolean process​(org.apache.camel.Exchange exchange,
                       org.apache.camel.AsyncCallback callback)

      • getEndpoint

        public RestEndpoint getEndpoint()
        Specified by:
        getEndpoint in interface org.apache.camel.EndpointAware
        Overrides:
        getEndpoint in class org.apache.camel.support.DefaultProducer

      • 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 org.apache.camel.spi.RestConfiguration.RestBindingMode getBindingMode()

      • setBindingMode

        public void setBindingMode​(org.apache.camel.spi.RestConfiguration.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​(org.apache.camel.Exchange exchange)
                        throws Exception
        Throws:
        Exception

      • doInit

        protected void doInit()
               throws Exception
        Overrides:
        doInit in class org.apache.camel.support.service.BaseService
        Throws:
        Exception

      • doStart

        protected void doStart()
                throws Exception
        Overrides:
        doStart in class org.apache.camel.support.DefaultProducer
        Throws:
        Exception

      • doStop

        protected void doStop()
               throws Exception
        Overrides:
        doStop in class org.apache.camel.support.DefaultProducer
        Throws:
        Exception

      • createBindingProcessor

        protected org.apache.camel.AsyncProcessor createBindingProcessor()
                                                          throws Exception
        Throws:
        Exception