Package com.nimbusds.oauth2.sdk

Class TokenIntrospectionSuccessResponse

java.lang.Object
com.nimbusds.oauth2.sdk.TokenIntrospectionResponse
com.nimbusds.oauth2.sdk.TokenIntrospectionSuccessResponse
All Implemented Interfaces:
Message, Response, SuccessResponse
@Immutable public class TokenIntrospectionSuccessResponse extends TokenIntrospectionResponse implements SuccessResponse
Token introspection success response.

Related specifications:

  • OAuth 2.0 Token Introspection (RFC 7662).
  • OAuth 2.0 Rich Authorization Requests (RFC 9396), section 9.2.
  • OAuth 2.0 Mutual TLS Client Authentication and Certificate Bound Access Tokens (RFC 8705).
  • OAuth 2.0 Demonstrating Proof-of-Possession at the Application Layer (DPoP) (RFC 9449)

  • Constructor Details

    • TokenIntrospectionSuccessResponse

      public TokenIntrospectionSuccessResponse(net.minidev.json.JSONObject params)
      Creates a new token introspection success response.
      Parameters:
      params - The response parameters. Must contain at least the required active parameter and not be null.

  • Method Details

    • isActive

      public boolean isActive()
      Returns the active status for the token. Corresponds to the active parameter.
      Returns:
      true if the token is active, else false.

    • getScope

      public Scope getScope()
      Returns the scope of the token. Corresponds to the scope parameter.
      Returns:
      The token scope, null if not specified.

    • getClientID

      public ClientID getClientID()
      Returns the identifier of the OAuth 2.0 client that requested the token. Corresponds to the client_id parameter.
      Returns:
      The client identifier, null if not specified.

    • getUsername

      public String getUsername()
      Returns the username of the resource owner who authorised the token. Corresponds to the username parameter.
      Returns:
      The username, null if not specified.

    • getTokenType

      public AccessTokenType getTokenType()
      Returns the access token type. Corresponds to the token_type parameter.
      Returns:
      The token type, null if not specified.

    • getExpirationTime

      public Date getExpirationTime()
      Returns the token expiration time. Corresponds to the exp parameter.
      Returns:
      The token expiration time, null if not specified.

    • getIssueTime

      public Date getIssueTime()
      Returns the token issue time. Corresponds to the iat parameter.
      Returns:
      The token issue time, null if not specified.

    • getNotBeforeTime

      public Date getNotBeforeTime()
      Returns the token not-before time. Corresponds to the nbf parameter.
      Returns:
      The token not-before time, null if not specified.

    • getSubject

      public Subject getSubject()
      Returns the subject of the token, usually a machine-readable identifier of the resource owner who authorised the token. Corresponds to the sub parameter.
      Returns:
      The token subject, null if not specified.

    • getAudience

      public List<Audience> getAudience()
      Returns the intended audience for the token. Corresponds to the aud parameter.
      Returns:
      The token audience, null if not specified.

    • getIssuer

      public Issuer getIssuer()
      Returns the token issuer. Corresponds to the iss parameter.
      Returns:
      The token issuer, null if not specified.

    • getJWTID

      public JWTID getJWTID()
      Returns the token identifier. Corresponds to the jti parameter.
      Returns:
      The token identifier, null if not specified.

    • getX509CertificateSHA256Thumbprint

      @Deprecated public com.nimbusds.jose.util.Base64URL getX509CertificateSHA256Thumbprint()
      Deprecated.
      Returns the client X.509 certificate SHA-256 thumbprint, for a mutual TLS client certificate bound access token. Corresponds to the cnf.x5t#S256 parameter.
      Returns:
      The client X.509 certificate SHA-256 thumbprint, null if not specified.

    • getX509CertificateConfirmation

      public X509CertificateConfirmation getX509CertificateConfirmation()
      Returns the client X.509 certificate confirmation, for a mutual TLS client certificate bound access token. Corresponds to the cnf.x5t#S256 parameter.
      Returns:
      The client X.509 certificate confirmation, null if not specified.

    • getJWKThumbprintConfirmation

      public JWKThumbprintConfirmation getJWKThumbprintConfirmation()
      Returns the JSON Web Key (JWK) SHA-256 thumbprint confirmation, for OAuth 2.0 DPoP. Corresponds to the cnf.jkt parameter.
      Returns:
      The JWK SHA-256 thumbprint confirmation, null if not specified.

    • getAuthorizationDetails

      public List<AuthorizationDetail> getAuthorizationDetails()
      Returns the Rich Authorisation Request (RAR) details. Corresponds to the authorization_details parameter.
      Returns:
      The authorisation details, null if not specified.

    • getStringParameter

      public String getStringParameter(String name)
      Returns the string parameter with the specified name.
      Parameters:
      name - The parameter name. Must not be null.
      Returns:
      The parameter value, null if not specified or if parsing failed.

    • getBooleanParameter

      public boolean getBooleanParameter(String name) throws ParseException
      Returns the boolean parameter with the specified name.
      Parameters:
      name - The parameter name. Must not be null.
      Returns:
      The parameter value.
      Throws:
      ParseException - If the parameter isn't specified or parsing failed.

    • getNumberParameter

      public Number getNumberParameter(String name)
      Returns the number parameter with the specified name.
      Parameters:
      name - The parameter name. Must not be null.
      Returns:
      The parameter value, null if not specified or parsing failed.

    • getStringListParameter

      public List<String> getStringListParameter(String name)
      Returns the string list parameter with the specified name.
      Parameters:
      name - The parameter name. Must not be null.
      Returns:
      The parameter value, null if not specified or if parsing failed.

    • getJSONObjectParameter

      public net.minidev.json.JSONObject getJSONObjectParameter(String name)
      Returns the JSON object parameter with the specified name.
      Parameters:
      name - The parameter name. Must not be null.
      Returns:
      The parameter value, null if not specified or if parsing failed.

    • getJSONArrayParameter

      public net.minidev.json.JSONArray getJSONArrayParameter(String name)
      Returns the JSON array parameter with the specified name.
      Parameters:
      name - The parameter name. Must not be null.
      Returns:
      The parameter value, null if not specified or if parsing failed.

    • getParameters

      public net.minidev.json.JSONObject getParameters()
      Returns the underlying parameters.
      Returns:
      The parameters, as JSON object.

    • toJSONObject

      public net.minidev.json.JSONObject toJSONObject()
      Returns a JSON object representation of this token introspection success response.

      Example JSON object: 

       {
  "active"          : true,
  "client_id"       : "l238j323ds-23ij4",
  "username"        : "jdoe",
  "scope"           : "read write dolphin",
  "sub"             : "Z5O3upPC88QrAjx00dis",
  "aud"             : "https://protected.example.net/resource",
  "iss"             : "https://server.example.com/",
  "exp"             : 1419356238,
  "iat"             : 1419350238,
  "extension_field" : "twenty-seven"
 }
      Returns:
      The JSON object.

    • indicatesSuccess

      public boolean indicatesSuccess()
      Description copied from interface: Response
      Checks if the response indicates success.
      Specified by:
      indicatesSuccess in interface Response
      Returns:
      true if the response indicates success, else false.

    • toHTTPResponse

      public HTTPResponse toHTTPResponse()
      Description copied from interface: Response
      Returns the matching HTTP response.
      Specified by:
      toHTTPResponse in interface Response
      Returns:
      The HTTP response.

    • parse

      public static TokenIntrospectionSuccessResponse parse(net.minidev.json.JSONObject jsonObject) throws ParseException
      Parses a token introspection success response from the specified JSON object.
      Parameters:
      jsonObject - The JSON object to parse. Must not be null.
      Returns:
      The token introspection success response.
      Throws:
      ParseException - If the JSON object couldn't be parsed to a token introspection success response.

    • parse

      public static TokenIntrospectionSuccessResponse parse(HTTPResponse httpResponse) throws ParseException
      Parses a token introspection success response from the specified HTTP response.
      Parameters:
      httpResponse - The HTTP response. Must not be null.
      Returns:
      The token introspection success response.
      Throws:
      ParseException - If the HTTP response couldn't be parsed to a token introspection success response.