RestEndpoint (Camel :: REST 3.0.1 API)

java.lang.Object
- org.apache.camel.support.service.ServiceSupport
- - org.apache.camel.support.DefaultEndpoint
  - - org.apache.camel.component.rest.RestEndpoint

All Implemented Interfaces:

AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService
```
@UriEndpoint(firstVersion="2.14.0",
             scheme="rest",
             title="REST",
             syntax="rest:method:path:uriTemplate",
             label="core,rest",
             lenientProperties=true)
public class RestEndpoint
extends org.apache.camel.support.DefaultEndpoint
```
The rest component is used for either hosting REST services (consumer) or calling external REST services (producer).

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_API_COMPONENT_NAME`
`static String[]`	`DEFAULT_REST_CONSUMER_COMPONENTS`
`static String[]`	`DEFAULT_REST_PRODUCER_COMPONENTS`
`static String`	`RESOURCE_PATH`

Fields inherited from class org.apache.camel.support.service.ServiceSupport
BUILDED, FAILED, INITIALIZED, lock, log, NEW, SHUTDOWN, SHUTTINGDOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

Constructor Summary

Constructors
Constructor and Description

RestEndpoint(String endpointUri, RestComponent component)

Constructors
Constructor and Description
`RestEndpoint(String endpointUri, RestComponent component)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.apache.camel.Consumer`	`createConsumer(org.apache.camel.Processor processor)`
`org.apache.camel.Producer`	`createProducer()`
`String`	`getApiDoc()`
`org.apache.camel.spi.RestConfiguration.RestBindingMode`	`getBindingMode()`
`RestComponent`	`getComponent()`
`String`	`getConsumerComponentName()`
`String`	`getConsumes()`
`String`	`getDescription()`
`String`	`getHost()`
`String`	`getInType()`
`String`	`getMethod()`
`String`	`getOutType()`
`Map<String,Object>`	`getParameters()`
`String`	`getPath()`
`String`	`getProducerComponentName()`
`String`	`getProduces()`
`String`	`getQueryParameters()`
`String`	`getRouteId()`
`String`	`getUriTemplate()`
`boolean`	`isLenientProperties()`
`void`	`setApiDoc(String apiDoc)` The swagger api doc resource to use.
`void`	`setBindingMode(org.apache.camel.spi.RestConfiguration.RestBindingMode bindingMode)` Configures the binding mode for the producer.
`void`	`setBindingMode(String bindingMode)`
`void`	`setConsumerComponentName(String consumerComponentName)` The Camel Rest component to use for (consumer) the REST transport, such as jetty, servlet, undertow.
`void`	`setConsumes(String consumes)` Media type such as: 'text/xml', or 'application/json' this REST service accepts.
`void`	`setDescription(String description)` Human description to document this REST service
`void`	`setHost(String host)` Host and port of HTTP service to use (override host in swagger schema)
`void`	`setInType(String inType)` To declare the incoming POJO binding type as a FQN class name
`void`	`setMethod(String method)` HTTP method to use.
`void`	`setOutType(String outType)` To declare the outgoing POJO binding type as a FQN class name
`void`	`setParameters(Map<String,Object> parameters)` Additional parameters to configure the consumer of the REST transport for this REST service
`void`	`setPath(String path)` The base path
`void`	`setProducerComponentName(String producerComponentName)` The Camel Rest component to use for (producer) the REST transport, such as http, undertow.
`void`	`setProduces(String produces)` Media type such as: 'text/xml', or 'application/json' this REST service returns.
`void`	`setQueryParameters(String queryParameters)` Query parameters for the HTTP service to call
`void`	`setRouteId(String routeId)` Name of the route this REST services creates
`void`	`setUriTemplate(String uriTemplate)` The uri template

Methods inherited from class org.apache.camel.support.DefaultEndpoint
configureConsumer, configurePollingConsumer, configureProperties, createAsyncProducer, createEndpointUri, createExchange, createExchange, createPollingConsumer, doInit, doStart, doStop, equals, getCamelContext, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBasicPropertyBinding, isBridgeErrorHandler, isLazyStartProducer, isPollingConsumerBlockWhenFull, isSingleton, isSynchronous, setBasicPropertyBinding, setBridgeErrorHandler, setCamelContext, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setLazyStartProducer, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

Methods inherited from class org.apache.camel.support.service.ServiceSupport
build, doBuild, doResume, doShutdown, doSuspend, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Service
build, close, init, start, stop

Methods inherited from interface org.apache.camel.CamelContextAware
trySetCamelContext

- Field Detail
  - DEFAULT_REST_CONSUMER_COMPONENTS
```
public static final String[] DEFAULT_REST_CONSUMER_COMPONENTS
```
  - DEFAULT_REST_PRODUCER_COMPONENTS
```
public static final String[] DEFAULT_REST_PRODUCER_COMPONENTS
```
  - DEFAULT_API_COMPONENT_NAME
```
public static final String DEFAULT_API_COMPONENT_NAME
```
    See Also:
    
    Constant Field Values
  - RESOURCE_PATH
```
public static final String RESOURCE_PATH
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RestEndpoint
```
public RestEndpoint(String endpointUri,
                    RestComponent component)
```
- Method Detail
  - getComponent
```
public RestComponent getComponent()
```
    Overrides:
    
    getComponent in class org.apache.camel.support.DefaultEndpoint
  - getMethod
```
public String getMethod()
```
  - setMethod
```
public void setMethod(String method)
```
    HTTP method to use.
  - getPath
```
public String getPath()
```
  - setPath
```
public void setPath(String path)
```
    The base path
  - getUriTemplate
```
public String getUriTemplate()
```
  - setUriTemplate
```
public void setUriTemplate(String uriTemplate)
```
    The uri template
  - getConsumes
```
public String getConsumes()
```
  - setConsumes
```
public void setConsumes(String consumes)
```
    Media type such as: 'text/xml', or 'application/json' this REST service accepts. By default we accept all kinds of types.
  - getProduces
```
public String getProduces()
```
  - setProduces
```
public void setProduces(String produces)
```
    Media type such as: 'text/xml', or 'application/json' this REST service returns.
  - getProducerComponentName
```
public String getProducerComponentName()
```
  - setProducerComponentName
```
public void setProducerComponentName(String producerComponentName)
```
    The Camel Rest component to use for (producer) the REST transport, such as http, undertow. If no component has been explicit configured, then Camel will lookup if there is a Camel component that integrates with the Rest DSL, or if a org.apache.camel.spi.RestProducerFactory is registered in the registry. If either one is found, then that is being used.
  - getConsumerComponentName
```
public String getConsumerComponentName()
```
  - setConsumerComponentName
```
public void setConsumerComponentName(String consumerComponentName)
```
    The Camel Rest component to use for (consumer) the REST transport, such as jetty, servlet, undertow. If no component has been explicit configured, then Camel will lookup if there is a Camel component that integrates with the Rest DSL, or if a org.apache.camel.spi.RestConsumerFactory is registered in the registry. If either one is found, then that is being used.
  - getInType
```
public String getInType()
```
  - setInType
```
public void setInType(String inType)
```
    To declare the incoming POJO binding type as a FQN class name
  - getOutType
```
public String getOutType()
```
  - setOutType
```
public void setOutType(String outType)
```
    To declare the outgoing POJO binding type as a FQN class name
  - getRouteId
```
public String getRouteId()
```
  - setRouteId
```
public void setRouteId(String routeId)
```
    Name of the route this REST services creates
  - getDescription
```
public String getDescription()
```
  - setDescription
```
public void setDescription(String description)
```
    Human description to document this REST service
  - getParameters
```
public Map<String,Object> getParameters()
```
  - setParameters
```
public void setParameters(Map<String,Object> parameters)
```
    Additional parameters to configure the consumer of the REST transport for this REST service
  - getApiDoc
```
public String getApiDoc()
```
  - setApiDoc
```
public void setApiDoc(String apiDoc)
```
    The swagger api doc resource to use. The resource is loaded from classpath by default and must be in JSon format.
  - getHost
```
public String getHost()
```
  - setHost
```
public void setHost(String host)
```
    Host and port of HTTP service to use (override host in swagger schema)
  - getQueryParameters
```
public String getQueryParameters()
```
  - setQueryParameters
```
public void setQueryParameters(String queryParameters)
```
    Query parameters for the HTTP service to call
  - getBindingMode
```
public org.apache.camel.spi.RestConfiguration.RestBindingMode getBindingMode()
```
  - setBindingMode
```
public void setBindingMode(org.apache.camel.spi.RestConfiguration.RestBindingMode bindingMode)
```
    Configures the binding mode for the producer. If set to anything other than 'off' the producer will try to convert the body of the incoming message from inType to the json or xml, and the response from json or xml to outType.
  - setBindingMode
```
public void setBindingMode(String bindingMode)
```
  - createProducer
```
public org.apache.camel.Producer createProducer()
                                         throws Exception
```
    Throws:
    
    Exception
  - createConsumer
```
public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor)
                                         throws Exception
```
    Throws:
    
    Exception
  - isLenientProperties
```
public boolean isLenientProperties()
```
    Specified by:
    
    isLenientProperties in interface org.apache.camel.Endpoint
    
    Overrides:
    
    isLenientProperties in class org.apache.camel.support.DefaultEndpoint

Class RestEndpoint

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.camel.Service

Methods inherited from interface org.apache.camel.CamelContextAware

Field Detail

DEFAULT_REST_CONSUMER_COMPONENTS

DEFAULT_REST_PRODUCER_COMPONENTS

DEFAULT_API_COMPONENT_NAME

RESOURCE_PATH

Constructor Detail

RestEndpoint

Method Detail

getComponent

getMethod

setMethod

getPath

setPath

getUriTemplate

setUriTemplate

getConsumes

setConsumes

getProduces

setProduces

getProducerComponentName

setProducerComponentName

getConsumerComponentName

setConsumerComponentName

getInType

setInType

getOutType

setOutType

getRouteId

setRouteId

getDescription

setDescription

getParameters

setParameters

getApiDoc

setApiDoc

getHost

setHost

getQueryParameters

setQueryParameters

getBindingMode

setBindingMode

setBindingMode

createProducer

createConsumer

isLenientProperties