org.mule.module.ldap.config

Class AbstractConfig

java.lang.Object

org.mule.module.ldap.config.AbstractConfig

Direct Known Subclasses:

LDAPCacheConfig, LDAPTlsConfig

public abstract class AbstractConfig
extends Object

Abstract class for LDAP Global elements configuration. There are two config types , a LDAP Cache connection and a LDAP TLS connection. Please refer to the individual implementation for details.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	authentication
Map<String,String>	extendedConfiguration This is a Map instance holding extended configuration attributes that will be used in the Context environment.
Referral	referral Constant that holds the name of the environment property for specifying how referrals encountered by the service provider are to be processed (follow, ignore, throw).
boolean	schemaEnabled If set to true, the LDAP connector will use the LDAP schema (only works for LDAP v3) to define the structure of the LDAP entry (or map).
Type	type The implementation of the connection to be used.
String	url The connection URL to the LDAP server with the following syntax: ldap[s]://hostname:port/base_dn.

Constructor Summary

Constructors

Constructor and Description
AbstractConfig()

Method Summary

Methods

Modifier and Type	Method and Description
String	connectionId() Returns the connection ID
LDAPConnection	createPooledConnections(String authDn, String authPassword, String authentication, boolean tlsEnabled)
void	disconnect() Disconnect the current connection
LDAPConnection	getConnection()
Map<String,String>	getExtendedConfiguration()
LDAPPool<LDAPConnection>	getLdapConnectionPool()
MetadataBuilder	getMetadataBuilder()
Referral	getReferral()
Type	getType()
String	getUrl()
boolean	isConnected() Are we connected?
boolean	isSchemaEnabled()
abstract void	releaseConnection(LDAPConnection connection)
void	setExtendedConfiguration(Map<String,String> extendedConfiguration)
void	setMetadataBuilder(MetadataBuilder metadataBuilder)
void	setReferral(Referral referral)
void	setSchemaEnabled(boolean schemaEnabled)
void	setType(Type type)
void	setUrl(String url)

Methods inherited from class java.lang.Object

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

Field Detail

url

@Configurable
@Placement(group="Connection",
           order=0)
@FriendlyName(value="URL")
public String url

The connection URL to the LDAP server with the following syntax: ldap[s]://hostname:port/base_dn.

type

@Configurable
@Default(value="JNDI")
public Type type

The implementation of the connection to be used.

referral

@Configurable
@Default(value="IGNORE")
@Placement(group="Advanced")
public Referral referral

Constant that holds the name of the environment property for specifying how referrals encountered by the service provider are to be processed (follow, ignore, throw).

extendedConfiguration

@Configurable
@Optional
@Placement(group="Advanced")
public Map<String,String> extendedConfiguration

This is a Map instance holding extended configuration attributes that will be used in the Context environment. When working with TLS connectionInfo you need to make sure that the native LDAP pooling functionality is turned off. For example if using JNDI do not use attributes such as 'com.sun.jndi.ldap.connect.pool=true' will cause problems when using TLS.

schemaEnabled

@Configurable
@Default(value="false")
@Placement(group="General")
public boolean schemaEnabled

If set to true, the LDAP connector will use the LDAP schema (only works for LDAP v3) to define the structure of the LDAP entry (or map). This needs to be 'true' in order to use DataSense as it will affect the implementing class of LDAPEntry attributes.

Since:

2.0.0

authentication

protected String authentication

Constructor Detail

AbstractConfig

public AbstractConfig()

Method Detail

getLdapConnectionPool

public LDAPPool<LDAPConnection> getLdapConnectionPool()

createPooledConnections

public LDAPConnection createPooledConnections(String authDn,
                                     String authPassword,
                                     String authentication,
                                     boolean tlsEnabled)
                                       throws LDAPException

Throws:

LDAPException

connectionId

@ConnectionIdentifier
public String connectionId()

Returns the connection ID

Returns:

String with the connection Id

disconnect

@Disconnect
public void disconnect()

Disconnect the current connection

isConnected

@ValidateConnection
public boolean isConnected()

Are we connected?

Returns:

boolean true if the connection is still valid or false otherwise.

getUrl

public String getUrl()

setUrl

public void setUrl(String url)

getType

public Type getType()

setType

public void setType(Type type)

getReferral

public Referral getReferral()

setReferral

public void setReferral(Referral referral)

getExtendedConfiguration

public Map<String,String> getExtendedConfiguration()

setExtendedConfiguration

public void setExtendedConfiguration(Map<String,String> extendedConfiguration)

isSchemaEnabled

public boolean isSchemaEnabled()

setSchemaEnabled

public void setSchemaEnabled(boolean schemaEnabled)

getConnection

public LDAPConnection getConnection()

getMetadataBuilder

public MetadataBuilder getMetadataBuilder()

setMetadataBuilder

public void setMetadataBuilder(MetadataBuilder metadataBuilder)

releaseConnection

public abstract void releaseConnection(LDAPConnection connection)