org.apache.camel.component.rest

Class RestApiEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.rest.RestApiEndpoint

All Implemented Interfaces:

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

@UriEndpoint(firstVersion="2.16.0",
             scheme="rest-api",
             title="REST API",
             syntax="rest-api:path/contextIdPattern",
             consumerOnly=true,
             label="core,rest",
             lenientProperties=true)
public class RestApiEndpoint
extends DefaultEndpoint

The rest-api component is used for providing Swagger API of the REST services which has been defined using the rest-dsl in Camel.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_API_COMPONENT_NAME
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
RestApiEndpoint(String endpointUri, RestApiComponent 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	getApiComponentName()
RestApiComponent	getComponent() Returns the component that created this endpoint.
String	getComponentName()
String	getContextIdPattern()
Map<String,Object>	getParameters()
String	getPath()
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	setApiComponentName(String apiComponentName) The Camel Rest API component to use for generating the API of the REST services, such as swagger.
void	setComponentName(String componentName) The Camel Rest component to use for the REST transport, such as restlet, spark-rest.
void	setContextIdPattern(String contextIdPattern) Optional CamelContext id pattern to only allow Rest APIs from rest services within CamelContext's which name matches the pattern.
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

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_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

RestApiEndpoint

public RestApiEndpoint(String endpointUri,
                       RestApiComponent component)

Method Detail

getComponent

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

getPath

public String getPath()

setPath

public void setPath(String path)

The base path

getContextIdPattern

public String getContextIdPattern()

setContextIdPattern

public void setContextIdPattern(String contextIdPattern)

Optional CamelContext id pattern to only allow Rest APIs from rest services within CamelContext's which name matches the pattern.

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.

getApiComponentName

public String getApiComponentName()

setApiComponentName

public void setApiComponentName(String apiComponentName)

The Camel Rest API component to use for generating the API of the REST services, such as swagger.

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

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