mirror of https://github.com/OpenIdentityPlatform/OpenDJ.git
opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/AttributeIndex.java
@@ -131,7 +131,7 @@ * * @param indexConfig The attribute index configuration. * @param entryContainer The entryContainer of this attribute index. * @param txn The database transaction * @param txn a non null database transaction * @throws ConfigException if a configuration related error occurs. */ AttributeIndex(BackendIndexCfg indexConfig, EntryContainer entryContainer, WriteableTransaction txn) @@ -260,9 +260,8 @@ /** * Open the attribute index. * * @param txn The database transaction * @throws StorageRuntimeException if a JE database error occurs while * opening the index. * @param txn a non null database transaction * @throws StorageRuntimeException if a database error occurs while opening the index */ void open(WriteableTransaction txn) throws StorageRuntimeException { @@ -313,7 +312,7 @@ * @param buffer The index buffer to use to store the added keys * @param entryID The entry ID. * @param entry The contents of the new entry. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. * @throws DirectoryException If a Directory Server error occurs. */ void addEntry(IndexBuffer buffer, EntryID entryID, Entry entry) @@ -331,7 +330,7 @@ * @param buffer The index buffer to use to store the deleted keys * @param entryID The entry ID * @param entry The contents of the deleted entry. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. * @throws DirectoryException If a Directory Server error occurs. */ void removeEntry(IndexBuffer buffer, EntryID entryID, Entry entry) @@ -353,7 +352,7 @@ * @param newEntry The entry after the modifications were applied. * @param mods The sequence of modifications in the Modify operation. * @throws StorageRuntimeException If an error occurs during an operation on a * JE database. * database. */ void modifyEntry(IndexBuffer buffer, EntryID entryID, @@ -882,9 +881,9 @@ } /** * Get the JE database name prefix for indexes in this attribute index. * Get the database name prefix for indexes in this attribute index. * * @return JE database name for this database container. * @return database name for this database container. */ String getName() { opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/BackendImpl.java
@@ -61,8 +61,8 @@ import org.opends.server.util.RuntimeInformation; /** * This is an implementation of a Directory Server Backend which stores entries locally in a * Berkeley DB JE database. * This is an implementation of a Directory Server Backend which stores entries locally * in a pluggable storage. * * @param <C> * the type of the BackendCfg for the current backend opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/DN2ID.java
@@ -49,7 +49,7 @@ * * @param treeName The name of the DN database. * @param entryContainer The entryContainer of the DN database. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ DN2ID(TreeName treeName, EntryContainer entryContainer) throws StorageRuntimeException { @@ -59,8 +59,7 @@ /** * Adds a new record into the DN database replacing any existing record having the same DN. * @param txn A JE database transaction to be used for the database operation, * or null if none. * @param txn a non null database transaction * @param dn The entry DN, which is the key to the record. * @param id The entry ID, which is the value of the record. * @throws StorageRuntimeException If an error occurred while attempting to insert @@ -75,8 +74,7 @@ /** * Remove a record from the DN database. * @param txn A JE database transaction to be used for the database operation, * or null if none. * @param txn a non null database transaction * @param dn The entry DN, which is the key to the record. * @return true if the record was removed, false if it was not removed. * @throws StorageRuntimeException If an error occurred while attempting to remove @@ -91,11 +89,10 @@ /** * Fetch the entry ID for a given DN. * @param txn A JE database transaction to be used for the database read, or * null if none is required. * @param txn a non null database transaction * @param dn The DN for which the entry ID is desired. * @return The entry ID, or null if the given DN is not in the DN database. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ EntryID get(ReadableTransaction txn, DN dn) throws StorageRuntimeException { opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/DN2URI.java
@@ -105,7 +105,7 @@ * @param entryContainer * The entryContainer of the DN database. * @throws StorageRuntimeException * If an error occurs in the JE database. * If an error occurs in the database. */ DN2URI(TreeName treeName, EntryContainer entryContainer) throws StorageRuntimeException { @@ -163,11 +163,10 @@ /** * Puts a URI value in the referral database. * * @param txn A database transaction used for the update, or null if none is * required. * @param txn a non null database transaction * @param dn The DN of the referral entry. * @param labeledURIs The labeled URI value of the ref attribute. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ private void put(final WriteableTransaction txn, final DN dn, final Collection<String> labeledURIs) throws StorageRuntimeException @@ -200,12 +199,11 @@ /** * Delete URI values for a given referral entry from the referral database. * * @param txn A database transaction used for the update, or null if none is * required. * @param txn a non null database transaction * @param dn The DN of the referral entry for which URI values are to be * deleted. * @return true if the values were deleted, false if not. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ private boolean delete(WriteableTransaction txn, DN dn) throws StorageRuntimeException { @@ -221,11 +219,10 @@ /** * Delete a single URI value from the referral database. * @param txn A database transaction used for the update, or null if none is * required. * @param txn a non null database transaction * @param dn The DN of the referral entry. * @param labeledURIs The URI value to be deleted. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ private void delete(final WriteableTransaction txn, final DN dn, final Collection<String> labeledURIs) throws StorageRuntimeException @@ -283,12 +280,11 @@ * not do anything unless the entry before the modification or the entry after * the modification is a referral entry. * * @param txn A database transaction used for the update, or null if none is * required. * @param txn a non null database transaction * @param before The entry before the modifications have been applied. * @param after The entry after the modifications have been applied. * @param mods The sequence of modifications made to the entry. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ void modifyEntry(WriteableTransaction txn, Entry before, Entry after, List<Modification> mods) throws StorageRuntimeException @@ -360,7 +356,7 @@ * @param after * The entry after it was replaced. * @throws StorageRuntimeException * If an error occurs in the JE database. * If an error occurs in the database. */ void replaceEntry(WriteableTransaction txn, Entry before, Entry after) throws StorageRuntimeException @@ -372,10 +368,9 @@ /** * Update the referral database for a new entry. Does nothing if the entry * is not a referral entry. * @param txn A database transaction used for the update, or null if none is * required. * @param txn a non null database transaction * @param entry The entry to be added. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ void addEntry(WriteableTransaction txn, Entry entry) throws StorageRuntimeException @@ -390,10 +385,9 @@ /** * Update the referral database for a deleted entry. Does nothing if the entry * was not a referral entry. * @param txn A database transaction used for the update, or null if none is * required. * @param txn a non null database transaction * @param entry The entry to be deleted. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ void deleteEntry(WriteableTransaction txn, Entry entry) throws StorageRuntimeException { @@ -509,7 +503,7 @@ /** * Process referral entries that are above the target DN of an operation. * @param txn The transaction to use when making the determination. * @param txn a non null database transaction * @param targetDN The target DN of the operation, or the base object of a * search operation. * @param searchScope The scope of the search operation, or null if the @@ -567,7 +561,7 @@ /** * Return search result references for a search operation using the referral * database to find all referral entries within scope of the search. * @param txn The transaction to use when making the determination. * @param txn a non null database transaction * @param searchOp The search operation for which search result references * should be returned. * @return <CODE>true</CODE> if the caller should continue processing the opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/DatabaseContainer.java
@@ -32,7 +32,7 @@ import org.opends.server.backends.pluggable.spi.WriteableTransaction; /** * This class is a wrapper around the JE database object and provides basic * This class is a wrapper around the tree object and provides basic * read and write methods for entries. */ abstract class DatabaseContainer @@ -51,13 +51,13 @@ } /** * Opens a JE database in this database container. If the provided database configuration is * Opens a database in this database container. If the provided database configuration is * transactional, a transaction will be created and used to perform the open. * * @param txn * The transaction. * a non null database transaction * @throws StorageRuntimeException * if a JE database error occurs while opening the index. * if a database error occurs while opening the index. */ void open(WriteableTransaction txn) throws StorageRuntimeException { @@ -68,7 +68,7 @@ * Deletes this database and all of its contents. * * @param txn * The transaction. * a non null database transaction * @throws StorageRuntimeException * if a database error occurs while deleting the index. */ @@ -81,7 +81,7 @@ * Returns the number of key/value pairs in this database container. * * @param txn * The transaction. * a non null database transaction * @return the number of key/value pairs in the provided tree. * @throws StorageRuntimeException * If an error occurs in the DB operation. @@ -103,9 +103,9 @@ } /** * Get the JE database name for this database container. * Get the database name for this database container. * * @return JE database name for this database container. * @return database name for this database container. */ final TreeName getName() { @@ -113,7 +113,7 @@ } /** * Set the JE database name to use for this container. * Set the database name to use for this container. * * @param name The database name to use for this container. */ opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/EntryContainer.java
@@ -153,7 +153,7 @@ /** The backend configuration. */ private PluggableBackendCfg config; /** The JE database environment. */ /** The database storage. */ private final Storage storage; /** The DN database maps a normalized DN string to an entry ID (8 bytes). */ @@ -478,8 +478,8 @@ /** * Opens the entryContainer for reading and writing. * * @param txn The database transaction * @throws StorageRuntimeException If an error occurs in the JE database. * @param txn a non null database transaction * @throws StorageRuntimeException If an error occurs in the database. * @throws ConfigException if a configuration related error occurs. */ void open(WriteableTransaction txn) throws StorageRuntimeException, ConfigException @@ -560,7 +560,7 @@ /** * Closes the entry container. * * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ @Override public void close() throws StorageRuntimeException @@ -699,9 +699,9 @@ * Determine the highest entryID in the entryContainer. * The entryContainer must already be open. * * @param txn The database transaction * @param txn a non null database transaction * @return The highest entry ID. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ EntryID getHighestEntryID(ReadableTransaction txn) throws StorageRuntimeException { @@ -730,7 +730,7 @@ * number of entries immediately under the given entry. * @return The number of subordinate entries for the given entry or -1 if * the entry does not exist. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ long getNumSubordinates(final DN entryDN, final boolean subtree) throws StorageRuntimeException @@ -772,7 +772,7 @@ * @throws DirectoryException * If a problem occurs while processing the * search. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. * @throws CanceledOperationException if this operation should be cancelled. */ void search(final SearchOperation searchOperation) @@ -1279,7 +1279,7 @@ /** * Returns the entry corresponding to the provided entryID. * * @param txn The database transaction * @param txn a non null database transaction * @param entryID * the id of the entry to retrieve * @return the entry corresponding to the provided entryID @@ -1486,7 +1486,7 @@ * performed internally. * @throws DirectoryException If a problem occurs while trying to add the * entry. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. * @throws CanceledOperationException if this operation should be cancelled. */ void addEntry(final Entry entry, final AddOperation addOperation) @@ -1620,7 +1620,7 @@ * deletes performed internally. * @throws DirectoryException If a problem occurs while trying to remove the * entry. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. * @throws CanceledOperationException if this operation should be cancelled. */ void deleteEntry(final DN entryDN, final DeleteOperation deleteOperation) @@ -1988,7 +1988,7 @@ * @param modifyOperation The modify operation with which this action is * associated. This may be <CODE>null</CODE> for * modifications performed internally. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. * @throws DirectoryException If a Directory Server error occurs. * @throws CanceledOperationException if this operation should be cancelled. */ @@ -2114,7 +2114,7 @@ * If this backend noticed and reacted * to a request to cancel or abandon the * modify DN operation. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ void renameEntry(final DN currentDN, final Entry entry, final ModifyDNOperation modifyDNOperation) throws StorageRuntimeException, DirectoryException, CanceledOperationException @@ -2590,7 +2590,7 @@ * @param buffer The index buffer used to buffer up the index changes. * @param entry The entry to be inserted into the indexes. * @param entryID The ID of the entry to be inserted into the indexes. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. * @throws DirectoryException If a Directory Server error occurs. */ private void indexInsertEntry(IndexBuffer buffer, Entry entry, EntryID entryID) @@ -2613,7 +2613,7 @@ * @param buffer The index buffer used to buffer up the index changes. * @param entry The entry to be removed from the indexes. * @param entryID The ID of the entry to be removed from the indexes. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. * @throws DirectoryException If a Directory Server error occurs. */ private void indexRemoveEntry(IndexBuffer buffer, Entry entry, EntryID entryID) @@ -2639,7 +2639,7 @@ * @param newEntry The contents of the entry after the change. * @param entryID The ID of the entry that was changed. * @param mods The sequence of modifications made to the entry. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. * @throws DirectoryException If a Directory Server error occurs. */ private void indexModifications(IndexBuffer buffer, Entry oldEntry, Entry newEntry, @@ -2665,9 +2665,9 @@ /** * Get a count of the number of entries stored in this entry container. * * @param txn The database transaction * @param txn a non null database transaction * @return The number of entries stored in this entry container. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ long getEntryCount(ReadableTransaction txn) throws StorageRuntimeException { @@ -2750,7 +2750,7 @@ * Delete this entry container from disk. The entry container should be * closed before calling this method. * * @param txn The database transaction * @param txn a non null database transaction * @throws StorageRuntimeException If an error occurs while removing the entry * container. */ @@ -2768,7 +2768,7 @@ /** * Remove a database from disk. * * @param txn The database transaction * @param txn a non null database transaction * @param database The database container to remove. * @throws StorageRuntimeException If an error occurs while attempting to delete the * database. @@ -2791,7 +2791,7 @@ * Removes a attribute index from disk. * * @param attributeIndex The attribute index to remove. * @throws StorageRuntimeException If an JE database error occurs while attempting * @throws StorageRuntimeException If an database error occurs while attempting * to delete the index. */ private void deleteAttributeIndex(WriteableTransaction txn, AttributeIndex attributeIndex) @@ -2822,7 +2822,7 @@ * existing databases in use by this entry container. * * @param newBaseDN The new database prefix to use. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ void setDatabasePrefix(final String newBaseDN) throws StorageRuntimeException { @@ -3047,9 +3047,9 @@ /** * Clear the contents for a database from disk. * * @param txn The database transaction * @param txn a non null database transaction * @param database The database to clear. * @throws StorageRuntimeException if a JE database error occurs. * @throws StorageRuntimeException if a database error occurs. */ void clearDatabase(WriteableTransaction txn, DatabaseContainer database) throws StorageRuntimeException @@ -3112,7 +3112,7 @@ /** * Creates a new index for an attribute. * * @param txn The database transaction * @param txn a non null database transaction * @param indexName the name to give to the new index * @param indexer the indexer to use when inserting data into the index * @param indexEntryLimit the index entry limit opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/ExportJob.java
@@ -87,7 +87,7 @@ /** * Export entries from the backend to an LDIF file. * @param rootContainer The root container to export. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. * @throws IOException If an I/O error occurs while writing an entry. * @throws LDIFException If an error occurs while trying to determine whether * to write an entry. @@ -186,7 +186,7 @@ * one of the base DNs. * @param entryContainer The entry container that holds the entries to be * exported. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. * @throws IOException If an error occurs while writing an entry. * @throws LDIFException If an error occurs while trying to determine * whether to write an entry. opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/ID2Entry.java
@@ -227,8 +227,7 @@ * @param dataConfig The desired compression and encryption options for data * stored in the entry database. * @param entryContainer The entryContainer of the entry database. * @throws StorageRuntimeException If an error occurs in the JE database. * * @throws StorageRuntimeException If an error occurs in the database. */ ID2Entry(TreeName name, DataConfig dataConfig) throws StorageRuntimeException { @@ -312,10 +311,10 @@ /** * Write a record in the entry database. * * @param txn The database transaction or null if none. * @param txn a non null database transaction * @param id The entry ID which forms the key. * @param entry The LDAP entry. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. * @throws DirectoryException If a problem occurs while attempting to encode * the entry. */ @@ -338,10 +337,10 @@ /** * Remove a record from the entry database. * * @param txn The database transaction or null if none. * @param txn a non null database transaction * @param id The entry ID which forms the key. * @return true if the entry was removed, false if it was not. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ boolean remove(WriteableTransaction txn, EntryID id) throws StorageRuntimeException { @@ -351,11 +350,11 @@ /** * Fetch a record from the entry database. * * @param txn The database transaction or null if none. * @param txn a non null database transaction * @param id The desired entry ID which forms the key. * @return The requested entry, or null if there is no such record. * @throws DirectoryException If a problem occurs while getting the entry. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ public Entry get(ReadableTransaction txn, EntryID id) throws DirectoryException, StorageRuntimeException opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/Importer.java
@@ -3608,7 +3608,7 @@ * Create a new rebuild index progress task. * * @throws StorageRuntimeException * If an error occurred while accessing the JE database. * If an error occurred while accessing the database. */ public RebuildFirstPhaseProgressTask() throws StorageRuntimeException { opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/Index.java
@@ -53,7 +53,7 @@ import org.opends.server.util.StaticUtils; /** * Represents an index implemented by a JE database in which each key maps to * Represents an index implemented by a tree in which each key maps to * a set of entry IDs. The key is a byte array, and is constructed from some * normalized form of an attribute value (or fragment of a value) appearing * in the entry. @@ -109,9 +109,9 @@ * @param cursorEntryLimit The configured limit on the number of entry IDs * @param maintainCount Whether to maintain a count of IDs for a key once * the entry limit has exceeded. * @param txn The transaction to use when creating this object * @param txn a non null database transaction * @param entryContainer The database entryContainer holding this index. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ Index(TreeName name, Indexer indexer, State state, int indexEntryLimit, int cursorEntryLimit, boolean maintainCount, WriteableTransaction txn, EntryContainer entryContainer) throws StorageRuntimeException @@ -145,7 +145,7 @@ /** * Delete the specified import ID set from the import ID set associated with the key. * * @param txn The database transaction * @param txn a non null database transaction * @param importIdSet The import ID set to delete. * @throws StorageRuntimeException If a database error occurs. */ @@ -174,7 +174,7 @@ /** * Insert the specified import ID set into this index. Creates a DB cursor if needed. * * @param txn The database transaction * @param txn a non null database transaction * @param importIdSet The set of import IDs. * @throws StorageRuntimeException If a database error occurs. */ @@ -397,7 +397,7 @@ * @return true if the entry ID is indexed by the given key, false if it is not indexed by the * given key, undefined if the key has exceeded the entry limit. * @throws StorageRuntimeException * If an error occurs in the JE database. * If an error occurs in the database. */ ConditionResult containsID(ReadableTransaction txn, ByteString key, EntryID entryID) throws StorageRuntimeException @@ -418,7 +418,7 @@ /** * Reads the value associated to a key. * * @param txn The transaction to use for the operation * @param txn a non null database transaction * @param key The key to read * @return The non null set of entry IDs. */ @@ -444,7 +444,7 @@ * Reads a range of keys and collects all their entry IDs into a * single set. * * @param txn The transaction to use for the operation * @param txn a non null database transaction * @param lower The lower bound of the range. A 0 length byte array indicates * no lower bound and the range will start from the * smallest key. opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/IndexBuffer.java
@@ -235,8 +235,8 @@ * Flush the buffered index changes until the given transaction to * the database. * * @param txn The database transaction to be used for the updates. * @throws StorageRuntimeException If an error occurs in the JE database. * @param txn a non null database transaction * @throws StorageRuntimeException If an error occurs in the database. * @throws DirectoryException If a Directory Server error occurs. */ void flush(WriteableTransaction txn) throws StorageRuntimeException, DirectoryException opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/IndexFilter.java
@@ -78,7 +78,7 @@ * Construct an index filter for a search operation. * * @param entryContainer The entry entryContainer. * @param txn The database transaction * @param txn a non null database transaction * @param searchOp The search operation to be evaluated. * @param monitor The monitor to gather filter usage stats. * @param debugBuilder If not null, a diagnostic string will be written opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/JECompressedSchema.java
@@ -53,7 +53,7 @@ /** * This class provides a compressed schema implementation whose definitions are * stored in a Berkeley DB JE database. * persisted in a database. */ final class JECompressedSchema extends CompressedSchema { @@ -85,7 +85,7 @@ * @param storage * A reference to the database environment in which the databases * will be held. * @param txn The database transaction * @param txn a non null database transaction * @throws StorageRuntimeException * If a database problem occurs while loading the compressed schema * definitions from the database. opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/RootContainer.java
@@ -118,7 +118,7 @@ private static final int IMPORT_PROGRESS_INTERVAL = 10000; /** The JE database environment. */ /** The database storage. */ private Storage storage; /** The backend to which this entry root container belongs. */ opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/SortValuesSet.java
@@ -99,7 +99,7 @@ * * @param sv The sort values to add. * @throws DirectoryException If a Directory Server error occurs. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ void add(SortValues sv) throws StorageRuntimeException, DirectoryException { @@ -115,7 +115,7 @@ * @return True if the information was successfully added or False * otherwise. * @throws DirectoryException If a Directory Server error occurs. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ private boolean add(long entryID, ByteString[] values, AttributeType[] types) throws StorageRuntimeException, DirectoryException @@ -387,7 +387,7 @@ * @return Index of the entry matching the values and optionally the entry ID * if it is found or a negative index if its not found. * @throws DirectoryException If a Directory Server error occurs. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ int binarySearch(long entryID, ByteString... values) throws StorageRuntimeException, DirectoryException @@ -483,7 +483,7 @@ * @return The key as an array of bytes that should be used for this set in * the database or NULL if this set is empty. * @throws DirectoryException If a Directory Server error occurs. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ ByteString getKeyBytes() throws StorageRuntimeException, DirectoryException @@ -521,7 +521,7 @@ * @return The key as a sort values object that should be used for this set in * the database or NULL if this set is empty or unbounded. * @throws DirectoryException If a Directory Server error occurs. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ SortValues getKeySortValues() throws StorageRuntimeException, DirectoryException @@ -556,7 +556,7 @@ * @param index The index of the sort values to get. * @return The sort values object at the specified index. * @throws DirectoryException If a Directory Server error occurs. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ SortValues getSortValues(int index) throws StorageRuntimeException, DirectoryException { @@ -615,7 +615,7 @@ * @param index The vlvIndex of the attribute value to retrieve. * @return The byte array representation of the attribute value. * @throws DirectoryException If a Directory Server error occurs. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ ByteString getValue(int index) throws StorageRuntimeException, DirectoryException opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/State.java
@@ -57,7 +57,7 @@ * * @param index The index we need the key for. * @return the key * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ private ByteString keyForIndex(DatabaseContainer index) throws StorageRuntimeException @@ -69,10 +69,10 @@ /** * Remove a record from the entry database. * * @param txn The database transaction or null if none. * @param txn a non null database transaction * @param index The index storing the trusted state info. * @return true if the entry was removed, false if it was not. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ boolean removeIndexTrustState(WriteableTransaction txn, DatabaseContainer index) throws StorageRuntimeException { @@ -82,10 +82,10 @@ /** * Fetch index state from the database. * @param txn The database transaction or null if none. * @param txn a non null database transaction * @param index The index storing the trusted state info. * @return The trusted state of the index in the database. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ boolean getIndexTrustState(ReadableTransaction txn, DatabaseContainer index) throws StorageRuntimeException @@ -98,10 +98,10 @@ /** * Put index state to database. * @param txn The database transaction or null if none. * @param txn a non null database transaction * @param index The index storing the trusted state info. * @param trusted The state value to put into the database. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ void putIndexTrustState(WriteableTransaction txn, DatabaseContainer index, boolean trusted) throws StorageRuntimeException opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/Suffix.java
@@ -202,18 +202,16 @@ * It will optionally check the dn2id database for the dn if the specified * cleared backend boolean is {@code true}. * * @param txn The database transaction * @param txn a non null database transaction * @param dn The DN to check for. * @param dnCache The importer DN cache. * @param clearedBackend Set to {@code true} if the import process cleared the * backend before processing. * @return {@code true} if the dn is contained in the parent ID, or * {@code false} otherwise. * * @throws StorageRuntimeException If an error occurred searching the DN cache, or * dn2id database. * @throws InterruptedException If an error occurred processing the pending * map. * @throws InterruptedException If an error occurred processing the pending map */ public boolean isParentProcessed(ReadableTransaction txn, DN dn, DNCache dnCache, boolean clearedBackend) throws StorageRuntimeException, InterruptedException { opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/VLVIndex.java
@@ -127,9 +127,9 @@ * @param state The state database to persist vlvIndex state info. * @param storage The storage currently in use * @param entryContainer The database entryContainer holding this vlvIndex. the sort order * @param txn The transaction to use when creating this object * @param txn a non null database transaction * @throws StorageRuntimeException * If an error occurs in the JE database. * If an error occurs in the database. * @throws ConfigException if a error occurs while reading the VLV index * configuration */ @@ -311,8 +311,7 @@ * @param mods The sequence of modifications in the Modify operation. * @return True if the modification was successfully processed or False * otherwise. * @throws StorageRuntimeException If an error occurs during an operation on a * JE database. * @throws StorageRuntimeException If an error occurs in the database. * @throws DirectoryException If a Directory Server error occurs. */ boolean modifyEntry(IndexBuffer buffer, @@ -386,15 +385,13 @@ * Get a sorted values set that should contain the entry with the given * information. * * @param txn The transaction to use when retrieving the set or NULL if it is * not required. * @param txn a non null database transaction * @param entryID The entry ID to use. * @param values The values to use. * @param types The types of the values to use. * @return The SortValuesSet that should contain the entry with the given * information. * @throws StorageRuntimeException If an error occurs during an operation on a * JE database. * @throws StorageRuntimeException If an error occurs in the database. * @throws DirectoryException If a Directory Server error occurs. */ private SortValuesSet getSortValuesSet(ReadableTransaction txn, long entryID, @@ -442,14 +439,13 @@ * Search for entries matching the entry ID and attribute values and * return its entry ID. * * @param txn The JE transaction to use for database updates. * @param txn a non null database transaction * @param entryID The entry ID to search for. * @param values The values to search for. * @param types The types of the values to search for. * @return The index of the entry ID matching the values or -1 if its not * found. * @throws StorageRuntimeException If an error occurs during an operation on a * JE database. * @throws StorageRuntimeException If an error occurs in the database. * @throws DirectoryException If a Directory Server error occurs. */ private boolean containsValues(ReadableTransaction txn, long entryID, ByteString[] values, AttributeType[] types) @@ -479,10 +475,10 @@ /** * Update the vlvIndex with the specified values to add and delete. * * @param txn A database transaction, or null if none is required. * @param txn a non null database transaction * @param addedValues The values to add to the VLV index. * @param deletedValues The values to delete from the VLV index. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. * @throws DirectoryException If a Directory Server * error occurs. */ @@ -630,8 +626,7 @@ /** * Evaluate a search with sort control using this VLV index. * * @param txn The transaction to used when reading the index or NULL if it is * not required. * @param txn a non null database transaction * @param searchOperation The search operation to evaluate. * @param sortControl The sort request control to evaluate. * @param vlvRequest The VLV request control to evaluate or NULL if VLV is not @@ -642,7 +637,7 @@ * @return The sorted EntryIDSet containing the entry IDs that match the * search criteria. * @throws DirectoryException If a Directory Server error occurs. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ EntryIDSet evaluate(ReadableTransaction txn, SearchOperation searchOperation, @@ -935,10 +930,9 @@ /** * Set the vlvIndex trust state. * @param txn A database transaction, or null if none is required. * @param trusted True if this vlvIndex should be trusted or false * otherwise. * @throws StorageRuntimeException If an error occurs in the JE database. * @param txn a non null database transaction * @param trusted True if this vlvIndex should be trusted or false otherwise. * @throws StorageRuntimeException If an error occurs in the database. */ synchronized void setTrusted(WriteableTransaction txn, boolean trusted) throws StorageRuntimeException @@ -1273,7 +1267,7 @@ * or zero if there is no difference between the values with regard to * ordering. * @throws StorageRuntimeException * If an error occurs during an operation on a JE database. * If an error occurs during an operation on a database. * @throws DirectoryException * If an error occurs while trying to normalize the value (e.g., if * it is not acceptable for use with the associated equality opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/VerifyJob.java
@@ -135,7 +135,7 @@ * * @param rootContainer The root container that holds the entries to verify. * @return The error count. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. * @throws DirectoryException If an error occurs while verifying the backend. */ long verifyBackend(final RootContainer rootContainer) throws StorageRuntimeException, @@ -385,7 +385,7 @@ * index completeness. We check that the ID for the entry is indeed * present in the indexes for the appropriate values. * * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ private void iterateID2Entry(ReadableTransaction txn) throws StorageRuntimeException { @@ -458,7 +458,7 @@ * index cleanliness. For each ID in the index we check that the * entry it refers to does indeed contain the expected value. * * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. * @throws DirectoryException If an error occurs reading values in the index. */ private void iterateIndex(ReadableTransaction txn) throws StorageRuntimeException, DirectoryException @@ -496,7 +496,7 @@ * Iterate through the entries in DN2ID to perform a check for * index cleanliness. * * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ private void iterateDN2ID(ReadableTransaction txn) throws StorageRuntimeException { @@ -567,7 +567,7 @@ * Iterate through the entries in ID2Children to perform a check for * index cleanliness. * * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ private void iterateID2Children(ReadableTransaction txn) throws StorageRuntimeException { @@ -693,7 +693,7 @@ * Iterate through the entries in ID2Subtree to perform a check for * index cleanliness. * * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ private void iterateID2Subtree(ReadableTransaction txn) throws StorageRuntimeException { @@ -870,7 +870,7 @@ * * @param vlvIndex The VLV index to perform the check against. * @param verifyID True to verify the IDs against id2entry. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. * @throws DirectoryException If an error occurs reading values in the index. */ private void iterateVLVIndex(ReadableTransaction txn, VLVIndex vlvIndex, boolean verifyID) @@ -975,7 +975,7 @@ * Iterate through the entries in an attribute index to perform a check for * index cleanliness. * @param index The index database to be checked. * @throws StorageRuntimeException If an error occurs in the JE database. * @throws StorageRuntimeException If an error occurs in the database. */ private void iterateAttrIndex(ReadableTransaction txn, Index index, IndexingOptions options) throws StorageRuntimeException
