com.nimbusds.common.ldap

Class ExampleDirectory

java.lang.Object

com.nimbusds.common.ldap.ExampleDirectory

All Implemented Interfaces:

EventListener, javax.servlet.ServletContextListener

public class ExampleDirectory
extends Object
implements javax.servlet.ServletContextListener

Example in-memory LDAP directory server for demonstration and testing purposes. Access is limited to read and bind (authenticate) only.

The directory server is configured by a set of "exampleDirectoryServer.*" properties, see ExampleDirectory.Configuration.

The example directory implements ServletContextListener. This enables its automatic startup and shutdown in a servlet container (Java web server), such as Apache Tomcat. When started from a servlet container the directory configuration is obtained from a properties file specified by a context parameter named exampleDirectoryServer.configurationFile.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExampleDirectory.Configuration The example directory server configuration.

Constructor Summary

Constructors

Constructor and Description
ExampleDirectory()

Method Summary

Methods

Modifier and Type	Method and Description
void	contextDestroyed(javax.servlet.ServletContextEvent sce) Handler for servlet context shutdown events.
void	contextInitialized(javax.servlet.ServletContextEvent sce) Handler for servlet context startup events.
void	start(ExampleDirectory.Configuration config) Starts the example in-memory directory server.
void	stop() Stops the example in-memory directory server (if previously started).

Methods inherited from class java.lang.Object

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

Constructor Detail

ExampleDirectory

public ExampleDirectory()

Method Detail

start

public void start(ExampleDirectory.Configuration config)
           throws com.unboundid.ldap.sdk.LDAPException,
                  IOException,
                  com.unboundid.ldif.LDIFException

Starts the example in-memory directory server.

Parameters:

config - The example directory server configuration. Must not be null.

Throws:

com.unboundid.ldap.sdk.LDAPException - If the in-memory directory server couldn't be started or its initialisation failed.

IOException - If a schema file was specified and it couldn't be read.

com.unboundid.ldif.LDIFException - If a schema file was specified that is not valid LDIF.

stop

public void stop()

Stops the example in-memory directory server (if previously started). Information and status messages are logged at INFO level.

contextInitialized

public void contextInitialized(javax.servlet.ServletContextEvent sce)

Handler for servlet context startup events. Launches the example in-memory directory server (if enabled per configuration). Exceptions are logged at ERROR level, information and status messages at INFO level.

The example directory server configuration is retrieved from a properties file which location is specified by a servlet context parameter named exampleDirectory.configurationFile.

Specified by:

contextInitialized in interface javax.servlet.ServletContextListener

Parameters:

sce - A servlet context event.

contextDestroyed

public void contextDestroyed(javax.servlet.ServletContextEvent sce)

Handler for servlet context shutdown events. Stops the example in-memory directory server (if previously started).

Specified by:

contextDestroyed in interface javax.servlet.ServletContextListener

Parameters:

sce - A servlet context event.