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

Class JWTUserInfoResponse

java.lang.Object

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

All Implemented Interfaces:

UserInfoResponse

public class JWTUserInfoResponse
extends Object
implements UserInfoResponse

A UserInfo response returned as a JWT which maybe signed and or encrypted.

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	claims	The claims represented by the JWT, could be null if JWT is encrypted and has not yet been decrypted.
private com.nimbusds.jwt.JWT	responseJwt	The UserInfo claims inside a JWT.

Constructor Summary

Constructors

Constructor	Description
JWTUserInfoResponse(com.nimbusds.jwt.JWT jwt)	Constructor.

Method Summary

Modifier and Type	Method	Description
com.nimbusds.openid.connect.sdk.claims.ClaimsSet	getClaimsSet()	Get the claims for the authenticated end-user.
com.nimbusds.jwt.JWT	getResponseJwt()	Get the UserInfo JWT response.
String	getSub()	Get the subject identifier for the authenticated end-user.
UserInfoResponse.UserInfoResponseType	getType()	Get the UserInfo response type.
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

responseJwt

@Nonnull
private final com.nimbusds.jwt.JWT responseJwt

The UserInfo claims inside a JWT.

claims

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

The claims represented by the JWT, could be null if JWT is encrypted and has not yet been decrypted.

Constructor Detail

JWTUserInfoResponse

public JWTUserInfoResponse(@Nonnull
                           com.nimbusds.jwt.JWT jwt)

Constructor.

Parameters:

jwt - the plain, signed, and or encrypted JWT representing UserInfo claims.

Method Detail

getResponseJwt

@Nonnull
public com.nimbusds.jwt.JWT getResponseJwt()

Get the UserInfo JWT response.

Returns:

the UserInfo JWT response.

getClaimsSet

@Nullable
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

@Nullable
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()

Is the response signed i.e. a JWS response. There is no easy way to determine if signed when nested inside a JWE, unless first decrypted.

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.