com.bankframe.ei.ldap
Class LDAPServerContext

java.lang.Object
  com.bankframe.ei.ldap.LDAPServerContext

All Implemented Interfaces:

Serializable

public class LDAPServerContext
extends Object
implements Serializable

This class provides the connectivity to an LDAP server. Connecting to the server requires several configuration parameters, these are defined as the following constant fields in this class

1. PROVIDER_URL - URL of the ldap server, and the context in the server to access
2. INITIAL_CONTEXT_FACTORY - The JNDI factory class to use to make the connection
3. SECURITY_AUTHENTICATION - The authentication method
4. SECURITY_PRINCIPAL - The user to authenticate
5. SECURITY_CREDENTIALS - The password to use for authentication
6. SECURITY_PROTOCOL - Specifies whether to connect using Secure Sockets Layer
7. BASE_DN - Specifies the base distinguished name of this context
8. CONTEXT_ALIAS - Specifies the name of the alias that defines the above settings
9. RDN_ATTRIBUTE - Specifies the name of the attribute that is used to form the dn
10. DEFAULT_SEARCH_FILTER - Specifies a default search filter to use for searches

These parameters are passed to the constructor as key-value pairs in a Hashtable. All the parameters may not be required, for example the LDAP server may not require authentication

The physical connection to the server will not be established until it is actually required ie. when one of create(), get(), update(), remove() or list() is called. The physical connection will be closed when the context is destroyed, it can also be closed explicitly by calling the close() method. The open() method can be used to explicitly establish the physical connection.

See Also:

Serialized Form

Field Summary

static String	BASE_DN
static String	CONTEXT_ALIAS
static String	DEFAULT_INITIAL_CONTEXT_FACTORY
static String	DEFAULT_SEARCH_FILTER
static String	INITIAL_CONTEXT_FACTORY
static String	PROVIDER_URL
static String	RDN_ATTRIBUTE
static String	REFERRAL
static String	SECURITY_AUTHENTICATION
static String	SECURITY_CREDENTIALS
static String	SECURITY_PRINCIPAL
static String	SECURITY_PROTOCOL

Constructor Summary

LDAPServerContext(Hashtable ldapServerProperties)
This constructor creates a LDAPServerContext instance using the configuration settings in the hashtable.

Method Summary

void	close() This method closes the connection to the server
void	create(String rdn, Attributes attrs) This method creates a new entry in the context with the specified attributes
Attributes	get(String rdn) This method retrieves the attributes of an existing entry
String	getDn(String rdn) This method gets the fully qualified distinguished name of the specified object
DirContext	getJndiContext() This method gets a reference to the JNDI context for this connection
Object	getProperty(String name) This method gets a property setting for this context
Enumeration	list() This method lists the names of all the entries in this context
void	open() This method opens a connection with the LDAP server
void	putProperty(String name, Object value) This method updates or adds a property setting in this context
void	remove(String rdn) This method removes an entry from the context
NamingEnumeration	search(String filter, Object[] filterArgs) This method searches for objects matching the specified filter, in the current context and in all sub-contexts.
String	toString() This method converts this context to a string representation.
void	update(String rdn, Attributes attrs) This method updates the attributes of an existing entry

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PROVIDER_URL

public static final String PROVIDER_URL

See Also:

Constant Field Values

INITIAL_CONTEXT_FACTORY

public static final String INITIAL_CONTEXT_FACTORY

See Also:

Constant Field Values

SECURITY_AUTHENTICATION

public static final String SECURITY_AUTHENTICATION

See Also:

Constant Field Values

SECURITY_PRINCIPAL

public static final String SECURITY_PRINCIPAL

See Also:

Constant Field Values

SECURITY_CREDENTIALS

public static final String SECURITY_CREDENTIALS

See Also:

Constant Field Values

SECURITY_PROTOCOL

public static final String SECURITY_PROTOCOL

See Also:

Constant Field Values

REFERRAL

public static final String REFERRAL

See Also:

Constant Field Values

BASE_DN

public static final String BASE_DN

See Also:

Constant Field Values

CONTEXT_ALIAS

public static final String CONTEXT_ALIAS

See Also:

Constant Field Values

RDN_ATTRIBUTE

public static final String RDN_ATTRIBUTE

See Also:

Constant Field Values

DEFAULT_SEARCH_FILTER

public static final String DEFAULT_SEARCH_FILTER

See Also:

Constant Field Values

DEFAULT_INITIAL_CONTEXT_FACTORY

public static final String DEFAULT_INITIAL_CONTEXT_FACTORY

See Also:

Constant Field Values

Constructor Detail

LDAPServerContext

public LDAPServerContext(Hashtable ldapServerProperties)

This constructor creates a LDAPServerContext instance using the configuration settings in the hashtable. The required values are described in the documentation for this class

Parameters:

ldapServerProperties - Hashtable containing the configuration information

Method Detail

close

public void close()
           throws NamingException

This method closes the connection to the server

Throws:

NamingException - if an error occurs

create

public void create(String rdn,
                   Attributes attrs)
            throws NamingException

This method creates a new entry in the context with the specified attributes

Parameters:

rdn - Relative Distinguished Name of the new entry

attrs - Attributes of the new entry

Throws:

NamingException - if the entry cannot be created

get

public Attributes get(String rdn)
               throws NamingException

This method retrieves the attributes of an existing entry

Parameters:

rdn - String Relative Distinguished Name of the entry to retrieve

Returns:

Attributes of the entry

Throws:

NamingException - if the entry cannot be rerieved

getDn

public String getDn(String rdn)
             throws NamingException

This method gets the fully qualified distinguished name of the specified object

Parameters:

rdn - String Relative distinguished name of the object

Returns:

String containing the dn of the object

Throws:

NamingException - on error

getJndiContext

public DirContext getJndiContext()
                          throws NamingException

This method gets a reference to the JNDI context for this connection

Throws:

NamingException

getProperty

public Object getProperty(String name)

This method gets a property setting for this context

Parameters:

name - String Name of the property to retrieve

Returns:

reference to the requested property, null if the property does not exist

list

public Enumeration list()
                 throws NamingException

This method lists the names of all the entries in this context

Returns:

Enumeration of Strings containing the rdns of all entrys in this context

Throws:

NamingException - on error

open

public void open()
          throws NamingException

This method opens a connection with the LDAP server

Throws:

NamingException - if the connection cannot be opened

putProperty

public void putProperty(String name,
                        Object value)
                 throws NamingException

This method updates or adds a property setting in this context

Parameters:

name - Name of the property to add/update

value - Value of the property

Throws:

NamingException - if an error occurs

remove

public void remove(String rdn)
            throws NamingException

This method removes an entry from the context

Parameters:

rdn - Relative Distinguished Name of the entry to remove

Throws:

NamingException - on error

search

public NamingEnumeration search(String filter,
                                Object[] filterArgs)
                         throws NamingException,
                                InvalidSearchFilterException

This method searches for objects matching the specified filter, in the current context and in all sub-contexts. Returns an Enumeration of SearchResults

Throws:

NamingException

InvalidSearchFilterException

toString

public String toString()

This method converts this context to a string representation. For information purposes only

Overrides:

toString in class Object

update

public void update(String rdn,
                   Attributes attrs)
            throws NamingException

This method updates the attributes of an existing entry

Parameters:

rdn - Relative Distinguished Name of the entry to update

attrs - The attributes to update

Throws:

NamingException - on error