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

Class RestOpenApiEndpoint

  • 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="3.1.0",
             scheme="rest-openapi",
             title="REST OpenApi",
             syntax="rest-openapi:specificationUri#operationId",
             category={OPENAPI,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

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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.apache.camel.Consumer createConsumer​(org.apache.camel.Processor processor)  
      org.apache.camel.Producer createProducer()  
      String getBasePath()  
      static String getBasePathFromOasDocument​(io.apicurio.datamodels.openapi.models.OasDocument openapi)  
      String getComponentName()  
      String getConsumes()  
      String getHost()  
      String getOperationId()  
      String getProduces()  
      URI getSpecificationUri()  
      boolean isLenientProperties()  
      static String parseVariables​(String url, io.apicurio.datamodels.openapi.v3.models.Oas30Server 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 setSpecificationUri​(URI specificationUri)  

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

        configureConsumer, configurePollingConsumer, configureProperties, createAsyncProducer, createEndpointUri, createExchange, createExchange, createPollingConsumer, doInit, doStart, doStop, equals, getCamelContext, getComponent, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBasicPropertyBinding, isBridgeErrorHandler, isLazyStartProducer, isPollingConsumerBlockWhenFull, isSingleton, isSynchronous, setBasicPropertyBinding, setBridgeErrorHandler, setCamelContext, setComponent, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setLazyStartProducer, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

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

        build, doBuild, doFail, doLifecycleChange, doResume, doShutdown, 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 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

    • Method Detail

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

      • getBasePathFromOasDocument

        public static String getBasePathFromOasDocument​(io.apicurio.datamodels.openapi.models.OasDocument openapi)

      • parseVariables

        public static String parseVariables​(String url,
                                    io.apicurio.datamodels.openapi.v3.models.Oas30Server server)