| /** |
| * 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.http; |
| |
| import java.io.IOException; |
| import java.io.InputStream; |
| import java.io.UnsupportedEncodingException; |
| import java.util.HashMap; |
| import java.util.Map; |
| |
| import org.apache.camel.Exchange; |
| import org.apache.camel.Message; |
| import org.apache.camel.RuntimeCamelException; |
| import org.apache.camel.component.http.helper.GZIPHelper; |
| import org.apache.camel.component.http.helper.HttpProducerHelper; |
| import org.apache.camel.converter.stream.CachedOutputStream; |
| import org.apache.camel.impl.DefaultProducer; |
| import org.apache.camel.spi.HeaderFilterStrategy; |
| import org.apache.camel.util.ExchangeHelper; |
| import org.apache.camel.util.IOHelper; |
| import org.apache.camel.util.ObjectHelper; |
| import org.apache.commons.httpclient.Header; |
| import org.apache.commons.httpclient.HttpClient; |
| import org.apache.commons.httpclient.HttpMethod; |
| import org.apache.commons.httpclient.methods.EntityEnclosingMethod; |
| import org.apache.commons.httpclient.methods.RequestEntity; |
| import org.apache.commons.httpclient.methods.StringRequestEntity; |
| import org.apache.commons.logging.Log; |
| import org.apache.commons.logging.LogFactory; |
| |
| /** |
| * @version $Revision$ |
| */ |
| public class HttpProducer extends DefaultProducer { |
| private static final transient Log LOG = LogFactory.getLog(HttpProducer.class); |
| private HttpClient httpClient; |
| private boolean throwException; |
| |
| public HttpProducer(HttpEndpoint endpoint) { |
| super(endpoint); |
| this.httpClient = endpoint.createHttpClient(); |
| this.throwException = endpoint.isThrowExceptionOnFailure(); |
| } |
| |
| public void process(Exchange exchange) throws Exception { |
| if (((HttpEndpoint)getEndpoint()).isBridgeEndpoint()) { |
| exchange.setProperty(Exchange.SKIP_GZIP_ENCODING, Boolean.TRUE); |
| } |
| HttpMethod method = createMethod(exchange); |
| Message in = exchange.getIn(); |
| HeaderFilterStrategy strategy = getEndpoint().getHeaderFilterStrategy(); |
| |
| // propagate headers as HTTP headers |
| for (Map.Entry<String, Object> entry : in.getHeaders().entrySet()) { |
| String headerValue = in.getHeader(entry.getKey(), String.class); |
| if (strategy != null && !strategy.applyFilterToCamelHeaders(entry.getKey(), headerValue, exchange)) { |
| method.addRequestHeader(entry.getKey(), headerValue); |
| } |
| } |
| |
| // lets store the result in the output message. |
| try { |
| if (LOG.isDebugEnabled()) { |
| LOG.debug("Executing http " + method.getName() + " method: " + method.getURI().toString()); |
| } |
| int responseCode = executeMethod(method); |
| if (LOG.isDebugEnabled()) { |
| LOG.debug("Http responseCode: " + responseCode); |
| } |
| |
| if (!throwException) { |
| // if we do not use failed exception then populate response for all response codes |
| populateResponse(exchange, method, in, strategy, responseCode); |
| } else { |
| if (responseCode >= 100 && responseCode < 300) { |
| // only populate response for OK response |
| populateResponse(exchange, method, in, strategy, responseCode); |
| } else { |
| // operation failed so populate exception to throw |
| throw populateHttpOperationFailedException(exchange, method, responseCode); |
| } |
| } |
| } finally { |
| method.releaseConnection(); |
| } |
| } |
| |
| @Override |
| public HttpEndpoint getEndpoint() { |
| return (HttpEndpoint) super.getEndpoint(); |
| } |
| |
| protected void populateResponse(Exchange exchange, HttpMethod method, Message in, HeaderFilterStrategy strategy, int responseCode) throws IOException { |
| Message answer = exchange.getOut(); |
| |
| answer.setHeaders(in.getHeaders()); |
| answer.setHeader(Exchange.HTTP_RESPONSE_CODE, responseCode); |
| answer.setBody(extractResponseBody(method, exchange)); |
| |
| // propagate HTTP response headers |
| Header[] headers = method.getResponseHeaders(); |
| for (Header header : headers) { |
| String name = header.getName(); |
| String value = header.getValue(); |
| if (name.toLowerCase().equals("content-type")) { |
| name = Exchange.CONTENT_TYPE; |
| } |
| if (strategy != null && !strategy.applyFilterToExternalHeaders(name, value, exchange)) { |
| answer.setHeader(name, value); |
| } |
| } |
| } |
| |
| protected HttpOperationFailedException populateHttpOperationFailedException(Exchange exchange, HttpMethod method, int responseCode) throws IOException { |
| HttpOperationFailedException exception; |
| String uri = method.getURI().toString(); |
| String statusText = method.getStatusLine() != null ? method.getStatusLine().getReasonPhrase() : null; |
| Map<String, String> headers = extractResponseHeaders(method.getResponseHeaders()); |
| InputStream is = extractResponseBody(method, exchange); |
| // make a defensive copy of the response body in the exception so its detached from the cache |
| String copy = null; |
| if (is != null) { |
| copy = exchange.getContext().getTypeConverter().convertTo(String.class, exchange, is); |
| } |
| |
| if (responseCode >= 300 && responseCode < 400) { |
| String redirectLocation; |
| Header locationHeader = method.getResponseHeader("location"); |
| if (locationHeader != null) { |
| redirectLocation = locationHeader.getValue(); |
| exception = new HttpOperationFailedException(uri, responseCode, statusText, redirectLocation, headers, copy); |
| } else { |
| // no redirect location |
| exception = new HttpOperationFailedException(uri, responseCode, statusText, null, headers, copy); |
| } |
| } else { |
| // internal server error (error code 500) |
| exception = new HttpOperationFailedException(uri, responseCode, statusText, null, headers, copy); |
| } |
| |
| return exception; |
| } |
| |
| /** |
| * Strategy when executing the method (calling the remote server). |
| * |
| * @param method the method to execute |
| * @return the response code |
| * @throws IOException can be thrown |
| */ |
| protected int executeMethod(HttpMethod method) throws IOException { |
| return httpClient.executeMethod(method); |
| } |
| |
| /** |
| * Extracts the response headers |
| * |
| * @param responseHeaders the headers |
| * @return the extracted headers or <tt>null</tt> if no headers existed |
| */ |
| protected static Map<String, String> extractResponseHeaders(Header[] responseHeaders) { |
| if (responseHeaders == null || responseHeaders.length == 0) { |
| return null; |
| } |
| |
| Map<String, String> answer = new HashMap<String, String>(); |
| for (Header header : responseHeaders) { |
| answer.put(header.getName(), header.getValue()); |
| } |
| |
| return answer; |
| } |
| |
| /** |
| * Extracts the response from the method as a InputStream. |
| * |
| * @param method the method that was executed |
| * @return the response as a stream |
| * @throws IOException can be thrown |
| */ |
| protected static InputStream extractResponseBody(HttpMethod method, Exchange exchange) throws IOException { |
| InputStream is = method.getResponseBodyAsStream(); |
| if (is == null) { |
| return null; |
| } |
| |
| Header header = method.getRequestHeader(Exchange.CONTENT_ENCODING); |
| String contentEncoding = header != null ? header.getValue() : null; |
| |
| if (!exchange.getProperty(Exchange.SKIP_GZIP_ENCODING, Boolean.FALSE, Boolean.class)) { |
| is = GZIPHelper.uncompressGzip(contentEncoding, is); |
| } |
| |
| // Honor the character encoding |
| header = method.getResponseHeader("content-type"); |
| if (header != null) { |
| String contentType = header.getValue(); |
| // find the charset and set it to the Exchange |
| int index = contentType.indexOf("charset="); |
| if (index > 0) { |
| String charset = contentType.substring(index + 8); |
| exchange.setProperty(Exchange.CHARSET_NAME, charset); |
| } |
| } |
| return doExtractResponseBody(is, exchange); |
| } |
| |
| private static InputStream doExtractResponseBody(InputStream is, Exchange exchange) throws IOException { |
| // As httpclient is using a AutoCloseInputStream, it will be closed when the connection is closed |
| // we need to cache the stream for it. |
| try { |
| CachedOutputStream cos = new CachedOutputStream(exchange); |
| IOHelper.copy(is, cos); |
| return cos.getInputStream(); |
| } finally { |
| ObjectHelper.close(is, "Extracting response body", LOG); |
| } |
| } |
| |
| /** |
| * Creates the HttpMethod to use to call the remote server, either its GET or POST. |
| * |
| * @param exchange the exchange |
| * @return the created method as either GET or POST |
| */ |
| protected HttpMethod createMethod(Exchange exchange) { |
| |
| String url = HttpProducerHelper.createURL(exchange, getEndpoint()); |
| |
| RequestEntity requestEntity = createRequestEntity(exchange); |
| HttpMethods methodToUse = HttpProducerHelper.createMethod(exchange, getEndpoint(), requestEntity != null); |
| HttpMethod method = methodToUse.createMethod(url); |
| |
| // is a query string provided in the endpoint URI or in a header (header overrules endpoint) |
| String queryString = exchange.getIn().getHeader(Exchange.HTTP_QUERY, String.class); |
| if (queryString == null) { |
| queryString = getEndpoint().getHttpUri().getQuery(); |
| } |
| if (queryString != null) { |
| method.setQueryString(queryString); |
| } |
| |
| if (methodToUse.isEntityEnclosing()) { |
| ((EntityEnclosingMethod)method).setRequestEntity(requestEntity); |
| if (requestEntity != null && requestEntity.getContentType() == null) { |
| if (LOG.isDebugEnabled()) { |
| LOG.debug("No Content-Type provided for URL: " + url + " with exchange: " + exchange); |
| } |
| } |
| } |
| |
| return method; |
| } |
| |
| /** |
| * Creates a holder object for the data to send to the remote server. |
| * |
| * @param exchange the exchange with the IN message with data to send |
| * @return the data holder |
| */ |
| protected RequestEntity createRequestEntity(Exchange exchange) { |
| Message in = exchange.getIn(); |
| if (in.getBody() == null) { |
| return null; |
| } |
| |
| RequestEntity answer = in.getBody(RequestEntity.class); |
| if (answer == null) { |
| try { |
| String data = in.getBody(String.class); |
| if (data != null) { |
| String contentType = ExchangeHelper.getContentType(exchange); |
| String charset = exchange.getProperty(Exchange.CHARSET_NAME, String.class); |
| answer = new StringRequestEntity(data, contentType, charset); |
| } |
| } catch (UnsupportedEncodingException e) { |
| throw new RuntimeCamelException(e); |
| } |
| } |
| return answer; |
| } |
| |
| public HttpClient getHttpClient() { |
| return httpClient; |
| } |
| |
| public void setHttpClient(HttpClient httpClient) { |
| this.httpClient = httpClient; |
| } |
| } |