Package com.azure.core.http.policy

Class CookiePolicy

java.lang.Object

com.azure.core.http.policy.CookiePolicy

All Implemented Interfaces:

HttpPipelinePolicy

public class CookiePolicy
extends Object
implements HttpPipelinePolicy

The CookiePolicy class is an implementation of the HttpPipelinePolicy interface. This policy is used to handle cookies in HTTP requests and responses.

This class stores cookies from the "Set-Cookie" header of the HTTP response and adds them to subsequent HTTP requests. This is useful for maintaining session information or other stateful information across multiple requests to the same server.

Code sample:

In this example, a CookiePolicy is constructed. The policy can then be added to a pipeline. Any cookies set by the server in the response to a request by the pipeline will be stored by the CookiePolicy and added to subsequent requests to the same server.

 CookiePolicy cookiePolicy = new CookiePolicy();
 

See Also:

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

Constructor Summary

Constructors

Constructor	Description
CookiePolicy()	Creates a new instance of CookiePolicy.

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

CookiePolicy

public CookiePolicy()

Creates a new instance of CookiePolicy.

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.