org.mule.module.ldap.config

Class LDAPCacheConfig

java.lang.Object

org.mule.module.ldap.config.AbstractConfig

org.mule.module.ldap.config.LDAPCacheConfig

@ConnectionManagement(friendlyName="Configuration",
                      configElementName="config")
public class LDAPCacheConfig
extends AbstractConfig

Field Summary

Fields inherited from class org.mule.module.ldap.config.AbstractConfig

authentication, extendedConfiguration, referral, schemaEnabled, type, url

Constructor Summary

Constructors

Constructor and Description
LDAPCacheConfig()

Method Summary

Methods

Modifier and Type	Method and Description
void	connect(String authDn, String authPassword, String authentication) Establish the connection to the LDAP server and use connection management to handle different users.
int	getInitialPoolSize()
int	getMaxPoolSize()
long	getPoolTimeout()
void	releaseConnection(LDAPConnection connection)
void	setInitialPoolSize(int initialPoolSize)
void	setMaxPoolSize(int maxPoolSize)
void	setPoolTimeout(long poolTimeout)

Methods inherited from class org.mule.module.ldap.config.AbstractConfig

connectionId, createPooledConnections, disconnect, getConnection, getExtendedConfiguration, getLdapConnectionPool, getMetadataBuilder, getReferral, getType, getUrl, isConnected, isSchemaEnabled, setExtendedConfiguration, setMetadataBuilder, setReferral, setSchemaEnabled, setType, setUrl

Methods inherited from class java.lang.Object

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

Constructor Detail

LDAPCacheConfig

public LDAPCacheConfig()

Method Detail

connect

@Connect(strategy=SINGLE_INSTANCE)
@TestConnectivity
public void connect(@ConnectionKey@FriendlyName(value="Principal DN")
                                    String authDn,
                                    @Optional@FriendlyName(value="Password")@Password
                                    String authPassword,
                                    @Optional
                                    String authentication)
             throws org.mule.api.ConnectionException

Establish the connection to the LDAP server and use connection management to handle different users.

Parameters:

authDn - The DN (distinguished name) of the user (for example: uid=user,ou=people,dc=mulesoft,dc=org). If using Microsoft Active Directory, instead of the DN, you can provide the user@domain (for example: user@mulesoft.org). DevKit doesn't support null values for the @Connect parameters. In order to have an anonymous bind, the authentication parameter should be "none" and a default value should be provided as value for "authDn".

authPassword - The password of the user

authentication - Specifies the authentication mechanism to use. For the Sun LDAP service provider, this can be one of the following strings:

• simple (DEFAULT): Used for user/password authentication.
• none: Used for anonymous authentication.
• sasl_mech (UNSUPPORTED): Where sasl_mech is a space-separated list of SASL mechanism names. SASL is the Simple Authentication and Security Layer (RFC 2222). It specifies a challenge-response protocol in which data is exchanged between the client and the server for the purposes of authentication and establishment of a security layer on which to carry out subsequent communication. By using SASL, the LDAP can support any type of authentication agreed upon by the LDAP client and server.

Throws:

org.mule.api.ConnectionException - Holding one of the possible values in ConnectionExceptionCode.

getInitialPoolSize

public int getInitialPoolSize()

setInitialPoolSize

public void setInitialPoolSize(int initialPoolSize)

getMaxPoolSize

public int getMaxPoolSize()

setMaxPoolSize

public void setMaxPoolSize(int maxPoolSize)

getPoolTimeout

public long getPoolTimeout()

setPoolTimeout

public void setPoolTimeout(long poolTimeout)

releaseConnection

public void releaseConnection(LDAPConnection connection)

Specified by:

releaseConnection in class AbstractConfig