public Class RequestUserAgent

Class Inheritance

extends Object
implements HttpRequestInterceptor

java.lang.Object
org.apache.hc.core5.http.protocol.RequestUserAgent

All Implemented Interfaces

org.apache.hc.core5.http.HttpRequestInterceptor

Annotations

@Contract
threading:IMMUTABLE

Imports

java.io.IOException, org.apache.hc.core5.annotation.Contract, .ThreadingBehavior, org.apache.hc.core5.http.EntityDetails, .HttpException, .HttpHeaders, .HttpRequest, .HttpRequestInterceptor, org.apache.hc.core5.util.Args

RequestUserAgent is responsible for adding User-Agent header. This interceptor is recommended for client side protocol processors.

Since: 4.0

Field Summary

Modifier and Type	Field and Description
public static final HttpRequestInterceptor	INSTANCE Singleton instance.
private final String	userAgent

Constructor Summary

Access	Constructor and Description
public	RequestUserAgent(final String userAgent)
public	RequestUserAgent()

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

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

INSTANCE

back to summary

public static final HttpRequestInterceptor INSTANCE

Singleton instance.

Since: 5.2

userAgent	back to summary
private final String userAgent

Constructor Detail

RequestUserAgent	back to summary
public RequestUserAgent(final String userAgent)

RequestUserAgent	back to summary
public RequestUserAgent()

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