java.lang.Object
- org.ldaptive.ad.control.util.DirSyncClient

```
public class DirSyncClient
extends Object
```
Client that simplifies using the active directory dir sync control.

Field Summary

Fields
Modifier and Type	Field	Description
`private DirSyncControl.Flag[]`	`dirSyncFlags`	DirSync flags.
`private LdapEntryHandler[]`	`entryHandlers`	Functions to handle response entries.
`private ExceptionHandler`	`exceptionHandler`	Function to handle exceptions.
`private ExtendedDnControl.Flag`	`extendedDnFlag`	ExtendedDn flags.
`private ConnectionFactory`	`factory`	Connection factory to get a connection from.
`protected Logger`	`logger`	Logger for this class.
`private int`	`maxAttributeCount`	Maximum attribute count.
`private SearchReferenceHandler[]`	`referenceHandlers`	Functions to handle response references.
`private ResultHandler[]`	`resultHandlers`	Functions to handle response results.
`private SearchResultHandler[]`	`searchResultHandlers`	Functions to handle response results.
`private ResultPredicate`	`throwCondition`	Function to test results.

Constructor Summary

Constructors
Constructor	Description
`DirSyncClient(ConnectionFactory cf)`	Creates a new dir sync client.
`DirSyncClient(ConnectionFactory cf, DirSyncControl.Flag[] dsFlags)`	Creates a new dir sync client.
`DirSyncClient(ConnectionFactory cf, DirSyncControl.Flag[] dsFlags, int count)`	Creates a new dir sync client.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`private RequestControl[]`	`createRequestControls(byte[] cookie)`	Returns the list of request controls configured for this client.
`protected SearchOperation`	`createSearchOperation()`	Creates a new search operation configured with the properties on this client.
`SearchResponse`	`execute(SearchRequest request)`	Performs a search operation with the `DirSyncControl`.
`SearchResponse`	`execute(SearchRequest request, CookieManager manager)`	Performs a search operation with the `DirSyncControl`.
`SearchResponse`	`execute(SearchRequest request, SearchResponse result)`	Performs a search operation with the `DirSyncControl`.
`SearchResponse`	`executeToCompletion(SearchRequest request)`	Invokes `execute(SearchRequest, CookieManager)` with a `DefaultCookieManager`.
`SearchResponse`	`executeToCompletion(SearchRequest request, CookieManager manager)`	Performs a search operation with the `DirSyncControl`.
`protected byte[]`	`getDirSyncCookie(SearchResponse result)`	Returns the dir sync cookie in the supplied response or null if no cookie exists.
`protected long`	`getDirSyncFlags(SearchResponse result)`	Returns the dir sync flags in the supplied response or -1 if no flags exists.
`LdapEntryHandler[]`	`getEntryHandlers()`
`ExceptionHandler`	`getExceptionHandler()`
`ExtendedDnControl.Flag`	`getExtendedDnFlag()`	Returns the flag that is used on the extended dn control.
`SearchReferenceHandler[]`	`getReferenceHandlers()`
`ResultHandler[]`	`getResultHandlers()`
`SearchResultHandler[]`	`getSearchResultHandlers()`
`ResultPredicate`	`getThrowCondition()`
`boolean`	`hasMore(SearchResponse result)`	Returns whether `execute(SearchRequest, SearchResponse)` can be invoked again.
`void`	`setEntryHandlers(LdapEntryHandler... handlers)`
`void`	`setExceptionHandler(ExceptionHandler handler)`
`void`	`setExtendedDnFlag(ExtendedDnControl.Flag flag)`	Sets the flag to use on the extended dn control.
`void`	`setReferenceHandlers(SearchReferenceHandler... handlers)`
`void`	`setResultHandlers(ResultHandler... handlers)`
`void`	`setSearchResultHandlers(SearchResultHandler... handlers)`
`void`	`setThrowCondition(ResultPredicate function)`

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

- Field Detail
  - logger
```
protected final Logger logger
```
    Logger for this class.
  - factory
```
private final ConnectionFactory factory
```
    Connection factory to get a connection from.
  - dirSyncFlags
```
private final DirSyncControl.Flag[] dirSyncFlags
```
    DirSync flags.
  - maxAttributeCount
```
private final int maxAttributeCount
```
    Maximum attribute count.
  - extendedDnFlag
```
private ExtendedDnControl.Flag extendedDnFlag
```
    ExtendedDn flags.
  - resultHandlers
```
private ResultHandler[] resultHandlers
```
    Functions to handle response results.
  - exceptionHandler
```
private ExceptionHandler exceptionHandler
```
    Function to handle exceptions.
  - throwCondition
```
private ResultPredicate throwCondition
```
    Function to test results.
  - entryHandlers
```
private LdapEntryHandler[] entryHandlers
```
    Functions to handle response entries.
  - referenceHandlers
```
private SearchReferenceHandler[] referenceHandlers
```
    Functions to handle response references.
  - searchResultHandlers
```
private SearchResultHandler[] searchResultHandlers
```
    Functions to handle response results.
- Constructor Detail
  - DirSyncClient
```
public DirSyncClient(ConnectionFactory cf)
```
    Creates a new dir sync client.
    
    Parameters:
    
    cf - to get a connection from
  - DirSyncClient
```
public DirSyncClient(ConnectionFactory cf,
                     DirSyncControl.Flag[] dsFlags)
```
    Creates a new dir sync client.
    
    Parameters:
    
    cf - to get a connection from
    
    dsFlags - to set on the dir sync control
  - DirSyncClient
```
public DirSyncClient(ConnectionFactory cf,
                     DirSyncControl.Flag[] dsFlags,
                     int count)
```
    Creates a new dir sync client.
    
    Parameters:
    
    cf - to get a connection from
    
    dsFlags - to set on the dir sync control
    
    count - max attribute count
- Method Detail
  - getResultHandlers
```
public ResultHandler[] getResultHandlers()
```
  - setResultHandlers
```
public void setResultHandlers(ResultHandler... handlers)
```
  - getExceptionHandler
```
public ExceptionHandler getExceptionHandler()
```
  - setExceptionHandler
```
public void setExceptionHandler(ExceptionHandler handler)
```
  - getThrowCondition
```
public ResultPredicate getThrowCondition()
```
  - setThrowCondition
```
public void setThrowCondition(ResultPredicate function)
```
  - getEntryHandlers
```
public LdapEntryHandler[] getEntryHandlers()
```
  - setEntryHandlers
```
public void setEntryHandlers(LdapEntryHandler... handlers)
```
  - getReferenceHandlers
```
public SearchReferenceHandler[] getReferenceHandlers()
```
  - setReferenceHandlers
```
public void setReferenceHandlers(SearchReferenceHandler... handlers)
```
  - getSearchResultHandlers
```
public SearchResultHandler[] getSearchResultHandlers()
```
  - setSearchResultHandlers
```
public void setSearchResultHandlers(SearchResultHandler... handlers)
```
  - getExtendedDnFlag
```
public ExtendedDnControl.Flag getExtendedDnFlag()
```
    Returns the flag that is used on the extended dn control.
    
    Returns:
    
    extended dn control flag
  - setExtendedDnFlag
```
public void setExtendedDnFlag(ExtendedDnControl.Flag flag)
```
    Sets the flag to use on the extended dn control.
    
    Parameters:
    
    flag - to set on the extended dn control
  - execute
```
public SearchResponse execute(SearchRequest request)
                       throws LdapException
```
    Performs a search operation with the DirSyncControl. The supplied request is modified in the following way:
    
    AbstractRequestMessage.setControls( org.ldaptive.control.RequestControl...) is invoked with DirSyncControl, ShowDeletedControl, and ExtendedDnControl
    Parameters:
    
    request - search request to execute
    
    Returns:
    
    search operation response
    
    Throws:
    
    LdapException - if the search fails
  - execute
```
public SearchResponse execute(SearchRequest request,
                              SearchResponse result)
                       throws LdapException
```
    Performs a search operation with the DirSyncControl. The supplied request is modified in the following way:
    
    AbstractRequestMessage.setControls( org.ldaptive.control.RequestControl...) is invoked with DirSyncControl, ShowDeletedControl, and ExtendedDnControl
    
    The cookie is extracted from the supplied response and replayed in the request.
    Parameters:
    
    request - search request to execute
    
    result - of a previous dir sync operation
    
    Returns:
    
    search operation response
    
    Throws:
    
    IllegalArgumentException - if the response does not contain a dir sync cookie
    
    LdapException - if the search fails
  - execute
```
public SearchResponse execute(SearchRequest request,
                              CookieManager manager)
                       throws LdapException
```
    Performs a search operation with the DirSyncControl. The supplied request is modified in the following way:
    
    AbstractRequestMessage.setControls( org.ldaptive.control.RequestControl...) is invoked with DirSyncControl, ShowDeletedControl, and ExtendedDnControl
    
    The cookie used in the request is read from the cookie manager and written to the cookie manager after a successful search, if the response contains a cookie.
    Parameters:
    
    request - search request to execute
    
    manager - for reading and writing cookies
    
    Returns:
    
    search operation response
    
    Throws:
    
    LdapException - if the search fails
  - hasMore
```
public boolean hasMore(SearchResponse result)
```
    Returns whether execute(SearchRequest, SearchResponse) can be invoked again.
    
    Parameters:
    
    result - of a previous dir sync operation
    
    Returns:
    
    whether more dir sync results can be retrieved from the server
  - executeToCompletion
```
public SearchResponse executeToCompletion(SearchRequest request)
                                   throws LdapException
```
    Invokes execute(SearchRequest, CookieManager) with a DefaultCookieManager.
    
    Parameters:
    
    request - search request to execute
    
    Returns:
    
    search operation response of the last dir sync operation
    
    Throws:
    
    LdapException - if the search fails
  - executeToCompletion
```
public SearchResponse executeToCompletion(SearchRequest request,
                                          CookieManager manager)
                                   throws LdapException
```
    Performs a search operation with the DirSyncControl. The supplied request is modified in the following way:
    
    AbstractRequestMessage.setControls( org.ldaptive.control.RequestControl...) is invoked with DirSyncControl, ShowDeletedControl, and ExtendedDnControl
    
    This method will continue to execute search operations until all dir sync search results have been retrieved from the server. The returned response contains the response data of the last dir sync operation plus the entries and references returned by all previous search operations.
    
    The cookie used for each request is read from the cookie manager and written to the cookie manager after a successful search, if the response contains a cookie.
    Parameters:
    
    request - search request to execute
    
    manager - for reading and writing cookies
    
    Returns:
    
    search operation response of the last dir sync operation
    
    Throws:
    
    LdapException - if the search fails
  - createSearchOperation
```
protected SearchOperation createSearchOperation()
```
    Creates a new search operation configured with the properties on this client.
    
    Returns:
    
    new search operation
  - getDirSyncFlags
```
protected long getDirSyncFlags(SearchResponse result)
```
    Returns the dir sync flags in the supplied response or -1 if no flags exists.
    
    Parameters:
    
    result - of a previous dir sync operation
    
    Returns:
    
    dir sync flags or -1
  - getDirSyncCookie
```
protected byte[] getDirSyncCookie(SearchResponse result)
```
    Returns the dir sync cookie in the supplied response or null if no cookie exists.
    
    Parameters:
    
    result - of a previous dir sync operation
    
    Returns:
    
    dir sync cookie or null
  - createRequestControls
```
private RequestControl[] createRequestControls(byte[] cookie)
```
    Returns the list of request controls configured for this client.
    
    Parameters:
    
    cookie - to add to the dir sync control or null
    
    Returns:
    
    search request controls

Class DirSyncClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

factory

dirSyncFlags

maxAttributeCount

extendedDnFlag

resultHandlers

exceptionHandler

throwCondition

entryHandlers

referenceHandlers

searchResultHandlers

Constructor Detail

DirSyncClient

DirSyncClient

DirSyncClient

Method Detail

getResultHandlers

setResultHandlers

getExceptionHandler

setExceptionHandler

getThrowCondition

setThrowCondition

getEntryHandlers

setEntryHandlers

getReferenceHandlers

setReferenceHandlers

getSearchResultHandlers

setSearchResultHandlers

getExtendedDnFlag

setExtendedDnFlag

execute

execute

execute

hasMore

executeToCompletion

executeToCompletion

createSearchOperation

getDirSyncFlags

getDirSyncCookie

createRequestControls