Class RequestUserAgent
- java.lang.Object
-
- org.apache.hc.core5.http.protocol.RequestUserAgent
-
- All Implemented Interfaces:
HttpRequestInterceptor
@Contract(threading=IMMUTABLE) public class RequestUserAgent extends java.lang.Object implements HttpRequestInterceptor
RequestUserAgent is responsible for addingUser-Agent
header. This interceptor is recommended for client side protocol processors.- Since:
- 4.0
-
-
Field Summary
Fields Modifier and Type Field Description static HttpRequestInterceptor
INSTANCE
Singleton instance.private java.lang.String
userAgent
-
Constructor Summary
Constructors Constructor Description RequestUserAgent()
RequestUserAgent(java.lang.String userAgent)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
process(HttpRequest request, EntityDetails entity, HttpContext context)
Processes a request.
-
-
-
Field Detail
-
INSTANCE
public static final HttpRequestInterceptor INSTANCE
Singleton instance.- Since:
- 5.2
-
userAgent
private final java.lang.String userAgent
-
-
Method Detail
-
process
public void process(HttpRequest request, EntityDetails entity, HttpContext context) throws HttpException, java.io.IOException
Description copied from interface:HttpRequestInterceptor
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.- Specified by:
process
in interfaceHttpRequestInterceptor
- Parameters:
request
- the request to processentity
- the request entity details ornull
if not availablecontext
- the context for the request- Throws:
HttpException
- in case of an HTTP protocol violationjava.io.IOException
- in case of an I/O error
-
-