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.

Author:

Anil Saldhana, Pedro Silva

Constructor Summary

Constructors

Constructor and Description
LDAPOperationManager(LDAPIdentityStoreConfiguration config)

Method Summary

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	createSubContext(String name, Attributes attributes)
String	decodeEntryUUID(Object entryUUID)
Attributes	getAttributes(String entryUUID, String baseDN, LDAPMappingConfiguration mappingConfiguration)
String	getFilterById(String baseDN, String id)
SearchResult	lookupById(String baseDN, String id, LDAPMappingConfiguration mappingConfiguration)
void	modifyAttribute(String dn, Attribute attribute) Modifies the given Attribute instance using the given DN.
void	modifyAttributes(String dn, NamingEnumeration<Attribute> attributes) Modifies the given Attribute instances using the given DN.
void	removeAttribute(String dn, Attribute attribute) Removes the given Attribute instance using the given DN.
void	removeEntryById(String baseDN, String id, LDAPMappingConfiguration mappingConfiguration) Searches the LDAP tree.
List<SearchResult>	search(String baseDN, String filter, LDAPMappingConfiguration mappingConfiguration)
<V extends IdentityType> List<SearchResult>	searchPaginated(String baseDN, String filter, LDAPMappingConfiguration mappingConfiguration, IdentityQuery<V> identityQuery)

Methods inherited from class java.lang.Object

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

Constructor Detail

LDAPOperationManager

public LDAPOperationManager(LDAPIdentityStoreConfiguration config)
                     throws NamingException

Throws:

NamingException

Method Detail

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 -

modifyAttributes

public void modifyAttributes(String dn,
                             NamingEnumeration<Attribute> attributes)

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

Parameters:

dn -

attributes -

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 -

removeEntryById

public void removeEntryById(String baseDN,
                            String id,
                            LDAPMappingConfiguration mappingConfiguration)

Searches the LDAP tree.

Parameters:

baseDN -

id -

search

public List<SearchResult> search(String baseDN,
                                 String filter,
                                 LDAPMappingConfiguration mappingConfiguration)
                          throws NamingException

Throws:

NamingException

searchPaginated

public <V extends IdentityType> List<SearchResult> searchPaginated(String baseDN,
                                                                   String filter,
                                                                   LDAPMappingConfiguration mappingConfiguration,
                                                                   IdentityQuery<V> identityQuery)
                                                            throws NamingException

Throws:

NamingException

getFilterById

public String getFilterById(String baseDN,
                            String id)

lookupById

public SearchResult lookupById(String baseDN,
                               String id,
                               LDAPMappingConfiguration mappingConfiguration)

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)

getAttributes

public Attributes getAttributes(String entryUUID,
                                String baseDN,
                                LDAPMappingConfiguration mappingConfiguration)

decodeEntryUUID

public String decodeEntryUUID(Object entryUUID)