public class EntryContainer extends Object implements SuffixContainer, ConfigurationChangeListener<LocalDBBackendCfg>
Modifier and Type | Field and Description |
---|---|
static String |
DN2ID_DATABASE_NAME
The name of the DN database.
|
static String |
ID2ENTRY_DATABASE_NAME
The name of the entry database.
|
ATTR_DEBUG_SEARCH_INDEX, DN2ID_INDEX_NAME, DN2URI_INDEX_NAME, ID2CHILDREN_COUNT_NAME, ID2CHILDREN_INDEX_NAME, ID2ENTRY_INDEX_NAME, ID2SUBTREE_INDEX_NAME, REFERRAL_INDEX_NAME, STATE_INDEX_NAME
Modifier and Type | Method and Description |
---|---|
ConfigChangeResult |
applyConfigurationChange(LocalDBBackendCfg cfg)
Applies the configuration changes to this change listener.
|
com.sleepycat.je.Transaction |
beginTransaction()
Begin a leaf transaction using the default configuration.
|
void |
clear()
Clear the contents of this entry container.
|
void |
clearDatabase(DatabaseContainer database)
Clear the contents for a database from disk.
|
void |
close()
Closes the entry container.
|
Collection<AttributeIndex> |
getAttributeIndexes()
Retrieve all attribute indexes.
|
DN |
getBaseDN()
Returns the baseDN that this suffix container is responsible for.
|
String |
getDatabasePrefix()
This method constructs a container name from a base DN.
|
DN2ID |
getDN2ID()
Get the DN database used by this entry container.
|
DN2URI |
getDN2URI()
Get the referral database used by this entry container.
|
long |
getEntryCount()
Get a count of the number of entries stored in this entry container.
|
int |
getEntryLimitExceededCount()
Get the number of values for which the entry limit has been exceeded
since the entry container was opened.
|
com.sleepycat.je.EnvironmentConfig |
getEnvironmentConfig()
Get the environment config of the JE environment used in this entry
container.
|
EntryID |
getHighestEntryID()
Determine the highest entryID in the entryContainer.
|
Index |
getID2Children()
Get the children database used by this entry container.
|
ID2Entry |
getID2Entry()
Get the entry database used by this entry container.
|
Index |
getID2Subtree()
Get the subtree database used by this entry container.
|
RootContainer |
getRootContainer()
Retrieves a reference to the root container in which this entry container
exists.
|
State |
getState()
Get the state database used by this entry container.
|
Collection<VLVIndex> |
getVLVIndexes()
Retrieve all VLV indexes.
|
boolean |
isConfigurationChangeAcceptable(LocalDBBackendCfg cfg,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the proposed change to the configuration is
acceptable to this change listener.
|
void |
listDatabases(List<DatabaseContainer> dbList)
Get a list of the databases opened by the entryContainer.
|
void |
lock()
Get the exclusive lock.
|
void |
setDatabasePrefix(String newDatabasePrefix)
Sets a new database prefix for this entry container and rename all
existing databases in use by this entry container.
|
String |
toString() |
static void |
transactionAbort(com.sleepycat.je.Transaction txn)
Abort a transaction.
|
static void |
transactionCommit(com.sleepycat.je.Transaction txn)
Commit a transaction.
|
void |
unlock()
Unlock the exclusive lock.
|
public static final String ID2ENTRY_DATABASE_NAME
public static final String DN2ID_DATABASE_NAME
public void close() throws com.sleepycat.je.DatabaseException
close
in interface Closeable
close
in interface AutoCloseable
com.sleepycat.je.DatabaseException
- If an error occurs in the JE database.public RootContainer getRootContainer()
public DN2ID getDN2ID()
public ID2Entry getID2Entry()
public DN2URI getDN2URI()
public Index getID2Children()
public Index getID2Subtree()
public State getState()
public Collection<AttributeIndex> getAttributeIndexes()
public Collection<VLVIndex> getVLVIndexes()
public EntryID getHighestEntryID() throws com.sleepycat.je.DatabaseException
com.sleepycat.je.DatabaseException
- If an error occurs in the JE database.public long getEntryCount() throws com.sleepycat.je.DatabaseException
com.sleepycat.je.DatabaseException
- If an error occurs in the JE database.public int getEntryLimitExceededCount()
public void listDatabases(List<DatabaseContainer> dbList)
dbList
- A list of database containers.public com.sleepycat.je.Transaction beginTransaction() throws com.sleepycat.je.DatabaseException
com.sleepycat.je.DatabaseException
- If an error occurs while attempting to begin
a new transaction.public static void transactionCommit(com.sleepycat.je.Transaction txn) throws com.sleepycat.je.DatabaseException
txn
- The JE transaction handle.com.sleepycat.je.DatabaseException
- If an error occurs while attempting to commit
the transaction.public static void transactionAbort(com.sleepycat.je.Transaction txn) throws com.sleepycat.je.DatabaseException
txn
- The JE transaction handle.com.sleepycat.je.DatabaseException
- If an error occurs while attempting to abort the
transaction.public String getDatabasePrefix()
public void setDatabasePrefix(String newDatabasePrefix) throws com.sleepycat.je.DatabaseException, JebException
newDatabasePrefix
- The new database prefix to use.com.sleepycat.je.DatabaseException
- If an error occurs in the JE database.JebException
- If an error occurs in the JE backend.public DN getBaseDN()
getBaseDN
in interface SuffixContainer
public boolean isConfigurationChangeAcceptable(LocalDBBackendCfg cfg, List<LocalizableMessage> unacceptableReasons)
isConfigurationChangeAcceptable
in interface ConfigurationChangeListener<LocalDBBackendCfg>
cfg
- The new configuration containing the changes.unacceptableReasons
- A list that can be used to hold messages about why the
provided configuration is not acceptable.true
if the proposed change is
acceptable, or false
if it is not.public ConfigChangeResult applyConfigurationChange(LocalDBBackendCfg cfg)
applyConfigurationChange
in interface ConfigurationChangeListener<LocalDBBackendCfg>
cfg
- The new configuration containing the changes.public com.sleepycat.je.EnvironmentConfig getEnvironmentConfig() throws com.sleepycat.je.DatabaseException
com.sleepycat.je.DatabaseException
- If an error occurs while retrieving the
configuration object.public void clear() throws com.sleepycat.je.DatabaseException
com.sleepycat.je.DatabaseException
- If an error occurs while removing the entry
container.public void clearDatabase(DatabaseContainer database) throws com.sleepycat.je.DatabaseException
database
- The database to clear.com.sleepycat.je.DatabaseException
- if a JE database error occurs.public void lock()
public void unlock()
Copyright © 2010-2015 ForgeRock AS. All Rights Reserved.