io.reactivex.netty.protocol.http.client

Interface RedirectOperator.RedirectHandler<I,O>

Type Parameters:

I - Content type of request sent over this handler.

O - Content type of response received over this handler.

All Known Implementing Classes:

DefaultRedirectHandler

Enclosing class:

RedirectOperator<I,O>

public static interface RedirectOperator.RedirectHandler<I,O>

A handler contract for handling HTTP redirects. This handler is used in the following way:

• After every response, requiresRedirect(RedirectionContext, HttpClientResponse) is called to know whether the response requires a further redirection.
• If a response requires redirection, it checks whether the redirect limit has already been breached. This is asserted based on validate(RedirectionContext, HttpClientResponse). The reason for this not included in the previous call is that we want to differentiate between a response not requiring redirects vs a response requiring redirects but not being performed because of limits like max redirects allowed, redirect loops etc..
• If the redirect limit is not yet breached, then doRedirect(RedirectionContext, HttpClientRequest, HttpClient.HttpClientConfig) will be called.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RedirectOperator.RedirectHandler.RedirectionContext

Method Summary

Modifier and Type	Method and Description
rx.Observable<HttpClientResponse<O>>	doRedirect(RedirectOperator.RedirectHandler.RedirectionContext context, HttpClientRequest<I> originalRequest, HttpClient.HttpClientConfig config) Performs the redirect operation.
boolean	requiresRedirect(RedirectOperator.RedirectHandler.RedirectionContext context, HttpClientResponse<O> response) Asserts whether the passed response requires a redirect.
void	validate(RedirectOperator.RedirectHandler.RedirectionContext context, HttpClientResponse<O> redirectResponse) This is invoked if a particular response requires a redirect as evaluated by requiresRedirect(RedirectionContext, HttpClientResponse).

Method Detail

doRedirect

rx.Observable<HttpClientResponse<O>> doRedirect(RedirectOperator.RedirectHandler.RedirectionContext context,
                                                HttpClientRequest<I> originalRequest,
                                                HttpClient.HttpClientConfig config)

Performs the redirect operation. This should at the least call RedirectOperator.RedirectHandler.RedirectionContext.newLocation(String) with the new redirect location.

Parameters:

context - Redirection context.

originalRequest - Original request that started this response processing.

config - Client config to use while making the redirect request.

Returns:

The response after executing the redirect.

requiresRedirect

boolean requiresRedirect(RedirectOperator.RedirectHandler.RedirectionContext context,
                         HttpClientResponse<O> response)

Asserts whether the passed response requires a redirect. If this returns true then doRedirect(RedirectionContext, HttpClientRequest, HttpClient.HttpClientConfig) will be called for this response if and only if the redirect is valid specified by validate(RedirectionContext, HttpClientResponse)

Parameters:

context - Redirection context.

response - The response to be evaluated for redirects.

Returns:

true if the response needs redirection, else false

validate

void validate(RedirectOperator.RedirectHandler.RedirectionContext context,
              HttpClientResponse<O> redirectResponse)

This is invoked if a particular response requires a redirect as evaluated by requiresRedirect(RedirectionContext, HttpClientResponse). If this returns false the redirect is not performed, instead an error is propagated.

This should throw an exception if the redirect is not valid. eg: If the max redirects limit is 3 and the redirects till now are 2, then this method should thrown an exception.

Parameters:

context - The redirection context.

redirectResponse - The response to be evaluated for redirects.

Throws:

HttpRedirectException - if the redirect is not valid.