org.opends.server.backends.pluggable

Interface SuffixContainer

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

EntryContainer

public interface SuffixContainer
extends Closeable

Container for a whole suffix environment which stores all entries from the subtree of the suffix' baseDN. A suffix container has a set of key-value stores a.k.a indexes. It stores entries in these key-values stores and maintain the indexes all in sync on updates.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_DEBUG_SEARCH_INDEX The attribute used to return a search index debug string to the client.
static String	DN2ID_INDEX_NAME The name of the index associating normalized DNs to ids.
static String	DN2URI_INDEX_NAME The name of the index associating normalized DNs to URIs.
static String	ID2CHILDREN_COUNT_NAME The name of the index associating an entry id to the number of immediate children below it.
static String	ID2CHILDREN_INDEX_NAME The name of the index associating an entry id to the entry id set of all its children, i.e.
static String	ID2ENTRY_INDEX_NAME The name of the index associating entry ids to entries.
static String	ID2SUBTREE_INDEX_NAME The name of the index associating an entry id to the entry id set of all its subordinates, i.e.
static String	REFERRAL_INDEX_NAME The name of the index associating normalized DNs to normalized URIs.
static String	STATE_INDEX_NAME The name of the index which associates indexes with their trust state, i.e.

Method Summary

Methods

Modifier and Type	Method and Description
DN	getBaseDN() Returns the baseDN that this suffix container is responsible for.

Methods inherited from interface java.io.Closeable

close

Field Detail

DN2ID_INDEX_NAME

static final String DN2ID_INDEX_NAME

The name of the index associating normalized DNs to ids. LDAP DNs uniquely identify entries.

See Also:

Constant Field Values

DN2URI_INDEX_NAME

static final String DN2URI_INDEX_NAME

The name of the index associating normalized DNs to URIs.

See Also:

Constant Field Values

ID2ENTRY_INDEX_NAME

static final String ID2ENTRY_INDEX_NAME

The name of the index associating entry ids to entries. Entry ids are monotonically increasing unique longs and entries are serialized versions of LDAP entries.

See Also:

Constant Field Values

ID2CHILDREN_INDEX_NAME

static final String ID2CHILDREN_INDEX_NAME

The name of the index associating an entry id to the entry id set of all its children, i.e. its immediate children.

See Also:

Constant Field Values

ID2CHILDREN_COUNT_NAME

static final String ID2CHILDREN_COUNT_NAME

The name of the index associating an entry id to the number of immediate children below it.

See Also:

Constant Field Values

ID2SUBTREE_INDEX_NAME

static final String ID2SUBTREE_INDEX_NAME

The name of the index associating an entry id to the entry id set of all its subordinates, i.e. the children, grand-children, grand-grand-children, ....

See Also:

Constant Field Values

REFERRAL_INDEX_NAME

static final String REFERRAL_INDEX_NAME

The name of the index associating normalized DNs to normalized URIs.

See Also:

Constant Field Values

STATE_INDEX_NAME

static final String STATE_INDEX_NAME

The name of the index which associates indexes with their trust state, i.e. does the index needs to be rebuilt ?

See Also:

Constant Field Values

ATTR_DEBUG_SEARCH_INDEX

static final String ATTR_DEBUG_SEARCH_INDEX

The attribute used to return a search index debug string to the client.

See Also:

Constant Field Values

Method Detail

getBaseDN

DN getBaseDN()

Returns the baseDN that this suffix container is responsible for.

Returns:

the baseDN that this suffix container is responsible for