com.nimbusds.infinispan.persistence.ldap.backend

Class LDAPConnector

java.lang.Object

com.nimbusds.infinispan.persistence.ldap.backend.LDAPConnector

@ThreadSafe
public class LDAPConnector
extends Object

LDAP connector to the backend directory. Provides retrieval, addition / modify and deletion operations.

Field Summary

Fields

Modifier and Type	Field and Description
static com.unboundid.ldap.sdk.Filter	MATCH_ANY_FILTER Filter that matches any LDAP entry.

Constructor Summary

Constructors

Constructor and Description
LDAPConnector(LDAPStoreConfiguration config, String cacheName, Set<String> attributes, boolean supportAttributeOptions) Creates a new LDAP connector.

Method Summary

Modifier and Type	Method and Description
boolean	addEntry(com.unboundid.ldap.sdk.ReadOnlyEntry entry) Adds the specified entry to the LDAP directory.
int	countEntries() Counts the number of entries under the base DN.
int	deleteEntries() Deletes all entries under the base DN.
boolean	deleteEntry(com.unboundid.ldap.sdk.DN dn) Deletes the specified entry from the LDAP directory.
boolean	entryExists(com.unboundid.ldap.sdk.DN dn) Checks that the specified entry exists in the LDAP directory.
com.unboundid.ldap.sdk.LDAPConnectionPool	getPool() Returns the underlying LDAP connection pool.
protected static boolean	indicatesConnectionException(com.unboundid.ldap.sdk.LDAPException e) Checks if the specified LDAP exception is caused by the LDAP server being unavailable, disconnected or timing out.
protected static boolean	indicatesConnectionException(com.unboundid.ldap.sdk.ResultCode code) Checks if the specified LDAP result code indicates the LDAP server is unavailable, disconnected or timing out.
boolean	replaceEntry(com.unboundid.ldap.sdk.ReadOnlyEntry entry) Replaces the specified entry in the LDAP directory.
void	retrieveEntries(com.nimbusds.common.appendable.Appendable<com.unboundid.ldap.sdk.ReadOnlyEntry> appendable) Retrieves all entries from the LDAP directory under the base DN.
com.unboundid.ldap.sdk.ReadOnlyEntry	retrieveEntry(com.unboundid.ldap.sdk.DN dn) Retrieves the specified entry from the LDAP directory.
void	shutdown() Shuts down this LDAP connector by releasing any associated resources (LDAP connection pool).

Methods inherited from class java.lang.Object

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

Field Detail

MATCH_ANY_FILTER

public static final com.unboundid.ldap.sdk.Filter MATCH_ANY_FILTER

Filter that matches any LDAP entry.

Constructor Detail

LDAPConnector

public LDAPConnector(LDAPStoreConfiguration config,
                     String cacheName,
                     Set<String> attributes,
                     boolean supportAttributeOptions)

Creates a new LDAP connector.

Parameters:

config - The LDAP configuration. Must not be null.

cacheName - The name of the Infinispan cache associated with this LDAP connector. Must not be null.

attributes - The names of the supported directory attributes. Must not be empty or null.

supportAttributeOptions - true if any of the supported directory attributes may include options (such as language tags), else false.

Method Detail

getPool

public com.unboundid.ldap.sdk.LDAPConnectionPool getPool()

Returns the underlying LDAP connection pool.

Returns:

The LDAP connection pool.

retrieveEntry

public com.unboundid.ldap.sdk.ReadOnlyEntry retrieveEntry(com.unboundid.ldap.sdk.DN dn)

Retrieves the specified entry from the LDAP directory.

Parameters:

dn - The Distinguished Name (DN) of the entry to retrieve. Must not be null.

Returns:

The matching directory entry, null if not found (or insufficient privileges).

retrieveEntries

public void retrieveEntries(com.nimbusds.common.appendable.Appendable<com.unboundid.ldap.sdk.ReadOnlyEntry> appendable)

Retrieves all entries from the LDAP directory under the base DN.

Parameters:

appendable - Collects the matching directory entries. Must not be null.

entryExists

public boolean entryExists(com.unboundid.ldap.sdk.DN dn)

Checks that the specified entry exists in the LDAP directory.

Parameters:

dn - The Distinguished Name (DN) of the entry to check. Must not be null.

Returns:

true if the entry exists, false if not found (or insufficient privileges).

addEntry

public boolean addEntry(com.unboundid.ldap.sdk.ReadOnlyEntry entry)

Adds the specified entry to the LDAP directory.

Parameters:

entry - The entry to add. Must not be null.

Returns:

true if the entry was added, false if there was a stored entry with that Distinguished Name (DN).

replaceEntry

public boolean replaceEntry(com.unboundid.ldap.sdk.ReadOnlyEntry entry)

Replaces the specified entry in the LDAP directory.

Parameters:

entry - The entry to replace. Must not be null.

Returns:

true if the entry was found, false if there was no stored entry with that Distinguished Name (DN).

deleteEntry

public boolean deleteEntry(com.unboundid.ldap.sdk.DN dn)

Deletes the specified entry from the LDAP directory.

Parameters:

dn - The Distinguished Name (DN) of the entry to delete. Must not be null.

Returns:

true if the matching directory entry was deleted, false if not found (or insufficient privileges).

indicatesConnectionException

protected static boolean indicatesConnectionException(com.unboundid.ldap.sdk.LDAPException e)

Checks if the specified LDAP exception is caused by the LDAP server being unavailable, disconnected or timing out.

Parameters:

e - The LDAP exception. Must not be null.

Returns:

true if the LDAP exception is caused by the LDAP server being unavailable, disconnected or timing out, else false.

indicatesConnectionException

protected static boolean indicatesConnectionException(com.unboundid.ldap.sdk.ResultCode code)

Checks if the specified LDAP result code indicates the LDAP server is unavailable, disconnected or timing out.

Parameters:

code - The LDAP result code. Must not be null.

Returns:

true if the LDAP result code indicates the LDAP server is unavailable, disconnected or timing out, else false.

countEntries

public int countEntries()

Counts the number of entries under the base DN.

Returns:

The entry count.

deleteEntries

public int deleteEntries()

Deletes all entries under the base DN.

Returns:

The number of deleted entries, zero if none found.

shutdown

public void shutdown()

Shuts down this LDAP connector by releasing any associated resources (LDAP connection pool).