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

Class Configuration

java.lang.Object

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

All Implemented Interfaces:

com.nimbusds.common.config.LoggableConfiguration

public final class Configuration
extends Object
implements com.nimbusds.common.config.LoggableConfiguration

LDAP claims source configuration. It is typically derived from a Java key / value properties file. The configuration is stored as public fields which become immutable (final) after their initialisation.

Example configuration properties:

 op.ldapClaimsSource.enable = true

 op.ldapClaimsSource.server.url = ldap://localhost:1389 ldap://remotehost:1389
 op.ldapClaimsSource.server.selectionAlgorithm = FAILOVER
 op.ldapClaimsSource.server.connectTimeout = 250
 op.ldapClaimsSource.server.security = STARTTLS
 op.ldapClaimsSource.server.trustSelfSignedCerts = true
 op.ldapClaimsSource.server.connectionPoolSize = 10
 op.ldapClaimsSource.server.connectionPoolMaxWaitTime = 250
 op.ldapClaimsSource.server.connectionMaxAge = 0

 op.ldapClaimsSource.directory.user.dn = cn=Directory Manager
 op.ldapClaimsSource.directory.user.password = secret

 op.ldapClaimsSource.directory.baseDN = ou=people,dc=wonderland,dc=net
 op.ldapClaimsSource.directory.scope = ONE
 op.ldapClaimsSource.directory.filter = (uid=%u)

 op.ldapClaimsSource.directory.attributeMap = oidcClaimsLdapMap.json

 op.ldapClaimsSource.customTrustStore.enable = false
 op.ldapClaimsSource.customTrustStore.file =
 op.ldapClaimsSource.customTrustStore.password =
 op.ldapClaimsSource.customTrustStore.type =

 op.ldapClaimsSource.customKeyStore.enable = false
 op.ldapClaimsSource.customKeyStore.file =
 op.ldapClaimsSource.customKeyStore.password =
 op.ldapClaimsSource.customKeyStore.type =
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Configuration.Directory Directory store details.

Field Summary

Fields

Modifier and Type	Field and Description
com.nimbusds.common.config.CustomKeyStoreConfiguration	customKeyStore The custom key store details.
com.nimbusds.common.config.CustomTrustStoreConfiguration	customTrustStore The custom trust store details.
static String	DEFAULT_PREFIX The default properties prefix.
Configuration.Directory	directory The directory store details.
boolean	enable Enables / disables the LDAP claims source.
com.nimbusds.common.config.LDAPServerConnectionPoolDetails	server The LDAP server connect details.

Fields inherited from interface com.nimbusds.common.config.LoggableConfiguration

LOG_CATEGORY

Constructor Summary

Constructors

Constructor and Description
Configuration(Properties props) Creates a new LDAP claims source configuration from the specified properties.

Method Summary

Methods

Modifier and Type	Method and Description
void	log() Logs the configuration details at INFO level.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PREFIX

public static final String DEFAULT_PREFIX

The default properties prefix.

See Also:

Constant Field Values

enable

public final boolean enable

Enables / disables the LDAP claims source.

Property key: [prefix]enable

server

public final com.nimbusds.common.config.LDAPServerConnectionPoolDetails server

The LDAP server connect details.

directory

public final Configuration.Directory directory

The directory store details.

customTrustStore

public final com.nimbusds.common.config.CustomTrustStoreConfiguration customTrustStore

The custom trust store details.

customKeyStore

public final com.nimbusds.common.config.CustomKeyStoreConfiguration customKeyStore

The custom key store details.

Constructor Detail

Configuration

public Configuration(Properties props)
              throws com.nimbusds.common.config.ConfigurationException

Creates a new LDAP claims source configuration from the specified properties.

Parameters:

props - The properties. Must not be null.

Throws:

com.nimbusds.common.config.ConfigurationException - On a missing or invalid property.

Method Detail

log

public void log()

Logs the configuration details at INFO level. Properties that may adversely affect security are logged at WARN level.

Specified by:

log in interface com.nimbusds.common.config.LoggableConfiguration