Core :: HTTP Client 12.0.6 · org.eclipse.jetty.client.HttpRedirector

Utility class that handles HTTP redirects.

Applications can disable redirection via Request#followRedirects(boolean) and then rely on this class to perform the redirect in a simpler way, for example:

HttpRedirector redirector = new HttpRedirector(httpClient);

Request request = httpClient.newRequest("http://host/path").followRedirects(false);
ContentResponse response = request.send();
while (redirector.isRedirect(response))
{
    // Validate the redirect URI
    if (!validate(redirector.extractRedirectURI(response)))
        break;

    Result result = redirector.redirect(request, response);
    request = result.getRequest();
    response = result.getResponse();
}

Field Summary

Modifier and Type	Field and Description
private static final String	ATTRIBUTE
private static final String	AUTHORITY_REGEXP
private final HttpClient	client
private static final String	DESTINATION_REGEXP
private static final String	FRAGMENT_REGEXP
private static final Logger	LOG
private static final String	PATH_REGEXP
private static final String	QUERY_REGEXP
private static final String	SCHEME_REGEXP
private static final Pattern	URI_PATTERN

Constructor Summary

Access	Constructor and Description
public	HttpRedirector(HttpClient client)

Method Summary

Modifier and Type	Method and Description
public URI	Returns: the absolute redirect URI, or null if the response does not contain a valid redirect location extractRedirectURI(Response the response to extract the redirect URI from response) Extracts and sanitizes (by making it absolute and escaping paths and query parameters) the redirect URI of the given `response`.
protected void	fail(Request request, Response response, Throwable failure)
protected void	fail(Request request, Throwable failure, Response response)
private void	fail(Request request, Throwable requestFailure, Response response, Throwable responseFailure)
public boolean	Returns: whether the response code is an HTTP redirect code isRedirect(Response the response to check for redirects response)
public Result	Returns: a `Result` object containing the request to the redirected location and its response redirect(Request the original request that triggered the redirect request, Response the response to the original request response) Redirects the given `response`, blocking until the redirect is complete.
public Request	Returns: the request to the redirected location redirect(Request the original request that triggered the redirect request, Response the response to the original request response, Response.CompleteListener the listener that receives response events listener) Redirects the given `response` asynchronously.
private Request	redirect(Request request, Response response, Response.CompleteListener listener, URI newURI)
private Request	redirect(Request request, Response response, Response.CompleteListener listener, URI location, String method)
private URI	sanitize(String location)
private Request	sendRedirect(HttpRequest httpRequest, Response response, Response.CompleteListener listener, URI location, String method)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ATTRIBUTE	back to summary
private static final String ATTRIBUTE

AUTHORITY_REGEXP	back to summary
private static final String AUTHORITY_REGEXP

client	back to summary
private final HttpClient client

DESTINATION_REGEXP	back to summary
private static final String DESTINATION_REGEXP

FRAGMENT_REGEXP	back to summary
private static final String FRAGMENT_REGEXP

LOG	back to summary
private static final Logger LOG

PATH_REGEXP	back to summary
private static final String PATH_REGEXP

QUERY_REGEXP	back to summary
private static final String QUERY_REGEXP

SCHEME_REGEXP	back to summary
private static final String SCHEME_REGEXP

URI_PATTERN	back to summary
private static final Pattern URI_PATTERN

Constructor Detail

HttpRedirector	back to summary
public HttpRedirector(HttpClient client)

Method Detail

extractRedirectURI back to summary

extractRedirectURI	back to summary
public URI extractRedirectURI(Response response) Extracts and sanitizes (by making it absolute and escaping paths and query parameters) the redirect URI of the given `response`. Parameters response:Response the response to extract the redirect URI from Returns:URI the absolute redirect URI, or null if the response does not contain a valid redirect location

public URI extractRedirectURI(Response response)

Extracts and sanitizes (by making it absolute and escaping paths and query parameters) the redirect URI of the given response.

Parameters

response:Response: the response to extract the redirect URI from

Returns:URI

the absolute redirect URI, or null if the response does not contain a valid redirect location

fail	back to summary
protected void fail(Request request, Response response, Throwable failure)

fail	back to summary
protected void fail(Request request, Throwable failure, Response response)

fail	back to summary
private void fail(Request request, Throwable requestFailure, Response response, Throwable responseFailure)

isRedirect	back to summary
public boolean isRedirect(Response response) Parameters response:Response the response to check for redirects Returns:boolean whether the response code is an HTTP redirect code

redirect back to summary

redirect	back to summary
public Result redirect(Request request, Response response) throws InterruptedException, ExecutionException Redirects the given `response`, blocking until the redirect is complete. Parameters request:Request the original request that triggered the redirect response:Response the response to the original request Returns:Result a `Result` object containing the request to the redirected location and its response Exceptions InterruptedException: if the thread is interrupted while waiting for the redirect to complete ExecutionException: if the redirect failed See Also `redirect(Request, Response, Response.CompleteListener)`

public Result redirect(Request request, Response response) throws InterruptedException, ExecutionException

Redirects the given response, blocking until the redirect is complete.

Parameters

request:Request: the original request that triggered the redirect
response:Response: the response to the original request

Returns:Result

a Result object containing the request to the redirected location and its response

Exceptions

InterruptedException:: if the thread is interrupted while waiting for the redirect to complete
ExecutionException:: if the redirect failed

redirect back to summary

redirect	back to summary
public Request redirect(Request request, Response response, Response.CompleteListener listener) Redirects the given `response` asynchronously. Parameters request:Request the original request that triggered the redirect response:Response the response to the original request listener:Response.CompleteListener the listener that receives response events Returns:Request the request to the redirected location

public Request redirect(Request request, Response response, Response.CompleteListener listener)

Redirects the given response asynchronously.

Parameters

request:Request: the original request that triggered the redirect
response:Response: the response to the original request
listener:Response.CompleteListener: the listener that receives response events

Returns:Request

the request to the redirected location

redirect	back to summary
private Request redirect(Request request, Response response, Response.CompleteListener listener, URI newURI)

redirect	back to summary
private Request redirect(Request request, Response response, Response.CompleteListener listener, URI location, String method)

sanitize	back to summary
private URI sanitize(String location)

sendRedirect	back to summary
private Request sendRedirect(HttpRequest httpRequest, Response response, Response.CompleteListener listener, URI location, String method)

public Class HttpRedirector

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail