Package org.apache.juneau.http

Class HttpHeaders

java.lang.Object

org.apache.juneau.http.HttpHeaders

public final class HttpHeaders
extends Object

Static factory methods for creating common HTTP headers.

This is a convenience class that provides shorthand access to all named header types in org.apache.juneau.http.header.

// Import statically for clean DSL-style usage import static HttpHeaders.*; RestRequest req = client.get("/api/resource") .header(accept("application/json")) .header(authorization("Bearer " + token));

See Also:

• Next-Generation REST Client

Since:

9.2.1

Method Summary

Modifier and Type	Method	Description
static Accept	accept(String value)
static Accept	accept(MediaRanges value)
static AcceptCharset	acceptCharset(String value)
static AcceptCharset	acceptCharset(StringRanges value)
static AcceptCharset	acceptCharsetLazyParsed(Supplier<StringRanges> value)
static AcceptCharset	acceptCharsetLazyWire(Supplier<String> value)
static AcceptEncoding	acceptEncoding(String value)
static AcceptEncoding	acceptEncoding(StringRanges value)
static AcceptEncoding	acceptEncodingLazyParsed(Supplier<StringRanges> value)
static AcceptEncoding	acceptEncodingLazyWire(Supplier<String> value)
static AcceptLanguage	acceptLanguage(String value)
static AcceptLanguage	acceptLanguage(StringRanges value)
static AcceptLanguage	acceptLanguageLazyParsed(Supplier<StringRanges> value)
static AcceptLanguage	acceptLanguageLazyWire(Supplier<String> value)
static Accept	acceptLazyParsed(Supplier<MediaRanges> value)
static Accept	acceptLazyWire(Supplier<String> value)
static AcceptRanges	acceptRanges(String value)
static AcceptRanges	acceptRanges(Supplier<String> value)
static Age	age(int seconds)
static Age	age(String value)
static Allow	allow(String value)
static Allow	allow(String... methods)
static Allow	allowLazyTokens(Supplier<String[]> tokenSupplier)
static Authorization	authorization(String value)
static Authorization	authorization(Supplier<String> value)
static CacheControl	cacheControl(String value)
static CacheControl	cacheControl(Supplier<String> value)
static ClientVersion	clientVersion(String value)
static Connection	connection(String value)
static ContentDisposition	contentDisposition(String value)
static ContentDisposition	contentDisposition(Supplier<StringRanges> value)
static ContentDisposition	contentDisposition(StringRanges value)
static ContentEncoding	contentEncoding(String value)
static ContentLanguage	contentLanguage(String value)
static ContentLength	contentLength(long bytes)
static ContentLength	contentLength(String value)
static ContentLocation	contentLocation(String value)
static ContentLocation	contentLocation(URI uri)
static ContentRange	contentRange(String value)
static ContentType	contentType(String value)
static ContentType	contentType(MediaType value)
static ContentType	contentTypeLazyParsed(Supplier<MediaType> value)
static ContentType	contentTypeLazyWire(Supplier<String> value)
static Date	date(String value)
static Date	date(ZonedDateTime value)
static Debug	debug()
static Debug	debug(String value)
static ETag	eTag(String value)
static ETag	eTag(EntityTag value)
static Expect	expect(String value)
static Expires	expires(String value)
static Expires	expires(ZonedDateTime value)
static Forwarded	forwarded(String value)
static From	from(String value)
static HttpHeader	header(String name, String value)	Creates a generic HttpHeader with the given name and value.
static HttpHeader	header(String name, Supplier<String> valueSupplier)	Creates a generic HttpHeader with a lazy value supplier.
static Host	host(String value)
static IfMatch	ifMatch(String value)
static IfMatch	ifMatch(EntityTags value)
static IfModifiedSince	ifModifiedSince(String value)
static IfModifiedSince	ifModifiedSince(ZonedDateTime value)
static IfNoneMatch	ifNoneMatch(String value)
static IfNoneMatch	ifNoneMatch(EntityTags value)
static IfRange	ifRange(String value)
static IfRange	ifRange(ZonedDateTime value)
static IfRange	ifRange(Supplier<?> value)
static IfRange	ifRange(EntityTag value)
static IfUnmodifiedSince	ifUnmodifiedSince(String value)
static IfUnmodifiedSince	ifUnmodifiedSince(ZonedDateTime value)
static LastModified	lastModified(String value)
static LastModified	lastModified(ZonedDateTime value)
static Location	location(String value)
static Location	location(URI uri)
static MaxForwards	maxForwards(int hops)
static MaxForwards	maxForwards(String value)
static NoTrace	noTrace()
static NoTrace	noTrace(String value)
static Origin	origin(String value)
static Pragma	pragma(String value)
static ProxyAuthenticate	proxyAuthenticate(String value)
static ProxyAuthorization	proxyAuthorization(String value)
static Range	range(String value)
static Referer	referer(String value)
static Referer	referer(URI uri)
static RetryAfter	retryAfter(int seconds)
static RetryAfter	retryAfter(String value)
static RetryAfter	retryAfter(ZonedDateTime value)
static RetryAfter	retryAfter(Supplier<?> value)
static Server	server(String value)
static TE	te(String value)
static TE	te(StringRanges value)
static TE	teLazyParsed(Supplier<StringRanges> value)
static TE	teLazyWire(Supplier<String> value)
static Thrown	thrown(String value)
static Trailer	trailer(String value)
static TransferEncoding	transferEncoding(String value)
static Upgrade	upgrade(String value)
static UserAgent	userAgent(String value)
static UserAgent	userAgent(Supplier<String> value)
static Vary	vary(String value)
static Via	via(String value)
static Warning	warning(String value)
static WwwAuthenticate	wwwAuthenticate(String value)

Methods inherited from class java.lang.Object

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

Method Details

accept

public static Accept accept(String value)

Parameters:

value - The header value. @return A new header.

acceptLazyWire

public static Accept acceptLazyWire(Supplier<String> value)

Parameters:

value - Supplier of the wire header value. @return A new header.

accept

public static Accept accept(MediaRanges value)

Parameters:

value - Parsed media ranges. @return A new header.

acceptLazyParsed

public static Accept acceptLazyParsed(Supplier<MediaRanges> value)

Parameters:

value - Supplier of parsed media ranges. @return A new header.

acceptCharset

public static AcceptCharset acceptCharset(String value)

Parameters:

value - The header value. @return A new header.

acceptCharsetLazyWire

public static AcceptCharset acceptCharsetLazyWire(Supplier<String> value)

Parameters:

value - Supplier of the wire header value. @return A new header.

acceptCharset

public static AcceptCharset acceptCharset(StringRanges value)

Parameters:

value - Parsed string ranges. @return A new header.

acceptCharsetLazyParsed

public static AcceptCharset acceptCharsetLazyParsed(Supplier<StringRanges> value)

Parameters:

value - Supplier of string ranges. @return A new header.

acceptEncoding

public static AcceptEncoding acceptEncoding(String value)

Parameters:

value - The header value. @return A new header.

acceptEncodingLazyWire

public static AcceptEncoding acceptEncodingLazyWire(Supplier<String> value)

Parameters:

value - Supplier of the wire header value. @return A new header.

acceptEncoding

public static AcceptEncoding acceptEncoding(StringRanges value)

Parameters:

value - Parsed string ranges. @return A new header.

acceptEncodingLazyParsed

public static AcceptEncoding acceptEncodingLazyParsed(Supplier<StringRanges> value)

Parameters:

value - Supplier of string ranges. @return A new header.

acceptLanguage

public static AcceptLanguage acceptLanguage(String value)

Parameters:

value - The header value. @return A new header.

acceptLanguageLazyWire

public static AcceptLanguage acceptLanguageLazyWire(Supplier<String> value)

Parameters:

value - Supplier of the wire header value. @return A new header.

acceptLanguage

public static AcceptLanguage acceptLanguage(StringRanges value)

Parameters:

value - Parsed string ranges. @return A new header.

acceptLanguageLazyParsed

public static AcceptLanguage acceptLanguageLazyParsed(Supplier<StringRanges> value)

Parameters:

value - Supplier of string ranges. @return A new header.

acceptRanges

public static AcceptRanges acceptRanges(String value)

Parameters:

value - The header value. @return A new header.

acceptRanges

public static AcceptRanges acceptRanges(Supplier<String> value)

Parameters:

value - The header value supplier. @return A new header.

age

public static Age age(String value)

Parameters:

value - The header value. @return A new header.

age

public static Age age(int seconds)

Parameters:

seconds - Age in seconds. @return A new header.

allow

public static Allow allow(String value)

Parameters:

value - The header value. @return A new header.

allow

public static Allow allow(String... methods)

Parameters:

methods - Allowed methods. @return A new header.

allowLazyTokens

public static Allow allowLazyTokens(Supplier<String[]> tokenSupplier)

Parameters:

tokenSupplier - Lazy token list. @return A new header.

authorization

public static Authorization authorization(String value)

Parameters:

value - The header value. @return A new header.

authorization

public static Authorization authorization(Supplier<String> value)

Parameters:

value - The header value supplier. @return A new header.

cacheControl

public static CacheControl cacheControl(String value)

Parameters:

value - The header value. @return A new header.

cacheControl

public static CacheControl cacheControl(Supplier<String> value)

Parameters:

value - The header value supplier. @return A new header.

connection

public static Connection connection(String value)

Parameters:

value - The header value. @return A new header.

contentDisposition

public static ContentDisposition contentDisposition(String value)

Parameters:

value - The header value. @return A new header.

contentDisposition

public static ContentDisposition contentDisposition(StringRanges value)

Parameters:

value - Parsed string ranges. @return A new header.

contentDisposition

public static ContentDisposition contentDisposition(Supplier<StringRanges> value)

Parameters:

value - Supplier of string ranges. @return A new header.

contentEncoding

public static ContentEncoding contentEncoding(String value)

Parameters:

value - The header value. @return A new header.

contentLanguage

public static ContentLanguage contentLanguage(String value)

Parameters:

value - The header value. @return A new header.

contentLength

public static ContentLength contentLength(String value)

Parameters:

value - The header value. @return A new header.

contentLength

public static ContentLength contentLength(long bytes)

Parameters:

bytes - The content length in bytes. @return A new header.

contentLocation

public static ContentLocation contentLocation(String value)

Parameters:

value - The header value. @return A new header.

contentLocation

public static ContentLocation contentLocation(URI uri)

Parameters:

uri - Content location URI. @return A new header.

contentRange

public static ContentRange contentRange(String value)

Parameters:

value - The header value. @return A new header.

contentType

public static ContentType contentType(String value)

Parameters:

value - The header value. @return A new header.

contentTypeLazyWire

public static ContentType contentTypeLazyWire(Supplier<String> value)

Parameters:

value - Supplier of the wire header value. @return A new header.

contentType

public static ContentType contentType(MediaType value)

Parameters:

value - Parsed media type. @return A new header.

contentTypeLazyParsed

public static ContentType contentTypeLazyParsed(Supplier<MediaType> value)

Parameters:

value - Supplier of media type. @return A new header.

date

public static Date date(String value)

Parameters:

value - The header value. @return A new header.

date

public static Date date(ZonedDateTime value)

Parameters:

value - HTTP-date. @return A new header.

eTag

public static ETag eTag(String value)

Parameters:

value - The header value. @return A new header.

eTag

public static ETag eTag(EntityTag value)

Parameters:

value - Parsed entity-tag. @return A new header.

expect

public static Expect expect(String value)

Parameters:

value - The header value. @return A new header.

expires

public static Expires expires(String value)

Parameters:

value - The header value. @return A new header.

expires

public static Expires expires(ZonedDateTime value)

Parameters:

value - HTTP-date. @return A new header.

forwarded

public static Forwarded forwarded(String value)

Parameters:

value - The header value. @return A new header.

from

public static From from(String value)

Parameters:

value - The header value. @return A new header.

host

public static Host host(String value)

Parameters:

value - The header value. @return A new header.

ifMatch

public static IfMatch ifMatch(String value)

Parameters:

value - The header value. @return A new header.

ifMatch

public static IfMatch ifMatch(EntityTags value)

Parameters:

value - Parsed entity-tags. @return A new header.

ifModifiedSince

public static IfModifiedSince ifModifiedSince(String value)

Parameters:

value - The header value. @return A new header.

ifModifiedSince

public static IfModifiedSince ifModifiedSince(ZonedDateTime value)

Parameters:

value - HTTP-date. @return A new header.

ifNoneMatch

public static IfNoneMatch ifNoneMatch(String value)

Parameters:

value - The header value. @return A new header.

ifNoneMatch

public static IfNoneMatch ifNoneMatch(EntityTags value)

Parameters:

value - Parsed entity-tags. @return A new header.

ifRange

public static IfRange ifRange(String value)

Parameters:

value - The header value. @return A new header.

ifRange

public static IfRange ifRange(EntityTag value)

Parameters:

value - Entity-tag. @return A new header.

ifRange

public static IfRange ifRange(ZonedDateTime value)

Parameters:

value - HTTP-date. @return A new header.

ifRange

public static IfRange ifRange(Supplier<?> value)

Parameters:

value - Supplier of tag or date. @return A new header.

ifUnmodifiedSince

public static IfUnmodifiedSince ifUnmodifiedSince(String value)

Parameters:

value - The header value. @return A new header.

ifUnmodifiedSince

public static IfUnmodifiedSince ifUnmodifiedSince(ZonedDateTime value)

Parameters:

value - HTTP-date. @return A new header.

lastModified

public static LastModified lastModified(String value)

Parameters:

value - The header value. @return A new header.

lastModified

public static LastModified lastModified(ZonedDateTime value)

Parameters:

value - HTTP-date. @return A new header.

location

public static Location location(String value)

Parameters:

value - The header value. @return A new header.

location

public static Location location(URI uri)

Parameters:

uri - Redirect URI. @return A new header.

maxForwards

public static MaxForwards maxForwards(String value)

Parameters:

value - The header value. @return A new header.

maxForwards

public static MaxForwards maxForwards(int hops)

Parameters:

hops - Max forwards count. @return A new header.

origin

public static Origin origin(String value)

Parameters:

value - The header value. @return A new header.

pragma

public static Pragma pragma(String value)

Parameters:

value - The header value. @return A new header.

proxyAuthenticate

public static ProxyAuthenticate proxyAuthenticate(String value)

Parameters:

value - The header value. @return A new header.

proxyAuthorization

public static ProxyAuthorization proxyAuthorization(String value)

Parameters:

value - The header value. @return A new header.

range

public static Range range(String value)

Parameters:

value - The header value. @return A new header.

referer

public static Referer referer(String value)

Parameters:

value - The header value. @return A new header.

referer

public static Referer referer(URI uri)

Parameters:

uri - Referer URI. @return A new header.

retryAfter

public static RetryAfter retryAfter(String value)

Parameters:

value - The header value. @return A new header.

retryAfter

public static RetryAfter retryAfter(int seconds)

Parameters:

seconds - Delta seconds. @return A new header.

retryAfter

public static RetryAfter retryAfter(ZonedDateTime value)

Parameters:

value - HTTP-date. @return A new header.

retryAfter

public static RetryAfter retryAfter(Supplier<?> value)

Parameters:

value - Supplier of seconds or date. @return A new header.

server

public static Server server(String value)

Parameters:

value - The header value. @return A new header.

te

public static TE te(String value)

Parameters:

value - The header value. @return A new header.

te

public static TE te(StringRanges value)

Parameters:

value - Parsed string ranges. @return A new header.

teLazyWire

public static TE teLazyWire(Supplier<String> value)

Parameters:

value - Supplier of the wire header value. @return A new header.

teLazyParsed

public static TE teLazyParsed(Supplier<StringRanges> value)

Parameters:

value - Supplier of string ranges. @return A new header.

trailer

public static Trailer trailer(String value)

Parameters:

value - The header value. @return A new header.

transferEncoding

public static TransferEncoding transferEncoding(String value)

Parameters:

value - The header value. @return A new header.

upgrade

public static Upgrade upgrade(String value)

Parameters:

value - The header value. @return A new header.

userAgent

public static UserAgent userAgent(String value)

Parameters:

value - The header value. @return A new header.

userAgent

public static UserAgent userAgent(Supplier<String> value)

Parameters:

value - The header value supplier. @return A new header.

vary

public static Vary vary(String value)

Parameters:

value - The header value. @return A new header.

via

public static Via via(String value)

Parameters:

value - The header value. @return A new header.

warning

public static Warning warning(String value)

Parameters:

value - The header value. @return A new header.

wwwAuthenticate

public static WwwAuthenticate wwwAuthenticate(String value)

Parameters:

value - The header value. @return A new header.

noTrace

public static NoTrace noTrace(String value)

Parameters:

value - The header value. @return A new header.

noTrace

public static NoTrace noTrace()

Returns:

A no-trace header with value "true".

debug

public static Debug debug(String value)

Parameters:

value - The header value. @return A new header.

debug

public static Debug debug()

Returns:

A debug header with value "true".

clientVersion

public static ClientVersion clientVersion(String value)

Parameters:

value - The header value. @return A new header.

thrown

public static Thrown thrown(String value)

Parameters:

value - The header value. @return A new header.

header

public static HttpHeader header(String name,
 String value)

Creates a generic HttpHeader with the given name and value.

Parameters:

name - The header name. Must not be null.

value - The header value. May be null.

Returns:

A new header. Never null.

header

public static HttpHeader header(String name,
 Supplier<String> valueSupplier)

Creates a generic HttpHeader with a lazy value supplier.

Parameters:

name - The header name. Must not be null.

valueSupplier - Supplier for the header value. Must not be null.

Returns:

A new header. Never null.