org.apache.directory.server.xdbm

Interface MasterTable

All Superinterfaces:

Table<java.lang.String,org.apache.directory.api.ldap.model.entry.Entry>

All Known Implementing Classes:

AvlMasterTable, JdbmMasterTable, MavibotMasterTable

public interface MasterTable
extends Table<java.lang.String,org.apache.directory.api.ldap.model.entry.Entry>

A master table used to store indexable entries.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DBF the base name for the db file for this table
static java.lang.String	SEQPROP_KEY the sequence key - stores last sequence value in the admin table

Method Summary

Modifier and Type	Method and Description
java.lang.String	getNextId(org.apache.directory.api.ldap.model.entry.Entry entry) Gets the next value from the sequence of this MasterTable.

Methods inherited from interface org.apache.directory.server.xdbm.Table

close, count, count, cursor, cursor, get, getKeyComparator, getName, getValueComparator, greaterThanCount, has, has, hasGreaterOrEqual, hasGreaterOrEqual, hasLessOrEqual, hasLessOrEqual, isDupsEnabled, lessThanCount, put, remove, remove, valueCursor

Field Detail

DBF

static final java.lang.String DBF

the base name for the db file for this table

See Also:

Constant Field Values

SEQPROP_KEY

static final java.lang.String SEQPROP_KEY

the sequence key - stores last sequence value in the admin table

See Also:

Constant Field Values

Method Detail

getNextId

java.lang.String getNextId(org.apache.directory.api.ldap.model.entry.Entry entry)
                    throws java.lang.Exception

Gets the next value from the sequence of this MasterTable. This has the side-effect of incrementing the sequence values permanently.

Parameters:

entry - the entry in case the id is derived from the entry.

Returns:

the current value of this MasterTable's sequence incremented by one

Throws:

java.lang.Exception - on failure to update the id sequence