001/** 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache License, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the License for the specific language governing permissions and 015 * limitations under the License. 016 */ 017package org.apache.camel.spi; 018 019import java.util.Map; 020 021import org.apache.camel.CamelContext; 022import org.apache.camel.Consumer; 023import org.apache.camel.Processor; 024 025/** 026 * Allows SPI to plugin a {@link RestApiConsumerFactory} that creates the Camel {@link Consumer} responsible 027 * for handling incoming HTTP GET requests from clients that request to access the REST API documentation. 028 * <p/> 029 * For example most of the Camel components that supports REST-DSL does that, 030 * such as <tt>camel-jetty</tt>, <tt>camel-netty4-http</tt>. 031 */ 032public interface RestApiConsumerFactory { 033 034 /** 035 * Creates a new REST API <a 036 * href="http://camel.apache.org/event-driven-consumer.html">Event 037 * Driven Consumer</a>, which provides API listing of the REST services 038 * 039 * @param camelContext the camel context 040 * @param processor the processor 041 * @param contextPath the context-path 042 * @param parameters additional parameters 043 * 044 * @return a newly created REST API consumer 045 * @throws Exception can be thrown 046 */ 047 Consumer createApiConsumer(CamelContext camelContext, Processor processor, String contextPath, 048 RestConfiguration configuration, Map<String, Object> parameters) throws Exception; 049 050}