Package com.azure.core.http.policy

Class RedirectPolicy

java.lang.Object

com.azure.core.http.policy.RedirectPolicy

All Implemented Interfaces:

HttpPipelinePolicy

public final class RedirectPolicy
extends Object
implements HttpPipelinePolicy

The RedirectPolicy class is an implementation of the HttpPipelinePolicy interface. This policy handles HTTP redirects by determining if an HTTP request should be redirected based on the received HttpResponse.

This class is useful when you need to handle HTTP redirects in a pipeline. It uses a RedirectStrategy to decide if a request should be redirected. By default, it uses the DefaultRedirectStrategy, which redirects the request based on the HTTP status code of the response.

Code sample:

In this example, a RedirectPolicy is constructed and can be added to a pipeline. For a request sent by the pipeline, if the server responds with a redirect status code, the request will be redirected according to the RedirectStrategy used by the RedirectPolicy.

 RedirectPolicy redirectPolicy = new RedirectPolicy();
 

See Also:

• com.azure.core.http.policy
• HttpPipelinePolicy
• HttpPipeline
• HttpRequest
• HttpResponse
• RedirectStrategy
• DefaultRedirectStrategy

Constructor Summary

Constructors

Constructor	Description
RedirectPolicy()	Creates RedirectPolicy with default DefaultRedirectStrategy as RedirectStrategy and uses the redirect status response code (301, 302, 307, 308) to determine if this request should be redirected.
RedirectPolicy(RedirectStrategy redirectStrategy)	Creates RedirectPolicy with the provided redirectStrategy as RedirectStrategy to determine if this request should be redirected.

Method Summary

Modifier and Type	Method	Description
Mono<HttpResponse>	process(HttpPipelineCallContext context, HttpPipelineNextPolicy next)	Processes provided request context and invokes the next policy.
HttpResponse	processSync(HttpPipelineCallContext context, HttpPipelineNextSyncPolicy next)	Processes provided request context and invokes the next policy synchronously.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.azure.core.http.policy.HttpPipelinePolicy

getPipelinePosition

Constructor Details

RedirectPolicy

public RedirectPolicy()

Creates RedirectPolicy with default DefaultRedirectStrategy as RedirectStrategy and uses the redirect status response code (301, 302, 307, 308) to determine if this request should be redirected.

RedirectPolicy

public RedirectPolicy(RedirectStrategy redirectStrategy)

Creates RedirectPolicy with the provided redirectStrategy as RedirectStrategy to determine if this request should be redirected.

Parameters:

redirectStrategy - The RedirectStrategy used for redirection.

Throws:

NullPointerException - When redirectStrategy is null.

Method Details

process

public Mono<HttpResponse> process(HttpPipelineCallContext context,
 HttpPipelineNextPolicy next)

Description copied from interface: HttpPipelinePolicy

Processes provided request context and invokes the next policy.

Specified by:

process in interface HttpPipelinePolicy

Parameters:

context - The request context.

next - The next policy to invoke.

Returns:

A publisher that initiates the request upon subscription and emits a response on completion.

processSync

public HttpResponse processSync(HttpPipelineCallContext context,
 HttpPipelineNextSyncPolicy next)

Description copied from interface: HttpPipelinePolicy

Processes provided request context and invokes the next policy synchronously.

Specified by:

processSync in interface HttpPipelinePolicy

Parameters:

context - The request context.

next - The next policy to invoke.

Returns:

A publisher that initiates the request upon subscription and emits a response on completion.