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

Class PlainUserInfoResponse

java.lang.Object

net.shibboleth.idp.plugin.authn.oidc.rp.messaging.PlainUserInfoResponse

All Implemented Interfaces:

UserInfoResponse

public class PlainUserInfoResponse
extends Object
implements UserInfoResponse

A UserInfo response that was a plain JSON object with claims.

Nested Class Summary

Nested classes/interfaces inherited from interface net.shibboleth.idp.plugin.authn.oidc.rp.messaging.UserInfoResponse

UserInfoResponse.UserInfoResponseType

Field Summary

Fields

Modifier and Type	Field	Description
private com.nimbusds.openid.connect.sdk.claims.ClaimsSet	userInfoClaims	The UserInfo claims inside a JWT.

Constructor Summary

Constructors

Constructor	Description
PlainUserInfoResponse(com.nimbusds.openid.connect.sdk.claims.ClaimsSet claims)	Constructor.

Method Summary

Modifier and Type	Method	Description
com.nimbusds.openid.connect.sdk.claims.ClaimsSet	getClaimsSet()	Get the claims for the authenticated end-user.
String	getSub()	Get the subject identifier for the authenticated end-user.
UserInfoResponse.UserInfoResponseType	getType()	Get the UserInfo response type.
com.nimbusds.openid.connect.sdk.claims.ClaimsSet	getUserInfoClaims()	The consented UserInfo claims.
boolean	isClaimsSetAvailable()	Is the claims set available for use? if so, UserInfoResponse.getClaimsSet() should never return null.
boolean	isEncrypted()	Is the response encrypted i.e.
boolean	isSigned()	Is the response signed i.e.

Methods inherited from class java.lang.Object

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

Field Detail

userInfoClaims

@Nonnull
private final com.nimbusds.openid.connect.sdk.claims.ClaimsSet userInfoClaims

The UserInfo claims inside a JWT.

Constructor Detail

PlainUserInfoResponse

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

Constructor.

Parameters:

claims - UserInfo claims.

Method Detail

getUserInfoClaims

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

The consented UserInfo claims.

Returns:

the claims.

getClaimsSet

public com.nimbusds.openid.connect.sdk.claims.ClaimsSet getClaimsSet()

Description copied from interface: UserInfoResponse

Get the claims for the authenticated end-user.

Specified by:

getClaimsSet in interface UserInfoResponse

Returns:

the claims for the authenticated end-user. Can be null if the underlying claims are not available and UserInfoResponse.isClaimsSetAvailable() is false e.g. an encrypted JWT which has not yet been decrypted. If UserInfoResponse.isClaimsSetAvailable() is true, this should never return null.

getSub

public String getSub()

Description copied from interface: UserInfoResponse

Get the subject identifier for the authenticated end-user.

Specified by:

getSub in interface UserInfoResponse

Returns:

the subject identifier.

isClaimsSetAvailable

public boolean isClaimsSetAvailable()

Description copied from interface: UserInfoResponse

Is the claims set available for use? if so, UserInfoResponse.getClaimsSet() should never return null.

Specified by:

isClaimsSetAvailable in interface UserInfoResponse

Returns:

true iff the claims set can be used.

isSigned

public boolean isSigned()

Description copied from interface: UserInfoResponse

Is the response signed i.e. a JWS response.

Specified by:

isSigned in interface UserInfoResponse

Returns:

true iff the response was signed.

isEncrypted

public boolean isEncrypted()

Description copied from interface: UserInfoResponse

Is the response encrypted i.e. a JWE response. Note, it could also be signed.

Specified by:

isEncrypted in interface UserInfoResponse

Returns:

true iff the response is encrypted.

getType

public UserInfoResponse.UserInfoResponseType getType()

Description copied from interface: UserInfoResponse

Get the UserInfo response type.

Specified by:

getType in interface UserInfoResponse

Returns:

the response type, e.g. plain or JWT.