2020-12-04 14:02:06 +03:00
### YamlMime:JavaType
uid : "com.azure.core.http.policy.CookiePolicy"
fullName : "com.azure.core.http.policy.CookiePolicy"
name : "CookiePolicy"
nameWithType : "CookiePolicy"
2024-03-12 07:45:40 +03:00
summary : "The `CookiePolicy` class is an implementation of the <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipelinePolicy\"></xref> interface."
2020-12-04 14:02:06 +03:00
inheritances :
2022-08-11 07:43:16 +03:00
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
2022-09-27 07:22:51 +03:00
inheritedClassMethods :
- classRef : "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef :
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
2022-11-01 07:30:49 +03:00
syntax : "public class **CookiePolicy**</br> implements <xref href=\"com.azure.core.http.policy.HttpPipelinePolicy?alt=com.azure.core.http.policy.HttpPipelinePolicy&text=HttpPipelinePolicy\" data-throw-if-not-resolved=\"False\" />"
2020-12-04 14:02:06 +03:00
constructors :
2022-08-22 08:55:24 +03:00
- uid : "com.azure.core.http.policy.CookiePolicy.CookiePolicy()"
fullName : "com.azure.core.http.policy.CookiePolicy.CookiePolicy()"
name : "CookiePolicy()"
nameWithType : "CookiePolicy.CookiePolicy()"
2022-11-08 00:09:01 +03:00
summary : "Creates a new instance of <xref uid=\"com.azure.core.http.policy.CookiePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CookiePolicy\"></xref>."
2022-08-22 08:55:24 +03:00
syntax : "public CookiePolicy()"
2022-11-08 00:09:01 +03:00
desc : "Creates a new instance of <xref uid=\"com.azure.core.http.policy.CookiePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CookiePolicy\"></xref>."
2020-12-04 14:02:06 +03:00
methods :
2022-08-22 08:55:24 +03:00
- uid : "com.azure.core.http.policy.CookiePolicy.process(com.azure.core.http.HttpPipelineCallContext,com.azure.core.http.HttpPipelineNextPolicy)"
fullName : "com.azure.core.http.policy.CookiePolicy.process(HttpPipelineCallContext context, HttpPipelineNextPolicy next)"
name : "process(HttpPipelineCallContext context, HttpPipelineNextPolicy next)"
nameWithType : "CookiePolicy.process(HttpPipelineCallContext context, HttpPipelineNextPolicy next)"
summary : "Processes provided request context and invokes the next policy."
parameters :
- name : "context"
type : "<xref href=\"com.azure.core.http.HttpPipelineCallContext?alt=com.azure.core.http.HttpPipelineCallContext&text=HttpPipelineCallContext\" data-throw-if-not-resolved=\"False\" />"
- name : "next"
type : "<xref href=\"com.azure.core.http.HttpPipelineNextPolicy?alt=com.azure.core.http.HttpPipelineNextPolicy&text=HttpPipelineNextPolicy\" data-throw-if-not-resolved=\"False\" />"
syntax : "public Mono<HttpResponse> process(HttpPipelineCallContext context, HttpPipelineNextPolicy next)"
desc : "Processes provided request context and invokes the next policy."
returns :
2024-08-08 08:04:37 +03:00
type : "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.HttpResponse?alt=com.azure.core.http.HttpResponse&text=HttpResponse\" data-throw-if-not-resolved=\"False\" />>"
2022-08-22 08:55:24 +03:00
- uid : "com.azure.core.http.policy.CookiePolicy.processSync(com.azure.core.http.HttpPipelineCallContext,com.azure.core.http.HttpPipelineNextSyncPolicy)"
fullName : "com.azure.core.http.policy.CookiePolicy.processSync(HttpPipelineCallContext context, HttpPipelineNextSyncPolicy next)"
name : "processSync(HttpPipelineCallContext context, HttpPipelineNextSyncPolicy next)"
nameWithType : "CookiePolicy.processSync(HttpPipelineCallContext context, HttpPipelineNextSyncPolicy next)"
summary : "Processes provided request context and invokes the next policy synchronously."
parameters :
- name : "context"
type : "<xref href=\"com.azure.core.http.HttpPipelineCallContext?alt=com.azure.core.http.HttpPipelineCallContext&text=HttpPipelineCallContext\" data-throw-if-not-resolved=\"False\" />"
- name : "next"
type : "<xref href=\"com.azure.core.http.HttpPipelineNextSyncPolicy?alt=com.azure.core.http.HttpPipelineNextSyncPolicy&text=HttpPipelineNextSyncPolicy\" data-throw-if-not-resolved=\"False\" />"
syntax : "public HttpResponse processSync(HttpPipelineCallContext context, HttpPipelineNextSyncPolicy next)"
desc : "Processes provided request context and invokes the next policy synchronously."
returns :
type : "<xref href=\"com.azure.core.http.HttpResponse?alt=com.azure.core.http.HttpResponse&text=HttpResponse\" data-throw-if-not-resolved=\"False\" />"
2020-12-04 14:02:06 +03:00
type : "class"
2024-03-12 07:45:40 +03:00
desc : "The `CookiePolicy` class is an implementation of the <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipelinePolicy\"></xref> interface. This policy is used to handle cookies in HTTP requests and responses.\n\nThis 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.\n\n**Code sample:**\n\nIn 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.\n\n```java\nCookiePolicy cookiePolicy = new CookiePolicy();\n```"
2020-12-04 14:02:06 +03:00
implements :
- "<xref href=\"com.azure.core.http.policy.HttpPipelinePolicy?alt=com.azure.core.http.policy.HttpPipelinePolicy&text=HttpPipelinePolicy\" data-throw-if-not-resolved=\"False\" />"
metadata : {}
package : "com.azure.core.http.policy"
2024-08-03 07:58:45 +03:00
artifact : com.azure:azure-core:1.51.0