Class OAuth2BearerWWWAuthenticateHeader
- java.lang.Object
-
- org.forgerock.http.protocol.Header
-
- org.forgerock.openig.filter.oauth2.client.OAuth2BearerWWWAuthenticateHeader
-
-
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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getName()
Returns the name of the header, as it would canonically appear within an HTTP message.org.forgerock.http.oauth2.OAuth2Error
getOAuth2Error()
Returns the OAuth 2.0 error represented by this header.List<String>
getValues()
Returns the header as a list of strings.static OAuth2BearerWWWAuthenticateHeader
valueOf(String string)
Constructs a new header, initialized from the specified string value.static OAuth2BearerWWWAuthenticateHeader
valueOf(Response message)
Constructs a new header, initialized from the specified message.-
Methods inherited from class org.forgerock.http.protocol.Header
equals, getFirstValue, hashCode, toString
-
-
-
-
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(Response 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()
Description copied from class:Header
Returns the name of the header, as it would canonically appear within an HTTP message.
-
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()
Description copied from class:Header
Returns the header as a list of strings. If the header has no values then it must return an empty list, never null. EachString
should represent the value component of the key-value pair that makes up the HTTP header - as such, for someHeader
implementations each String in thisList
may contain multiple token-separated values.The
List
returned from this method should not be expected to be mutable. However, some subclasses ofHeader
may choose to implement it as such.
-
-