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

Class Configuration.Directory

java.lang.Object

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

All Implemented Interfaces:

com.nimbusds.common.config.LoggableConfiguration

Enclosing class:

Configuration

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

Directory store details.

Field Summary

Fields

Modifier and Type	Field and Description
com.unboundid.ldap.sdk.DN	baseDN The base distinguished name (DN) of the directory branch where the user entries are stored.
com.nimbusds.common.ldap.FilterTemplate	filter The search filter to retrieve the user entries.
com.unboundid.ldap.sdk.SearchScope	scope The search scope for the user entries with respect to the specified base DN.
com.nimbusds.common.config.DirectoryUser	user The directory user credentials.

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

LOG_CATEGORY

Constructor Summary

Constructors

Constructor and Description
Configuration.Directory(String prefix, Properties props) Creates a new directory store details instance from the specified properties.

Method Summary

Methods

Modifier and Type	Method and Description
void	log()

Methods inherited from class java.lang.Object

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

Field Detail

user

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

The directory user credentials. Should have read permission to the directory tree containing the user entries.

Property keys: [prefix]user.*

baseDN

public final com.unboundid.ldap.sdk.DN baseDN

The base distinguished name (DN) of the directory branch where the user entries are stored.

Property key: [prefix]baseDN

scope

public final com.unboundid.ldap.sdk.SearchScope scope

The search scope for the user entries with respect to the specified base DN.

Property key: [prefix]scope

filter

public final com.nimbusds.common.ldap.FilterTemplate filter

The search filter to retrieve the user entries. The "%u" placeholder will be substituted with the subject identifier.

Property key: [prefix]filter

Constructor Detail

Configuration.Directory

public Configuration.Directory(String prefix,
                       Properties props)
                        throws com.thetransactioncompany.util.PropertyParseException

Creates a new directory store details instance from the specified properties.

Parameters:

prefix - The properties prefix. Must not be null.

props - The properties. Must not be null.

Throws:

com.thetransactioncompany.util.PropertyParseException - On a missing or invalid property.

Method Detail

log

public void log()

Specified by:

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