Package org.ldaptive.control.util

Class SyncReplRunner

java.lang.Object

org.ldaptive.control.util.SyncReplRunner

public final class SyncReplRunner
extends Object

Class that executes a SyncReplClient and expects to run continuously, reconnecting if the server is unavailable. Consumers must be registered to handle entries, results, and messages as they are returned from the server. If the connection validator fails, the runner will be stopped and started, then the sync repl search will execute again. Consumers cannot execute blocking LDAP operations on the same connection because the next incoming message is not read until the consumer has completed.

Field Summary

Fields

Modifier and Type	Field	Description
private final CookieManager	cookieManager	Sync repl cookie manager.
private static final int	IO_WORKER_THREADS	Number of I/O worker threads.
private static final Logger	LOGGER	Logger for this class.
private static final int	MESSAGE_WORKER_THREADS	Number of message worker threads.
private Consumer<LdapEntry>	onEntry	Invoked when an entry is received.
private Consumer<Exception>	onException	Invoked when an exception occurs.
private Consumer<SyncInfoMessage>	onMessage	Invoked when a sync info message is received.
private Consumer<SearchResultReference>	onReference	Invoked when a reference is received.
private Consumer<Result>	onResult	Invoked when a result is received.
private Supplier<Boolean>	onStart	Invoked when start() begins.
private final SearchRequest	searchRequest	Sync repl search request.
private boolean	started	Whether the sync repl search is running.
private final SyncReplClient	syncReplClient	Search operation handle.

Constructor Summary

Constructors

Constructor	Description
SyncReplRunner(SingleConnectionFactory cf, SearchRequest request, CookieManager manager)	Creates a new sync repl runner.

Method Summary

Modifier and Type	Method	Description
static void	configureConnectionFactory(SingleConnectionFactory factory)	Configures the supplied factory for use with a SyncReplRunner.
static SingleConnectionFactory	createConnectionFactory(ConnectionConfig config)	Creates a new single connection factory.
static SingleConnectionFactory	createConnectionFactory(ConnectionConfig config, ConnectionValidator validator)	Creates a new single connection factory.
static SingleConnectionFactory	createConnectionFactory(Transport transport, ConnectionConfig config, ConnectionValidator validator)	Creates a new single connection factory.
private static Transport	createTransport()	Returns a transport configured to use for sync repl.
void	initialize()	Prepare this runner for use.
boolean	isStarted()	Returns whether this runner is started.
void	restartSearch()	Cancels the sync repl search and sends a new search request.
void	setOnEntry(Consumer<LdapEntry> consumer)	Sets the onEntry consumer.
void	setOnException(Consumer<Exception> consumer)	Sets the onException consumer.
void	setOnMessage(Consumer<SyncInfoMessage> consumer)	Sets the onMessage consumer.
void	setOnReference(Consumer<SearchResultReference> consumer)	Sets the onReference consumer.
void	setOnResult(Consumer<Result> consumer)	Sets the onResult consumer.
void	setOnStart(Supplier<Boolean> supplier)	Sets the onStart supplier.
void	start()	Starts this runner.
void	stop()	Stops this runner.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

private static final Logger LOGGER

Logger for this class.

IO_WORKER_THREADS

private static final int IO_WORKER_THREADS

Number of I/O worker threads.

See Also:

• Constant Field Values

MESSAGE_WORKER_THREADS

private static final int MESSAGE_WORKER_THREADS

Number of message worker threads.

See Also:

• Constant Field Values

searchRequest

private final SearchRequest searchRequest

Sync repl search request.

cookieManager

private final CookieManager cookieManager

Sync repl cookie manager.

syncReplClient

private final SyncReplClient syncReplClient

Search operation handle.

onStart

private Supplier<Boolean> onStart

Invoked when start() begins.

onEntry

private Consumer<LdapEntry> onEntry

Invoked when an entry is received.

onReference

private Consumer<SearchResultReference> onReference

Invoked when a reference is received.

onResult

private Consumer<Result> onResult

Invoked when a result is received.

onMessage

private Consumer<SyncInfoMessage> onMessage

Invoked when a sync info message is received.

onException

private Consumer<Exception> onException

Invoked when an exception occurs.

started

private boolean started

Whether the sync repl search is running.

Constructor Details

SyncReplRunner

public SyncReplRunner(SingleConnectionFactory cf,
 SearchRequest request,
 CookieManager manager)

Creates a new sync repl runner. The supplied connection factory is modified to invoke SyncReplClient.send(SearchRequest, CookieManager) when the connection opens and SyncReplClient.cancel() when the connection closes.

Parameters:

cf - to get a connection from

request - sync repl search request

manager - sync repl cookie manager

Method Details

createConnectionFactory

public static SingleConnectionFactory createConnectionFactory(ConnectionConfig config)

Creates a new single connection factory. Uses a SearchConnectionValidator for connection validation. See createTransport()

Parameters:

config - sync repl connection configuration

Returns:

single connection factory for use with a sync repl runner

createConnectionFactory

public static SingleConnectionFactory createConnectionFactory(ConnectionConfig config,
 ConnectionValidator validator)

Creates a new single connection factory. See createTransport().

Parameters:

config - sync repl connection configuration

validator - connection validator

Returns:

single connection factory for use with a sync repl runner

createConnectionFactory

public static SingleConnectionFactory createConnectionFactory(Transport transport,
 ConnectionConfig config,
 ConnectionValidator validator)

Creates a new single connection factory.

Parameters:

transport - sync repl connection transport

config - sync repl connection configuration

validator - connection validator

Returns:

single connection factory for use with a sync repl runner

configureConnectionFactory

public static void configureConnectionFactory(SingleConnectionFactory factory)

Configures the supplied factory for use with a SyncReplRunner. The factory's configuration will have the following modifications:

• ConnectionConfig.setAutoReconnect(boolean) to false
• ConnectionConfig.setAutoReplay(boolean) to false
• ConnectionConfig.setAutoRead(boolean) to false
• SingleConnectionFactory.setFailFastInitialize(boolean) to false
• SingleConnectionFactory.setNonBlockingInitialize(boolean) to false
• AbstractConnectionValidator.setOnFailure(Consumer) to SingleConnectionFactory.ReinitializeConnectionConsumer

Parameters:

factory - to configure

createTransport

private static Transport createTransport()

Returns a transport configured to use for sync repl. Use IO_WORKER_THREADS number of I/O threads and MESSAGE_WORKER_THREADS number of message threads. This transport is configured never to be shutdown.

Returns:

transport

setOnStart

public void setOnStart(Supplier<Boolean> supplier)

Sets the onStart supplier.

Parameters:

supplier - to invoke on start

setOnEntry

public void setOnEntry(Consumer<LdapEntry> consumer)

Sets the onEntry consumer.

Parameters:

consumer - to invoke when an entry is received

setOnReference

public void setOnReference(Consumer<SearchResultReference> consumer)

Sets the onReference consumer.

Parameters:

consumer - to invoke when a reference is received

setOnResult

public void setOnResult(Consumer<Result> consumer)

Sets the onResult consumer.

Parameters:

consumer - to invoke when a result is received

setOnMessage

public void setOnMessage(Consumer<SyncInfoMessage> consumer)

Sets the onMessage consumer.

Parameters:

consumer - to invoke when a sync info message is received

setOnException

public void setOnException(Consumer<Exception> consumer)

Sets the onException consumer.

Parameters:

consumer - to invoke when an exception is received

initialize

public void initialize()

Prepare this runner for use.

start

public void start()

Starts this runner.

stop

public void stop()

Stops this runner.

isStarted

public boolean isStarted()

Returns whether this runner is started.

Returns:

whether this runner is started

restartSearch

public void restartSearch()

Cancels the sync repl search and sends a new search request.

toString

public String toString()

Overrides:

toString in class Object