org.apache.camel.spi.RestProducerFactory Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of camel-core Show documentation
Show all versions of camel-core Show documentation
The Core Camel Java DSL based router
/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.camel.spi;
import java.util.Map;
import org.apache.camel.CamelContext;
import org.apache.camel.Exchange;
import org.apache.camel.Producer;
/**
* Allows SPI to plugin a {@link RestProducerFactory} that creates the Camel {@link Producer} responsible
* for performing HTTP requests to call a remote REST service.
*/
public interface RestProducerFactory {
/**
* Creates a new REST producer.
*
* @param camelContext the camel context
* @param host host in the syntax scheme:hostname:port, such as http:myserver:8080
* @param verb HTTP verb such as GET, POST
* @param basePath base path
* @param uriTemplate uri template
* @param queryParameters uri query parameters
* @param consumes media-types for what the REST service consume as input (accept-type), is null or */* for anything
* @param produces media-types for what the REST service produces as output, can be null
* @param parameters additional parameters
* @return a newly created REST producer
* @throws Exception can be thrown
*/
Producer createProducer(CamelContext camelContext, String host,
String verb, String basePath, String uriTemplate, String queryParameters,
String consumes, String produces, Map parameters) throws Exception;
}