java.lang.Object

org.ldaptive.control.util.SyncReplClient

public class SyncReplClient extends Object

Client that simplifies using the sync repl control.

Field Summary

Fields

Modifier and Type

Field

Description

private final ConnectionFactory

factory

Connection factory to get a connection from.

private SearchOperationHandle

handle

Search operation handle.

protected final org.slf4j.Logger

logger

Logger for this class.

private Consumer<LdapEntry>

onEntry

Invoked when an entry is received.

private Consumer<Exception>

onException

Invoked when an exception is received.

private Consumer<SyncInfoMessage>

onMessage

Invoked when a sync info message is received.

private Consumer<Result>

onResult

Invoked when a result is received.

private boolean

receivedResult

Whether the sync repl search has received a result response.

private final boolean

refreshAndPersist

Controls which mode the sync repl control should use.
Constructor Summary

Constructors

Constructor

Description

SyncReplClient(ConnectionFactory cf, boolean persist)

Creates a new sync repl client.
Method Summary

Modifier and Type

Method

Description

ExtendedOperationHandle

cancel()

Sends a cancel operation on the underlying search operation.

void

close()

Closes the connection factory.

ConnectionFactory

getConnectionFactory()

Returns the connection factory.

boolean

isComplete()

Returns whether a search result has been received by this client.

SearchOperationHandle

send(SearchRequest request)

Invokes send(SearchRequest, CookieManager) with a DefaultCookieManager.

SearchOperationHandle

send(SearchRequest request, CookieManager manager)

Performs an async search operation with the SyncRequestControl.

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

setOnResult(Consumer<Result> consumer)

Sets the onResult consumer.

String

toString()

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- logger
  
  protected final org.slf4j.Logger logger
  
  Logger for this class.
- factory
  
  private final ConnectionFactory factory
  
  Connection factory to get a connection from.
- refreshAndPersist
  
  private final boolean refreshAndPersist
  
  Controls which mode the sync repl control should use.
- handle
  
  private SearchOperationHandle handle
  
  Search operation handle.
- onEntry
  
  private Consumer<LdapEntry> onEntry
  
  Invoked when an entry 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 is received.
- receivedResult
  
  private boolean receivedResult
  
  Whether the sync repl search has received a result response.
Constructor Details
- SyncReplClient
  
  public SyncReplClient(ConnectionFactory cf, boolean persist)
  
  Creates a new sync repl client.
  
  Parameters:
  
  cf - to get a connection from
  
  persist - whether to refresh and persist or just refresh
Method Details
- getConnectionFactory
  
  public ConnectionFactory getConnectionFactory()
  
  Returns the connection factory.
  
  Returns:
  
  connection factory
- setOnEntry
  
  public void setOnEntry(Consumer<LdapEntry> consumer)
  
  Sets the onEntry consumer.
  
  Parameters:
  
  consumer - to invoke when an entry 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 a sync info message is received
- send
  
  public SearchOperationHandle send(SearchRequest request) throws LdapException
  
  Invokes send(SearchRequest, CookieManager) with a DefaultCookieManager.
  
  Parameters:
  
  request - search request to execute
  
  Returns:
  
  search operation handle
  
  Throws:
  
  LdapException - if the search fails
- send
  
  public SearchOperationHandle send(SearchRequest request, CookieManager manager) throws LdapException
  Performs an async search operation with the SyncRequestControl. The supplied request is modified in the following way:
  
  AbstractRequestMessage.setControls(org.ldaptive.control.RequestControl...) is invoked with SyncRequestControl
  
  The search request object should not be reused for any other search operations.
  Parameters:
  
  request - search request to execute
  
  manager - for reading and writing cookies
  
  Returns:
  
  search operation handle
  
  Throws:
  
  LdapException - if the search fails
- isComplete
  
  public boolean isComplete()
  
  Returns whether a search result has been received by this client.
  
  Returns:
  
  whether a search result has been received
- cancel
  
  public ExtendedOperationHandle cancel()
  
  Sends a cancel operation on the underlying search operation. See DefaultOperationHandle.cancel().
  
  Returns:
  
  cancel operation result
- close
  
  public void close()
  
  Closes the connection factory.
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object

Class SyncReplClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

logger

factory

refreshAndPersist

handle

onEntry

onResult

onMessage

onException

receivedResult

Constructor Details

SyncReplClient

Method Details

getConnectionFactory

setOnEntry

setOnResult

setOnMessage

setOnException

send

send

isComplete

cancel

close

toString