com.atlassian.crowd.apacheds

Class ApacheDSContextListener

java.lang.Object

com.atlassian.crowd.apacheds.ApacheDSContextListener

All Implemented Interfaces:

EventListener, javax.servlet.ServletContextListener

public class ApacheDSContextListener
extends Object
implements javax.servlet.ServletContextListener

A Servlet context listener to start and stop ApacheDS.

The following environment variables are supported:

• apacheds.ldap.port - the LDAP connector port (default: 10389)
• apacheds.partition.name - the LDAP partition distinguished name (default: dc=example,dc=com)
• apacheds.ldif.file - the LDIF classpath file to import just after startup (default: default-example.ldif)

The server is both self-contained and light-weight.

Constructor Summary

Constructors

Constructor and Description
ApacheDSContextListener()

Method Summary

Modifier and Type	Method and Description
void	contextDestroyed(javax.servlet.ServletContextEvent evt) Shutdown ApacheDS embedded.
void	contextInitialized(javax.servlet.ServletContextEvent evt) Startup ApacheDS embedded.
protected int	getLdapPort()
protected String	getLdifFile()
protected String	getPartitionDN()
protected List<org.apache.directory.api.ldap.model.ldif.LdifEntry>	loadLdif(InputStream in, boolean verifyEntries) Loads an LDIF from an input stream and adds the entries it contains to the server.
protected void	verify(org.apache.directory.api.ldap.model.ldif.LdifEntry entry) Verifies that an entry exists in the directory with the specified attributes.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApacheDSContextListener

public ApacheDSContextListener()

Method Detail

getPartitionDN

protected String getPartitionDN()

getLdapPort

protected int getLdapPort()

getLdifFile

protected String getLdifFile()

loadLdif

protected List<org.apache.directory.api.ldap.model.ldif.LdifEntry> loadLdif(InputStream in,
                                                                            boolean verifyEntries)
                                                                     throws Exception

Loads an LDIF from an input stream and adds the entries it contains to the server. It appears as though the administrator added these entries to the server.

Parameters:

in - the input stream containing the LDIF entries to load

verifyEntries - whether or not all entry additions are checked to see if they were in fact correctly added to the server

Returns:

a list of entries added to the server in the order they were added

Throws:

NamingException - of the load fails

Exception

verify

protected void verify(org.apache.directory.api.ldap.model.ldif.LdifEntry entry)
               throws Exception

Verifies that an entry exists in the directory with the specified attributes.

Parameters:

entry - the entry to verify

Throws:

NamingException - if there are problems accessing the entry

Exception

contextInitialized

public void contextInitialized(javax.servlet.ServletContextEvent evt)

Startup ApacheDS embedded.

If you get an error message in the logs like: "The value 'inetOrgPerson' is incorrect, it hasn't been added" Don't stress, it's an ApacheDS bug: https://issues.apache.org/jira/browse/DIRSERVER-1253

Also if you see an error message like this: "OID for name 'monitorcontext' was not found within the OID registry" It's an Apache LDAP Studio bug.

Specified by:

contextInitialized in interface javax.servlet.ServletContextListener

contextDestroyed

public void contextDestroyed(javax.servlet.ServletContextEvent evt)

Shutdown ApacheDS embedded.

Specified by:

contextDestroyed in interface javax.servlet.ServletContextListener