com.unboundid.ldap.listener

Class InMemoryDirectoryServerSnapshot

java.lang.Object

com.unboundid.ldap.listener.InMemoryDirectoryServerSnapshot

All Implemented Interfaces:

java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class InMemoryDirectoryServerSnapshot
extends java.lang.Object
implements java.io.Serializable

This class provides an opaque data structure which represents a point-in-time snapshot for an in-memory directory server instance. Note that this snapshot will reflect only data held in the server (including both user data and any changelog information, if that is enabled), but will not alter the settings of the server which are defined through configuration.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
java.util.Map<DN,ReadOnlyEntry>	getEntryMap() Retrieves an unmodifiable map of all entries defined in the server at the time the snapshot was created.
long	getFirstChangeNumber() Retrieves the first change number for the server at the time the snapshot was created.
long	getLastChangeNumber() Retrieves the last change number for the server at the time the snapshot was created.

Methods inherited from class java.lang.Object

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

Method Detail

getEntryMap

@NotNull
public java.util.Map<DN,ReadOnlyEntry> getEntryMap()

Retrieves an unmodifiable map of all entries defined in the server at the time the snapshot was created. This will include user-defined entries as sell as changelog entries, but it will exclude the root DSE and the schema subentry (since they are dynamically generated from the configuration).

Returns:

An unmodifiable map of all entries defined in the server at the time the snapshot was created.

getFirstChangeNumber

public long getFirstChangeNumber()

Retrieves the first change number for the server at the time the snapshot was created.

Returns:

The first change number for the server at the time the snapshot was created.

getLastChangeNumber

public long getLastChangeNumber()

Retrieves the last change number for the server at the time the snapshot was created.

Returns:

The last change number for the server at the time the snapshot was created.