| /* |
| * ==================================================================== |
| * 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 org.apache.hc.client5.http.impl.async; |
| |
| import java.io.IOException; |
| import java.net.URI; |
| |
| import org.apache.hc.client5.http.CircularRedirectException; |
| import org.apache.hc.client5.http.HttpRoute; |
| import org.apache.hc.client5.http.RedirectException; |
| import org.apache.hc.client5.http.async.AsyncExecCallback; |
| import org.apache.hc.client5.http.async.AsyncExecChain; |
| import org.apache.hc.client5.http.async.AsyncExecChainHandler; |
| import org.apache.hc.client5.http.auth.AuthExchange; |
| import org.apache.hc.client5.http.config.RequestConfig; |
| import org.apache.hc.client5.http.protocol.HttpClientContext; |
| import org.apache.hc.client5.http.protocol.RedirectLocations; |
| import org.apache.hc.client5.http.protocol.RedirectStrategy; |
| import org.apache.hc.client5.http.routing.HttpRoutePlanner; |
| import org.apache.hc.client5.http.utils.URIUtils; |
| import org.apache.hc.core5.annotation.Contract; |
| import org.apache.hc.core5.annotation.Internal; |
| import org.apache.hc.core5.annotation.ThreadingBehavior; |
| import org.apache.hc.core5.http.EntityDetails; |
| import org.apache.hc.core5.http.HttpException; |
| import org.apache.hc.core5.http.HttpHost; |
| import org.apache.hc.core5.http.HttpRequest; |
| import org.apache.hc.core5.http.HttpResponse; |
| import org.apache.hc.core5.http.HttpStatus; |
| import org.apache.hc.core5.http.Method; |
| import org.apache.hc.core5.http.ProtocolException; |
| import org.apache.hc.core5.http.message.BasicHttpRequest; |
| import org.apache.hc.core5.http.nio.AsyncDataConsumer; |
| import org.apache.hc.core5.http.nio.AsyncEntityProducer; |
| import org.apache.hc.core5.util.LangUtils; |
| import org.slf4j.Logger; |
| import org.slf4j.LoggerFactory; |
| |
| /** |
| * Request execution handler in the asynchronous request execution chain |
| * responsbile for handling of request redirects. |
| * <p> |
| * Further responsibilities such as communication with the opposite |
| * endpoint is delegated to the next executor in the request execution |
| * chain. |
| * </p> |
| * |
| * @since 5.0 |
| */ |
| @Contract(threading = ThreadingBehavior.STATELESS) |
| @Internal |
| public final class AsyncRedirectExec implements AsyncExecChainHandler { |
| |
| private final Logger log = LoggerFactory.getLogger(getClass()); |
| |
| private final HttpRoutePlanner routePlanner; |
| private final RedirectStrategy redirectStrategy; |
| |
| AsyncRedirectExec(final HttpRoutePlanner routePlanner, final RedirectStrategy redirectStrategy) { |
| this.routePlanner = routePlanner; |
| this.redirectStrategy = redirectStrategy; |
| } |
| |
| private static class State { |
| |
| volatile URI redirectURI; |
| volatile int maxRedirects; |
| volatile int redirectCount; |
| volatile HttpRequest currentRequest; |
| volatile AsyncEntityProducer currentEntityProducer; |
| volatile RedirectLocations redirectLocations; |
| volatile AsyncExecChain.Scope currentScope; |
| volatile boolean reroute; |
| |
| } |
| |
| private void internalExecute( |
| final State state, |
| final AsyncExecChain chain, |
| final AsyncExecCallback asyncExecCallback) throws HttpException, IOException { |
| |
| final HttpRequest request = state.currentRequest; |
| final AsyncEntityProducer entityProducer = state.currentEntityProducer; |
| final AsyncExecChain.Scope scope = state.currentScope; |
| final HttpClientContext clientContext = scope.clientContext; |
| final String exchangeId = scope.exchangeId; |
| final HttpRoute currentRoute = scope.route; |
| chain.proceed(request, entityProducer, scope, new AsyncExecCallback() { |
| |
| @Override |
| public AsyncDataConsumer handleResponse( |
| final HttpResponse response, |
| final EntityDetails entityDetails) throws HttpException, IOException { |
| |
| state.redirectURI = null; |
| final RequestConfig config = clientContext.getRequestConfig(); |
| if (config.isRedirectsEnabled() && redirectStrategy.isRedirected(request, response, clientContext)) { |
| if (state.redirectCount >= state.maxRedirects) { |
| throw new RedirectException("Maximum redirects (" + state.maxRedirects + ") exceeded"); |
| } |
| |
| state.redirectCount++; |
| |
| final URI redirectUri = redirectStrategy.getLocationURI(request, response, clientContext); |
| if (log.isDebugEnabled()) { |
| log.debug(exchangeId + ": redirect requested to location '" + redirectUri + "'"); |
| } |
| if (!config.isCircularRedirectsAllowed()) { |
| if (state.redirectLocations.contains(redirectUri)) { |
| throw new CircularRedirectException("Circular redirect to '" + redirectUri + "'"); |
| } |
| } |
| state.redirectLocations.add(redirectUri); |
| |
| final int statusCode = response.getCode(); |
| |
| state.currentRequest = null; |
| switch (statusCode) { |
| case HttpStatus.SC_MOVED_PERMANENTLY: |
| case HttpStatus.SC_MOVED_TEMPORARILY: |
| case HttpStatus.SC_SEE_OTHER: |
| if (Method.POST.isSame(request.getMethod())) { |
| state.currentRequest = new BasicHttpRequest(Method.GET, redirectUri); |
| state.currentEntityProducer = null; |
| } |
| } |
| if (state.currentRequest == null) { |
| state.currentRequest = new BasicHttpRequest(request.getMethod(), redirectUri); |
| } |
| state.currentRequest.setHeaders(scope.originalRequest.getHeaders()); |
| final HttpHost newTarget = URIUtils.extractHost(redirectUri); |
| if (newTarget == null) { |
| throw new ProtocolException("Redirect URI does not specify a valid host name: " + redirectUri); |
| } |
| |
| state.reroute = false; |
| state.redirectURI = redirectUri; |
| |
| if (!LangUtils.equals(currentRoute.getTargetHost(), newTarget)) { |
| final HttpRoute newRoute = routePlanner.determineRoute(newTarget, clientContext); |
| if (!LangUtils.equals(currentRoute, newRoute)) { |
| state.reroute = true; |
| final AuthExchange targetAuthExchange = clientContext.getAuthExchange(currentRoute.getTargetHost()); |
| if (log.isDebugEnabled()) { |
| log.debug(exchangeId + ": resetting target auth state"); |
| } |
| targetAuthExchange.reset(); |
| if (currentRoute.getProxyHost() != null) { |
| final AuthExchange proxyAuthExchange = clientContext.getAuthExchange(currentRoute.getProxyHost()); |
| if (proxyAuthExchange.isConnectionBased()) { |
| if (log.isDebugEnabled()) { |
| log.debug(exchangeId + ": resetting proxy auth state"); |
| } |
| proxyAuthExchange.reset(); |
| } |
| } |
| state.currentScope = new AsyncExecChain.Scope(scope.exchangeId, newRoute, |
| scope.originalRequest, scope.cancellableDependency, clientContext, scope.execRuntime); |
| } |
| } |
| } |
| if (state.redirectURI != null) { |
| if (log.isDebugEnabled()) { |
| log.debug(exchangeId + ": redirecting to '" + state.redirectURI + "' via " + currentRoute); |
| } |
| return null; |
| } |
| return asyncExecCallback.handleResponse(response, entityDetails); |
| } |
| |
| @Override |
| public void handleInformationResponse( |
| final HttpResponse response) throws HttpException, IOException { |
| asyncExecCallback.handleInformationResponse(response); |
| } |
| |
| @Override |
| public void completed() { |
| if (state.redirectURI == null) { |
| asyncExecCallback.completed(); |
| } else { |
| final AsyncEntityProducer entityProducer = state.currentEntityProducer; |
| if (entityProducer != null && !entityProducer.isRepeatable()) { |
| if (log.isDebugEnabled()) { |
| log.debug(exchangeId + ": cannot redirect non-repeatable request"); |
| } |
| asyncExecCallback.completed(); |
| } else { |
| try { |
| if (state.reroute) { |
| scope.execRuntime.releaseEndpoint(); |
| } |
| internalExecute(state, chain, asyncExecCallback); |
| } catch (final IOException | HttpException ex) { |
| asyncExecCallback.failed(ex); |
| } |
| } |
| } |
| } |
| |
| @Override |
| public void failed(final Exception cause) { |
| asyncExecCallback.failed(cause); |
| } |
| |
| }); |
| |
| } |
| |
| @Override |
| public void execute( |
| final HttpRequest request, |
| final AsyncEntityProducer entityProducer, |
| final AsyncExecChain.Scope scope, |
| final AsyncExecChain chain, |
| final AsyncExecCallback asyncExecCallback) throws HttpException, IOException { |
| final HttpClientContext clientContext = scope.clientContext; |
| RedirectLocations redirectLocations = clientContext.getRedirectLocations(); |
| if (redirectLocations == null) { |
| redirectLocations = new RedirectLocations(); |
| clientContext.setAttribute(HttpClientContext.REDIRECT_LOCATIONS, redirectLocations); |
| } |
| redirectLocations.clear(); |
| |
| final RequestConfig config = clientContext.getRequestConfig(); |
| |
| final State state = new State(); |
| state.maxRedirects = config.getMaxRedirects() > 0 ? config.getMaxRedirects() : 50; |
| state.redirectCount = 0; |
| state.currentRequest = request; |
| state.currentEntityProducer = entityProducer; |
| state.redirectLocations = redirectLocations; |
| state.currentScope = scope; |
| |
| internalExecute(state, chain, asyncExecCallback); |
| } |
| |
| } |
