LDAP Search Listener

LDAP Search Listener – Executes a query against an LDAP directory and provides any results as XML.

Select the LDAP Listener from the Listener Type drop-down.

This Listener has 4 tabs: Advanced, Transaction Logging, Connection and Search.

1. Advanced: At the Advanced tab, you can specify:

Initialize on trigger only: If enabled, Listener doesn’t start up until a trigger initializes it.
Allow command-line invocation: If enabled, Listener can be invoked using the CLI client application.

Restart on listening error: If enabled, the Listener will be restarted after an error occurs.

FIFO Queue Name: The FIFO stuff enables a “First In, First Out” queuing mechanism between Listeners and Transports. If a “FIFO Queue Name” is provided, that name will be used as a key for a queue Transactions & will be pushed into before reaching a transport. They’ll be ordered in this queue according to when the Listener created them.

FIFO Queue Delay: It is the interval between updates/checks against that queue. Providing a queue name guarantees that a given Transport sends transactions in the same order the Listener created them in.

Additional Properties: Additional properties to be placed in the JNDI LDAP context.

2. Transaction Logging – This tab allows us to enable transaction events logging. That data can be logged by a TransactionEventListener.

The Transaction Logging Enable checkbox allows transaction events originating from this listener to be logged by a TransactionEventListener.

Log Transaction Attribute – if enabled, logs transaction attributes.

Log Transaction Data – if enabled, logs transaction data body.

Log Transaction Data Base64 – if enabled, logs transaction data body as Base64.

3. Connection: In the Connection tab, you can specify:

URL: URL of the LDAP server.
Use SSL: Use SSL for LDAP connection or not.
User Name (Principal): LDAP username (e.g., cn=jdoe, ou=employees, o=Pilotfish)
Password: LDAP password.
Authentication type: Authentication style for the LDAP connection. It can be Simple or DIGEST-MD5.
Polling interval: How often the directory is searched.

4. Search – In the Search tab, you can specify:

Search Base: LDAP subtree to search. This could be blank.
Search Filter: LDAP filter string.
Scope: Scope of the search. It can be Object, Subtree or One-level.
Max Results: Maximum number of entries returned on the search.