Package org.apache.juneau.http.header

Class UserAgent

java.lang.Object

org.apache.juneau.http.header.BasicHeader

org.apache.juneau.http.header.BasicStringHeader

org.apache.juneau.http.header.UserAgent

All Implemented Interfaces:

Serializable, Cloneable, Header, NameValuePair

@Header("User-Agent")
public class UserAgent
extends BasicStringHeader

Represents a parsed User-Agent HTTP request header.

The user agent string of the user agent.

Example

User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:12.0) Gecko/20100101 Firefox/21.0

RFC2616 Specification

The User-Agent request-header field contains information about the user agent originating the request. This is for statistical purposes, the tracing of protocol violations, and automated recognition of user agents for the sake of tailoring responses to avoid particular user agent limitations. User agents SHOULD include this field with requests. The field can contain multiple product tokens (section 3.8) and comments identifying the agent and any sub-products which form a significant part of the user agent. By convention, the product tokens are listed in order of their significance for identifying the application.

User-Agent = "User-Agent" ":" 1*( product | comment )

Example:

User-Agent: CERN-LineMode/2.15 libwww/2.17b3

See Also:

• juneau-rest-common Basics
• Hypertext Transfer Protocol -- HTTP/1.1

Constructor Summary

Constructors

Constructor	Description
UserAgent(String value)	Constructor.
UserAgent(Supplier<String> value)	Constructor with delayed value.

Method Summary

Modifier and Type	Method	Description
static UserAgent	of(String value)	Static creator.
static UserAgent	of(Supplier<String> value)	Static creator with delayed value.

Methods inherited from class org.apache.juneau.http.header.BasicStringHeader

assertString, asString, getValue, of, of, ofPair, orElse

Methods inherited from class org.apache.juneau.http.header.BasicHeader

assertName, assertStringValue, equals, equalsIgnoreCase, get, getElements, getName, hashCode, isNotEmpty, isPresent, of, of, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

UserAgent

public UserAgent(String value)

Constructor.

Parameters:

value - The header value.
Can be null.

UserAgent

public UserAgent(Supplier<String> value)

Constructor with delayed value.

Header value is re-evaluated on each call to BasicStringHeader.getValue().

Parameters:

value - The supplier of the header value.
Can be null.

Method Details

of

public static UserAgent of(String value)

Static creator.

Parameters:

value - The header value.
Can be null.

Returns:

A new header bean, or null if the value is null.

of

public static UserAgent of(Supplier<String> value)

Static creator with delayed value.

Header value is re-evaluated on each call to BasicStringHeader.getValue().

Parameters:

value - The supplier of the header value.
Can be null.

Returns:

A new header bean, or null if the value is null.