Package org.jeegen.jee6.util

Class AbstractLdapConnector

java.lang.Object

org.jeegen.jee6.util.AbstractLdapConnector

public abstract class AbstractLdapConnector
extends Object

This class works as a LDAP connector.

Field Summary

Fields

Modifier and Type	Field	Description
protected DirContext	ctx	The directory context used internally.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractLdapConnector(String url, String dn, String part, String secret)	This constructor initializes a connection to a LDAP server.
protected	AbstractLdapConnector(DirContext context, String dn)	This constructor setups an existing DirContext and the given dn.

Method Summary

Modifier and Type	Method	Description
void	close()	This method closes the LDAP connection.
void	create(String partDn, Attributes attrs)	This method creates a directory entry using the given Attributes.
void	delete(String partDn)	This method deletes a directory entry from the LDAP server.
Attributes	getAttributes(String partDn, String filter)	This method returns the Attributes of a LDAP entry.
Collection<String>	getGroup(String group)	This method returns a Collection of all group members.
protected abstract String	getGroupDn()	This method returns the groups sub DN of this LDAP connection.
String	getSearchBase(String partDn)	Diese Methode baut eine komplette DN zusammen.
Attributes	getUser(String user)	This method returns all Attributes of a user.
protected abstract String	getUserDn()	This method returns the users sub DN of this LDAP connection.
static String	getValue(Attributes attributes, String key)	Diese Methode ermittelt aus Attributen ein mit einem Schlüsselwort definiertes Einfachattribut.
static List<String>	getValues(Attributes attributes, String key)	Diese Methode ermittelt aus Attributen ein mit einem Schlüsselwort definiertes Mehrfachattribut.
void	modify(String partDn, Attributes attributes)	This method modifies the given Attributes inside the given partial DN.
NamingEnumeration<SearchResult>	search(String partDn, String filter)	This method searches for a sub DN inside a LDAP server.
static void	setAttribute(Attributes attributes, String key, Object value)	This method sets an Attribute with the specified key to the given value.
static void	setAttribute(Attributes attributes, String key, String value)	This method sets an Attribute with the specified key to the given String.

Methods inherited from class java.lang.Object

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

Field Detail

ctx

protected DirContext ctx

The directory context used internally.

Constructor Detail

AbstractLdapConnector

protected AbstractLdapConnector(String url,
                                String dn,
                                String part,
                                String secret)
                         throws NamingException

This constructor initializes a connection to a LDAP server. If the user DN and the user secret is not null, the connection is bound with this user credential. The user DN is a sub DN of the base DN and are concatenated internally.

Parameters:

url - URL to the LDAP server

dn - The base DN.

part - The user part of the DN without the base DN.

secret - The user secret.

Throws:

NamingException - on error.

AbstractLdapConnector

protected AbstractLdapConnector(DirContext context,
                                String dn)
                         throws NamingException

This constructor setups an existing DirContext and the given dn.

Parameters:

context - The initialized DirContext

dn - The distinguished name to use.

Throws:

NamingException - on error.

Method Detail

close

public void close()

This method closes the LDAP connection.

getSearchBase

public String getSearchBase(String partDn)

Diese Methode baut eine komplette DN zusammen. Die Basis-DN darf nicht angegeben werden, da sie ja schon mit einer Instanz dieser Klasse verknüpft ist. Es wird also nur eine Sub-DN mit angegeben.

Parameters:

partDn - Die Sub-DN

Returns:

Die komplette DN.

getValue

public static String getValue(Attributes attributes,
                              String key)
                       throws NamingException

Diese Methode ermittelt aus Attributen ein mit einem Schlüsselwort definiertes Einfachattribut.

Parameters:

attributes - Die Attribute

key - Der Attributname

Returns:

Der Attributwert

Throws:

IllegalArgumentException - Falls das Attribut doch ein Mehrfachattribut ist.

NamingException - on error.

getValues

public static List<String> getValues(Attributes attributes,
                                     String key)
                              throws NamingException

Diese Methode ermittelt aus Attributen ein mit einem Schlüsselwort definiertes Mehrfachattribut.

Parameters:

attributes - Die Attribute

key - Der Attributname

Returns:

Eine Liste von Attributwerten.

Throws:

NamingException - on error.

search

public NamingEnumeration<SearchResult> search(String partDn,
                                              String filter)
                                       throws NamingException

This method searches for a sub DN inside a LDAP server. The complete DN is computed using the getSearchBase(String) method.

Parameters:

partDn - The sub DN

filter - The search filter

Returns:

The search results as a NamingEnumeration.

Throws:

NamingException - on error.

See Also:

getSearchBase(String)

getAttributes

public Attributes getAttributes(String partDn,
                                String filter)
                         throws NamingException

This method returns the Attributes of a LDAP entry.

Parameters:

partDn - Ths sub DN of the Attributes

filter - An additional search filter.

Returns:

The Attributes of the search result.

Throws:

NamingException - on error.

getUser

public Attributes getUser(String user)
                   throws NamingException

This method returns all Attributes of a user.

Parameters:

user - The User.

Returns:

The Attributes of the user.

Throws:

NamingException - on error.

getGroup

public Collection<String> getGroup(String group)
                            throws NamingException

This method returns a Collection of all group members.

Parameters:

group - The group name.

Returns:

The Collection of all group members.

Throws:

NamingException - on error.

setAttribute

public static void setAttribute(Attributes attributes,
                                String key,
                                Object value)

This method sets an Attribute with the specified key to the given value. If the Attribute doesn't exist the Attribute is created. If existing it will be modified. The Attribute is not transferred to the LDAP-server. This will be done using the modify(String, Attributes) method.

Parameters:

attributes - The Attributes.

key - The key of the Attribute to change.

value - The value to use.

setAttribute

public static void setAttribute(Attributes attributes,
                                String key,
                                String value)
                         throws UnsupportedEncodingException

This method sets an Attribute with the specified key to the given String. The String ist converted into an UTF-8 byte sequence. If the Attribute doesn't exist the Attribute is created. If existing it will be modified. The Attribute is not transferred to the LDAP-server. This will be done using the modify(String, Attributes) method.

Parameters:

attributes - The Attributes.

key - The key of the Attribute to change.

value - The value to use.

Throws:

UnsupportedEncodingException - on error.

create

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

This method creates a directory entry using the given Attributes.

Parameters:

partDn - The partial DN to create.

attrs - The Attributes to fill in.

Throws:

NamingException - on error.

See Also:

getSearchBase(String)

modify

public void modify(String partDn,
                   Attributes attributes)
            throws NamingException

This method modifies the given Attributes inside the given partial DN. Only the given Attributes are modified. The other Attributes inside the DN are left unmodified.

Parameters:

partDn - The partial DN to modify.

attributes - The modified Attributes.

Throws:

NamingException - on error.

See Also:

getSearchBase(String)

delete

public void delete(String partDn)
            throws NamingException

This method deletes a directory entry from the LDAP server.

Parameters:

partDn - The partial DN to delete.

Throws:

NamingException - on error.

See Also:

getSearchBase(String)

getUserDn

protected abstract String getUserDn()

This method returns the users sub DN of this LDAP connection. The sub tree of this DN contains all users inside the LDAP server. This may be hardcoded into the implementation class.

Returns:

The users sub DN.

getGroupDn

protected abstract String getGroupDn()

This method returns the groups sub DN of this LDAP connection. The sub tree of this DN contains all groups inside the LDAP server. This may be hardcoded into the implementation class.

Returns:

The groups sub DN.