Package com.nimbusds.common.config

Class DirectoryUser

java.lang.Object

com.nimbusds.common.config.DirectoryUser

All Implemented Interfaces:

LoggableConfiguration

public class DirectoryUser
extends Object
implements LoggableConfiguration

Directory user, with DN and password.

The configuration is stored as public fields which become immutable (final) after their initialisation.

Property keys: [prefix]*

Field Summary

Fields

Modifier and Type	Field	Description
com.unboundid.ldap.sdk.DN	dn	The distinguished name (DN) of the directory user DN.
String	password	The directory user password.

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

LOG_CATEGORY

Constructor Summary

Constructors

Constructor	Description
DirectoryUser(com.unboundid.ldap.sdk.DN dn, String password)	Creates a new directory user.
DirectoryUser(String prefix, Properties props)	Creates a new directory user from the specified properties.

Method Summary

Modifier and Type	Method	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

dn

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

The distinguished name (DN) of the directory user DN. A DN.NULL_DN value represents an anonymous user.

Property key: [prefix]dn

password

public final String password

The directory user password. An empty string represents an anonymous user.

Property key: [prefix]password

Constructor Detail

DirectoryUser

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

Creates a new directory user from the specified properties.

Mandatory properties:

• [prefix]dn
• [prefix]password

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.

DirectoryUser

public DirectoryUser(com.unboundid.ldap.sdk.DN dn,
                     String password)

Creates a new directory user.

Parameters:

dn - The distinguished name (DN) of the directory user DN. A DN.NULL_DN value represents an anonymous user. Must not be null.

password - The directory user password. An empty string represents an anonymous user.

Method Detail

log

public void log()

Logs the configuration details at INFO level.

Specified by:

log in interface LoggableConfiguration