org.apache.camel.component.rest

Class RestApiEndpoint

java.lang.Object

org.apache.camel.support.service.ServiceSupport

org.apache.camel.support.DefaultEndpoint

org.apache.camel.component.rest.RestApiEndpoint

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.16.0",
             scheme="rest-api",
             title="REST API",
             syntax="rest-api:path/contextIdPattern",
             consumerOnly=true,
             label="core,rest",
             lenientProperties=true)
public class RestApiEndpoint
extends org.apache.camel.support.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.service.ServiceSupport

BUILDED, FAILED, INITIALIZED, lock, log, NEW, SHUTDOWN, SHUTTINGDOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

Constructor Summary

Constructors

Constructor and Description
RestApiEndpoint(String endpointUri, RestApiComponent component)

Method Summary

Modifier and Type	Method and Description
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor)
org.apache.camel.Producer	createProducer()
String	getApiComponentName()
RestApiComponent	getComponent()
String	getConsumerComponentName()
String	getContextIdPattern()
Map<String,Object>	getParameters()
String	getPath()
boolean	isLenientProperties()
void	setApiComponentName(String apiComponentName) The Camel Rest API component to use for generating the API of the REST services, such as swagger.
void	setConsumerComponentName(String consumerComponentName) The Camel Rest component to use for (consumer) the REST transport, such as jetty, servlet, undertow.
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.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_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()

Overrides:

getComponent in class org.apache.camel.support.DefaultEndpoint

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.

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.

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