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. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * <http://www.apache.org/>. * */ package com.epam.reportportal.apache.http.impl.execchain; import java.io.IOException; import java.net.URI; import java.net.URISyntaxException; import com.epam.reportportal.apache.http.HttpException; import com.epam.reportportal.apache.http.HttpHost; import com.epam.reportportal.apache.http.HttpRequest; import com.epam.reportportal.apache.http.ProtocolException; import com.epam.reportportal.apache.http.annotation.Immutable; import com.epam.reportportal.apache.http.auth.AuthScope; import com.epam.reportportal.apache.http.auth.UsernamePasswordCredentials; import com.epam.reportportal.apache.http.client.CredentialsProvider; import com.epam.reportportal.apache.http.client.methods.CloseableHttpResponse; import com.epam.reportportal.apache.http.client.methods.HttpExecutionAware; import com.epam.reportportal.apache.http.client.methods.HttpRequestWrapper; import com.epam.reportportal.apache.http.client.methods.HttpUriRequest; import com.epam.reportportal.apache.http.client.params.ClientPNames; import com.epam.reportportal.apache.http.client.utils.URIUtils; import com.epam.reportportal.apache.http.conn.routing.HttpRoute; import com.epam.reportportal.apache.http.impl.client.BasicCredentialsProvider; import com.epam.reportportal.apache.http.protocol.HttpCoreContext; import com.epam.reportportal.apache.http.protocol.HttpProcessor; import com.epam.reportportal.apache.http.util.Args; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import com.epam.reportportal.apache.http.client.protocol.HttpClientContext; import com.epam.reportportal.apache.http.params.HttpParams; /** * Request executor in the request execution chain that is responsible * for implementation of HTTP specification requirements. * Internally this executor relies on a {@link HttpProcessor} to populate * requisite HTTP request headers, process HTTP response headers and update * session state in {@link HttpClientContext}. * <p/> * Further responsibilities such as communication with the opposite * endpoint is delegated to the next executor in the request execution * chain. * * @since 4.3 */ @Immutable @SuppressWarnings("deprecation") public class ProtocolExec implements ClientExecChain { private final Log log = LogFactory.getLog(getClass()); private final ClientExecChain requestExecutor; private final HttpProcessor httpProcessor; public ProtocolExec(final ClientExecChain requestExecutor, final HttpProcessor httpProcessor) { Args.notNull(requestExecutor, "HTTP client request executor"); Args.notNull(httpProcessor, "HTTP protocol processor"); this.requestExecutor = requestExecutor; this.httpProcessor = httpProcessor; } void rewriteRequestURI(final HttpRequestWrapper request, final HttpRoute route) throws ProtocolException { try { URI uri = request.getURI(); if (uri != null) { if (route.getProxyHost() != null && !route.isTunnelled()) { // Make sure the request URI is absolute if (!uri.isAbsolute()) { final HttpHost target = route.getTargetHost(); uri = URIUtils.rewriteURI(uri, target, true); } else { uri = URIUtils.rewriteURI(uri); } } else { // Make sure the request URI is relative if (uri.isAbsolute()) { uri = URIUtils.rewriteURI(uri, null, true); } else { uri = URIUtils.rewriteURI(uri); } } request.setURI(uri); } } catch (final URISyntaxException ex) { throw new ProtocolException("Invalid URI: " + request.getRequestLine().getUri(), ex); } } public CloseableHttpResponse execute(final HttpRoute route, final HttpRequestWrapper request, final HttpClientContext context, final HttpExecutionAware execAware) throws IOException, HttpException { Args.notNull(route, "HTTP route"); Args.notNull(request, "HTTP request"); Args.notNull(context, "HTTP context"); final HttpRequest original = request.getOriginal(); URI uri = null; if (original instanceof HttpUriRequest) { uri = ((HttpUriRequest) original).getURI(); } else { final String uriString = original.getRequestLine().getUri(); try { uri = URI.create(uriString); } catch (final IllegalArgumentException ex) { if (this.log.isDebugEnabled()) { this.log.debug("Unable to parse '" + uriString + "' as a valid URI; " + "request URI and Host header may be inconsistent", ex); } } } request.setURI(uri); // Re-write request URI if needed rewriteRequestURI(request, route); final HttpParams params = request.getParams(); HttpHost virtualHost = (HttpHost) params.getParameter(ClientPNames.VIRTUAL_HOST); // HTTPCLIENT-1092 - add the port if necessary if (virtualHost != null && virtualHost.getPort() == -1) { final int port = route.getTargetHost().getPort(); if (port != -1) { virtualHost = new HttpHost(virtualHost.getHostName(), port, virtualHost.getSchemeName()); } if (this.log.isDebugEnabled()) { this.log.debug("Using virtual host" + virtualHost); } } HttpHost target = null; if (virtualHost != null) { target = virtualHost; } else { if (uri != null && uri.isAbsolute() && uri.getHost() != null) { target = new HttpHost(uri.getHost(), uri.getPort(), uri.getScheme()); } } if (target == null) { target = route.getTargetHost(); } // Get user info from the URI if (uri != null) { final String userinfo = uri.getUserInfo(); if (userinfo != null) { CredentialsProvider credsProvider = context.getCredentialsProvider(); if (credsProvider == null) { credsProvider = new BasicCredentialsProvider(); context.setCredentialsProvider(credsProvider); } credsProvider.setCredentials(new AuthScope(target), new UsernamePasswordCredentials(userinfo)); } } // Run request protocol interceptors context.setAttribute(HttpCoreContext.HTTP_TARGET_HOST, target); context.setAttribute(HttpClientContext.HTTP_ROUTE, route); context.setAttribute(HttpCoreContext.HTTP_REQUEST, request); this.httpProcessor.process(request, context); final CloseableHttpResponse response = this.requestExecutor.execute(route, request, context, execAware); try { // Run response protocol interceptors context.setAttribute(HttpCoreContext.HTTP_RESPONSE, response); this.httpProcessor.process(response, context); return response; } catch (final RuntimeException ex) { response.close(); throw ex; } catch (final IOException ex) { response.close(); throw ex; } catch (final HttpException ex) { response.close(); throw ex; } } }