TokenIntrospectionSuccessResponse (Nimbus OAuth 2.0 SDK with OpenID Connect 1.0 extensions v5.34.2)

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).
- Mutual TLS Profile for OAuth 2.0 (draft-ietf-oauth-mtls-03), section 3.2.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TokenIntrospectionSuccessResponse.Builder
Builder for constructing token introspection success responses.

Nested Classes
Modifier and Type	Class and Description
`static class`	`TokenIntrospectionSuccessResponse.Builder` Builder for constructing token introspection success responses.

Constructor Summary

Constructors
Constructor and Description

TokenIntrospectionSuccessResponse(net.minidev.json.JSONObject params)
Creates a new token introspection success response.

Constructors
Constructor and Description
`TokenIntrospectionSuccessResponse(net.minidev.json.JSONObject params)` Creates a new token introspection success response.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<Audience>`	`getAudience()` Returns the intended audience for the token.
`ClientID`	`getClientID()` Returns the identifier of the OAuth 2.0 client that requested the token.
`Date`	`getExpirationTime()` Returns the token expiration time.
`Issuer`	`getIssuer()` Returns the token issuer.
`Date`	`getIssueTime()` Returns the token issue time.
`JWTID`	`getJWTID()` Returns the token identifier.
`Date`	`getNotBeforeTime()` Returns the token not-before time.
`Scope`	`getScope()` Returns the scope of the token.
`Subject`	`getSubject()` Returns the subject of the token, usually a machine-readable identifier of the resource owner who authorised the token.
`AccessTokenType`	`getTokenType()` Returns the access token type.
`String`	`getUsername()` Returns the username of the resource owner who authorised the token.
`com.nimbusds.jose.util.Base64URL`	`getX509CertificateSHA256Thumbprint()` Returns the client X.509 certificate SHA-256 thumbprint, for a mutual TLS sender constrained access token.
`boolean`	`indicatesSuccess()` Checks if the response indicates success.
`boolean`	`isActive()` Returns the active status for the token.
`static TokenIntrospectionSuccessResponse`	`parse(HTTPResponse httpResponse)` Parses an token introspection success response from the specified HTTP response.
`static TokenIntrospectionSuccessResponse`	`parse(net.minidev.json.JSONObject jsonObject)` Parses a token introspection success response from the specified JSON object.
`HTTPResponse`	`toHTTPResponse()` Returns the matching HTTP response.
`net.minidev.json.JSONObject`	`toJSONObject()` Returns a JSON object representation of this token introspection success response.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - 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 Detail
  - isActive
```
public boolean isActive()
```
    Returns the active status for the token. Corresponds to the active claim.
    
    Returns:
    
    true if the token is active, else false.
  - getScope
```
public Scope getScope()
```
    Returns the scope of the token. Corresponds to the scope claim.
    
    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 claim.
    
    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 claim.
    
    Returns:
    
    The username, null if not specified.
  - getTokenType
```
public AccessTokenType getTokenType()
```
    Returns the access token type. Corresponds to the token_type claim.
    
    Returns:
    
    The token type, null if not specified.
  - getExpirationTime
```
public Date getExpirationTime()
```
    Returns the token expiration time. Corresponds to the exp claim.
    
    Returns:
    
    The token expiration time, null if not specified.
  - getIssueTime
```
public Date getIssueTime()
```
    Returns the token issue time. Corresponds to the iat claim.
    
    Returns:
    
    The token issue time, null if not specified.
  - getNotBeforeTime
```
public Date getNotBeforeTime()
```
    Returns the token not-before time. Corresponds to the nbf claim.
    
    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 claim.
    
    Returns:
    
    The token subject, null if not specified.
  - getAudience
```
public List<Audience> getAudience()
```
    Returns the intended audience for the token. Corresponds to the aud claim.
    
    Returns:
    
    The token audience, null if not specified.
  - getIssuer
```
public Issuer getIssuer()
```
    Returns the token issuer. Corresponds to the iss claim.
    
    Returns:
    
    The token issuer, null if not specified.
  - getJWTID
```
public JWTID getJWTID()
```
    Returns the token identifier. Corresponds to the jti claim.
    
    Returns:
    
    The token identifier, null if not specified.
  - getX509CertificateSHA256Thumbprint
```
public com.nimbusds.jose.util.Base64URL getX509CertificateSHA256Thumbprint()
```
    Returns the client X.509 certificate SHA-256 thumbprint, for a mutual TLS sender constrained access token. Corresponds to the cnf.x5t#S256 claim.
    
    Returns:
    
    The client X.509 certificate SHA-256 thumbprint, null if not specified.
  - 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 an 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.

Class TokenIntrospectionSuccessResponse

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TokenIntrospectionSuccessResponse

Method Detail

isActive

getScope

getClientID

getUsername

getTokenType

getExpirationTime

getIssueTime

getNotBeforeTime

getSubject

getAudience

getIssuer

getJWTID

getX509CertificateSHA256Thumbprint

toJSONObject

indicatesSuccess

toHTTPResponse

parse

parse