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 "aud"
static java.lang.String	EXP "exp"
static java.lang.String	IAT "iat"
static java.lang.String	ISS "iss"
static java.lang.String	SCOPE "scope"
static java.lang.String	TOKEN_TYPE "token_type"
static java.lang.String	TYP "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.util.Set<java.lang.String> scopes, java.lang.String principal, java.util.Set<java.lang.String> groups, long issuedAtMs, long expiresAtMs, com.fasterxml.jackson.databind.JsonNode payload)
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
boolean	equals(java.lang.Object o)
long	expiresAtMs() Get token expiry time in ISO millis time
java.util.Set<java.lang.String>	groups() Get groups for this token
int	hashCode()
long	issuedAtMs() Get token creation time ISO millis
com.fasterxml.jackson.databind.node.ObjectNode	payload() Get the payload object passed during construction.
java.lang.String	principal() Get a principal (user id) for this token
java.util.Set<java.lang.String>	scope() Get scopes for this token
java.lang.String	token() Get raw access token

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

SCOPE

public static final java.lang.String SCOPE

"scope"

See Also:

Constant Field Values

IAT

public static final java.lang.String IAT

"iat"

See Also:

Constant Field Values

EXP

public static final java.lang.String EXP

"exp"

See Also:

Constant Field Values

ISS

public static final java.lang.String ISS

"iss"

See Also:

Constant Field Values

TYP

public static final java.lang.String TYP

"typ"

See Also:

Constant Field Values

TOKEN_TYPE

public static final java.lang.String TOKEN_TYPE

"token_type"

See Also:

Constant Field Values

AUD

public static final java.lang.String AUD

"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 of 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 of 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

TokenInfo

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

Parameters:

token - The raw access token

scopes - The list of scopes

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

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

Method Detail

token

public java.lang.String token()

Get raw access token

Returns:

Access token as String

scope

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

Get scopes for this token

Returns:

A Set of scopes as strings

expiresAtMs

public long expiresAtMs()

Get token expiry time in ISO millis time

Returns:

Long value representing time

principal

public java.lang.String principal()

Get a principal (user id) for this token

Returns:

User id as String

groups

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

Get groups for this token

Returns:

Set of groups as strings

issuedAtMs

public long issuedAtMs()

Get token creation time ISO millis

Returns:

Long value representing time

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.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object