Package com.nimbusds.oauth2.sdk.token

Class TokenTypeURI

java.lang.Object

com.nimbusds.oauth2.sdk.token.TokenTypeURI

All Implemented Interfaces:

Serializable

@Immutable
public final class TokenTypeURI
extends Object
implements Serializable

Token type URI. A URN used to identify the type of token in a token exchange. The token type URIs can potentially be used in other contexts.

The standard OAuth URIs are registered at IANA, see https://www.iana.org/assignments/oauth-parameters/oauth-parameters.xhtml#uri

• OAuth 2.0 Token Exchange (RFC 8693), section 3.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final TokenTypeURI	ACCESS_TOKEN	The token type URI for an OAuth 2.0 access token.
static final TokenTypeURI	ID_TOKEN	The token type URI for an OpenID Connect ID Token.
static final TokenTypeURI	JWT	The token type URI for a JSON Web Token (JWT).
static final TokenTypeURI	REFRESH_TOKEN	The token type URI for an OAuth 2.0 refresh token.
static final TokenTypeURI	SAML1	The token type URI for a BASE64URL-encoded SAML 1.1 assertion.
static final TokenTypeURI	SAML2	The token type URI for a BASE64URL-encoded SAML 2.0 assertion.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
URI	getURI()	Returns the URI for this token type.
int	hashCode()
static TokenTypeURI	parse(String uriValue)	Parses a token type URI from the specified string.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

ACCESS_TOKEN

public static final TokenTypeURI ACCESS_TOKEN

The token type URI for an OAuth 2.0 access token.

REFRESH_TOKEN

public static final TokenTypeURI REFRESH_TOKEN

The token type URI for an OAuth 2.0 refresh token.

ID_TOKEN

public static final TokenTypeURI ID_TOKEN

The token type URI for an OpenID Connect ID Token.

SAML1

public static final TokenTypeURI SAML1

The token type URI for a BASE64URL-encoded SAML 1.1 assertion.

SAML2

public static final TokenTypeURI SAML2

The token type URI for a BASE64URL-encoded SAML 2.0 assertion.

JWT

public static final TokenTypeURI JWT

The token type URI for a JSON Web Token (JWT).

Method Details

getURI

public URI getURI()

Returns the URI for this token type.

Returns:

The URI.

parse

public static TokenTypeURI parse(String uriValue)
                          throws ParseException

Parses a token type URI from the specified string.

Parameters:

uriValue - The URI string value. Must not be null.

Returns:

The token type URI.

Throws:

ParseException - If the token type URI value is illegal.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object