org.springframework.security.oauth2.server.authorization

Class OAuth2Authorization.Token<T extends org.springframework.security.oauth2.core.OAuth2Token>

java.lang.Object

org.springframework.security.oauth2.server.authorization.OAuth2Authorization.Token<T>

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

OAuth2Authorization

public static class OAuth2Authorization.Token<T extends org.springframework.security.oauth2.core.OAuth2Token>
extends java.lang.Object
implements java.io.Serializable

A holder of an OAuth 2.0 Token and it's associated metadata.

Since:

0.1.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLAIMS_METADATA_NAME The name of the metadata used for the claims of the token.
static java.lang.String	INVALIDATED_METADATA_NAME The name of the metadata that indicates if the token has been invalidated.
protected static java.lang.String	TOKEN_METADATA_NAMESPACE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Token(T token)
protected	Token(T token, java.util.Map<java.lang.String,java.lang.Object> metadata)

Method Summary

Modifier and Type	Method and Description
protected static java.util.Map<java.lang.String,java.lang.Object>	defaultMetadata()
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,java.lang.Object>	getClaims() Returns the claims associated to the token.
java.util.Map<java.lang.String,java.lang.Object>	getMetadata() Returns the metadata associated to the token.
<V> V	getMetadata(java.lang.String name) Returns the value of the metadata associated to the token.
T	getToken() Returns the token of type OAuth2Token.
int	hashCode()
boolean	isActive() Returns true if the token is currently active.
boolean	isBeforeUse() Returns true if the token is before the time it can be used.
boolean	isExpired() Returns true if the token has expired.
boolean	isInvalidated() Returns true if the token has been invalidated (e.g.

Methods inherited from class java.lang.Object

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

Field Detail

TOKEN_METADATA_NAMESPACE

protected static final java.lang.String TOKEN_METADATA_NAMESPACE

See Also:

Constant Field Values

INVALIDATED_METADATA_NAME

public static final java.lang.String INVALIDATED_METADATA_NAME

The name of the metadata that indicates if the token has been invalidated.

CLAIMS_METADATA_NAME

public static final java.lang.String CLAIMS_METADATA_NAME

The name of the metadata used for the claims of the token.

Constructor Detail

Token

protected Token(T token)

Token

protected Token(T token,
                java.util.Map<java.lang.String,java.lang.Object> metadata)

Method Detail

getToken

public T getToken()

Returns the token of type OAuth2Token.

Returns:

the token of type OAuth2Token

isInvalidated

public boolean isInvalidated()

Returns true if the token has been invalidated (e.g. revoked). The default is false.

Returns:

true if the token has been invalidated, false otherwise

isExpired

public boolean isExpired()

Returns true if the token has expired.

Returns:

true if the token has expired, false otherwise

isBeforeUse

public boolean isBeforeUse()

Returns true if the token is before the time it can be used.

Returns:

true if the token is before the time it can be used, false otherwise

isActive

public boolean isActive()

Returns true if the token is currently active.

Returns:

true if the token is currently active, false otherwise

getClaims

@Nullable
public java.util.Map<java.lang.String,java.lang.Object> getClaims()

Returns the claims associated to the token.

Returns:

a Map of the claims, or null if not available

getMetadata

@Nullable
public <V> V getMetadata(java.lang.String name)

Returns the value of the metadata associated to the token.

Type Parameters:

V - the value type of the metadata

Parameters:

name - the name of the metadata

Returns:

the value of the metadata, or null if not available

getMetadata

public java.util.Map<java.lang.String,java.lang.Object> getMetadata()

Returns the metadata associated to the token.

Returns:

a Map of the metadata

defaultMetadata

protected static java.util.Map<java.lang.String,java.lang.Object> defaultMetadata()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object