public abstract class

LDAPConnection

extends Object
java.lang.Object
   ↳ org.mule.module.ldap.ldap.api.LDAPConnection
Known Direct Subclasses

Class Overview

This class is the abstraction

Summary

Constants
String AUTHENTICATION_ATTR
String CONNECTION_TYPE_ATTR
String INITIAL_POOL_CONNECTIONS_ATTR
String LDAP_URL_ATTR
String MAX_POOL_CONNECTIONS_ATTR
String NO_AUTHENTICATION
String POOL_TIMEOUT_ATTR
String REFERRAL_ATTR
String SIMPLE_AUTHENTICATION
Fields
protected static final Map<String, Class<?>> CONNECTION_IMPLEMENTATIONS
protected final Log logger
private String name
Public Constructors
LDAPConnection()
Public Methods
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()
@return
static LDAPConnection getConnection(String type, String url, String authentication, int initialPoolSize, int maxPoolSize, long poolTimeout, String referral, Map<String, String> extendedConf)
static LDAPConnection getConnection(String type, String url, String authentication, Map<String, String> extendedConf)
static LDAPConnection getConnection(String type, String url, String authentication)
static LDAPConnection getConnection(String type, String url, String authentication, int initialPoolSize, int maxPoolSize, long poolTimeout, String referral)
static LDAPConnection getConnection(Map<String, String> conf)
@return
String getName()
abstract boolean isClosed()
@return
abstract LDAPEntry lookup(String dn)
@return
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, Object[] filterArgs, LDAPSearchControls controls)
@return
abstract LDAPResultSet search(String baseDn, String filter, LDAPSearchControls controls)
@return
void setName(String name)
abstract void updateAttribute(String dn, LDAPEntryAttribute attribute)
abstract void updateEntry(LDAPEntry entry)
Protected Methods
abstract void initialize(Map<String, String> conf)
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String AUTHENTICATION_ATTR

Constant Value: "authentication"

public static final String CONNECTION_TYPE_ATTR

Constant Value: "type"

public static final String INITIAL_POOL_CONNECTIONS_ATTR

Constant Value: "initialPoolSize"

public static final String LDAP_URL_ATTR

Constant Value: "url"

public static final String MAX_POOL_CONNECTIONS_ATTR

Constant Value: "maxPoolSize"

public static final String NO_AUTHENTICATION

Constant Value: "none"

public static final String POOL_TIMEOUT_ATTR

Constant Value: "poolTimeout"

public static final String REFERRAL_ATTR

Constant Value: "referral"

public static final String SIMPLE_AUTHENTICATION

Constant Value: "simple"

Fields

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

protected final Log logger

private String name

Public Constructors

public LDAPConnection ()

Public Methods

public abstract void addAttribute (String dn, LDAPEntryAttribute attribute)

Parameters
dn
attribute
Throws
LDAPException

public abstract void addEntry (LDAPEntry entry)

Parameters
entry
Throws
LDAPException

public abstract void bind (String dn, String password)

Parameters
dn
password
Throws
LDAPException

public abstract void close ()

Throws
LDAPException

public abstract void deleteAttribute (String dn, LDAPEntryAttribute attribute)

Deletes the attribute or the value of the attribute.

Parameters
dn
attribute
Throws
LDAPException

public abstract void deleteEntry (LDAPEntry entry)

Parameters
entry
Throws
LDAPException

public abstract void deleteEntry (String dn)

Parameters
dn
Throws
LDAPException

public abstract String getBindedUserDn ()

@return

Throws
LDAPException

public static LDAPConnection getConnection (String type, String url, String authentication, int initialPoolSize, int maxPoolSize, long poolTimeout, String referral, Map<String, String> extendedConf)

Parameters
type
url
authentication
initialPoolSize
maxPoolSize
poolTimeout
referral
extendedConf
Throws
LDAPException

public static LDAPConnection getConnection (String type, String url, String authentication, Map<String, String> extendedConf)

Parameters
type
url
authentication
extendedConf
Throws
LDAPException

public static LDAPConnection getConnection (String type, String url, String authentication)

Parameters
type
url
authentication
Throws
LDAPException

public static LDAPConnection getConnection (String type, String url, String authentication, int initialPoolSize, int maxPoolSize, long poolTimeout, String referral)

Parameters
type
url
authentication
initialPoolSize
maxPoolSize
poolTimeout
referral
Throws
LDAPException

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

@return

Parameters
conf
Throws
LDAPException

public String getName ()

public abstract boolean isClosed ()

@return

Throws
LDAPException

public abstract LDAPEntry lookup (String dn)

@return

Parameters
dn
Throws
LDAPException

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

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

Parameters
dn
attributes Attributes names to fetch.
Throws
LDAPException

public abstract void rebind ()

Throws
LDAPException

public abstract void renameEntry (String oldDn, String newDn)

Parameters
oldDn
newDn
Throws
LDAPException

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

@return

Parameters
baseDn
filter
filterArgs
controls
Throws
LDAPException

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

@return

Parameters
baseDn
filter
controls
Throws
LDAPException

public void setName (String name)

Parameters
name

public abstract void updateAttribute (String dn, LDAPEntryAttribute attribute)

Parameters
dn
attribute
Throws
LDAPException

public abstract void updateEntry (LDAPEntry entry)

Parameters
entry
Throws
LDAPException

Protected Methods

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

Parameters
conf
Throws
LDAPException