Package com.nimbusds.oauth2.sdk.token

Class AccessToken

    • Constructor Detail

      • AccessToken

        public AccessToken​(AccessTokenType type)
        Creates a new minimal access token with a randomly generated 256-bit (32-byte) value, Base64URL-encoded. The optional lifetime and scope are left undefined.
        Parameters:
        type - The access token type. Must not be null.

      • AccessToken

        public AccessToken​(AccessTokenType type,
                   int byteLength)
        Creates a new minimal access token with a randomly generated value of the specified byte length, Base64URL-encoded. The optional lifetime and scope are left undefined.
        Parameters:
        type - The access token type. Must not be null.
        byteLength - The byte length of the value to generate. Must be greater than one.

      • AccessToken

        public AccessToken​(AccessTokenType type,
                   long lifetime,
                   Scope scope)
        Creates a new access token with a randomly generated 256-bit (32-byte) value, Base64URL-encoded.
        Parameters:
        type - The access token type. Must not be null.
        lifetime - The lifetime in seconds, 0 if not specified.
        scope - The scope, null if not specified.

      • AccessToken

        public AccessToken​(AccessTokenType type,
                   int byteLength,
                   long lifetime,
                   Scope scope)
        Creates a new access token with a randomly generated value of the specified byte length, Base64URL-encoded, and optional lifetime and scope.
        Parameters:
        type - The access token type. Must not be null.
        byteLength - The byte length of the value to generate. Must be greater than one.
        lifetime - The lifetime in seconds, 0 if not specified.
        scope - The scope, null if not specified.

      • AccessToken

        public AccessToken​(AccessTokenType type,
                   String value)
        Creates a new minimal access token with the specified value. The optional lifetime and scope are left undefined.
        Parameters:
        type - The access token type. Must not be null.
        value - The access token value. Must not be null or empty string.

      • AccessToken

        public AccessToken​(AccessTokenType type,
                   String value,
                   long lifetime,
                   Scope scope)
        Creates a new access token with the specified value and optional lifetime and scope.
        Parameters:
        type - The access token type. Must not be null.
        value - The access token value. Must not be null or empty string.
        lifetime - The lifetime in seconds, 0 if not specified.
        scope - The scope, null if not specified.

    • Method Detail

      • getLifetime

        public long getLifetime()
        Returns the lifetime of this access token.
        Returns:
        The lifetime in seconds, 0 if not specified.

      • getScope

        public Scope getScope()
        Returns the scope of this access token.
        Returns:
        The scope, null if not specified.

      • getParameterNames

        public Set<String> getParameterNames()
        Description copied from class: Token
        Returns the token parameter names included in the JSON object, as required for the composition of an access token response. See OAuth 2.0 (RFC 6749), section 5.1.
        Specified by:
        getParameterNames in class Token
        Returns:
        The token parameter names.

      • toJSONObject

        public net.minidev.json.JSONObject toJSONObject()
        Description copied from class: Token
        Returns the token parameters as a JSON object, as required for the composition of an access token response. See OAuth 2.0 (RFC 6749), section 5.1.

        Note that JSONObject implements Map&lt;String,Object&gt;.

        Example: 

         {
   "access_token"      : "2YotnFZFEjr1zCsicMWpAA",
   "token_type"        : "example",
   "expires_in"        : 3600,
   "example_parameter" : "example_value"
 }
        Specified by:
        toJSONObject in class Token
        Returns:
        The token parameters as a JSON object.

      • toJSONString

        public String toJSONString()
        Description copied from class: Identifier
        Returns the JSON string representation of this identifier.
        Specified by:
        toJSONString in interface net.minidev.json.JSONAware
        Overrides:
        toJSONString in class Identifier
        Returns:
        The JSON string.

      • toAuthorizationHeader

        public abstract String toAuthorizationHeader()
        Returns the Authorization HTTP request header value for this access token.
        Returns:
        The Authorization header value.

      • parse

        public static AccessToken parse​(net.minidev.json.JSONObject jsonObject)
                         throws ParseException
        Parses an access token from a JSON object access token response. Only bearer access tokens are supported.
        Parameters:
        jsonObject - The JSON object to parse. Must not be null.
        Returns:
        The access token.
        Throws:
        ParseException - If the JSON object couldn't be parsed to an access token.

      • parse

        public static AccessToken parse​(String header)
                         throws ParseException
        Parses an Authorization HTTP request header value for an access token. Only bearer access token are supported.
        Parameters:
        header - The Authorization header value to parse. Must not be null.
        Returns:
        The access token.
        Throws:
        ParseException - If the Authorization header value couldn't be parsed to an access token.