org.mule.module.ldap.api

Class LDAPConnection

java.lang.Object

org.mule.module.ldap.api.LDAPConnection

All Implemented Interfaces:

LDAPSchemaAware

Direct Known Subclasses:

LDAPJNDIConnection

public abstract class LDAPConnection
extends Object
implements LDAPSchemaAware

This class is the abstraction

Author:

mariano

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTHENTICATION_ATTR
protected static Map<String,Class<?>>	CONNECTION_IMPLEMENTATIONS
static String	CONNECTION_TYPE_ATTR
static boolean	DEFAULT_SCHEMA_ENABLED
static boolean	DEFAULT_TLS_ENABLED
static String	INITIAL_POOL_CONNECTIONS_ATTR
static String	LDAP_URL_ATTR
static String	MAX_POOL_CONNECTIONS_ATTR
static String	NO_AUTHENTICATION
static String	POOL_TIMEOUT_ATTR
static String	REFERRAL_ATTR
static String	SCHEMA_ENABLED
static String	SIMPLE_AUTHENTICATION
static String	TLS_ENABLED

Constructor Summary

Constructors

Constructor and Description
LDAPConnection()

Method Summary

Modifier and Type	Method and Description
abstract void	addAttribute(String dn, LDAPEntryAttribute attribute)
abstract void	addEntry(LDAPEntry entry)
abstract void	bind(String dn, String password)
abstract void	close()
abstract void	deleteAttribute(String dn, LDAPEntryAttribute attribute) Deletes the attribute or the value of the attribute.
abstract void	deleteEntry(LDAPEntry entry)
abstract void	deleteEntry(String dn)
abstract String	getBindedUserDn()
static LDAPConnection	getConnection(Map<String,String> conf)
static LDAPConnection	getConnection(String type, String url, String authentication, String referral, Map<String,String> extendedConf, boolean schemaEnabled)
static LDAPConnection	getConnection(String type, String url, String authentication, String referral, Map<String,String> extendedConf, boolean schemaEnabled, boolean tlsEnabled)
protected abstract void	initialize(Map<String,String> conf)
abstract boolean	isClosed()
boolean	isSchemaEnabled()
boolean	isTlsEnabled()
abstract LDAPEntry	lookup(String dn)
abstract LDAPEntry	lookup(String dn, String[] attributes) Returns the LDAP entry matching the given dn.
abstract void	rebind()
abstract void	renameEntry(String oldDn, String newDn)
abstract LDAPResultSet	search(String baseDn, String filter, LDAPSearchControls controls)
abstract LDAPResultSet	search(String baseDn, String filter, Object[] filterArgs, LDAPSearchControls controls)
abstract void	setAuthentication(String authentication)
void	setSchemaEnabled(boolean schemaEnabled)
void	setTlsEnabled(boolean tlsEnabled)
abstract void	setTrustStore(String trustStorePath)
abstract void	setTrustStorePassword(String trustStorePassword)
abstract void	updateAttribute(String dn, LDAPEntryAttribute attribute)
abstract void	updateEntry(LDAPEntry entry)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.module.ldap.api.LDAPSchemaAware

getAllObjectClasses, getAttributeTypeDefinition, getObjectClassDefinition

Field Detail

DEFAULT_SCHEMA_ENABLED

public static final boolean DEFAULT_SCHEMA_ENABLED

See Also:

Constant Field Values

DEFAULT_TLS_ENABLED

public static final boolean DEFAULT_TLS_ENABLED

See Also:

Constant Field Values

CONNECTION_IMPLEMENTATIONS

protected static final Map<String,Class<?>> CONNECTION_IMPLEMENTATIONS

NO_AUTHENTICATION

public static final String NO_AUTHENTICATION

See Also:

Constant Field Values

SIMPLE_AUTHENTICATION

public static final String SIMPLE_AUTHENTICATION

See Also:

Constant Field Values

CONNECTION_TYPE_ATTR

public static final String CONNECTION_TYPE_ATTR

See Also:

Constant Field Values

LDAP_URL_ATTR

public static final String LDAP_URL_ATTR

See Also:

Constant Field Values

AUTHENTICATION_ATTR

public static final String AUTHENTICATION_ATTR

See Also:

Constant Field Values

INITIAL_POOL_CONNECTIONS_ATTR

public static final String INITIAL_POOL_CONNECTIONS_ATTR

See Also:

Constant Field Values

MAX_POOL_CONNECTIONS_ATTR

public static final String MAX_POOL_CONNECTIONS_ATTR

See Also:

Constant Field Values

POOL_TIMEOUT_ATTR

public static final String POOL_TIMEOUT_ATTR

See Also:

Constant Field Values

REFERRAL_ATTR

public static final String REFERRAL_ATTR

See Also:

Constant Field Values

SCHEMA_ENABLED

public static final String SCHEMA_ENABLED

See Also:

Constant Field Values

TLS_ENABLED

public static final String TLS_ENABLED

See Also:

Constant Field Values

Constructor Detail

LDAPConnection

public LDAPConnection()

Method Detail

getConnection

public static LDAPConnection getConnection(String type,
                                           String url,
                                           String authentication,
                                           String referral,
                                           Map<String,String> extendedConf,
                                           boolean schemaEnabled,
                                           boolean tlsEnabled)
                                    throws LDAPException

Throws:

LDAPException

getConnection

public static LDAPConnection getConnection(String type,
                                           String url,
                                           String authentication,
                                           String referral,
                                           Map<String,String> extendedConf,
                                           boolean schemaEnabled)
                                    throws LDAPException

Throws:

LDAPException

getConnection

public static LDAPConnection getConnection(Map<String,String> conf)
                                    throws LDAPException

Returns:

LDAPConnection

Throws:

LDAPException

initialize

protected abstract void initialize(Map<String,String> conf)
                            throws LDAPException

Parameters:

conf - Configurations

Throws:

LDAPException

bind

public abstract void bind(String dn,
                          String password)
                   throws LDAPException

Parameters:

dn - Distinguished Name

password - Password

Throws:

LDAPException

rebind

public abstract void rebind()
                     throws LDAPException

Throws:

LDAPException

search

public abstract LDAPResultSet search(String baseDn,
                                     String filter,
                                     Object[] filterArgs,
                                     LDAPSearchControls controls)
                              throws LDAPException

Parameters:

baseDn - Base Distinguished Name

filter - Filter

filterArgs - Filter Arguments

controls - LDAP Search Controls

Returns:

LDAPResultSet

Throws:

LDAPException

getBindedUserDn

public abstract String getBindedUserDn()
                                throws LDAPException

Returns:

String

Throws:

LDAPException

search

public abstract LDAPResultSet search(String baseDn,
                                     String filter,
                                     LDAPSearchControls controls)
                              throws LDAPException

Parameters:

baseDn - Base Distinguished Name

filter - Filter

controls - LDAP Search Controls

Returns:

LDAPResultSet

Throws:

LDAPException

lookup

public abstract LDAPEntry lookup(String dn)
                          throws LDAPException

Parameters:

dn - Distinguished Name

Returns:

LDAPEntry

Throws:

LDAPException

renameEntry

public abstract void renameEntry(String oldDn,
                                 String newDn)
                          throws LDAPException

Parameters:

oldDn - Old Distinguished Name

newDn - New Distinguished Name

Throws:

LDAPException

lookup

public abstract LDAPEntry lookup(String dn,
                                 String[] attributes)
                          throws LDAPException

Returns the LDAP entry matching the given dn. The entry will contain only the defined attributes.

Parameters:

dn - Distinguished Name

attributes - Attributes names to fetch.

Returns:

LDAPEntry

Throws:

LDAPException

addEntry

public abstract void addEntry(LDAPEntry entry)
                       throws LDAPException

Parameters:

entry - LDAPEntry

Throws:

LDAPException

updateEntry

public abstract void updateEntry(LDAPEntry entry)
                          throws LDAPException

Parameters:

entry - LDAPEntry

Throws:

LDAPException

deleteEntry

public abstract void deleteEntry(LDAPEntry entry)
                          throws LDAPException

Parameters:

entry - LDAPEntry

Throws:

LDAPException

deleteEntry

public abstract void deleteEntry(String dn)
                          throws LDAPException

Parameters:

dn - Distinguished Name

Throws:

LDAPException

addAttribute

public abstract void addAttribute(String dn,
                                  LDAPEntryAttribute attribute)
                           throws LDAPException

Parameters:

dn - Distinguished Name

attribute - Attribute

Throws:

LDAPException

updateAttribute

public abstract void updateAttribute(String dn,
                                     LDAPEntryAttribute attribute)
                              throws LDAPException

Parameters:

dn - Distinguished Name

attribute - Attribute

Throws:

LDAPException

deleteAttribute

public abstract void deleteAttribute(String dn,
                                     LDAPEntryAttribute attribute)
                              throws LDAPException

Deletes the attribute or the value of the attribute.

Parameters:

dn - Distinguished Name

attribute - Attribute

Throws:

LDAPException

close

public abstract void close()
                    throws LDAPException

Throws:

LDAPException

isClosed

public abstract boolean isClosed()
                          throws LDAPException

Returns:

boolean

Throws:

LDAPException

isSchemaEnabled

public boolean isSchemaEnabled()

Specified by:

isSchemaEnabled in interface LDAPSchemaAware

Returns:

true if the schema is enabled and should be used

setSchemaEnabled

public void setSchemaEnabled(boolean schemaEnabled)

isTlsEnabled

public boolean isTlsEnabled()

setTlsEnabled

public void setTlsEnabled(boolean tlsEnabled)

setAuthentication

public abstract void setAuthentication(String authentication)

setTrustStore

public abstract void setTrustStore(String trustStorePath)

setTrustStorePassword

public abstract void setTrustStorePassword(String trustStorePassword)