org.apache.camel.component.http

Class HttpComponent

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultComponent

org.apache.camel.impl.UriEndpointComponent

org.apache.camel.impl.HeaderFilterStrategyComponent

org.apache.camel.http.common.HttpCommonComponent

org.apache.camel.component.http.HttpComponent

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.Component, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HeaderFilterStrategyAware, org.apache.camel.spi.RestProducerFactory, org.apache.camel.SSLContextParametersAware, org.apache.camel.StatefulService, org.apache.camel.SuspendableService, org.apache.camel.VerifiableComponent

@Metadata(label="verifiers",
          enums="parameters,connectivity")
public class HttpComponent
extends org.apache.camel.http.common.HttpCommonComponent
implements org.apache.camel.spi.RestProducerFactory, org.apache.camel.VerifiableComponent, org.apache.camel.SSLContextParametersAware

The HTTP Component

Field Summary

Fields

Modifier and Type	Field and Description
protected HttpClientConfigurer	httpClientConfigurer
protected org.apache.commons.httpclient.HttpConnectionManager	httpConnectionManager

Fields inherited from class org.apache.camel.http.common.HttpCommonComponent

allowJavaSerializedObject, httpBinding, httpConfiguration

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
HttpComponent()
HttpComponent(Class<? extends HttpEndpoint> endpointClass)

Method Summary

Modifier and Type	Method and Description
protected HttpClientConfigurer	configureAuth(HttpClientConfigurer configurer, String authMethod, String username, String password, String domain, String host, Set<AuthMethod> authMethods) Configures the authentication method to be used
protected HttpClientConfigurer	configureProxyAuth(HttpClientConfigurer configurer, String authMethod, String username, String password, String domain, String host, Set<AuthMethod> authMethods) Configures the proxy authentication method to be used
protected org.apache.camel.Endpoint	createEndpoint(String uri, String remaining, Map<String,Object> parameters)
protected HttpClientConfigurer	createHttpClientConfigurer(Map<String,Object> parameters, Set<AuthMethod> authMethods) Creates the HttpClientConfigurer based on the given parameters
protected HttpEndpoint	createHttpEndpoint(String uri, HttpComponent component, org.apache.commons.httpclient.params.HttpClientParams clientParams, org.apache.commons.httpclient.HttpConnectionManager connectionManager, HttpClientConfigurer configurer)
org.apache.camel.Producer	createProducer(org.apache.camel.CamelContext camelContext, String host, String verb, String basePath, String uriTemplate, String queryParameters, String consumes, String produces, org.apache.camel.spi.RestConfiguration configuration, Map<String,Object> parameters)
HttpClientConfigurer	getHttpClientConfigurer()
org.apache.commons.httpclient.HttpConnectionManager	getHttpConnectionManager()
org.apache.camel.ComponentVerifier	getVerifier()
boolean	isUseGlobalSslContextParameters()
void	setAllowJavaSerializedObject(boolean allowJavaSerializedObject) Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object This is by default turned off.
void	setHttpBinding(org.apache.camel.http.common.HttpBinding httpBinding) To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
void	setHttpClientConfigurer(HttpClientConfigurer httpClientConfigurer) To use the custom HttpClientConfigurer to perform configuration of the HttpClient that will be used.
void	setHttpConfiguration(org.apache.camel.http.common.HttpConfiguration httpConfiguration) To use the shared HttpConfiguration as base configuration.
void	setHttpConnectionManager(org.apache.commons.httpclient.HttpConnectionManager httpConnectionManager) To use a custom HttpConnectionManager to manage connections
void	setUseGlobalSslContextParameters(boolean useGlobalSslContextParameters) Enable usage of global SSL context parameters.

Methods inherited from class org.apache.camel.http.common.HttpCommonComponent

connect, disconnect, getHttpBinding, getHttpConfiguration, getParameter, getParameter, isAllowJavaSerializedObject, useIntrospectionOnEndpoint

Methods inherited from class org.apache.camel.impl.HeaderFilterStrategyComponent

getHeaderFilterStrategy, setEndpointHeaderFilterStrategy, setHeaderFilterStrategy

Methods inherited from class org.apache.camel.impl.UriEndpointComponent

createComponentConfiguration, createParameterConfigurationMap, getEndpointClass, getParameterConfigurationMap, populateParameterConfigurationMap, setEndpointClass

Methods inherited from class org.apache.camel.impl.DefaultComponent

afterConfiguration, createConfiguration, createEndpoint, doStart, doStop, getAndRemoveOrResolveReferenceParameter, getAndRemoveOrResolveReferenceParameter, getAndRemoveParameter, getAndRemoveParameter, getCamelContext, getExtension, getSupportedExtensions, ifStartsWithReturnRemainder, isResolvePropertyPlaceholders, preProcessUri, registerExtension, registerExtension, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceParameter, resolveAndRemoveReferenceParameter, setCamelContext, setProperties, setProperties, setResolvePropertyPlaceholders, useRawUri, validateParameters, validateURI

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.camel.SSLContextParametersAware

retrieveGlobalSslContextParameters

Methods inherited from interface org.apache.camel.CamelContextAware

getCamelContext, setCamelContext

Field Detail

httpClientConfigurer

@Metadata(label="advanced")
protected HttpClientConfigurer httpClientConfigurer

httpConnectionManager

@Metadata(label="advanced")
protected org.apache.commons.httpclient.HttpConnectionManager httpConnectionManager

Constructor Detail

HttpComponent

public HttpComponent()

HttpComponent

public HttpComponent(Class<? extends HttpEndpoint> endpointClass)

Method Detail

createHttpClientConfigurer

protected HttpClientConfigurer createHttpClientConfigurer(Map<String,Object> parameters,
                                                          Set<AuthMethod> authMethods)

Creates the HttpClientConfigurer based on the given parameters

Parameters:

parameters - the map of parameters

Returns:

the configurer

configureAuth

protected HttpClientConfigurer configureAuth(HttpClientConfigurer configurer,
                                             String authMethod,
                                             String username,
                                             String password,
                                             String domain,
                                             String host,
                                             Set<AuthMethod> authMethods)

Configures the authentication method to be used

Returns:

configurer to used

configureProxyAuth

protected HttpClientConfigurer configureProxyAuth(HttpClientConfigurer configurer,
                                                  String authMethod,
                                                  String username,
                                                  String password,
                                                  String domain,
                                                  String host,
                                                  Set<AuthMethod> authMethods)

Configures the proxy authentication method to be used

Returns:

configurer to used

createEndpoint

protected org.apache.camel.Endpoint createEndpoint(String uri,
                                                   String remaining,
                                                   Map<String,Object> parameters)
                                            throws Exception

Specified by:

createEndpoint in class org.apache.camel.impl.DefaultComponent

Throws:

Exception

createHttpEndpoint

protected HttpEndpoint createHttpEndpoint(String uri,
                                          HttpComponent component,
                                          org.apache.commons.httpclient.params.HttpClientParams clientParams,
                                          org.apache.commons.httpclient.HttpConnectionManager connectionManager,
                                          HttpClientConfigurer configurer)
                                   throws URISyntaxException

Throws:

URISyntaxException

createProducer

public org.apache.camel.Producer createProducer(org.apache.camel.CamelContext camelContext,
                                                String host,
                                                String verb,
                                                String basePath,
                                                String uriTemplate,
                                                String queryParameters,
                                                String consumes,
                                                String produces,
                                                org.apache.camel.spi.RestConfiguration configuration,
                                                Map<String,Object> parameters)
                                         throws Exception

Specified by:

createProducer in interface org.apache.camel.spi.RestProducerFactory

Throws:

Exception

getHttpClientConfigurer

public HttpClientConfigurer getHttpClientConfigurer()

setHttpClientConfigurer

public void setHttpClientConfigurer(HttpClientConfigurer httpClientConfigurer)

To use the custom HttpClientConfigurer to perform configuration of the HttpClient that will be used.

getHttpConnectionManager

public org.apache.commons.httpclient.HttpConnectionManager getHttpConnectionManager()

setHttpConnectionManager

public void setHttpConnectionManager(org.apache.commons.httpclient.HttpConnectionManager httpConnectionManager)

To use a custom HttpConnectionManager to manage connections

setHttpBinding

public void setHttpBinding(org.apache.camel.http.common.HttpBinding httpBinding)

To use a custom HttpBinding to control the mapping between Camel message and HttpClient.

Overrides:

setHttpBinding in class org.apache.camel.http.common.HttpCommonComponent

setHttpConfiguration

public void setHttpConfiguration(org.apache.camel.http.common.HttpConfiguration httpConfiguration)

To use the shared HttpConfiguration as base configuration.

Overrides:

setHttpConfiguration in class org.apache.camel.http.common.HttpCommonComponent

setAllowJavaSerializedObject

public void setAllowJavaSerializedObject(boolean allowJavaSerializedObject)

Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object

This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk.

Overrides:

setAllowJavaSerializedObject in class org.apache.camel.http.common.HttpCommonComponent

isUseGlobalSslContextParameters

public boolean isUseGlobalSslContextParameters()

Specified by:

isUseGlobalSslContextParameters in interface org.apache.camel.SSLContextParametersAware

setUseGlobalSslContextParameters

public void setUseGlobalSslContextParameters(boolean useGlobalSslContextParameters)

Enable usage of global SSL context parameters.

Specified by:

setUseGlobalSslContextParameters in interface org.apache.camel.SSLContextParametersAware

getVerifier

public org.apache.camel.ComponentVerifier getVerifier()

Specified by:

getVerifier in interface org.apache.camel.VerifiableComponent