de.hybris.platform.oauth2.jwt.util

Class IdTokenHelper.ClaimsBuilder

java.lang.Object

de.hybris.platform.oauth2.jwt.util.IdTokenHelper.ClaimsBuilder

Enclosing class:

IdTokenHelper

public static class IdTokenHelper.ClaimsBuilder
extends java.lang.Object

The Builder for Claims.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLAIMS_SCOPE_NAME

Constructor Summary

Constructors

Constructor and Description
ClaimsBuilder()

Method Summary

Modifier and Type	Method and Description
IdTokenHelper.ClaimsBuilder	addClaim(java.lang.String key, java.lang.Object value) Adds a generic claim.
IdTokenHelper.ClaimsBuilder	addScopes(java.lang.String name, java.util.List<java.lang.String> scopes) Adds the scope to existing scope claim (for a given name).
IdTokenHelper.ClaimsBuilder	exp(int seconds) Adds the exp claim (using new Date().getTime() + seconds * 1000).
java.util.Map<java.lang.String,java.lang.Object>	getClaims() Gets the claims as a map.
IdTokenHelper.ClaimsBuilder	iat() Adds the iat claim (using new Date().getTime()).
IdTokenHelper.ClaimsBuilder	iss(java.lang.String iss) Adds iss (issuer) claim.
IdTokenHelper.ClaimsBuilder	nonce(java.lang.String nonce) Adds nonce claim.
IdTokenHelper.ClaimsBuilder	setScopes(java.lang.String name, java.util.List<java.lang.String> scopes) Sets the scopes claim (for a given name).
IdTokenHelper.ClaimsBuilder	state(java.lang.String state) Adds state claim.
IdTokenHelper.ClaimsBuilder	sub(java.lang.String sub) Adds sub claim.

Methods inherited from class java.lang.Object

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

Field Detail

CLAIMS_SCOPE_NAME

public static final java.lang.String CLAIMS_SCOPE_NAME

See Also:

Constant Field Values

Constructor Detail

ClaimsBuilder

public ClaimsBuilder()

Method Detail

iss

public IdTokenHelper.ClaimsBuilder iss(java.lang.String iss)

Adds iss (issuer) claim.

Parameters:

iss - the issuer

Returns:

the claims builder

sub

public IdTokenHelper.ClaimsBuilder sub(java.lang.String sub)

Adds sub claim.

Parameters:

sub - the sub

Returns:

the claims builder

nonce

public IdTokenHelper.ClaimsBuilder nonce(java.lang.String nonce)

Adds nonce claim.

Parameters:

nonce - the nonce

Returns:

the claims builder

state

public IdTokenHelper.ClaimsBuilder state(java.lang.String state)

Adds state claim.

Parameters:

state - the (web) state

Returns:

the claims builder

setScopes

public IdTokenHelper.ClaimsBuilder setScopes(java.lang.String name,
                                             java.util.List<java.lang.String> scopes)

Sets the scopes claim (for a given name).

Parameters:

name - the name of the scopes claim (usually should be "scope")

scopes - the scopes

Returns:

the claims builder

addScopes

public IdTokenHelper.ClaimsBuilder addScopes(java.lang.String name,
                                             java.util.List<java.lang.String> scopes)

Adds the scope to existing scope claim (for a given name).

Parameters:

name - the name of the scopes claim (usually should be "scope")

scopes - the scopes

Returns:

the claims builder

iat

public IdTokenHelper.ClaimsBuilder iat()

Adds the iat claim (using new Date().getTime()).

Returns:

the claims builder

exp

public IdTokenHelper.ClaimsBuilder exp(int seconds)

Adds the exp claim (using new Date().getTime() + seconds * 1000).

Parameters:

seconds - after how many seconds should expire

Returns:

the claims builder

addClaim

public IdTokenHelper.ClaimsBuilder addClaim(java.lang.String key,
                                            java.lang.Object value)

Adds a generic claim.

Parameters:

key - the key - name of the claim

value - the value

Returns:

the claims builder

getClaims

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

Gets the claims as a map.

Returns:

the claims