Package org.apache.juneau.http.header

Class WwwAuthenticate

java.lang.Object

org.apache.juneau.http.header.HttpHeaderBean

org.apache.juneau.http.header.HttpStringHeader

org.apache.juneau.http.header.WwwAuthenticate

All Implemented Interfaces:

HttpHeader

public class WwwAuthenticate
extends HttpStringHeader

Represents an HTTP WWW-Authenticate header.

Indicates the authentication scheme that should be used to access the requested entity.

See Also:

• Next-Generation REST Client

Since:

9.2.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WwwAuthenticate.Builder	Fluent builder for assembling an HTTP WWW-Authenticate challenge value.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME	The header name

Constructor Summary

Constructors

Constructor	Description
WwwAuthenticate(String value)	Constructor with an eager value.
WwwAuthenticate(Supplier<String> valueSupplier)	Constructor with a lazy value supplier.

Method Summary

Modifier and Type	Method	Description
static WwwAuthenticate.Builder	basic(String realm)	Creates a WwwAuthenticate.Builder pre-populated with a Basic challenge for the given realm.
static WwwAuthenticate.Builder	bearer()	Creates a WwwAuthenticate.Builder pre-populated with a Bearer challenge.
static WwwAuthenticate.Builder	create()	Creates a new empty WwwAuthenticate.Builder.
static WwwAuthenticate.Builder	digest()	Creates a WwwAuthenticate.Builder pre-populated with a Digest challenge.
static WwwAuthenticate	of(String value)	Static factory method with an eager value.
static WwwAuthenticate	of(Supplier<String> valueSupplier)	Static factory method with a lazy value supplier.

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

of, of, ofPair

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

equals, equalsIgnoreCase, getName, getValue, hashCode, toString

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

The header name

See Also:

• Constant Field Values

Constructor Details

WwwAuthenticate

public WwwAuthenticate(String value)

Constructor with an eager value.

Parameters:

value - The header value. May be null.

WwwAuthenticate

public WwwAuthenticate(Supplier<String> valueSupplier)

Constructor with a lazy value supplier.

Parameters:

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

Method Details

of

public static WwwAuthenticate of(String value)

Static factory method with an eager value.

Parameters:

value - The header value. May be null.

Returns:

A new instance. Never null.

of

public static WwwAuthenticate of(Supplier<String> valueSupplier)

Static factory method with a lazy value supplier.

Parameters:

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

Returns:

A new instance. Never null.

create

public static WwwAuthenticate.Builder create()

Creates a new empty WwwAuthenticate.Builder.

Returns:

A new builder. Never null.

basic

public static WwwAuthenticate.Builder basic(String realm)

Creates a WwwAuthenticate.Builder pre-populated with a Basic challenge for the given realm.

Parameters:

realm - The protection space realm. Must not be null.

Returns:

A new builder. Never null.

bearer

public static WwwAuthenticate.Builder bearer()

Creates a WwwAuthenticate.Builder pre-populated with a Bearer challenge.

Returns:

A new builder. Never null.

digest

public static WwwAuthenticate.Builder digest()

Creates a WwwAuthenticate.Builder pre-populated with a Digest challenge.

Returns:

A new builder. Never null.