org.pfsw.text.json

Class JsonClaims

java.lang.Object

org.pfsw.text.json.JsonObjectWrapper

org.pfsw.text.json.JsonClaims

public class JsonClaims
extends JsonObjectWrapper

Provides a simplified view of JSON based claims used with OAUTH2 and OIDC.

Constructor Summary

Constructors

Constructor and Description
JsonClaims() Creates a claim object on an empty JSON object.
JsonClaims(JsonObject jsonObject) Creates a claim object on the given JSON object.
JsonClaims(JsonObjectAccessor jsonAccessor) Creates a claim object on the given JSON object accessor.

Method Summary

Modifier and Type	Method and Description
static JsonClaims	create() Creates a claim object on an empty JSON object.
static JsonClaims	create(JsonObject jsonObject) Creates a claim object on the given JSON object.
static JsonClaims	create(JsonObjectAccessor jsonAccessor) Creates a claim object on the given JSON object accessor.
java.util.List<java.lang.String>	getClaimNames() Returns all claim names present in the underlying JSON object (maybe empty but never null).
<T> T	getCustomField(IStringConstant name, java.lang.Class<T> type) Returns the value at the specified field name.
<T> T	getCustomField(java.lang.String name, java.lang.Class<T> type) Returns the value at the specified field name.
JsonObjectAccessor	getJsonAccessor() Returns the underlying JsonObjectAccessor;
JsonObject	getJsonObject() Returns the token part as JsonObject.
JsonObject	getJsonObjectField(IStringConstant name) Returns the JSON object at the specified field name.
JsonObject	getJsonObjectField(java.lang.String name) Returns the JSON object at the specified field name.
TimeValue	getTimeValue(IStringConstant name, TimeUnit timeUnit) Returns the value at the specified field name as a TimeValue with the specified TimeUnit.
TimeValue	getTimeValue(java.lang.String name, TimeUnit timeUnit) Returns the value at the specified field name as a TimeValue with the specified TimeUnit.
boolean	isEmpty() Returns true if this object contains no claim at all.

Methods inherited from class org.pfsw.text.json.JsonObjectWrapper

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonClaims

public JsonClaims()

Creates a claim object on an empty JSON object.

JsonClaims

public JsonClaims(JsonObject jsonObject)

Creates a claim object on the given JSON object.

JsonClaims

public JsonClaims(JsonObjectAccessor jsonAccessor)

Creates a claim object on the given JSON object accessor.

Method Detail

create

public static JsonClaims create()

Creates a claim object on an empty JSON object.

create

public static JsonClaims create(JsonObject jsonObject)

Creates a claim object on the given JSON object.

create

public static JsonClaims create(JsonObjectAccessor jsonAccessor)

Creates a claim object on the given JSON object accessor.

getClaimNames

public java.util.List<java.lang.String> getClaimNames()

Returns all claim names present in the underlying JSON object (maybe empty but never null).

getJsonObjectField

public JsonObject getJsonObjectField(java.lang.String name)

Returns the JSON object at the specified field name.

Parameters:

name - The name of the field (must not be null).

Returns:

Returns either the JSON object or null if field not present.

getJsonObjectField

public JsonObject getJsonObjectField(IStringConstant name)

Returns the JSON object at the specified field name.

Parameters:

name - The name of the field (must not be null).

Returns:

Returns either the JSON object or null if field not present.

getCustomField

public <T> T getCustomField(java.lang.String name,
                            java.lang.Class<T> type)

Returns the value at the specified field name.

Parameters:

name - The name of the field (must not be null).

type - The expected return type (must not be null).

Returns:

Returns either the value or null if field not present.

getCustomField

public <T> T getCustomField(IStringConstant name,
                            java.lang.Class<T> type)

Returns the value at the specified field name.

Parameters:

name - The name of the field (must not be null).

type - The expected return type (must not be null).

Returns:

Returns either the value or null if field not present.

getTimeValue

public TimeValue getTimeValue(java.lang.String name,
                              TimeUnit timeUnit)

Returns the value at the specified field name as a TimeValue with the specified TimeUnit.

Parameters:

name - The name of the field (must not be null).

timeUnit - The time unit of the value found in the object (must not be null).

Returns:

Returns either the TimeUnit or null if field not present.

getTimeValue

public TimeValue getTimeValue(IStringConstant name,
                              TimeUnit timeUnit)

Returns the value at the specified field name as a TimeValue with the specified TimeUnit.

Parameters:

name - The name of the field (must not be null).

timeUnit - The time unit of the value found in the object (must not be null).

Returns:

Returns either the TimeUnit or null if field not present.

isEmpty

public boolean isEmpty()

Returns true if this object contains no claim at all.

getJsonObject

public JsonObject getJsonObject()

Returns the token part as JsonObject.

Overrides:

getJsonObject in class JsonObjectWrapper

getJsonAccessor

public JsonObjectAccessor getJsonAccessor()

Returns the underlying JsonObjectAccessor;

Overrides:

getJsonAccessor in class JsonObjectWrapper