Package com.isode.dsapi.bulk

Interface DirectoryIterator<T>

All Superinterfaces:

Iterator<T>

All Known Implementing Classes:

DirectoryDump, DirectoryScan, DirectoryScanDN

public interface DirectoryIterator<T>
extends Iterator<T>

Interface for iterating through directory-data, one DN or Entry or ChangeEntry at a time. This is a Java Iterator, plus another method to query for errors encountered during the scan.

Author:

jp

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DirectoryIterator.FatalException	Exception used to indicate unexpected failures in directory-scans.
static class	DirectoryIterator.ScanException	Exception used to indicate unexpected failures in directory-scans.

Method Summary

Modifier and Type	Method	Description
DirectoryIterator.ScanException	getException()	Returns the next outstanding Exception, or null if there are no more exceptions outstanding at this point in the scan.

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Method Details

getException

DirectoryIterator.ScanException getException()

Returns the next outstanding Exception, or null if there are no more exceptions outstanding at this point in the scan. This can be called during the scan to find out problems as soon as possible, or may be checked when the scan is complete (there may be several exceptions queued by the end of the scan). They must be checked at some point, though, or otherwise errors may go undetected.

The Exceptions are ScanExceptions or FatalExceptions, with an explanation and the problem DN in the message text. If the exception was caused by a DSAPIException, this is available using the getCause() method. A FatalException is used if this indicates an unexpected condition rather than simply a warning about an expected failure.