Package org.apache.camel.component.rest.openapi

Class RestOpenApiEndpoint

java.lang.Object

org.apache.camel.support.service.BaseService

org.apache.camel.support.service.ServiceSupport

org.apache.camel.support.DefaultEndpoint

org.apache.camel.component.rest.openapi.RestOpenApiEndpoint

All Implemented Interfaces:

AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.ComponentAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasCamelContext, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

@UriEndpoint(firstVersion="3.1.0",
             scheme="rest-openapi",
             title="REST OpenApi",
             syntax="rest-openapi:specificationUri#operationId",
             category={REST,API})
public final class RestOpenApiEndpoint
extends org.apache.camel.support.DefaultEndpoint

To call REST services using OpenAPI specification as contract.

Field Summary

Fields

Modifier and Type	Field	Description
static final String[]	DEFAULT_REST_OPENAPI_CONSUMER_COMPONENTS

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
RestOpenApiEndpoint()
RestOpenApiEndpoint(String uri, String remaining, RestOpenApiComponent component, Map<String,Object> parameters)

Method Summary

Modifier and Type	Method	Description
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor)
protected org.apache.camel.Consumer	createConsumerFor(String basePath, RestOpenApiProcessor processor)
org.apache.camel.Producer	createProducer()
String	getApiContextPath()
String	getBasePath()
String	getBindingPackageScan()
RestOpenApiComponent	getComponent()
String	getComponentName()
String	getConsumerComponentName()
String	getConsumes()
String	getHost()
String	getMissingOperation()
String	getMockIncludePattern()
String	getOperationId()
String	getProduces()
RestOpenapiProcessorStrategy	getRestOpenapiProcessorStrategy()
String	getSpecificationUri()
boolean	isClientRequestValidation()
boolean	isClientResponseValidation()
boolean	isLenientProperties()
boolean	isRequestValidationEnabled()
void	setApiContextPath(String apiContextPath)
void	setBasePath(String basePath)
void	setBindingPackageScan(String bindingPackageScan)
void	setClientRequestValidation(boolean clientRequestValidation)
void	setClientResponseValidation(boolean clientResponseValidation)
void	setComponentName(String componentName)
void	setConsumerComponentName(String consumerComponentName)
void	setConsumes(String consumes)
void	setHost(String host)
void	setMissingOperation(String missingOperation)
void	setMockIncludePattern(String mockIncludePattern)
void	setOperationId(String operationId)
void	setProduces(String produces)
void	setRequestValidationEnabled(boolean requestValidationEnabled)
void	setRestOpenapiProcessorStrategy(RestOpenapiProcessorStrategy restOpenapiProcessorStrategy)
void	setSpecificationUri(String specificationUri)

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

configureConsumer, configureExchange, configurePollingConsumer, configureProperties, createAsyncProducer, createEndpointUri, createExchange, createExchange, createPollingConsumer, doInit, equals, getCamelContext, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, isPollingConsumerBlockWhenFull, isPollingConsumerCopy, isSingleton, setAutowiredEnabled, setBridgeErrorHandler, setCamelContext, setComponent, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setLazyStartProducer, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerCopy, setPollingConsumerQueueSize, setProperties, toString

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

build, doBuild, doFail, doLifecycleChange, doResume, doShutdown, doStart, doStop, doSuspend, fail, getInternalLock, 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.ComponentAware

getComponent

Methods inherited from interface org.apache.camel.Endpoint

getEndpointBaseUri, isRemote, isSingletonProducer

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

Field Details

DEFAULT_REST_OPENAPI_CONSUMER_COMPONENTS

public static final String[] DEFAULT_REST_OPENAPI_CONSUMER_COMPONENTS

Constructor Details

RestOpenApiEndpoint

public RestOpenApiEndpoint()

RestOpenApiEndpoint

public RestOpenApiEndpoint(String uri,
 String remaining,
 RestOpenApiComponent component,
 Map<String,Object> parameters)

Method Details

getComponent

public RestOpenApiComponent getComponent()

Specified by:

getComponent in interface org.apache.camel.ComponentAware

Overrides:

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

createConsumer

public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor)
                                         throws Exception

Throws:

Exception

createConsumerFor

protected org.apache.camel.Consumer createConsumerFor(String basePath,
 RestOpenApiProcessor processor)
                                               throws Exception

Throws:

Exception

createProducer

public org.apache.camel.Producer createProducer()
                                         throws Exception

Throws:

Exception

getBasePath

public String getBasePath()

getComponentName

public String getComponentName()

getConsumerComponentName

public String getConsumerComponentName()

getConsumes

public String getConsumes()

getHost

public String getHost()

getOperationId

public String getOperationId()

getProduces

public String getProduces()

getSpecificationUri

public String getSpecificationUri()

isLenientProperties

public boolean isLenientProperties()

Specified by:

isLenientProperties in interface org.apache.camel.Endpoint

Overrides:

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

setBasePath

public void setBasePath(String basePath)

setComponentName

public void setComponentName(String componentName)

setConsumerComponentName

public void setConsumerComponentName(String consumerComponentName)

setConsumes

public void setConsumes(String consumes)

setHost

public void setHost(String host)

setOperationId

public void setOperationId(String operationId)

setProduces

public void setProduces(String produces)

setSpecificationUri

public void setSpecificationUri(String specificationUri)

setRequestValidationEnabled

public void setRequestValidationEnabled(boolean requestValidationEnabled)

isRequestValidationEnabled

public boolean isRequestValidationEnabled()

isClientRequestValidation

public boolean isClientRequestValidation()

setClientRequestValidation

public void setClientRequestValidation(boolean clientRequestValidation)

isClientResponseValidation

public boolean isClientResponseValidation()

setClientResponseValidation

public void setClientResponseValidation(boolean clientResponseValidation)

getRestOpenapiProcessorStrategy

public RestOpenapiProcessorStrategy getRestOpenapiProcessorStrategy()

setRestOpenapiProcessorStrategy

public void setRestOpenapiProcessorStrategy(RestOpenapiProcessorStrategy restOpenapiProcessorStrategy)

getMissingOperation

public String getMissingOperation()

setMissingOperation

public void setMissingOperation(String missingOperation)

setMockIncludePattern

public void setMockIncludePattern(String mockIncludePattern)

getMockIncludePattern

public String getMockIncludePattern()

getApiContextPath

public String getApiContextPath()

setApiContextPath

public void setApiContextPath(String apiContextPath)

getBindingPackageScan

public String getBindingPackageScan()

setBindingPackageScan

public void setBindingPackageScan(String bindingPackageScan)