Package org.springframework.ldap.control

Class ControlExchangeDirContextProcessor<S extends Control,T extends Control>

java.lang.Object

org.springframework.ldap.control.ControlExchangeDirContextProcessor<S,T>

Type Parameters:

S - the type of the request Control

T - the type of the response Control

All Implemented Interfaces:

DirContextProcessor

Direct Known Subclasses:

PagedResultsControlExchangeDirContextProcessor

public class ControlExchangeDirContextProcessor<S extends Control,T extends Control>
extends Object
implements DirContextProcessor

A generic DirContextProcessor implementation for managing LDAP request and response controls through a ControlExchange.

This processor handles the lifecycle of LDAP controls by:

• Adding the request control from the exchange to the LdapContext before operations
• Extracting matching response controls after operations
• Updating the exchange with the response control for subsequent operations

For stateful controls that require maintaining connection state across multiple operations (such as paged results or server-side sorting), the same LDAP connection must be reused. Spring LDAP's SingleContextSource and TransactionAwareContextSourceProxy provide this capability when wired into LdapTemplate and LdapClient instances.

Since:

4.1

See Also:

• ControlExchange
• SingleContextSource
• ContextSourceTransactionManager
• TransactionAwareContextSourceProxy

Constructor Summary

Constructors

Constructor	Description
ControlExchangeDirContextProcessor(ControlExchange<S,T> exchange)	Construct this DirContextProcessor, providing the ControlExchange to use

Method Summary

Modifier and Type	Method	Description
ControlExchange<S,T>	getExchange()	Returns the current control exchange containing the request and response controls.
void	postProcess(DirContext ctx)	Extracts the response control matching the request control's ID from the LdapContext and updates the exchange.
void	preProcess(DirContext ctx)	Adds the request control from the exchange to the LdapContext, replacing any existing control with the same ID.

Methods inherited from class java.lang.Object

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

Constructor Details

ControlExchangeDirContextProcessor

public ControlExchangeDirContextProcessor(ControlExchange<S,T> exchange)

Construct this DirContextProcessor, providing the ControlExchange to use

Parameters:

exchange - the ControlExchange to use for managing request and response controls

Method Details

preProcess

public void preProcess(DirContext ctx)
                throws NamingException

Adds the request control from the exchange to the LdapContext, replacing any existing control with the same ID.

Specified by:

preProcess in interface DirContextProcessor

Parameters:

ctx - the DirContext to pre-process; must be an instance of LdapContext

Throws:

NamingException - if an error occurs while processing

IllegalArgumentException - if ctx is not an LdapContext

postProcess

public void postProcess(DirContext ctx)
                 throws NamingException

Extracts the response control matching the request control's ID from the LdapContext and updates the exchange.

Specified by:

postProcess in interface DirContextProcessor

Parameters:

ctx - the DirContext to post-process; must be an instance of LdapContext

Throws:

NamingException - if an error occurs while processing

IllegalArgumentException - if ctx is not an LdapContext

getExchange

public ControlExchange<S,T> getExchange()

Returns the current control exchange containing the request and response controls.

The exchange is updated after each postProcess(DirContext) call when a matching response control is found.

Returns:

the current ControlExchange