Package org.apache.http.protocol

Class RequestUserAgent

java.lang.Object

org.apache.http.protocol.RequestUserAgent

All Implemented Interfaces:

HttpRequestInterceptor

@Contract(threading=IMMUTABLE)
public class RequestUserAgent
extends java.lang.Object
implements HttpRequestInterceptor

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

Since:

4.0

Constructor Summary

Constructors

Constructor	Description
RequestUserAgent()
RequestUserAgent(java.lang.String userAgent)

Method Summary

Modifier and Type	Method	Description
void	process(HttpRequest request, HttpContext context)	Processes a request.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RequestUserAgent

public RequestUserAgent(java.lang.String userAgent)

RequestUserAgent

public RequestUserAgent()

Method Detail

process

public void process(HttpRequest request,
                    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 interface HttpRequestInterceptor

Parameters:

request - the request to preprocess

context - the context for the request

Throws:

HttpException - in case of an HTTP protocol violation

java.io.IOException - in case of an I/O error