Package com.nimbusds.openid.connect.sdk.federation.trust.marks

Class TrustMarkClaimsSet

java.lang.Object

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

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

com.nimbusds.openid.connect.sdk.federation.trust.marks.TrustMarkClaimsSet

All Implemented Interfaces:

net.minidev.json.JSONAware

public class TrustMarkClaimsSet
extends CommonClaimsSet

Federation trust mark claims set, serialisable to a JSON object.

Example claims set:

 {
   "iss" : "https://swamid.sunet.se",
   "sub" : "https://umu.se/op",
   "iat" : 1577833200,
   "exp" : 1609369200,
   "id"  : "https://refeds.org/wp-content/uploads/2016/01/Sirtfi-1.0.pdf"
 }
 

Related specifications:

• OpenID Connect Federation 1.0, section 5.3.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXP_CLAIM_NAME	The expiration time claim name.
static final String	ID_CLAIM_NAME	The identifier claim name.
static final String	LOGO_URI_CLAIM_NAME	The mark / logo URI name.
static final String	REF_CLAIM_NAME	The reference 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
TrustMarkClaimsSet(com.nimbusds.jwt.JWTClaimsSet jwtClaimsSet)	Creates a new trust mark claims set from the specified JWT claims set.
TrustMarkClaimsSet(Issuer iss, Subject sub, Identifier id, Date iat)	Creates a new trust mark claims set with the minimum required claims.

Method Summary

Modifier and Type	Method	Description
Date	getExpirationTime()	Gets the expiration time.
Identifier	getID()	Returns the identifier.
URI	getLogoURI()	Gets the mark / logo URI.
URI	getReference()	Gets the reference URI.
void	setExpirationTime(Date exp)	Sets the expiration time.
void	setMark(URI markURI)	Sets the mark / logo URI.
void	setReference(URI refURI)	Sets the reference URI.
void	validateRequiredClaimsPresence()	Validates this claims set for having all minimum required claims for a trust mark.

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

getIssueTime, getStandardClaimNames, 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 Details

ID_CLAIM_NAME

public static final String ID_CLAIM_NAME

The identifier claim name.

See Also:

• Constant Field Values

LOGO_URI_CLAIM_NAME

public static final String LOGO_URI_CLAIM_NAME

The mark / logo URI name.

See Also:

• Constant Field Values

EXP_CLAIM_NAME

public static final String EXP_CLAIM_NAME

The expiration time claim name.

See Also:

• Constant Field Values

REF_CLAIM_NAME

public static final String REF_CLAIM_NAME

The reference claim name.

See Also:

• Constant Field Values

Constructor Details

TrustMarkClaimsSet

public TrustMarkClaimsSet(Issuer iss,
 Subject sub,
 Identifier id,
 Date iat)

Creates a new trust mark claims set with the minimum required claims.

Parameters:

iss - The issuer. Corresponds to the iss claim. Must not be null.

sub - The subject. Corresponds to the sub claim. Must not be null.

id - The identifier. Corresponds to the id claim. Must not be null.

iat - The issue time. Corresponds to the iat claim. Must not be null.

TrustMarkClaimsSet

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

Creates a new trust mark 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 trust mark claims set.

Method Details

validateRequiredClaimsPresence

public void validateRequiredClaimsPresence()
                                    throws ParseException

Validates this claims set for having all minimum required claims for a trust mark.

Throws:

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

getID

public Identifier getID()

Returns the identifier. Corresponds to the id claim.

Returns:

The identifier.

getLogoURI

public URI getLogoURI()

Gets the mark / logo URI. Corresponds to the logo_uri claim.

Returns:

The mark / logo URI, null if not specified or parsing failed.

setMark

public void setMark(URI markURI)

Sets the mark / logo URI. Corresponds to the logo_uri claim.

Parameters:

markURI - The mark / logo URI, null if not specified.

getExpirationTime

public Date getExpirationTime()

Gets the expiration time. Corresponds to the exp claim.

Returns:

The expiration time, null if not specified or parsing failed.

setExpirationTime

public void setExpirationTime(Date exp)

Sets the expiration time. Corresponds to the exp claim.

Parameters:

exp - The expiration time, null if not specified.

getReference

public URI getReference()

Gets the reference URI. Corresponds to the ref claim.

Returns:

The reference URI, null if not specified or parsing failed.

setReference

public void setReference(URI refURI)

Sets the reference URI. Corresponds to the ref claim.

Parameters:

refURI - The reference URI, null if not specified.