net.krotscheck.kangaroo.authz.oauth2.resource

Class IntrospectionResponseEntity

java.lang.Object

net.krotscheck.kangaroo.authz.oauth2.resource.IntrospectionResponseEntity

public final class IntrospectionResponseEntity
extends Object

A POJO that represents the response from the introspection endpoint.

Author:

Michael Krotscheck

Constructor Summary

Constructors

Constructor and Description
IntrospectionResponseEntity() Create a new IntrospectionResponseEntity with default values (mostly null).
IntrospectionResponseEntity(OAuthToken token) Create a new IntrospectionResponseEntity from a token.

Method Summary

Modifier and Type	Method and Description
BigInteger	getAud() Intended audience, in our case the Client ID.
BigInteger	getClientId() The client ID.
Calendar	getExp() The expiration timestamp.
Calendar	getIat() Issued At timestamp.
String	getIss() The issuer, as in the entity that issued this token.
BigInteger	getJti() The token ID.
Calendar	getNbf() Not-Before timestamp.
String	getScope() The list of scopes authorized for this token.
BigInteger	getSub() The token subject, usually the resource owner.
OAuthTokenType	getTokenType() Return the token type.
String	getUsername() The username, if applicable.
boolean	isActive() The current active state of this token.

Methods inherited from class java.lang.Object

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

Constructor Detail

IntrospectionResponseEntity

public IntrospectionResponseEntity(OAuthToken token)

Create a new IntrospectionResponseEntity from a token.

Parameters:

token - The token.

IntrospectionResponseEntity

public IntrospectionResponseEntity()

Create a new IntrospectionResponseEntity with default values (mostly null).

Method Detail

isActive

public boolean isActive()

The current active state of this token.

Returns:

True if it's active, otherwise false.

getScope

public String getScope()

The list of scopes authorized for this token.

Returns:

A space-separated list of scopes.

getClientId

public BigInteger getClientId()

The client ID.

Returns:

The client ID.

getUsername

public String getUsername()

The username, if applicable.

Returns:

The username.

getTokenType

public OAuthTokenType getTokenType()

Return the token type.

Returns:

The token type.

getExp

public Calendar getExp()

The expiration timestamp.

Returns:

The time when this token expires.

getIat

public Calendar getIat()

Issued At timestamp.

Returns:

The date this token was issued.

getNbf

public Calendar getNbf()

Not-Before timestamp.

Returns:

The time _before which_ this token may not be used.

getSub

public BigInteger getSub()

The token subject, usually the resource owner.

Returns:

The ID of the resource owner.

getAud

public BigInteger getAud()

Intended audience, in our case the Client ID.

Returns:

The client ID.

getIss

public String getIss()

The issuer, as in the entity that issued this token.

Returns:

The URL of this kangaroo server.

getJti

public BigInteger getJti()

The token ID.

Returns:

String identifier for the token (the ID).