Package org.eclipse.jetty.client
Class HttpRedirector
- java.lang.Object
-
- org.eclipse.jetty.client.HttpRedirector
-
public class HttpRedirector extends java.lang.Object
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
Fields Modifier and Type Field Description private static java.lang.String
ATTRIBUTE
private static java.lang.String
AUTHORITY_REGEXP
private HttpClient
client
private static java.lang.String
DESTINATION_REGEXP
private static java.lang.String
FRAGMENT_REGEXP
private static Logger
LOG
private ResponseNotifier
notifier
private static java.lang.String
PATH_REGEXP
private static java.lang.String
QUERY_REGEXP
private static java.lang.String
SCHEME_REGEXP
private static java.util.regex.Pattern
URI_PATTERN
-
Constructor Summary
Constructors Constructor Description HttpRedirector(HttpClient client)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.net.URI
extractRedirectURI(Response response)
Extracts and sanitizes (by making it absolute and escaping paths and query parameters) the redirect URI of the givenresponse
.protected void
fail(Request request, Response response, java.lang.Throwable failure)
boolean
isRedirect(Response response)
Result
redirect(Request request, Response response)
Redirects the givenresponse
, blocking until the redirect is complete.Request
redirect(Request request, Response response, Response.CompleteListener listener)
Redirects the givenresponse
asynchronously.private Request
redirect(Request request, Response response, Response.CompleteListener listener, java.net.URI newURI)
private Request
redirect(Request request, Response response, Response.CompleteListener listener, java.net.URI location, java.lang.String method)
private java.net.URI
sanitize(java.lang.String location)
private Request
sendRedirect(HttpRequest httpRequest, Response response, Response.CompleteListener listener, java.net.URI location, java.lang.String method)
-
-
-
Field Detail
-
LOG
private static final Logger LOG
-
SCHEME_REGEXP
private static final java.lang.String SCHEME_REGEXP
- See Also:
- Constant Field Values
-
AUTHORITY_REGEXP
private static final java.lang.String AUTHORITY_REGEXP
- See Also:
- Constant Field Values
-
DESTINATION_REGEXP
private static final java.lang.String DESTINATION_REGEXP
- See Also:
- Constant Field Values
-
PATH_REGEXP
private static final java.lang.String PATH_REGEXP
- See Also:
- Constant Field Values
-
QUERY_REGEXP
private static final java.lang.String QUERY_REGEXP
- See Also:
- Constant Field Values
-
FRAGMENT_REGEXP
private static final java.lang.String FRAGMENT_REGEXP
- See Also:
- Constant Field Values
-
URI_PATTERN
private static final java.util.regex.Pattern URI_PATTERN
-
ATTRIBUTE
private static final java.lang.String ATTRIBUTE
-
client
private final HttpClient client
-
notifier
private final ResponseNotifier notifier
-
-
Constructor Detail
-
HttpRedirector
public HttpRedirector(HttpClient client)
-
-
Method Detail
-
isRedirect
public boolean isRedirect(Response response)
- Parameters:
response
- the response to check for redirects- Returns:
- whether the response code is an HTTP redirect code
-
redirect
public Result redirect(Request request, Response response) throws java.lang.InterruptedException, java.util.concurrent.ExecutionException
Redirects the givenresponse
, blocking until the redirect is complete.- Parameters:
request
- the original request that triggered the redirectresponse
- the response to the original request- Returns:
- a
Result
object containing the request to the redirected location and its response - Throws:
java.lang.InterruptedException
- if the thread is interrupted while waiting for the redirect to completejava.util.concurrent.ExecutionException
- if the redirect failed- See Also:
redirect(Request, Response, Response.CompleteListener)
-
redirect
public Request redirect(Request request, Response response, Response.CompleteListener listener)
Redirects the givenresponse
asynchronously.- Parameters:
request
- the original request that triggered the redirectresponse
- the response to the original requestlistener
- the listener that receives response events- Returns:
- the request to the redirected location
-
extractRedirectURI
public java.net.URI extractRedirectURI(Response response)
Extracts and sanitizes (by making it absolute and escaping paths and query parameters) the redirect URI of the givenresponse
.- Parameters:
response
- the response to extract the redirect URI from- Returns:
- the absolute redirect URI, or null if the response does not contain a valid redirect location
-
sanitize
private java.net.URI sanitize(java.lang.String location)
-
redirect
private Request redirect(Request request, Response response, Response.CompleteListener listener, java.net.URI newURI)
-
redirect
private Request redirect(Request request, Response response, Response.CompleteListener listener, java.net.URI location, java.lang.String method)
-
sendRedirect
private Request sendRedirect(HttpRequest httpRequest, Response response, Response.CompleteListener listener, java.net.URI location, java.lang.String method)
-
-