Package net.shibboleth.idp.plugin.authn.oidc.rp.context

Class EndUserClaimsContext

java.lang.Object

org.opensaml.messaging.context.BaseContext

net.shibboleth.idp.plugin.authn.oidc.rp.context.EndUserClaimsContext

All Implemented Interfaces:

Iterable<BaseContext>

public class EndUserClaimsContext
extends BaseContext

A context to hold the final set of claims associated with an authenticated end-user.

Nested Class Summary

Nested classes/interfaces inherited from class org.opensaml.messaging.context.BaseContext

BaseContext.ContextSetNoRemoveIteratorDecorator, BaseContext.DeprecatedContextClassNameLookAside

Field Summary

Fields

Modifier and Type	Field	Description
private com.nimbusds.openid.connect.sdk.claims.ClaimsSet	endUserClaims	The claims associated with the authenticated end-user.
private com.nimbusds.jwt.JWTClaimsSet	unprocessedIdTokenClaims	The set of unprocessed id_token claims as returned from an id_token source.

Constructor Summary

Constructors

Constructor	Description
EndUserClaimsContext()

Method Summary

Modifier and Type	Method	Description
com.nimbusds.openid.connect.sdk.claims.ClaimsSet	getEndUserClaims()	Get the claims about the authenticated end-user.
com.nimbusds.jwt.JWTClaimsSet	getUnprocessedIdTokenClaims()	Get the unproccessed id_token claims.
EndUserClaimsContext	setEndUserClaims(com.nimbusds.openid.connect.sdk.claims.ClaimsSet claims)	Set the claims about the authenticated end-user.
EndUserClaimsContext	setUnprocessedIdTokenClaims(com.nimbusds.jwt.JWTClaimsSet claims)	Set the id_token claims about the authenticated end-user as returned from the id_token endpoint e.g.

Methods inherited from class org.opensaml.messaging.context.BaseContext

addSubcontext, addSubcontext, clearSubcontexts, containsSubcontext, createSubcontext, ensureSubcontext, ensureSubcontext, getParent, getSubcontext, getSubcontext, getSubcontext, getSubcontext, iterator, removeFromParent, removeSubcontext, removeSubcontext, setParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

endUserClaims

@Nullable
private com.nimbusds.openid.connect.sdk.claims.ClaimsSet endUserClaims

The claims associated with the authenticated end-user. Often an aggregate of id_token and UserInfo claims

unprocessedIdTokenClaims

@Nullable
private com.nimbusds.jwt.JWTClaimsSet unprocessedIdTokenClaims

The set of unprocessed id_token claims as returned from an id_token source.

Constructor Details

EndUserClaimsContext

public EndUserClaimsContext()

Method Details

getEndUserClaims

@Nullable
public com.nimbusds.openid.connect.sdk.claims.ClaimsSet getEndUserClaims()

Get the claims about the authenticated end-user.

Returns:

the claims.

setEndUserClaims

public EndUserClaimsContext setEndUserClaims(@Nonnull
 com.nimbusds.openid.connect.sdk.claims.ClaimsSet claims)

Set the claims about the authenticated end-user.

Parameters:

claims - the claims.

Returns:

this

setUnprocessedIdTokenClaims

public EndUserClaimsContext setUnprocessedIdTokenClaims(@Nonnull
 com.nimbusds.jwt.JWTClaimsSet claims)

Set the id_token claims about the authenticated end-user as returned from the id_token endpoint e.g. from a successful Token Response.

In contrast, the endUserClaims may contain both an aggregation of claims obtained from other sources e.g. the UserInfo endpoint, and a subset of the id_token claims e.g. only 'identity' claims and not 'validation' claims.

Parameters:

claims - the id_token claims

Returns:

this

getUnprocessedIdTokenClaims

@Nullable
public com.nimbusds.jwt.JWTClaimsSet getUnprocessedIdTokenClaims()

Get the unproccessed id_token claims.

Returns:

the unprocessed id_token claims.