Java tutorial
/** * 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.component.http4; import java.net.URI; import java.util.HashMap; import java.util.Map; import org.apache.camel.Endpoint; import org.apache.camel.ResolveEndpointFailedException; import org.apache.camel.impl.HeaderFilterStrategyComponent; import org.apache.camel.util.CastUtils; import org.apache.camel.util.IntrospectionSupport; import org.apache.camel.util.URISupport; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.apache.http.auth.params.AuthParamBean; import org.apache.http.client.params.ClientParamBean; import org.apache.http.conn.ClientConnectionManager; import org.apache.http.conn.params.ConnConnectionParamBean; import org.apache.http.conn.params.ConnManagerParamBean; import org.apache.http.conn.params.ConnPerRouteBean; import org.apache.http.conn.params.ConnRouteParamBean; import org.apache.http.conn.scheme.PlainSocketFactory; import org.apache.http.conn.scheme.Scheme; import org.apache.http.conn.scheme.SchemeRegistry; import org.apache.http.conn.ssl.SSLSocketFactory; import org.apache.http.cookie.params.CookieSpecParamBean; import org.apache.http.impl.conn.tsccm.ThreadSafeClientConnManager; import org.apache.http.params.BasicHttpParams; import org.apache.http.params.HttpConnectionParamBean; import org.apache.http.params.HttpParams; import org.apache.http.params.HttpProtocolParamBean; /** * Defines the <a href="http://camel.apache.org/http.html">HTTP * Component</a> * * @version $Revision$ */ public class HttpComponent extends HeaderFilterStrategyComponent { private static final transient Log LOG = LogFactory.getLog(HttpComponent.class); protected HttpClientConfigurer httpClientConfigurer; protected ClientConnectionManager clientConnectionManager; protected HttpBinding httpBinding; // options to the default created http connection manager protected int maxTotalConnections = 200; protected int connectionsPerRoute = 20; /** * Connects the URL specified on the endpoint to the specified processor. * * @param consumer the consumer * @throws Exception can be thrown */ public void connect(HttpConsumer consumer) throws Exception { } /** * Disconnects the URL specified on the endpoint from the specified processor. * * @param consumer the consumer * @throws Exception can be thrown */ public void disconnect(HttpConsumer consumer) throws Exception { } /** * Creates the HttpClientConfigurer based on the given parameters * * @param parameters the map of parameters * @return the configurer */ protected HttpClientConfigurer createHttpClientConfigurer(Map<String, Object> parameters) { // prefer to use endpoint configured over component configured HttpClientConfigurer configurer = resolveAndRemoveReferenceParameter(parameters, "httpClientConfigurerRef", HttpClientConfigurer.class); if (configurer == null) { // try without ref configurer = resolveAndRemoveReferenceParameter(parameters, "httpClientConfigurer", HttpClientConfigurer.class); } if (configurer == null) { // fallback to component configured configurer = getHttpClientConfigurer(); } // check the user name and password for basic authentication String username = getAndRemoveParameter(parameters, "username", String.class); String password = getAndRemoveParameter(parameters, "password", String.class); String domain = getAndRemoveParameter(parameters, "domain", String.class); String host = getAndRemoveParameter(parameters, "host", String.class); if (username != null && password != null) { configurer = CompositeHttpConfigurer.combineConfigurers(configurer, new BasicAuthenticationHttpClientConfigurer(username, password, domain, host)); } // check the proxy details for proxy configuration String proxyHost = getAndRemoveParameter(parameters, "proxyHost", String.class); Integer proxyPort = getAndRemoveParameter(parameters, "proxyPort", Integer.class); if (proxyHost != null && proxyPort != null) { String proxyUsername = getAndRemoveParameter(parameters, "proxyUsername", String.class); String proxyPassword = getAndRemoveParameter(parameters, "proxyPassword", String.class); String proxyDomain = getAndRemoveParameter(parameters, "proxyDomain", String.class); String proxyNtHost = getAndRemoveParameter(parameters, "proxyNtHost", String.class); if (proxyUsername != null && proxyPassword != null) { configurer = CompositeHttpConfigurer.combineConfigurers(configurer, new ProxyHttpClientConfigurer( proxyHost, proxyPort, proxyUsername, proxyPassword, proxyDomain, proxyNtHost)); } else { configurer = CompositeHttpConfigurer.combineConfigurers(configurer, new ProxyHttpClientConfigurer(proxyHost, proxyPort)); } } return configurer; } @Override protected Endpoint createEndpoint(String uri, String remaining, Map<String, Object> parameters) throws Exception { String addressUri = uri; if (!uri.startsWith("http4:") && !uri.startsWith("https4:")) { addressUri = remaining; } Map<String, Object> httpClientParameters = new HashMap<String, Object>(parameters); // http client can be configured from URI options HttpParams clientParams = configureHttpParams(parameters); // must extract well known parameters before we create the endpoint HttpBinding binding = resolveAndRemoveReferenceParameter(parameters, "httpBindingRef", HttpBinding.class); if (binding == null) { // try without ref binding = resolveAndRemoveReferenceParameter(parameters, "httpBinding", HttpBinding.class); } Boolean throwExceptionOnFailure = getAndRemoveParameter(parameters, "throwExceptionOnFailure", Boolean.class); Boolean transferException = getAndRemoveParameter(parameters, "transferException", Boolean.class); Boolean bridgeEndpoint = getAndRemoveParameter(parameters, "bridgeEndpoint", Boolean.class); Boolean matchOnUriPrefix = getAndRemoveParameter(parameters, "matchOnUriPrefix", Boolean.class); Boolean disableStreamCache = getAndRemoveParameter(parameters, "disableStreamCache", Boolean.class); // validate that we could resolve all httpClient. parameters as this component is lenient validateParameters(uri, parameters, "httpClient."); // create the configurer to use for this endpoint HttpClientConfigurer configurer = createHttpClientConfigurer(parameters); URI endpointUri = URISupport.createRemainingURI(new URI(addressUri), CastUtils.cast(httpClientParameters)); // restructure uri to be based on the parameters left as we dont want to include the Camel internal options URI httpUri = URISupport.createRemainingURI(new URI(addressUri), CastUtils.cast(parameters)); // validate http uri that end-user did not duplicate the http part that can be a common error String part = httpUri.getSchemeSpecificPart(); if (part != null) { part = part.toLowerCase(); if (part.startsWith("//http//") || part.startsWith("//https//")) { throw new ResolveEndpointFailedException(uri, "The uri part is not configured correctly. You have duplicated the http(s) protocol."); } } // register port on schema registry boolean secure = isSecureConnection(uri); int port = getPort(httpUri); registerPort(secure, port); // create the endpoint HttpEndpoint endpoint = new HttpEndpoint(endpointUri.toString(), this, httpUri, clientParams, clientConnectionManager, configurer); setEndpointHeaderFilterStrategy(endpoint); // prefer to use endpoint configured over component configured if (binding == null) { // fallback to component configured binding = getHttpBinding(); } if (binding != null) { endpoint.setBinding(binding); } // should we use an exception for failed error codes? if (throwExceptionOnFailure != null) { endpoint.setThrowExceptionOnFailure(throwExceptionOnFailure); } // should we transfer exception as serialized object if (transferException != null) { endpoint.setTransferException(transferException); } if (bridgeEndpoint != null) { endpoint.setBridgeEndpoint(bridgeEndpoint); } if (matchOnUriPrefix != null) { endpoint.setMatchOnUriPrefix(matchOnUriPrefix); } if (disableStreamCache != null) { endpoint.setDisableStreamCache(disableStreamCache); } setProperties(endpoint, parameters); return endpoint; } private static int getPort(URI uri) { int port = uri.getPort(); if (port < 0) { if ("http4".equals(uri.getScheme()) || "http".equals(uri.getScheme())) { port = 80; } else if ("https4".equals(uri.getScheme()) || "https".equals(uri.getScheme())) { port = 443; } else { throw new IllegalArgumentException("Unknown scheme, cannot determine port number for uri: " + uri); } } return port; } protected void registerPort(boolean secure, int port) { SchemeRegistry registry = clientConnectionManager.getSchemeRegistry(); if (secure) { // must register both https and https4 registry.register(new Scheme("https", SSLSocketFactory.getSocketFactory(), port)); LOG.info("Registering SSL scheme https on port " + port); registry.register(new Scheme("https4", SSLSocketFactory.getSocketFactory(), port)); LOG.info("Registering SSL scheme https4 on port " + port); } else { // must register both http and http4 registry.register(new Scheme("http", PlainSocketFactory.getSocketFactory(), port)); LOG.info("Registering PLAIN scheme http on port " + port); registry.register(new Scheme("http4", PlainSocketFactory.getSocketFactory(), port)); LOG.info("Registering PLAIN scheme http4 on port " + port); } } protected ClientConnectionManager createConnectionManager() { SchemeRegistry schemeRegistry = new SchemeRegistry(); // configure additional configurations HttpParams params = new BasicHttpParams(); ConnManagerParamBean param = new ConnManagerParamBean(params); if (getMaxTotalConnections() > 0) { param.setMaxTotalConnections(getMaxTotalConnections()); } if (getConnectionsPerRoute() > 0) { param.setConnectionsPerRoute(new ConnPerRouteBean(getConnectionsPerRoute())); } ThreadSafeClientConnManager answer = new ThreadSafeClientConnManager(params, schemeRegistry); LOG.info("Created ClientConnectionManager " + answer); return answer; } protected HttpParams configureHttpParams(Map<String, Object> parameters) throws Exception { HttpParams clientParams = new BasicHttpParams(); AuthParamBean authParamBean = new AuthParamBean(clientParams); IntrospectionSupport.setProperties(authParamBean, parameters, "httpClient."); ClientParamBean clientParamBean = new ClientParamBean(clientParams); IntrospectionSupport.setProperties(clientParamBean, parameters, "httpClient."); ConnConnectionParamBean connConnectionParamBean = new ConnConnectionParamBean(clientParams); IntrospectionSupport.setProperties(connConnectionParamBean, parameters, "httpClient."); ConnManagerParamBean connManagerParamBean = new ConnManagerParamBean(clientParams); IntrospectionSupport.setProperties(connManagerParamBean, parameters, "httpClient."); ConnRouteParamBean connRouteParamBean = new ConnRouteParamBean(clientParams); IntrospectionSupport.setProperties(connRouteParamBean, parameters, "httpClient."); CookieSpecParamBean cookieSpecParamBean = new CookieSpecParamBean(clientParams); IntrospectionSupport.setProperties(cookieSpecParamBean, parameters, "httpClient."); HttpConnectionParamBean httpConnectionParamBean = new HttpConnectionParamBean(clientParams); IntrospectionSupport.setProperties(httpConnectionParamBean, parameters, "httpClient."); HttpProtocolParamBean httpProtocolParamBean = new HttpProtocolParamBean(clientParams); IntrospectionSupport.setProperties(httpProtocolParamBean, parameters, "httpClient."); return clientParams; } private boolean isSecureConnection(String uri) { return uri.startsWith("https"); } @Override protected boolean useIntrospectionOnEndpoint() { return false; } public HttpClientConfigurer getHttpClientConfigurer() { return httpClientConfigurer; } public void setHttpClientConfigurer(HttpClientConfigurer httpClientConfigurer) { this.httpClientConfigurer = httpClientConfigurer; } public ClientConnectionManager getClientConnectionManager() { return clientConnectionManager; } public void setClientConnectionManager(ClientConnectionManager clientConnectionManager) { this.clientConnectionManager = clientConnectionManager; } public HttpBinding getHttpBinding() { return httpBinding; } public void setHttpBinding(HttpBinding httpBinding) { this.httpBinding = httpBinding; } public int getMaxTotalConnections() { return maxTotalConnections; } public void setMaxTotalConnections(int maxTotalConnections) { this.maxTotalConnections = maxTotalConnections; } public int getConnectionsPerRoute() { return connectionsPerRoute; } public void setConnectionsPerRoute(int connectionsPerRoute) { this.connectionsPerRoute = connectionsPerRoute; } @Override public void start() throws Exception { super.start(); if (clientConnectionManager == null) { clientConnectionManager = createConnectionManager(); } } @Override public void stop() throws Exception { // shutdown connection manager if (clientConnectionManager != null) { LOG.info("Shutting down ClientConnectionManager: " + clientConnectionManager); clientConnectionManager.shutdown(); clientConnectionManager = null; } super.stop(); } }