org.apache.camel.component.rest

Class RestEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.rest.RestEndpoint

All Implemented Interfaces:

CamelContextAware, Endpoint, IsSingleton, Service, ShutdownableService, HasId, StatefulService, SuspendableService

@UriEndpoint(firstVersion="2.14.0",
             scheme="rest",
             title="REST",
             syntax="rest:method:path:uriTemplate",
             label="core,rest",
             lenientProperties=true)
public class RestEndpoint
extends 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.ServiceSupport

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

Constructor Summary

Constructors

Constructor and Description
RestEndpoint(String endpointUri, RestComponent component)

Method Summary

Modifier and Type	Method and Description
Consumer	createConsumer(Processor processor) Creates a new Event Driven Consumer which consumes messages from the endpoint using the given processor
Producer	createProducer() Creates a new producer which is used send messages into the endpoint
String	getApiDoc()
RestBindingMode	getBindingMode()
RestComponent	getComponent() Returns the component that created this endpoint.
String	getComponentName()
String	getConsumes()
String	getDescription()
String	getHost()
String	getInType()
String	getMethod()
String	getOutType()
Map<String,Object>	getParameters()
String	getPath()
String	getProduces()
String	getQueryParameters()
String	getRouteId()
String	getUriTemplate()
boolean	isLenientProperties() Should all properties be known or does the endpoint allow unknown options? lenient = false means that the endpoint should validate that all given options is known and configured properly.
boolean	isSingleton() Whether this class supports being singleton or not.
void	setApiDoc(String apiDoc) The swagger api doc resource to use.
void	setBindingMode(RestBindingMode bindingMode) Configures the binding mode for the producer.
void	setComponentName(String componentName) The Camel Rest component to use for the REST transport, such as restlet, spark-rest.
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	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.impl.DefaultEndpoint

configureConsumer, configurePollingConsumer, configureProperties, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, createPollingConsumer, doStart, doStop, equals, getCamelContext, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBridgeErrorHandler, isPollingConsumerBlockWhenFull, isSynchronous, setBridgeErrorHandler, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, 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, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Service

start, stop

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

Description copied from class: DefaultEndpoint

Returns the component that created this endpoint.

Overrides:

getComponent in class DefaultEndpoint

Returns:

the component that created this endpoint, or null if none set

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.

getComponentName

public String getComponentName()

setComponentName

public void setComponentName(String componentName)

The Camel Rest component to use for the REST transport, such as restlet, spark-rest. 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 RestBindingMode getBindingMode()

setBindingMode

public void setBindingMode(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.

createProducer

public Producer createProducer()
                        throws Exception

Description copied from interface: Endpoint

Creates a new producer which is used send messages into the endpoint

Returns:

a newly created producer

Throws:

Exception - can be thrown

createConsumer

public Consumer createConsumer(Processor processor)
                        throws Exception

Description copied from interface: Endpoint

Creates a new Event Driven Consumer which consumes messages from the endpoint using the given processor

Parameters:

processor - the given processor

Returns:

a newly created consumer

Throws:

Exception - can be thrown

isSingleton

public boolean isSingleton()

Description copied from interface: IsSingleton

Whether this class supports being singleton or not.

Returns:

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

isLenientProperties

public boolean isLenientProperties()

Description copied from interface: Endpoint

Should all properties be known or does the endpoint allow unknown options?

lenient = false means that the endpoint should validate that all given options is known and configured properly. lenient = true means that the endpoint allows additional unknown options to be passed to it but does not throw a ResolveEndpointFailedException when creating the endpoint.

This options is used by a few components for instance the HTTP based that can have dynamic URI options appended that is targeted for an external system.

Most endpoints is configured to be not lenient.

Specified by:

isLenientProperties in interface Endpoint

Overrides:

isLenientProperties in class DefaultEndpoint

Returns:

whether properties is lenient or not