org.mule.module.ldap.api.jndi

Class LDAPJNDIConnection

java.lang.Object

org.mule.module.ldap.api.LDAPConnection

org.mule.module.ldap.api.jndi.LDAPJNDIConnection

All Implemented Interfaces:

LDAPSchemaAware

public class LDAPJNDIConnection
extends LDAPConnection

This class is the abstraction

Author:

mariano

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_INITIAL_CONTEXT_FACTORY
static int	DEFAULT_INITIAL_POOL_CONNECTIONS
static int	DEFAULT_MAX_POOL_CONNECTIONS
static long	DEFAULT_POOL_TIMEOUT
static String	DEFAULT_REFERRAL

Fields inherited from class org.mule.module.ldap.api.LDAPConnection

AUTHENTICATION_ATTR, CONNECTION_IMPLEMENTATIONS, CONNECTION_TYPE_ATTR, DEFAULT_SCHEMA_ENABLED, DEFAULT_TLS_ENABLED, INITIAL_POOL_CONNECTIONS_ATTR, LDAP_URL_ATTR, MAX_POOL_CONNECTIONS_ATTR, NO_AUTHENTICATION, POOL_TIMEOUT_ATTR, REFERRAL_ATTR, SCHEMA_ENABLED, SIMPLE_AUTHENTICATION, TLS_ENABLED

Constructor Summary

Constructors

Constructor and Description
LDAPJNDIConnection() Default Constructor
LDAPJNDIConnection(String providerUrl)
LDAPJNDIConnection(String providerUrl, String initialContextFactory)
LDAPJNDIConnection(String providerUrl, String initialContextFactory, String authentication)
LDAPJNDIConnection(String providerUrl, String initialContextFactory, String authentication, int maxPoolConnections, int initialPoolSizeConnections, long poolTimeout)
LDAPJNDIConnection(String providerUrl, String initialContextFactory, String authentication, int maxPoolConnections, int initialPoolSizeConnections, long poolTimeout, boolean schemaEnabled)

Method Summary

Methods

Modifier and Type	Method and Description
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)
List<String>	getAllObjectClasses()
LDAPEntryAttributeTypeDefinition	getAttributeTypeDefinition(String attributeName)
String	getAuthentication()
String	getBindedUserDn()
String	getInitialContextFactory()
int	getInitialPoolSizeConnections()
int	getMaxPoolConnections()
LDAPEntryObjectClassDefinition	getObjectClassDefinition(String objectClassName)
long	getPoolTimeout()
String	getProviderUrl()
String	getReferral()
protected void	initialize(Map<String,String> conf)
boolean	isClosed()
boolean	isConnectionPoolEnabled()
boolean	isNoAuthentication()
LDAPEntry	lookup(String dn)
LDAPEntry	lookup(String dn, String[] attributes) Returns the LDAP entry matching the given dn.
void	rebind()
void	renameEntry(String oldDn, String newDn)
protected LDAPEntryAttributeTypeDefinition	retrieveAttributeTypeDefinition(String attributeName)
LDAPResultSet	search(String baseDn, String filter, LDAPSearchControls controls)
LDAPResultSet	search(String baseDn, String filter, Object[] filterArgs, LDAPSearchControls controls)
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)
String	toString()
void	updateAttribute(String dn, LDAPEntryAttribute attribute)
void	updateEntry(LDAPEntry entry)

Methods inherited from class org.mule.module.ldap.api.LDAPConnection

getConnection, getConnection, getConnection, getConnection, getConnection, getConnection, getConnection, isSchemaEnabled, isTlsEnabled, setSchemaEnabled, setTlsEnabled

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_POOL_CONNECTIONS

public static final int DEFAULT_MAX_POOL_CONNECTIONS

See Also:

Constant Field Values

DEFAULT_INITIAL_POOL_CONNECTIONS

public static final int DEFAULT_INITIAL_POOL_CONNECTIONS

See Also:

Constant Field Values

DEFAULT_POOL_TIMEOUT

public static final long DEFAULT_POOL_TIMEOUT

See Also:

Constant Field Values

DEFAULT_INITIAL_CONTEXT_FACTORY

public static final String DEFAULT_INITIAL_CONTEXT_FACTORY

See Also:

Constant Field Values

DEFAULT_REFERRAL

public static final String DEFAULT_REFERRAL

See Also:

Constant Field Values

Constructor Detail

LDAPJNDIConnection

public LDAPJNDIConnection()

Default Constructor

LDAPJNDIConnection

public LDAPJNDIConnection(String providerUrl)
                   throws LDAPException

Parameters:

providerUrl - Provider Url

Throws:

LDAPException

LDAPJNDIConnection

public LDAPJNDIConnection(String providerUrl,
                  String initialContextFactory)
                   throws LDAPException

Parameters:

providerUrl - Provider URL

initialContextFactory - Initial Context Factory

Throws:

LDAPException

LDAPJNDIConnection

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

Parameters:

providerUrl - Provider URL

initialContextFactory - Initial Context Factory

authentication - Authentication

maxPoolConnections - Max Pool Connections

initialPoolSizeConnections - Initial Pool Size Connections

poolTimeout - Pool Timeout

Throws:

LDAPException

LDAPJNDIConnection

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

Parameters:

providerUrl - Provider URL

initialContextFactory - Initial Context Factory

authentication - Authentication

Throws:

LDAPException

LDAPJNDIConnection

public LDAPJNDIConnection(String providerUrl,
                  String initialContextFactory,
                  String authentication,
                  int maxPoolConnections,
                  int initialPoolSizeConnections,
                  long poolTimeout,
                  boolean schemaEnabled)
                   throws LDAPException

Parameters:

providerUrl - Provider URL

initialContextFactory - Initial Context Factory

authentication - Authentication

maxPoolConnections - Max Pool Connections

initialPoolSizeConnections - Initial Pool Size Connections

poolTimeout - Pool Timeout

schemaEnabled - Is Schema Enabled

Throws:

LDAPException

Method Detail

initialize

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

Specified by:

initialize in class LDAPConnection

Parameters:

conf - Map of configurations

Throws:

LDAPException

See Also:

LDAPConnection.initialize(java.util.Map)

isNoAuthentication

public boolean isNoAuthentication()

Returns:

boolean

isClosed

public boolean isClosed()

Specified by:

isClosed in class LDAPConnection

Returns:

boolean

See Also:

LDAPConnection.isClosed()

close

public void close()
           throws LDAPException

Specified by:

close in class LDAPConnection

Throws:

LDAPException

See Also:

LDAPConnection.close()

rebind

public void rebind()
            throws LDAPException

Specified by:

rebind in class LDAPConnection

Throws:

LDAPException

See Also:

LDAPConnection.rebind()

bind

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

Specified by:

bind in class LDAPConnection

Parameters:

dn - Distinguished Name

password - Password

Throws:

LDAPException

See Also:

LDAPConnection.bind(java.lang.String, java.lang.String)

getBindedUserDn

public String getBindedUserDn()
                       throws LDAPException

Specified by:

getBindedUserDn in class LDAPConnection

Returns:

String

Throws:

LDAPException

See Also:

LDAPConnection.getBindedUserDn()

search

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

Specified by:

search in class LDAPConnection

Parameters:

baseDn - Base DN

filter - Filter

controls - Controls

Returns:

LDAPResultSet

Throws:

LDAPException

See Also:

LDAPConnection.search(java.lang.String, java.lang.String, org.mule.module.ldap.api.LDAPSearchControls)

search

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

Specified by:

search in class LDAPConnection

Parameters:

baseDn - Base Distinguished Name

filter - Filter

filterArgs - Filter Arguments

controls - Controls

Returns:

LDAPResultSet

Throws:

LDAPException

See Also:

LDAPConnection.search(java.lang.String, java.lang.String, java.lang.Object[], org.mule.module.ldap.api.LDAPSearchControls)

lookup

public LDAPEntry lookup(String dn)
                 throws LDAPException

Specified by:

lookup in class LDAPConnection

Parameters:

dn - Distinguished Name

Returns:

LDAPEntry

Throws:

LDAPException

See Also:

LDAPConnection.lookup(java.lang.String)

lookup

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

Description copied from class: LDAPConnection

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

Specified by:

lookup in class LDAPConnection

Parameters:

dn - Distinguished Name

attributes - Attributes

Returns:

LDAPEntry

Throws:

LDAPException

See Also:

LDAPConnection.lookup(java.lang.String, java.lang.String[])

addEntry

public void addEntry(@NotNull
            LDAPEntry entry)
              throws LDAPException

Specified by:

addEntry in class LDAPConnection

Parameters:

entry - LDAPEntry

Throws:

LDAPException

See Also:

LDAPConnection.addEntry(org.mule.module.ldap.api.LDAPEntry)

updateEntry

public void updateEntry(@NotNull
               LDAPEntry entry)
                 throws LDAPException

Specified by:

updateEntry in class LDAPConnection

Parameters:

entry - LDAPEntry

Throws:

LDAPException

See Also:

LDAPConnection.updateEntry(org.mule.module.ldap.api.LDAPEntry)

deleteEntry

public void deleteEntry(LDAPEntry entry)
                 throws LDAPException

Specified by:

deleteEntry in class LDAPConnection

Parameters:

entry - LDAPEntry

Throws:

LDAPException

See Also:

LDAPConnection.deleteEntry(org.mule.module.ldap.api.LDAPEntry)

deleteEntry

public void deleteEntry(String dn)
                 throws LDAPException

Specified by:

deleteEntry in class LDAPConnection

Parameters:

dn - Distinguished Name

Throws:

LDAPException

See Also:

LDAPConnection.deleteEntry(java.lang.String)

renameEntry

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

Specified by:

renameEntry in class LDAPConnection

Parameters:

oldDn - Old Distinguished Name

newDn - New Distinguished Name

Throws:

LDAPException

See Also:

LDAPConnection.renameEntry(java.lang.String, java.lang.String)

addAttribute

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

Specified by:

addAttribute in class LDAPConnection

Parameters:

dn - Distinguished Name

attribute - Attribute

Throws:

LDAPException

See Also:

LDAPConnection.addAttribute(java.lang.String, org.mule.module.ldap.api.LDAPEntryAttribute)

updateAttribute

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

Specified by:

updateAttribute in class LDAPConnection

Parameters:

dn - Distinguished Name

attribute - Attribute

Throws:

LDAPException

See Also:

LDAPConnection.updateAttribute(java.lang.String, org.mule.module.ldap.api.LDAPEntryAttribute)

deleteAttribute

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

Description copied from class: LDAPConnection

Deletes the attribute or the value of the attribute.

Specified by:

deleteAttribute in class LDAPConnection

Parameters:

dn - Distinguished Name

attribute - Attribute

Throws:

LDAPException

See Also:

LDAPConnection.deleteAttribute(java.lang.String, org.mule.module.ldap.api.LDAPEntryAttribute)

getAttributeTypeDefinition

public LDAPEntryAttributeTypeDefinition getAttributeTypeDefinition(@NotNull
                                                          String attributeName)
                                                            throws LDAPException

Returns:

Throws:

LDAPException

retrieveAttributeTypeDefinition

protected LDAPEntryAttributeTypeDefinition retrieveAttributeTypeDefinition(@NotNull
                                                               String attributeName)
                                                                    throws LDAPException

Parameters:

attributeName - Attribute Name

Returns:

LDAPEntryAttributeTypeDefinition

Throws:

LDAPException

getAllObjectClasses

public List<String> getAllObjectClasses()
                                 throws LDAPException

Returns:

Throws:

LDAPException

getObjectClassDefinition

public LDAPEntryObjectClassDefinition getObjectClassDefinition(String objectClassName)
                                                        throws LDAPException

Returns:

Throws:

LDAPException

getAuthentication

public String getAuthentication()

Returns:

Returns the authentication.

setAuthentication

public void setAuthentication(String authentication)

Specified by:

setAuthentication in class LDAPConnection

Parameters:

authentication - The authentication to set.

getInitialPoolSizeConnections

public int getInitialPoolSizeConnections()

Returns:

Returns the initialPoolSizeConnections.

setInitialPoolSizeConnections

public void setInitialPoolSizeConnections(int initialPoolSizeConnections)

Parameters:

initialPoolSizeConnections - The initialPoolSizeConnections to set.

getMaxPoolConnections

public int getMaxPoolConnections()

Returns:

Returns the maxPoolConnections.

setMaxPoolConnections

public void setMaxPoolConnections(int maxPoolConnections)

Parameters:

maxPoolConnections - The maxPoolConnections to set.

getPoolTimeout

public long getPoolTimeout()

Returns:

Returns the poolTimeout.

setPoolTimeout

public void setPoolTimeout(long poolTimeout)

Parameters:

poolTimeout - The poolTimeout to set.

getProviderUrl

public String getProviderUrl()

Returns:

Returns the providerUrl.

setProviderUrl

public void setProviderUrl(String provider)

Parameters:

provider - The providerUrl to set.

isConnectionPoolEnabled

public boolean isConnectionPoolEnabled()

Returns:

boolean

getInitialContextFactory

public String getInitialContextFactory()

Returns:

Returns the initialContextFactory.

setInitialContextFactory

public void setInitialContextFactory(String initialContextFactory)

Parameters:

initialContextFactory - The initialContextFactory to set.

getReferral

public String getReferral()

setReferral

public void setReferral(String referral)

toString

public String toString()

Overrides:

toString in class Object