public class

LDAPJNDIConnection

extends LDAPConnection
java.lang.Object
   ↳ org.mule.module.ldap.ldap.api.LDAPConnection
     ↳ org.mule.module.ldap.ldap.api.jndi.LDAPJNDIConnection

Class Overview

This class is the abstraction

Summary

Constants
String AUTHENTICATION_ENV_PARAM
String DEFAULT_INITIAL_CONTEXT_FACTORY
int DEFAULT_INITIAL_POOL_CONNECTIONS
int DEFAULT_MAX_POOL_CONNECTIONS
long DEFAULT_POOL_TIMEOUT
String DEFAULT_REFERRAL
boolean IGNORE_CASE
String INITIAL_CONTEXT_FACTORY_ATTR
String INIT_POOL_SIZE_ENV_PARAM
String MAX_POOL_SIZE_ENV_PARAM
String POOL_ENABLED_ENV_PARAM Final constants for managing JNDI Pool connections.
String TIME_OUT_ENV_PARAM
[Expand]
Inherited Constants
From class org.mule.module.ldap.ldap.api.LDAPConnection
Fields
private String authentication
private LdapContext conn
private Map<String, String> extendedEnvironment
private String initialContextFactory
private int initialPoolSizeConnections
private int maxPoolConnections
private long poolTimeout
private String providerUrl
private String referral
[Expand]
Inherited Fields
From class org.mule.module.ldap.ldap.api.LDAPConnection
Public Constructors
LDAPJNDIConnection()
LDAPJNDIConnection(String providerUrl)
LDAPJNDIConnection(String providerUrl, String initialContextFactory)
LDAPJNDIConnection(String providerUrl, String initialContextFactory, String authentication, int maxPoolConnections, int initialPoolSizeConnections, long poolTimeout)
LDAPJNDIConnection(String providerUrl, String initialContextFactory, String authentication)
Public Methods
void addAttribute(String dn, LDAPEntryAttribute attribute)
void addEntry(LDAPEntry entry)
void bind(String dn, String password)
void close()
void deleteAttribute(String dn, LDAPEntryAttribute attribute)
Deletes the attribute or the value of the attribute.
void deleteEntry(LDAPEntry entry)
void deleteEntry(String dn)
String getAuthentication()
String getBindedUserDn()
@return
String getInitialContextFactory()
int getInitialPoolSizeConnections()
int getMaxPoolConnections()
long getPoolTimeout()
String getProviderUrl()
String getReferral()
boolean isClosed()
@return
boolean isConnectionPoolEnabled()
boolean isNoAuthentication()
LDAPEntry lookup(String dn)
@return
LDAPEntry lookup(String dn, String[] attributes)
@return
void rebind()
void renameEntry(String oldDn, String newDn)
LDAPResultSet search(String baseDn, String filter, Object[] filterArgs, LDAPSearchControls controls)
@return
LDAPResultSet search(String baseDn, String filter, LDAPSearchControls controls)
@return
void setAuthentication(String authentication)
void setInitialContextFactory(String initialContextFactory)
void setInitialPoolSizeConnections(int initialPoolSizeConnections)
void setMaxPoolConnections(int maxPoolConnections)
void setPoolTimeout(long poolTimeout)
void setProviderUrl(String provider)
void setReferral(String referral)
void updateAttribute(String dn, LDAPEntryAttribute attribute)
void updateEntry(LDAPEntry entry)
Protected Methods
void initialize(Map<String, String> conf)
[Expand]
Inherited Methods
From class org.mule.module.ldap.ldap.api.LDAPConnection
From class java.lang.Object

Constants

private static final String AUTHENTICATION_ENV_PARAM

Constant Value: "com.sun.jndi.ldap.pool.authentication"

public static final String DEFAULT_INITIAL_CONTEXT_FACTORY

Constant Value: "com.sun.jndi.ldap.LdapCtxFactory"

public static final int DEFAULT_INITIAL_POOL_CONNECTIONS

Constant Value: 0 (0x00000000)

public static final int DEFAULT_MAX_POOL_CONNECTIONS

Constant Value: 0 (0x00000000)

public static final long DEFAULT_POOL_TIMEOUT

Constant Value: 0 (0x0000000000000000)

public static final String DEFAULT_REFERRAL

Constant Value: "ignore"

private static final boolean IGNORE_CASE

Constant Value: true

private static final String INITIAL_CONTEXT_FACTORY_ATTR

Constant Value: "initialContextFactory"

private static final String INIT_POOL_SIZE_ENV_PARAM

Constant Value: "com.sun.jndi.ldap.connect.pool.initsize"

private static final String MAX_POOL_SIZE_ENV_PARAM

Constant Value: "com.sun.jndi.ldap.connect.pool.maxsize"

private static final String POOL_ENABLED_ENV_PARAM

Final constants for managing JNDI Pool connections.

Constant Value: "com.sun.jndi.ldap.connect.pool"

private static final String TIME_OUT_ENV_PARAM

Constant Value: "com.sun.jndi.ldap.connect.pool.timeout"

Fields

private String authentication

private LdapContext conn

private Map<String, String> extendedEnvironment

private String initialContextFactory

private int initialPoolSizeConnections

private int maxPoolConnections

private long poolTimeout

private String providerUrl

private String referral

Public Constructors

public LDAPJNDIConnection ()

public LDAPJNDIConnection (String providerUrl)

Parameters
providerUrl
Throws
LDAPException

public LDAPJNDIConnection (String providerUrl, String initialContextFactory)

Parameters
providerUrl
initialContextFactory
Throws
LDAPException

public LDAPJNDIConnection (String providerUrl, String initialContextFactory, String authentication, int maxPoolConnections, int initialPoolSizeConnections, long poolTimeout)

Parameters
providerUrl
initialContextFactory
authentication
maxPoolConnections
initialPoolSizeConnections
poolTimeout
Throws
LDAPException

public LDAPJNDIConnection (String providerUrl, String initialContextFactory, String authentication)

Parameters
providerUrl
initialContextFactory
authentication
Throws
LDAPException

Public Methods

public void addAttribute (String dn, LDAPEntryAttribute attribute)

Parameters
dn
attribute
Throws
LDAPException
See Also

public void addEntry (LDAPEntry entry)

Parameters
entry
Throws
LDAPException
See Also

public void bind (String dn, String password)

Parameters
dn
password
Throws
LDAPException
See Also

public void close ()

Throws
LDAPException
See Also

public void deleteAttribute (String dn, LDAPEntryAttribute attribute)

Deletes the attribute or the value of the attribute.

Parameters
dn
attribute
Throws
LDAPException
See Also

public void deleteEntry (LDAPEntry entry)

Parameters
entry
Throws
LDAPException
See Also

public void deleteEntry (String dn)

Parameters
dn
Throws
LDAPException
See Also

public String getAuthentication ()

Returns
  • Returns the authentication.

public String getBindedUserDn ()

@return

Throws
LDAPException

public String getInitialContextFactory ()

Returns
  • Returns the initialContextFactory.

public int getInitialPoolSizeConnections ()

Returns
  • Returns the initialPoolSizeConnections.

public int getMaxPoolConnections ()

Returns
  • Returns the maxPoolConnections.

public long getPoolTimeout ()

Returns
  • Returns the poolTimeout.

public String getProviderUrl ()

Returns
  • Returns the providerUrl.

public String getReferral ()

public boolean isClosed ()

@return

See Also

public boolean isConnectionPoolEnabled ()

public boolean isNoAuthentication ()

public LDAPEntry lookup (String dn)

@return

Parameters
dn
Throws
LDAPException
See Also

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

@return

Parameters
dn
attributes Attributes names to fetch.
Throws
LDAPException
See Also

public void rebind ()

Throws
LDAPException
See Also

public void renameEntry (String oldDn, String newDn)

Parameters
oldDn
newDn
Throws
LDAPException
See Also

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

@return

Parameters
baseDn
filter
filterArgs
controls
Throws
LDAPException
See Also

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

@return

Parameters
baseDn
filter
controls
Throws
LDAPException
See Also

public void setAuthentication (String authentication)

Parameters
authentication The authentication to set.

public void setInitialContextFactory (String initialContextFactory)

Parameters
initialContextFactory The initialContextFactory to set.

public void setInitialPoolSizeConnections (int initialPoolSizeConnections)

Parameters
initialPoolSizeConnections The initialPoolSizeConnections to set.

public void setMaxPoolConnections (int maxPoolConnections)

Parameters
maxPoolConnections The maxPoolConnections to set.

public void setPoolTimeout (long poolTimeout)

Parameters
poolTimeout The poolTimeout to set.

public void setProviderUrl (String provider)

Parameters
provider

public void setReferral (String referral)

Parameters
referral

public void updateAttribute (String dn, LDAPEntryAttribute attribute)

Parameters
dn
attribute
Throws
LDAPException
See Also

public void updateEntry (LDAPEntry entry)

Parameters
entry
Throws
LDAPException
See Also

Protected Methods

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

Parameters
conf
Throws
LDAPException
See Also
  • org.mule.module.ldap.ldap.api.LDAPConnection#initialize(leonards.common.conf.Configuration)