Package org.forgerock.openig.filter.oauth2.client

Class OAuth2BearerWWWAuthenticateHeader

java.lang.Object

org.forgerock.http.protocol.Header

org.forgerock.openig.filter.oauth2.client.OAuth2BearerWWWAuthenticateHeader

public class OAuth2BearerWWWAuthenticateHeader
extends org.forgerock.http.protocol.Header

Processes the OAuth 2.0 Bearer WWW-Authenticate message header. For more information, see RFC 6750.

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME	The name of the header that this object represents.

Constructor Summary

Constructors

Constructor	Description
OAuth2BearerWWWAuthenticateHeader()	Constructs a new empty header.
OAuth2BearerWWWAuthenticateHeader(org.forgerock.http.oauth2.OAuth2Error error)	Constructs a new header with the provided error.

Method Summary

Modifier and Type	Method	Description
String	getName()
org.forgerock.http.oauth2.OAuth2Error	getOAuth2Error()	Returns the OAuth 2.0 error represented by this header.
List<String>	getValues()
static OAuth2BearerWWWAuthenticateHeader	valueOf(String string)	Constructs a new header, initialized from the specified string value.
static OAuth2BearerWWWAuthenticateHeader	valueOf(org.forgerock.http.protocol.Message message)	Constructs a new header, initialized from the specified message.

Methods inherited from class org.forgerock.http.protocol.Header

equals, getFirstValue, hashCode, toString

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

The name of the header that this object represents.

See Also:

Constant Field Values

Constructor Detail

OAuth2BearerWWWAuthenticateHeader

public OAuth2BearerWWWAuthenticateHeader()

Constructs a new empty header.

OAuth2BearerWWWAuthenticateHeader

public OAuth2BearerWWWAuthenticateHeader(org.forgerock.http.oauth2.OAuth2Error error)

Constructs a new header with the provided error.

Parameters:

error - The possibly null OAuth 2.0 error.

Method Detail

valueOf

public static OAuth2BearerWWWAuthenticateHeader valueOf(org.forgerock.http.protocol.Message message)

Constructs a new header, initialized from the specified message.

Parameters:

message - The message to initialize the header from.

Returns:

The parsed header.

valueOf

public static OAuth2BearerWWWAuthenticateHeader valueOf(String string)

Constructs a new header, initialized from the specified string value.

Parameters:

string - The value to initialize the header from.

Returns:

The parsed header.

getName

public String getName()

Specified by:

getName in class org.forgerock.http.protocol.Header

getOAuth2Error

public org.forgerock.http.oauth2.OAuth2Error getOAuth2Error()

Returns the OAuth 2.0 error represented by this header.

Returns:

The OAuth 2.0 error represented by this header.

getValues

public List<String> getValues()

Specified by:

getValues in class org.forgerock.http.protocol.Header