Top Description Fields Constructors Methods
org.apache.hc.client5.http.protocol

public Class RequestAddCookies

extends Object
implements HttpRequestInterceptor
Class Inheritance
All Implemented Interfaces
org.apache.hc.core5.http.HttpRequestInterceptor
Annotations
@Contract
threading:STATELESS
Imports
java.io.IOException, java.time.Instant, java.util.ArrayList, .List, org.apache.hc.client5.http.RouteInfo, org.apache.hc.client5.http.cookie.StandardCookieSpec, .Cookie, .CookieOrigin, .CookieSpec, .CookieSpecFactory, .CookieStore, org.apache.hc.client5.http.config.RequestConfig, org.apache.hc.core5.annotation.Contract, .ThreadingBehavior, org.apache.hc.core5.http.EntityDetails, .Header, .HttpException, .HttpRequest, .HttpRequestInterceptor, .Method, org.apache.hc.core5.http.config.Lookup, org.apache.hc.core5.http.protocol.HttpContext, org.apache.hc.core5.net.URIAuthority, org.apache.hc.core5.util.Args, .TextUtils, org.slf4j.Logger, .LoggerFactory

Request interceptor that matches cookies available in the current CookieStore to the request being executed and generates corresponding Cookie request headers.
Since
4.0

Field Summary

Modifier and TypeField and Description
public static final RequestAddCookies
INSTANCE

Singleton instance.

private static final Logger

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
process(final HttpRequest
the request to process
request
,
final EntityDetails
the request entity details or null if not available
entity
,
final HttpContext
the context for the request
context
)

Implements org.apache.hc.core5.http.HttpRequestInterceptor.process.

Processes a request.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

INSTANCEback to summary
public static final RequestAddCookies INSTANCE

Singleton instance.

Since
5.2
LOGback to summary
private static final Logger LOG

Constructor Detail

RequestAddCookiesback to summary
public RequestAddCookies()

Method Detail

processback to summary
public void process(final HttpRequest request, final EntityDetails entity, final HttpContext context) throws HttpException, IOException

Implements org.apache.hc.core5.http.HttpRequestInterceptor.process.

Doc from org.apache.hc.core5.http.HttpRequestInterceptor.process.

Processes a request. On the client side, this step is performed before the request is sent to the server. On the server side, this step is performed on incoming messages before the message body is evaluated.

Parameters
request:HttpRequest

the request to process

entity:EntityDetails

the request entity details or null if not available

context:HttpContext

the context for the request

Annotations
@Override
Exceptions
HttpException:
in case of an HTTP protocol violation
IOException:
in case of an I/O error