Package com.nimbusds.oauth2.sdk.token

Class Token

java.lang.Object
com.nimbusds.oauth2.sdk.id.Identifier
com.nimbusds.oauth2.sdk.token.Token
All Implemented Interfaces:
Serializable, Comparable<Identifier>, net.minidev.json.JSONAware
Direct Known Subclasses:
AccessToken, DeviceSecretToken, RefreshToken, TypelessToken
public abstract class Token extends Identifier
The base abstract class for access, refresh and other tokens. Concrete extending classes should be immutable.

Related specifications:

  • OAuth 2.0 (RFC 6749)
See Also:

  • Constructor Details

    • Token

      protected Token(String value)
      Creates a new token with the specified value.
      Parameters:
      value - The token value. Must not be null or empty string.

    • Token

      protected Token(int byteLength)
      Creates a new token with a randomly generated value of the specified byte length, Base64URL-encoded.
      Parameters:
      byteLength - The byte length of the value to generate. Must be greater than one.

    • Token

      protected Token()
      Creates a new token with a randomly generated 256-bit (32-byte) value, Base64URL-encoded.

  • Method Details

    • getParameterNames

      public abstract Set<String> getParameterNames()
      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.
      Returns:
      The token parameter names.

    • toJSONObject

      public abstract net.minidev.json.JSONObject toJSONObject()
      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"
 }
      Returns:
      The token parameters as a JSON object.

    • getCustomParameters

      public Map<String,Object> getCustomParameters()
      Returns the additional custom parameters.
      Returns:
      The custom parameters, empty map if none.