Class OAuth2BearerWWWAuthenticateHeader


  • public class OAuth2BearerWWWAuthenticateHeader
    extends Header
    Processes the OAuth 2.0 Bearer WWW-Authenticate message header. For more information, see RFC 6750.
    • 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.
        Specified by:
        getName in 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. Each String should represent the value component of the key-value pair that makes up the HTTP header - as such, for some Header implementations each String in this List may contain multiple token-separated values.

        The List returned from this method should not be expected to be mutable. However, some subclasses of Header may choose to implement it as such.

        Specified by:
        getValues in class Header
        Returns:
        The header as a non-null list of string values. Can be an empty list.