Package org.apache.camel.spi
Interface RestApiConsumerFactory
-
public interface RestApiConsumerFactory
Allows SPI to plugin aRestApiConsumerFactory
that creates the CamelConsumer
responsible for handling incoming HTTP GET requests from clients that request to access the REST API documentation. For example most of the Camel components that supports REST-DSL does that, such as camel-jetty, camel-netty-http.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Consumer
createApiConsumer(CamelContext camelContext, Processor processor, String contextPath, RestConfiguration configuration, Map<String,Object> parameters)
Creates a new REST API Event Driven Consumer, which provides API listing of the REST services
-
-
-
Method Detail
-
createApiConsumer
Consumer createApiConsumer(CamelContext camelContext, Processor processor, String contextPath, RestConfiguration configuration, Map<String,Object> parameters) throws Exception
Creates a new REST API Event Driven Consumer, which provides API listing of the REST services- Parameters:
camelContext
- the camel contextprocessor
- the processorcontextPath
- the context-pathparameters
- additional parameters- Returns:
- a newly created REST API consumer
- Throws:
Exception
- can be thrown
-
-