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

Class LDAPClaimsSource

java.lang.Object

com.nimbusds.openid.connect.provider.spi.claims.ldap.LDAPClaimsSource

All Implemented Interfaces:

com.nimbusds.openid.connect.provider.spi.claims.ClaimsSource, com.nimbusds.openid.connect.provider.spi.Lifecycle

public class LDAPClaimsSource
extends Object
implements com.nimbusds.openid.connect.provider.spi.claims.ClaimsSource

LDAP connector for retrieving OpenID Connect UserInfo claims.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_FILE_PATH The configuration file path.
static String	MAP_FILE_PATH The LDAP claims map file path.

Constructor Summary

Constructors

Constructor and Description
LDAPClaimsSource() Creates a new LDAP claims source.

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)
void	init(com.nimbusds.openid.connect.provider.spi.InitContext initContext)
boolean	isEnabled()
protected List<String>	resolveRequestedClaims(Set<String> claims, List<com.nimbusds.langtag.LangTag> claimsLocales) Resolves the individual requested claims from the specified requested claims and preferred locales.
void	shutdown()
Set<String>	supportedClaims()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONFIG_FILE_PATH

public static final String CONFIG_FILE_PATH

The configuration file path.

See Also:

Constant Field Values

MAP_FILE_PATH

public static final String MAP_FILE_PATH

The LDAP claims map file path.

See Also:

Constant Field Values

Constructor Detail

LDAPClaimsSource

public LDAPClaimsSource()

Creates a new LDAP claims source. It must be initialised before it can be used.

Method Detail

init

public void init(com.nimbusds.openid.connect.provider.spi.InitContext initContext)
          throws Exception

Specified by:

init in interface com.nimbusds.openid.connect.provider.spi.Lifecycle

Throws:

Exception

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface com.nimbusds.openid.connect.provider.spi.Lifecycle

supportedClaims

public Set<String> supportedClaims()

Specified by:

supportedClaims in interface com.nimbusds.openid.connect.provider.spi.claims.ClaimsSource

resolveRequestedClaims

protected List<String> resolveRequestedClaims(Set<String> claims,
                                  List<com.nimbusds.langtag.LangTag> claimsLocales)

Resolves the individual requested claims from the specified requested claims and preferred locales.

Parameters:

claims - The requested claims. May contain optional language tags. Must not be null.

claimsLocales - The preferred locales, null if not specified.

Returns:

The resolved individual requested claims.

getClaims

public 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

Specified by:

getClaims in interface com.nimbusds.openid.connect.provider.spi.claims.ClaimsSource

Throws:

Exception

shutdown

public void shutdown()
              throws Exception

Specified by:

shutdown in interface com.nimbusds.openid.connect.provider.spi.Lifecycle

Throws:

Exception