org.picketlink.idm.ldap.internal

Class LDAPOperationManager

java.lang.Object

org.picketlink.idm.ldap.internal.LDAPOperationManager

public class LDAPOperationManager
extends Object

This class provides a set of operations to manage LDAP trees.

A different DirContext is used to perform authentication. The reason is that while managing the ldap tree information bindings are not allowed. Also, instead of creating a new DirContext each time we reuse it.

Author:

Anil Saldhana, Pedro Silva

Constructor Summary

Constructors

Constructor and Description
LDAPOperationManager(org.picketlink.idm.config.LDAPIdentityStoreConfiguration config)

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttribute(String dn, Attribute attribute) Adds the given Attribute instance using the given DN.
boolean	authenticate(String dn, String password) Performs a simple authentication using the ginve DN and password to bind to the authentication context.
void	bind(String dn, Object object) Binds a Object to the LDAP tree.
boolean	checkAttributePresence(String attributeName) Ask the ldap server for the schema for the attribute.
void	createSubContext(String name, Attributes attributes)
void	destroyRecursively(String dn)
void	destroySubcontext(String dn) Destroys a subcontext with the given DN from the LDAP tree.
boolean	isManagedAttribute(String attributeName) Checks if the attribute with the given name is a managed attributes.
<T> T	lookup(String dn) Looks up a entry on the LDAP tree with the given DN.
NamingEnumeration<SearchResult>	lookupById(String baseDN, String id)
void	modifyAttribute(String dn, Attribute attribute) Modifies the given Attribute instance using the given DN.
void	rebind(String dn, Object object) Re-binds a Object to the LDAP tree.
void	removeAttribute(String dn, Attribute attribute) Removes the given Attribute instance using the given DN.
<T> List<T>	removeEntryById(String baseDN, String id) Searches the LDAP tree.
NamingEnumeration<SearchResult>	search(String baseDN, String filter)
NamingEnumeration<SearchResult>	search(String baseDN, String filter, String[] attributesToReturn, SearchControls searchControls) Searches the LDAP tree.

Methods inherited from class java.lang.Object

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

Constructor Detail

LDAPOperationManager

public LDAPOperationManager(org.picketlink.idm.config.LDAPIdentityStoreConfiguration config)
                     throws NamingException

Throws:

NamingException

Method Detail

bind

public void bind(String dn,
        Object object)

Binds a Object to the LDAP tree.

Parameters:

ldapUser -

modifyAttribute

public void modifyAttribute(String dn,
                   Attribute attribute)

Modifies the given Attribute instance using the given DN. This method performs a REPLACE_ATTRIBUTE operation.

Parameters:

dn -

attribute -

removeAttribute

public void removeAttribute(String dn,
                   Attribute attribute)

Removes the given Attribute instance using the given DN. This method performs a REMOVE_ATTRIBUTE operation.

Parameters:

dn -

attribute -

addAttribute

public void addAttribute(String dn,
                Attribute attribute)

Adds the given Attribute instance using the given DN. This method performs a ADD_ATTRIBUTE operation.

Parameters:

dn -

attribute -

rebind

public void rebind(String dn,
          Object object)

Re-binds a Object to the LDAP tree.

Parameters:

dn -

object -

lookup

public <T> T lookup(String dn)

Looks up a entry on the LDAP tree with the given DN.

Parameters:

dn -

Returns:

Throws:

NamingException

removeEntryById

public <T> List<T> removeEntryById(String baseDN,
                          String id)

Searches the LDAP tree.

Parameters:

baseDN -

attributesToSearch -

Returns:

search

public NamingEnumeration<SearchResult> search(String baseDN,
                                     String filter,
                                     String[] attributesToReturn,
                                     SearchControls searchControls)

Searches the LDAP tree.

Parameters:

baseDN -

filter -

attributesToReturn -

searchControls -

Returns:

search

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

Throws:

NamingException

lookupById

public NamingEnumeration<SearchResult> lookupById(String baseDN,
                                         String id)

destroySubcontext

public void destroySubcontext(String dn)

Destroys a subcontext with the given DN from the LDAP tree.

Parameters:

dn -

destroyRecursively

public void destroyRecursively(String dn)

isManagedAttribute

public boolean isManagedAttribute(String attributeName)

Checks if the attribute with the given name is a managed attributes. Managed attributes are the ones defined in the underlying schema or those defined in the managed attribute list.

Parameters:

attributeName -

Returns:

checkAttributePresence

public boolean checkAttributePresence(String attributeName)

Ask the ldap server for the schema for the attribute.

Parameters:

attributeName -

Returns:

authenticate

public boolean authenticate(String dn,
                   String password)

Performs a simple authentication using the ginve DN and password to bind to the authentication context.

Parameters:

dn -

password -

Returns:

createSubContext

public void createSubContext(String name,
                    Attributes attributes)