io.strimzi.kafka.oauth.common

Class TokenInfo

java.lang.Object

io.strimzi.kafka.oauth.common.TokenInfo

public class TokenInfo
extends java.lang.Object

TokenInfo encapsulates the information about the access token. It can also be used for storing extra application information associated with the access token by directly accessing the payload JSON object.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUD
static java.lang.String	EXP
static java.lang.String	IAT
static java.lang.String	ISS
static java.lang.String	SCOPE
static java.lang.String	TOKEN_TYPE
static java.lang.String	TYP

Constructor Summary

Constructors

Constructor and Description
TokenInfo(com.fasterxml.jackson.databind.JsonNode payload, java.lang.String token, java.lang.String principal) Create a new instance
TokenInfo(com.fasterxml.jackson.databind.JsonNode payload, java.lang.String token, java.lang.String principal, java.util.Set<java.lang.String> groups) Create a new instance
TokenInfo(java.lang.String token, java.lang.String scope, java.lang.String principal, java.util.Set<java.lang.String> groups, long issuedAtMs, long expiresAtMs)

Method Summary

Modifier and Type	Method and Description
long	expiresAtMs()
java.util.Set<java.lang.String>	groups()
long	issuedAtMs()
com.fasterxml.jackson.databind.node.ObjectNode	payload() Get the payload object passed during construction.
java.lang.String	principal()
java.util.Set<java.lang.String>	scope()
java.lang.String	token()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SCOPE

public static final java.lang.String SCOPE

See Also:

Constant Field Values

IAT

public static final java.lang.String IAT

See Also:

Constant Field Values

EXP

public static final java.lang.String EXP

See Also:

Constant Field Values

ISS

public static final java.lang.String ISS

See Also:

Constant Field Values

TYP

public static final java.lang.String TYP

See Also:

Constant Field Values

TOKEN_TYPE

public static final java.lang.String TOKEN_TYPE

See Also:

Constant Field Values

AUD

public static final java.lang.String AUD

See Also:

Constant Field Values

Constructor Detail

TokenInfo

public TokenInfo(com.fasterxml.jackson.databind.JsonNode payload,
                 java.lang.String token,
                 java.lang.String principal)

Create a new instance

Parameters:

payload - The body of the JWT token or composed from authorization server's introspection endpoint response

token - The raw access token

principal - The extracted user ID

TokenInfo

public TokenInfo(com.fasterxml.jackson.databind.JsonNode payload,
                 java.lang.String token,
                 java.lang.String principal,
                 java.util.Set<java.lang.String> groups)

Create a new instance

Parameters:

payload - The body of the JWT token or composed from authorization server's introspection endpoint response

token - The raw access token

principal - The extracted user ID

groups - A set of groups extracted from JWT token or authorization server's inspect endpoint response

TokenInfo

public TokenInfo(java.lang.String token,
                 java.lang.String scope,
                 java.lang.String principal,
                 java.util.Set<java.lang.String> groups,
                 long issuedAtMs,
                 long expiresAtMs)

Parameters:

token - The raw access token

scope - The scope returned by authorization server's inspect endpoint response

principal - The extracted user ID

groups - A set of groups extracted from JWT token or authorization server's inspect endpoint response

issuedAtMs - The token's `issued at` time in millis

expiresAtMs - The token's `expires at` time in millis

Method Detail

token

public java.lang.String token()

scope

public java.util.Set<java.lang.String> scope()

expiresAtMs

public long expiresAtMs()

principal

public java.lang.String principal()

groups

public java.util.Set<java.lang.String> groups()

issuedAtMs

public long issuedAtMs()

payload

public com.fasterxml.jackson.databind.node.ObjectNode payload()

Get the payload object passed during construction. The same instance, passed to the TokenInfo constructor is returned which makes it possible to add custom attributes or make modifications during request processing.

Returns:

The payload object.