net.sf.michaelo.dirctxsrc

Class DirContextSource

java.lang.Object

net.sf.michaelo.dirctxsrc.DirContextSource

public class DirContextSource
extends Object

A JNDI directory context factory returning ready-to-use DirContext objects. The basic idea is borrowed from DataSource where you get a database connection. Same does this class with directory contexts. This directory context source has built-in support for anonymous and GSS-API with Kerberos 5 authentication. If you intend to use the latter, make sure that your environment is properly configured.

Here is a minimal example how to create a DirContextSource with the supplied builder:

 DirContextSource.Builder builder = new DirContextSource.Builder("ldap://hostname");
 DirContextSource contextSource = builder.build();
 // try and catch block omitted for the sake of brevity, handle NamingException appropriately
 DirContext context = contextSource.getDirContext();
 // Perform operations
 context.close();
 

Before returning a DirContext the source will loop several times until a connection has been established or the number of retries are exhausted, which ever comes first.

A DirContextSource object will be initially preconfigured by its builder for you:

1. The context factory is set by default to com.sun.jndi.ldap.LdapCtxFactory.
2. The default authentication scheme is set to none/anonymous.
3. If GSS-API authentication is used the login entry name defaults to DirContextSource.
4. By default a context source will try once to connect and will wait for 2000 ms between retries.

A complete overview of all DirContext properties can be found here. Make sure that you pass reasonable/valid values only otherwise the behavior is undefined.

Version:

$Id: DirContextSource.java 240 2019-03-01 10:42:41Z michael-o $

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DirContextSource.Auth Enum containing all supported authentication mechanisms.
static class	DirContextSource.Builder A builder to construct a DirContextSource with a fluent interface.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Oid	KRB5_MECHANISM

Method Summary

Modifier and Type	Method and Description
protected DirContext	getAnonymousDirContext()
DirContext	getDirContext() Returns a ready-to-use DirContext.
protected DirContext	getGssApiDirContext()

Methods inherited from class java.lang.Object

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

Field Detail

KRB5_MECHANISM

protected static final Oid KRB5_MECHANISM

Method Detail

getGssApiDirContext

protected DirContext getGssApiDirContext()
                                  throws NamingException

Throws:

NamingException

getAnonymousDirContext

protected DirContext getAnonymousDirContext()
                                     throws NamingException

Throws:

NamingException

getDirContext

public DirContext getDirContext()
                         throws NamingException

Returns a ready-to-use DirContext. Do not forget to close the context after all operations.

Returns:

a DirContext

Throws:

NamingException - thrown if a problem with the creation arises