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

Class CommonFederationClaimsSet

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

All Implemented Interfaces:

net.minidev.json.JSONAware

Direct Known Subclasses:

EntityStatementClaimsSet, ResolveClaimsSet

public abstract class CommonFederationClaimsSet
extends CommonClaimsSet

Common federation claims set.

Field Summary

Fields

Modifier and Type	Field	Description
static String	EXP_CLAIM_NAME	The expiration time claim name.
static String	METADATA_CLAIM_NAME	The metadata claim name.
static String	TRUST_MARKS_CLAIM_NAME	The 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

Modifier	Constructor	Description
protected	CommonFederationClaimsSet()	Creates a new empty common federation claims set.
protected	CommonFederationClaimsSet(net.minidev.json.JSONObject jsonObject)	Creates a new common federation claims set from the specified JSON object.

Method Summary

Modifier and Type	Method	Description
AuthorizationServerMetadata	getASMetadata()	Gets the OAuth 2.0 authorisation server metadata if present for this entity.
Date	getExpirationTime()	Gets the entity statement expiration time.
FederationEntityMetadata	getFederationEntityMetadata()	Gets the federation entity metadata if present for this entity.
EntityID	getIssuerEntityID()	Returns the issuer as entity ID.
net.minidev.json.JSONObject	getMetadata(EntityType type)	Gets the metadata for the specified entity type.
ClientMetadata	getOAuthClientMetadata()	Gets the OAuth 2.0 client metadata if present for this entity.
OIDCProviderMetadata	getOPMetadata()	Gets the OpenID provider metadata if present for this entity.
OIDCClientMetadata	getRPMetadata()	Gets the OpenID relying party metadata if present for this entity.
EntityID	getSubjectEntityID()	Returns the subject as entity ID.
TrustMarkIssuerMetadata	getTrustMarkIssuerMetadata()	Deprecated.
List<TrustMarkEntry>	getTrustMarks()	Gets the trust marks.
void	setASMetadata(AuthorizationServerMetadata asMetadata)	Sets the OAuth 2.0 authorisation server metadata if present for this entity.
void	setFederationEntityMetadata(FederationEntityMetadata entityMetadata)	Sets the federation entity metadata if present for this entity.
void	setMetadata(EntityType type, net.minidev.json.JSONObject metadata)	Sets the metadata for the specified entity type.
void	setOAuthClientMetadata(ClientMetadata clientMetadata)	Sets the OAuth 2.0 client metadata if present for this entity.
void	setOPMetadata(OIDCProviderMetadata opMetadata)	Gets the OpenID provider metadata if present for this entity.
void	setRPMetadata(OIDCClientMetadata rpMetadata)	Sets the OpenID relying party metadata if present for this entity.
void	setTrustMarks(List<TrustMarkEntry> marks)	Sets the trust marks.
protected void	validateRequiredClaimsPresence()	Validates this claims set for having all minimum required claims.

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 Detail

EXP_CLAIM_NAME

public static final String EXP_CLAIM_NAME

The expiration time claim name.

See Also:

Constant Field Values

METADATA_CLAIM_NAME

public static final String METADATA_CLAIM_NAME

The metadata claim name.

See Also:

Constant Field Values

TRUST_MARKS_CLAIM_NAME

public static final String TRUST_MARKS_CLAIM_NAME

The trust marks claim name.

See Also:

Constant Field Values

Constructor Detail

CommonFederationClaimsSet

protected CommonFederationClaimsSet()

Creates a new empty common federation claims set.

CommonFederationClaimsSet

protected CommonFederationClaimsSet(net.minidev.json.JSONObject jsonObject)

Creates a new common federation claims set from the specified JSON object.

Parameters:

jsonObject - The JSON object. Must not be null.

Method Detail

validateRequiredClaimsPresence

protected void validateRequiredClaimsPresence()
                                       throws ParseException

Validates this claims set for having all minimum required claims.

Throws:

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

getIssuerEntityID

public EntityID getIssuerEntityID()

Returns the issuer as entity ID. Corresponds to the iss claim.

Returns:

The issuer as entity ID.

getSubjectEntityID

public EntityID getSubjectEntityID()

Returns the subject as entity ID. Corresponds to the iss claim.

Returns:

The subject as entity ID.

getExpirationTime

public Date getExpirationTime()

Gets the entity statement expiration time. Corresponds to the exp claim.

Returns:

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

getMetadata

public net.minidev.json.JSONObject getMetadata(EntityType type)

Gets the metadata for the specified entity type. Use a typed getter, such as getRPMetadata(), when available. Corresponds to the metadata claim.

Parameters:

type - The entity type. Must not be null.

Returns:

The metadata, null if not specified or if parsing failed.

setMetadata

public void setMetadata(EntityType type,
                        net.minidev.json.JSONObject metadata)

Sets the metadata for the specified entity type. Use a typed setter, such as setRPMetadata(com.nimbusds.openid.connect.sdk.rp.OIDCClientMetadata), when available. Corresponds to the metadata claim.

Parameters:

type - The type. Must not be null.

metadata - The metadata, null if not specified.

getRPMetadata

public OIDCClientMetadata getRPMetadata()

Gets the OpenID relying party metadata if present for this entity. Corresponds to the metadata.openid_relying_party claim.

Returns:

The RP metadata, null if not specified or if parsing failed.

setRPMetadata

public void setRPMetadata(OIDCClientMetadata rpMetadata)

Sets the OpenID relying party metadata if present for this entity. Corresponds to the metadata.openid_relying_party claim.

Parameters:

rpMetadata - The RP metadata, null if not specified.

getOPMetadata

public OIDCProviderMetadata getOPMetadata()

Gets the OpenID provider metadata if present for this entity. Corresponds to the metadata.openid_provider claim.

Returns:

The OP metadata, null if not specified or if parsing failed.

setOPMetadata

public void setOPMetadata(OIDCProviderMetadata opMetadata)

Gets the OpenID provider metadata if present for this entity. Corresponds to the metadata.openid_provider claim.

Parameters:

opMetadata - The OP metadata, null if not specified.

getOAuthClientMetadata

public ClientMetadata getOAuthClientMetadata()

Gets the OAuth 2.0 client metadata if present for this entity. Corresponds to the metadata.oauth_client claim.

Returns:

The client metadata, null if not specified or if parsing failed.

setOAuthClientMetadata

public void setOAuthClientMetadata(ClientMetadata clientMetadata)

Sets the OAuth 2.0 client metadata if present for this entity. Corresponds to the metadata.oauth_client claim.

Parameters:

clientMetadata - The client metadata, null if not specified.

getASMetadata

public AuthorizationServerMetadata getASMetadata()

Gets the OAuth 2.0 authorisation server metadata if present for this entity. Corresponds to the metadata.oauth_authorization_server claim.

Returns:

The AS metadata, null if not specified or if parsing failed.

setASMetadata

public void setASMetadata(AuthorizationServerMetadata asMetadata)

Sets the OAuth 2.0 authorisation server metadata if present for this entity. Corresponds to the metadata.oauth_authorization_server claim.

Parameters:

asMetadata - The AS metadata, null if not specified.

getFederationEntityMetadata

public FederationEntityMetadata getFederationEntityMetadata()

Gets the federation entity metadata if present for this entity. Corresponds to the metadata.federation_entity claim.

Returns:

The federation entity metadata, null if not specified or if parsing failed.

setFederationEntityMetadata

public void setFederationEntityMetadata(FederationEntityMetadata entityMetadata)

Sets the federation entity metadata if present for this entity. Corresponds to the metadata.federation_entity claim.

Parameters:

entityMetadata - The federation entity metadata, null if not specified.

getTrustMarkIssuerMetadata

@Deprecated
public TrustMarkIssuerMetadata getTrustMarkIssuerMetadata()

Deprecated.

Gets the trust mark issuer metadata if present for this entity. Corresponds to the metadata.trust_mark_issuer claim.

Returns:

The trust mark issuer metadata, null if not specified or if parsing failed.

getTrustMarks

public List<TrustMarkEntry> getTrustMarks()

Gets the trust marks. Corresponds to the trust_marks claim.

Returns:

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

setTrustMarks

public void setTrustMarks(List<TrustMarkEntry> marks)

Sets the trust marks. Corresponds to the trust_marks claim.

Parameters:

marks - The trust marks, null if not specified.