org.apache.camel.component.http
Class HttpComponent

java.lang.Object
  extended by org.apache.camel.impl.ServiceSupport
      extended by org.apache.camel.impl.DefaultComponent
          extended by org.apache.camel.impl.HeaderFilterStrategyComponent
              extended by org.apache.camel.component.http.HttpComponent
All Implemented Interfaces:
CamelContextAware, Component, Service, ShutdownableService, HeaderFilterStrategyAware
Direct Known Subclasses:
JettyHttpComponent, ServletComponent

public class HttpComponent
extends HeaderFilterStrategyComponent

Defines the HTTP Component

Version:

Field Summary
protected  HttpBinding httpBinding
           
protected  HttpClientConfigurer httpClientConfigurer
           
protected  HttpConfiguration httpConfiguration
           
protected  org.apache.commons.httpclient.HttpConnectionManager httpConnectionManager
           
 
Constructor Summary
HttpComponent()
           
 
Method Summary
protected  HttpClientConfigurer configureAuth(HttpClientConfigurer configurer, AuthMethod authMethod, String username, String password, String domain, String host, Set<AuthMethod> authMethods)
          Configures the authentication method to be used
protected  HttpClientConfigurer configureProxyAuth(HttpClientConfigurer configurer, AuthMethod authMethod, String username, String password, String domain, String host, Set<AuthMethod> authMethods)
          Configures the proxy authentication method to be used
 void connect(HttpConsumer consumer)
          Connects the URL specified on the endpoint to the specified processor.
protected  Endpoint createEndpoint(String uri, String remaining, Map<String,Object> parameters)
          A factory method allowing derived components to create a new endpoint from the given URI, remaining path and optional parameters
protected  HttpClientConfigurer createHttpClientConfigurer(Map<String,Object> parameters, Set<AuthMethod> authMethods)
          Creates the HttpClientConfigurer based on the given parameters
 void disconnect(HttpConsumer consumer)
          Disconnects the URL specified on the endpoint from the specified processor.
 HttpBinding getHttpBinding()
           
 HttpClientConfigurer getHttpClientConfigurer()
           
 HttpConfiguration getHttpConfiguration()
           
 org.apache.commons.httpclient.HttpConnectionManager getHttpConnectionManager()
           
 void setHttpBinding(HttpBinding httpBinding)
           
 void setHttpClientConfigurer(HttpClientConfigurer httpClientConfigurer)
           
 void setHttpConfiguration(HttpConfiguration httpConfiguration)
           
 void setHttpConnectionManager(org.apache.commons.httpclient.HttpConnectionManager httpConnectionManager)
           
protected  boolean useIntrospectionOnEndpoint()
          Derived classes may wish to overload this to prevent the default introspection of URI parameters on the created Endpoint instance
 
Methods inherited from class org.apache.camel.impl.HeaderFilterStrategyComponent
getHeaderFilterStrategy, setEndpointHeaderFilterStrategy, setHeaderFilterStrategy
 
Methods inherited from class org.apache.camel.impl.DefaultComponent
afterConfiguration, createEndpoint, doStart, doStop, getAndRemoveParameter, getAndRemoveParameter, getCamelContext, ifStartsWithReturnRemainder, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceParameter, resolveAndRemoveReferenceParameter, setCamelContext, setProperties, validateParameters, validateURI
 
Methods inherited from class org.apache.camel.impl.ServiceSupport
addChildService, doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspended, isSuspending, removeChildService, resume, shutdown, start, start, stop, suspend
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

httpClientConfigurer

protected HttpClientConfigurer httpClientConfigurer

httpConnectionManager

protected org.apache.commons.httpclient.HttpConnectionManager httpConnectionManager

httpBinding

protected HttpBinding httpBinding

httpConfiguration

protected HttpConfiguration httpConfiguration
Constructor Detail

HttpComponent

public HttpComponent()
Method Detail

connect

public void connect(HttpConsumer consumer)
             throws Exception
Connects the URL specified on the endpoint to the specified processor.

Parameters:
consumer - the consumer
Throws:
Exception - can be thrown

disconnect

public void disconnect(HttpConsumer consumer)
                throws Exception
Disconnects the URL specified on the endpoint from the specified processor.

Parameters:
consumer - the consumer
Throws:
Exception - can be thrown

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,
                                             AuthMethod 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,
                                                  AuthMethod 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 Endpoint createEndpoint(String uri,
                                  String remaining,
                                  Map<String,Object> parameters)
                           throws Exception
Description copied from class: DefaultComponent
A factory method allowing derived components to create a new endpoint from the given URI, remaining path and optional parameters

Specified by:
createEndpoint in class DefaultComponent
Parameters:
uri - the full URI of the endpoint
remaining - the remaining part of the URI without the query parameters or component prefix
parameters - the optional parameters passed in
Returns:
a newly created endpoint or null if the endpoint cannot be created based on the inputs
Throws:
Exception

useIntrospectionOnEndpoint

protected boolean useIntrospectionOnEndpoint()
Description copied from class: DefaultComponent
Derived classes may wish to overload this to prevent the default introspection of URI parameters on the created Endpoint instance

Overrides:
useIntrospectionOnEndpoint in class DefaultComponent

getHttpClientConfigurer

public HttpClientConfigurer getHttpClientConfigurer()

setHttpClientConfigurer

public void setHttpClientConfigurer(HttpClientConfigurer httpClientConfigurer)

getHttpConnectionManager

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

setHttpConnectionManager

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

getHttpBinding

public HttpBinding getHttpBinding()

setHttpBinding

public void setHttpBinding(HttpBinding httpBinding)

getHttpConfiguration

public HttpConfiguration getHttpConfiguration()

setHttpConfiguration

public void setHttpConfiguration(HttpConfiguration httpConfiguration)


Apache CAMEL