com.nimbusds.openid.connect.provider.claims.source.spi

Interface ClaimsSource

public interface ClaimsSource

Source of OpenID Connect UserInfo and other claims about a subject.

Method Summary

Methods

Modifier and Type	Method and Description
com.nimbusds.openid.connect.sdk.claims.UserInfo	getClaims(com.nimbusds.oauth2.sdk.id.Subject subject, Set<String> claims, List<com.nimbusds.langtag.LangTag> claimsLocales) Requests claims for the specified subject.
void	init(InitContext initContext) Initialises the OpenID Connect claims source.
boolean	isEnabled() Checks if the OpenID Connect claims source is enabled.
void	shutdown() Shuts down the OpenID Connect claims source.
Set<String>	supportedClaims() Returns the names of the supported OpenID Connect claims.

Method Detail

init

void init(InitContext initContext)
          throws Exception

Initialises the OpenID Connect claims source. This method is called after the claims source SPI implementation is loaded.

Parameters:

initContext - The initialisation context. Can be used to retrieve a configuration file required to set up the claims source, e.g. the parameters to establish a database connection. Not null.

Throws:

Exception - If initialisation failed.

isEnabled

boolean isEnabled()

Checks if the OpenID Connect claims source is enabled.

Returns:

true if the claims source is enabled, else false.

supportedClaims

Set<String> supportedClaims()

Returns the names of the supported OpenID Connect claims.

Example:

 name
 email
 email_verified
 

Returns:

The supported claim names. Should not include the reserved sub (subject) claim name.

getClaims

com.nimbusds.openid.connect.sdk.claims.UserInfo getClaims(com.nimbusds.oauth2.sdk.id.Subject subject,
                                                        Set<String> claims,
                                                        List<com.nimbusds.langtag.LangTag> claimsLocales)
                                                          throws Exception

Requests claims for the specified subject.

Parameters:

subject - The subject. Must not be null.

claims - The names of the requested claims, with optional language tags. Must not be null.

claimsLocales - The preferred languages and scripts for the claims to return, null if not specified.

Returns:

The claims, null if the subject wasn't found or the claims source is disabled.

Throws:

Exception - If retrieval of the claims failed.

shutdown

void shutdown()
              throws Exception

Shuts down the OpenID Connect claims source. This method is called on OpenID Connect Provider (OP) shutdown.

Throws:

Exception - If proper shutdown failed.