public Class RequestDefaultHeaders

Class Inheritance

extends Object
implements HttpRequestInterceptor

java.lang.Object
org.apache.hc.client5.http.protocol.RequestDefaultHeaders

All Implemented Interfaces

org.apache.hc.core5.http.HttpRequestInterceptor

Annotations

@Contract
threading:STATELESS

Imports

java.io.IOException, java.util.Collection, org.apache.hc.core5.annotation.Contract, .ThreadingBehavior, org.apache.hc.core5.http.EntityDetails, .Header, .HttpException, .HttpRequest, .HttpRequestInterceptor, .Method, org.apache.hc.core5.http.protocol.HttpContext, org.apache.hc.core5.util.Args

Request interceptor that adds default request headers.

Since: 4.0

Field Summary

Modifier and Type	Field and Description
private final Collection<? extends Header>	defaultHeaders
public static final RequestDefaultHeaders	INSTANCE Singleton instance.

Constructor Summary

Access	Constructor and Description
public	RequestDefaultHeaders(final Collection<? extends Header> defaultHeaders)
public	RequestDefaultHeaders()

Method Summary

Modifier and Type	Method 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:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

defaultHeaders	back to summary
private final Collection<? extends Header> defaultHeaders

INSTANCE	back to summary
public static final RequestDefaultHeaders INSTANCE Singleton instance. Since 5.2

INSTANCE

back to summary

public static final RequestDefaultHeaders INSTANCE

Singleton instance.

Since: 5.2

Constructor Detail

RequestDefaultHeaders	back to summary
public RequestDefaultHeaders(final Collection<? extends Header> defaultHeaders) Since 4.3

RequestDefaultHeaders	back to summary
public RequestDefaultHeaders()

Method Detail

process back to summary

process	back 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

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