Package org.apache.juneau.http.header

Class WwwAuthenticate

java.lang.Object

org.apache.juneau.http.header.BasicHeader

org.apache.juneau.http.header.BasicStringHeader

org.apache.juneau.http.header.WwwAuthenticate

All Implemented Interfaces:

Serializable, Cloneable, Header, NameValuePair

@Header("WWW-Authenticate")
public class WwwAuthenticate
extends BasicStringHeader

Represents a parsed WWW-Authenticate HTTP response header.

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

Example

WWW-Authenticate: Basic

RFC2616 Specification

The WWW-Authenticate response-header field MUST be included in 401 (Unauthorized) response messages. The field value consists of at least one challenge that indicates the authentication scheme(s) and parameters applicable to the Request-URI.

WWW-Authenticate = "WWW-Authenticate" ":" 1#challenge

The HTTP access authentication process is described in "HTTP Authentication: Basic and Digest Access Authentication". User agents are advised to take special care in parsing the WWW-Authenticate field value as it might contain more than one challenge, or if more than one WWW-Authenticate header field is provided, the contents of a challenge itself can contain a comma-separated list of authentication parameters.

See Also:

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WwwAuthenticate	of(String value)	Static creator.
static WwwAuthenticate	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

WwwAuthenticate

public WwwAuthenticate(String value)

Constructor.

Parameters:

value - The header value.
Can be null.

WwwAuthenticate

public WwwAuthenticate(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 WwwAuthenticate 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 WwwAuthenticate 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.