Package org.apache.camel.component.rest

Class RestApiEndpoint

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.RestApiEndpoint
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="2.16.0", scheme="rest-api", title="REST API", syntax="rest-api:path", remote=false, consumerOnly=true, category={CORE,REST}, lenientProperties=true) public class RestApiEndpoint extends org.apache.camel.support.DefaultEndpoint
Expose OpenAPI Specification of the REST services defined using Camel REST DSL.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DEFAULT_API_COMPONENT_NAME
     
    static final String[]
    DEFAULT_REST_API_CONSUMER_COMPONENTS
     
    static final String
    RESOURCE_PATH
     

    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
    RestApiEndpoint(String endpointUri, RestApiComponent component)
     

  • Method Summary

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

      public static final String[] DEFAULT_REST_API_CONSUMER_COMPONENTS

    • DEFAULT_API_COMPONENT_NAME

      public static final String DEFAULT_API_COMPONENT_NAME
      See Also:

    • RESOURCE_PATH

      public static final String RESOURCE_PATH
      See Also:

  • Constructor Details

  • Method Details

    • isRemote

      public boolean isRemote()

    • getComponent

      public RestApiComponent getComponent()
      Specified by:
      getComponent in interface org.apache.camel.ComponentAware
      Overrides:
      getComponent in class org.apache.camel.support.DefaultEndpoint

    • getPath

      public String getPath()

    • setPath

      public void setPath(String path)
      The base path

    • getConsumerComponentName

      public String getConsumerComponentName()

    • setConsumerComponentName

      public void setConsumerComponentName(String consumerComponentName)
      The Camel Rest component to use for the consumer REST transport, such as jetty, servlet, undertow. If no component has been explicitly 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 openapi.

    • 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