Package com.nimbusds.openid.connect.sdk.federation.api

Class ResolveClaimsSet

java.lang.Object

com.nimbusds.openid.connect.sdk.claims.ClaimsSet

com.nimbusds.openid.connect.sdk.claims.CommonClaimsSet

com.nimbusds.openid.connect.sdk.federation.entities.CommonFederationClaimsSet

com.nimbusds.openid.connect.sdk.federation.api.ResolveClaimsSet

All Implemented Interfaces:

net.minidev.json.JSONAware

public class ResolveClaimsSet
extends CommonFederationClaimsSet

Resolve response claims set.

Related specifications:

• OpenID Connect Federation 1.0, section 7.2.2.

Field Summary

Fields

Modifier and Type	Field	Description
static String	TRUST_CHAIN_CLAIM_NAME	The trust chain claim name.

Fields inherited from class com.nimbusds.openid.connect.sdk.federation.entities.CommonFederationClaimsSet

EXP_CLAIM_NAME, METADATA_CLAIM_NAME, TRUST_MARKS_CLAIM_NAME

Fields inherited from class com.nimbusds.openid.connect.sdk.claims.CommonClaimsSet

IAT_CLAIM_NAME, SUB_CLAIM_NAME

Fields inherited from class com.nimbusds.openid.connect.sdk.claims.ClaimsSet

AUD_CLAIM_NAME, claims, ISS_CLAIM_NAME

Constructor Summary

Constructors

Constructor	Description
ResolveClaimsSet(com.nimbusds.jwt.JWTClaimsSet jwtClaimsSet)	Creates a new resolve response claims set from the specified JWT claims set.
ResolveClaimsSet(Issuer iss, Subject sub, Date iat, Date exp, net.minidev.json.JSONObject metadata)	Creates a new resolve response claims set with the minimum required claims.
ResolveClaimsSet(EntityID iss, EntityID sub, Date iat, Date exp, net.minidev.json.JSONObject metadata)	Creates a new resolve response claims set with the minimum required claims.

Method Summary

Modifier and Type	Method	Description
static Set<String>	getStandardClaimNames()	Gets the names of the standard top-level claims.
TrustChain	getTrustChain()	Gets the trust chain.
void	setTrustChain(TrustChain trustChain)	Sets the trust chain.
void	validateRequiredClaimsPresence()	Validates this claims set for having all minimum required claims for a resolve response.

Methods inherited from class com.nimbusds.openid.connect.sdk.federation.entities.CommonFederationClaimsSet

getASMetadata, getExpirationTime, getFederationEntityMetadata, getIssuerEntityID, getMetadata, getOAuthClientMetadata, getOPMetadata, getRPMetadata, getSubjectEntityID, getTrustMarkIssuerMetadata, getTrustMarks, setASMetadata, setFederationEntityMetadata, setMetadata, setOAuthClientMetadata, setOPMetadata, setRPMetadata, setTrustMarks

Methods inherited from class com.nimbusds.openid.connect.sdk.claims.CommonClaimsSet

getIssueTime, getSubject

Methods inherited from class com.nimbusds.openid.connect.sdk.claims.ClaimsSet

equals, getAudience, getBooleanClaim, getClaim, getClaim, getDateClaim, getIssuer, getJSONArrayClaim, getJSONObjectClaim, getLangTaggedClaim, getNumberClaim, getStringClaim, getStringClaim, getStringListClaim, getURIClaim, getURLClaim, hashCode, putAll, putAll, setAudience, setAudience, setClaim, setClaim, setDateClaim, setIssuer, setURIClaim, setURLClaim, toJSONObject, toJSONString, toJWTClaimsSet, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TRUST_CHAIN_CLAIM_NAME

public static final String TRUST_CHAIN_CLAIM_NAME

The trust chain claim name.

See Also:

Constant Field Values

Constructor Detail

ResolveClaimsSet

public ResolveClaimsSet(Issuer iss,
                        Subject sub,
                        Date iat,
                        Date exp,
                        net.minidev.json.JSONObject metadata)

Creates a new resolve response claims set with the minimum required claims.

Parameters:

iss - The issuer. Must not be null.

sub - The subject. Must not be null.

iat - The issue time. Must not be null.

exp - The expiration time. Must not be null.

metadata - The metadata JSON object. Must not be null.

ResolveClaimsSet

public ResolveClaimsSet(EntityID iss,
                        EntityID sub,
                        Date iat,
                        Date exp,
                        net.minidev.json.JSONObject metadata)

Creates a new resolve response claims set with the minimum required claims.

Parameters:

iss - The issuer. Must not be null.

sub - The subject. Must not be null.

iat - The issue time. Must not be null.

exp - The expiration time. Must not be null.

metadata - The metadata JSON object. Must not be null.

ResolveClaimsSet

public ResolveClaimsSet(com.nimbusds.jwt.JWTClaimsSet jwtClaimsSet)
                 throws ParseException

Creates a new resolve response claims set from the specified JWT claims set.

Parameters:

jwtClaimsSet - The JWT claims set. Must not be null.

Throws:

ParseException - If the JWT claims set doesn't represent a valid resolve response claims set.

Method Detail

getStandardClaimNames

public static Set<String> getStandardClaimNames()

Gets the names of the standard top-level claims.

Returns:

The names of the standard top-level claims (read-only set).

validateRequiredClaimsPresence

public void validateRequiredClaimsPresence()
                                    throws ParseException

Validates this claims set for having all minimum required claims for a resolve response.

Overrides:

validateRequiredClaimsPresence in class CommonFederationClaimsSet

Throws:

ParseException - If the validation failed and a required claim is missing.

getTrustChain

public TrustChain getTrustChain()

Gets the trust chain. Corresponds to the trust_chain claim.

Returns:

The trust chain, null if not specified or parsing failed.

setTrustChain

public void setTrustChain(TrustChain trustChain)

Sets the trust chain. Corresponds to the trust_chain claim.

Parameters:

trustChain - The trust chain, null if not specified.