com.jcabi.http.wire

Class UserAgentWire

java.lang.Object

com.jcabi.http.wire.UserAgentWire

All Implemented Interfaces:

Wire

@Immutable
public final class UserAgentWire
extends Object
implements Wire

Wire with default user agent.

This wire adds an extra HTTP header User-Agent to the request, if it's not yet provided, for example:

 String html = new JdkRequest("http://goggle.com")
   .through(UserAgentWire.class)
   .fetch()
   .body();

An actual HTTP request will be sent with User-Agent header with a value ReXSL-0.1/abcdef0 Java/1.6 (for example). It is recommended to use this wire decorator when you're working with third party RESTful services, to properly identify yourself and avoid troubles.

The class is immutable and thread-safe.

Since:

0.10

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

See Also:

RFC 2616 section 14.43 "User-Agent"

Constructor Summary

Constructors

Constructor and Description
UserAgentWire(Wire wire) Public ctor.

Method Summary

Methods

Modifier and Type	Method and Description
Response	send(Request req, String home, String method, Collection<Map.Entry<String,String>> headers, byte[] content) Send request and return response.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserAgentWire

public UserAgentWire(@NotNull(message="wire can\'t be NULL")
             Wire wire)

Public ctor.

Parameters:

wire - Original wire

Method Detail

send

public Response send(Request req,
            String home,
            String method,
            Collection<Map.Entry<String,String>> headers,
            byte[] content)
              throws IOException

Send request and return response.

Specified by:

send in interface Wire

Parameters:

req - Request

home - URI to fetch

method - HTTP method

headers - Headers

content - HTTP body

Returns:

Response obtained

Throws:

IOException - if fails

Suppressed Checkstyle violations:

ParameterNumber (7 lines)