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}, producerOnly=true) public final class RestOpenApiEndpoint extends org.apache.camel.support.DefaultEndpoint
Configure REST producers based on an OpenAPI specification document delegating to a component implementing the RestProducerFactory interface.

  • Field Summary

    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)
     
    org.apache.camel.Producer
    createProducer()
     
    String
    getBasePath()
     
    static String
    getBasePathFromOpenApi(io.swagger.v3.oas.models.OpenAPI openApi)
     
    String
    getComponentName()
     
    String
    getConsumes()
     
    String
    getHost()
     
    String
    getOperationId()
     
    String
    getProduces()
     
    RequestValidationCustomizer
    getRequestValidationCustomizer()
     
    Map<String,Object>
    getRequestValidationLevels()
     
    URI
    getSpecificationUri()
     
    boolean
    isLenientProperties()
     
    boolean
    isRequestValidationEnabled()
     
    static String
    parseVariables(String url, io.swagger.v3.oas.models.servers.Server server)
     
    void
    setBasePath(String basePath)
     
    void
    setComponentName(String componentName)
     
    void
    setConsumes(String consumes)
     
    void
    setHost(String host)
     
    void
    setOperationId(String operationId)
     
    void
    setProduces(String produces)
     
    void
    setRequestValidationCustomizer(RequestValidationCustomizer requestValidationCustomizer)
     
    void
    setRequestValidationEnabled(boolean requestValidationEnabled)
     
    void
    setRequestValidationLevels(Map<String,Object> requestValidationLevels)
     
    void
    setSpecificationUri(URI specificationUri)
     

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

    configureConsumer, configureExchange, configurePollingConsumer, configureProperties, createAsyncProducer, createEndpointUri, createExchange, createExchange, createPollingConsumer, doInit, equals, getCamelContext, getComponent, 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, 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, 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

  • Constructor Details

  • Method Details

    • createConsumer

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

    • createProducer

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

    • getBasePath

      public String getBasePath()

    • getComponentName

      public String getComponentName()

    • getConsumes

      public String getConsumes()

    • getHost

      public String getHost()

    • getOperationId

      public String getOperationId()

    • getProduces

      public String getProduces()

    • getSpecificationUri

      public URI 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)

    • 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(URI specificationUri)

    • setRequestValidationCustomizer

      public void setRequestValidationCustomizer(RequestValidationCustomizer requestValidationCustomizer)

    • getRequestValidationCustomizer

      public RequestValidationCustomizer getRequestValidationCustomizer()

    • setRequestValidationEnabled

      public void setRequestValidationEnabled(boolean requestValidationEnabled)

    • isRequestValidationEnabled

      public boolean isRequestValidationEnabled()

    • setRequestValidationLevels

      public void setRequestValidationLevels(Map<String,Object> requestValidationLevels)

    • getRequestValidationLevels

      public Map<String,Object> getRequestValidationLevels()

    • getBasePathFromOpenApi

      public static String getBasePathFromOpenApi(io.swagger.v3.oas.models.OpenAPI openApi)

    • parseVariables

      public static String parseVariables(String url, io.swagger.v3.oas.models.servers.Server server)