com.nimbusds.infinispan.persistence.ldap

Class LDAPStoreConfiguration

java.lang.Object

org.infinispan.configuration.cache.AbstractStoreConfiguration

com.nimbusds.infinispan.persistence.ldap.LDAPStoreConfiguration

All Implemented Interfaces:

com.nimbusds.common.config.LoggableConfiguration, org.infinispan.configuration.cache.StoreConfiguration

@Immutable
public class LDAPStoreConfiguration
extends org.infinispan.configuration.cache.AbstractStoreConfiguration
implements com.nimbusds.common.config.LoggableConfiguration

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

Example LDAP store configuration:

 # LDAP server details #
 ldapServer.url = ldap://localhost:1389 ldap://remotehost:1389
 ldapServer.selectionAlgorithm = FAILOVER
 ldapServer.connectTimeout = 100
 ldapServer.responseTimeout = 100
 ldapServer.security = NONE
 ldapServer.trustSelfSignedCerts = false
 ldapServer.connectionPoolSize = 5
 ldapServer.connectionPoolInitialSize = 0
 ldapServer.connectionPoolMaxWaitTime = 100
 ldapServer.connectionMaxAge = 0

 # LDAP user details #
 ldapUser.dn = cn=Directory Manager
 ldapUser.password = secret

 # LDAP directory entry details #
 ldapDirectory.baseDN = ou=authorizations, dc=wonderland, dc=net
 ldapDirectory.pageSize = 500
 ldapDirectory.entryTransformer = com.nimbusds.infinispan.persistence.ldap.UserEntityTransformer

 # Custom LDAP sever trust and key store #
 customTrustStore.enable = false
 customTrustStore.file =
 customTrustStore.password =
 customTrustStore.type =

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LDAPStoreConfiguration.LDAPDirectory LDAP directory entry configuration.

Field Summary

Fields

Modifier and Type	Field and Description
com.nimbusds.common.config.CustomKeyStoreConfiguration	customKeyStore The custom key store for secure LDAP server connections.
com.nimbusds.common.config.CustomTrustStoreConfiguration	customTrustStore The custom trust store for secure LDAP server connections.
LDAPStoreConfiguration.LDAPDirectory	ldapDirectory The LDAP directory entry details.
com.nimbusds.common.config.LDAPServerConnectionPoolDetails	ldapServer The LDAP server details.
com.nimbusds.common.config.DirectoryUser	ldapUser The LDAP directory user details.

Fields inherited from class org.infinispan.configuration.cache.AbstractStoreConfiguration

attributes, FETCH_PERSISTENT_STATE, IGNORE_MODIFICATIONS, PRELOAD, PROPERTIES, PURGE_ON_STARTUP, SHARED, TRANSACTIONAL

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

LOG_CATEGORY

Constructor Summary

Constructors

Constructor and Description
LDAPStoreConfiguration(boolean purgeOnStartup, boolean fetchPersistentState, boolean ignoreModifications, org.infinispan.configuration.cache.AsyncStoreConfiguration async, org.infinispan.configuration.cache.SingletonStoreConfiguration singletonStore, boolean preload, boolean shared, Properties properties) Creates a new LDAP store configuration.
LDAPStoreConfiguration(Properties properties) Creates a new LDAP store configuration from the specified properties.

Method Summary

Modifier and Type	Method and Description
void	log()

Methods inherited from class org.infinispan.configuration.cache.AbstractStoreConfiguration

async, attributeDefinitionSet, attributes, equals, fetchPersistentState, hashCode, ignoreModifications, preload, properties, purgeOnStartup, shared, singletonStore, toString, transactional

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ldapServer

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

The LDAP server details.

Property key: ldapServer

ldapUser

public final com.nimbusds.common.config.DirectoryUser ldapUser

The LDAP directory user details. The user must have read and add permissions to the directory tree containing the persisted entries.

Property key: ldapUser

ldapDirectory

public final LDAPStoreConfiguration.LDAPDirectory ldapDirectory

The LDAP directory entry details.

Property key: ldapDirectory

customTrustStore

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

The custom trust store for secure LDAP server connections.

Property key: customTrustStore

customKeyStore

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

The custom key store for secure LDAP server connections.

Property key: customKeyStore

Constructor Detail

LDAPStoreConfiguration

public LDAPStoreConfiguration(Properties properties)

Creates a new LDAP store configuration from the specified properties. All other settings assume defaults.

Parameters:

properties - The LDAP store specific configuration properties. Must not be null.

LDAPStoreConfiguration

public LDAPStoreConfiguration(boolean purgeOnStartup,
                              boolean fetchPersistentState,
                              boolean ignoreModifications,
                              org.infinispan.configuration.cache.AsyncStoreConfiguration async,
                              org.infinispan.configuration.cache.SingletonStoreConfiguration singletonStore,
                              boolean preload,
                              boolean shared,
                              Properties properties)

Creates a new LDAP store configuration.

Parameters:

purgeOnStartup - If true the cache store will be purged when it starts up.

fetchPersistentState - If true the persistent state be fetched when joining a cluster.

ignoreModifications - If true any operation that modifies the cache (put, remove, clear, store...etc) won't be applied to the cache store. This means that the cache store could become out of sync with the cache.

async - Configuration for the async cache loader.

singletonStore - Configuration for a singleton store.

preload - If true when the cache starts data stored in the cache loader will be pre-loaded into memory.

shared - If true the cache store is shared among all cache instances.

properties - The LDAP store specific configuration properties. Must not be null.

Method Detail

log

public void log()

Specified by:

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