org.apache.hc.client5.http.impl.protocol

Class DefaultRedirectStrategy

java.lang.Object

org.apache.hc.client5.http.impl.protocol.DefaultRedirectStrategy

All Implemented Interfaces:

RedirectStrategy

@Immutable
public class DefaultRedirectStrategy
extends Object
implements RedirectStrategy

Default implementation of RedirectStrategy. This strategy honors the restrictions on automatic redirection of entity enclosing methods such as POST and PUT imposed by the HTTP specification. 302 Moved Temporarily, 301 Moved Permanently and 307 Temporary Redirect status codes will result in an automatic redirect of HEAD and GET methods only. POST and PUT methods will not be automatically redirected as requiring user confirmation.

Since:

4.1

Field Summary

Fields

Modifier and Type	Field and Description
static DefaultRedirectStrategy	INSTANCE

Constructor Summary

Constructors

Constructor and Description
DefaultRedirectStrategy()

Method Summary

Methods

Modifier and Type	Method and Description
protected URI	createLocationURI(String location)
URI	getLocationURI(org.apache.hc.core5.http.HttpRequest request, org.apache.hc.core5.http.HttpResponse response, org.apache.hc.core5.http.protocol.HttpContext context)
HttpUriRequest	getRedirect(org.apache.hc.core5.http.HttpRequest request, org.apache.hc.core5.http.HttpResponse response, org.apache.hc.core5.http.protocol.HttpContext context) Determines the redirect location given the response from the target server and the current request execution context and generates a new request to be sent to the location.
boolean	isRedirected(org.apache.hc.core5.http.HttpRequest request, org.apache.hc.core5.http.HttpResponse response, org.apache.hc.core5.http.protocol.HttpContext context) Determines if a request should be redirected to a new location given the response from the target server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INSTANCE

public static final DefaultRedirectStrategy INSTANCE

Constructor Detail

DefaultRedirectStrategy

public DefaultRedirectStrategy()

Method Detail

isRedirected

public boolean isRedirected(org.apache.hc.core5.http.HttpRequest request,
                   org.apache.hc.core5.http.HttpResponse response,
                   org.apache.hc.core5.http.protocol.HttpContext context)
                     throws org.apache.hc.core5.http.ProtocolException

Description copied from interface: RedirectStrategy

Determines if a request should be redirected to a new location given the response from the target server.

Specified by:

isRedirected in interface RedirectStrategy

Parameters:

request - the executed request

response - the response received from the target server

context - the context for the request execution

Returns:

true if the request should be redirected, false otherwise

Throws:

org.apache.hc.core5.http.ProtocolException

getLocationURI

public URI getLocationURI(org.apache.hc.core5.http.HttpRequest request,
                 org.apache.hc.core5.http.HttpResponse response,
                 org.apache.hc.core5.http.protocol.HttpContext context)
                   throws org.apache.hc.core5.http.HttpException

Throws:

org.apache.hc.core5.http.HttpException

createLocationURI

protected URI createLocationURI(String location)
                         throws org.apache.hc.core5.http.ProtocolException

Throws:

org.apache.hc.core5.http.ProtocolException

Since:

4.1

getRedirect

public HttpUriRequest getRedirect(org.apache.hc.core5.http.HttpRequest request,
                         org.apache.hc.core5.http.HttpResponse response,
                         org.apache.hc.core5.http.protocol.HttpContext context)
                           throws org.apache.hc.core5.http.HttpException

Description copied from interface: RedirectStrategy

Determines the redirect location given the response from the target server and the current request execution context and generates a new request to be sent to the location.

Specified by:

getRedirect in interface RedirectStrategy

Parameters:

request - the executed request

response - the response received from the target server

context - the context for the request execution

Returns:

redirected request

Throws:

org.apache.hc.core5.http.HttpException