org.mule.module.ldap.config

Class LDAPTlsConfig

java.lang.Object

org.mule.module.ldap.config.AbstractConfig

org.mule.module.ldap.config.LDAPTlsConfig

@ConnectionManagement(friendlyName="TLS Configuration",
                      configElementName="tls-config")
public class LDAPTlsConfig
extends AbstractConfig

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DISABLE_POOLING
protected static int	NO_POOLING_TIMEOUT
protected static boolean	USE_TLS

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

authentication, connection, extendedConfiguration, referral, schemaEnabled, type, url

Constructor Summary

Constructors

Constructor and Description
LDAPTlsConfig()

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 using TLS.

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

connectionId, disconnect, getConnection, getExtendedConfiguration, 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

Field Detail

USE_TLS

protected static final boolean USE_TLS

See Also:

Constant Field Values

DISABLE_POOLING

protected static final int DISABLE_POOLING

See Also:

Constant Field Values

NO_POOLING_TIMEOUT

protected static final int NO_POOLING_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

LDAPTlsConfig

public LDAPTlsConfig()

Method Detail

connect

@Connect(strategy=MULTIPLE_INSTANCES)
@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 using TLS. As native LDAP pooling is not supported with TLS, pooling capabilities will be offered by the connector itself and as the TLS channel negotiation process is quite expensive, great performance benefits will be gained by doing so.

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)

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.