/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at legal-notices/CDDLv1_0.txt.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
*
* Copyright 2014-2015 ForgeRock AS
*/
/**
* This interface abstracts the underlying storage engine,
* isolating the pluggable backend generic code from a particular storage engine implementation.
*/
{
/**
* Starts the import operation.
* @return a new Importer object which must be closed to release all resources
* @throws ConfigException
* if there is a problem with the configuration
* @throws StorageRuntimeException
* if a problem occurs with the underlying storage engine
* @see #close() to release all resources once import is finished
*/
/**
* Opens the storage engine to allow executing operations on it.
*
* @param accessMode
* Specify the access mode to this storage.
* @throws NullPointerException
* if accessMode is null.
* @throws Exception
* if a problem occurs with the underlying storage engine
* @see #close() to release all resources once import is finished
*/
/**
* Executes a read operation. In case of a read operation rollback, implementations must ensure
* the read operation is retried until it succeeds.
*
* @param <T>
* type of the value returned
* @param readOperation
* the read operation to execute
* @return the value read by the read operation
* @throws Exception
* if a problem occurs with the underlying storage engine
*/
/**
* Executes a write operation. In case of a write operation rollback, implementations must ensure
* the write operation is retried until it succeeds.
*
* @param writeOperation
* the write operation to execute
* @throws Exception
* if a problem occurs with the underlying storage engine
*/
/**
* Remove all files for a backend of this storage.
*
* @throws StorageRuntimeException if removal fails
*/
/**
* Returns the current status of the storage.
*
* @return the current status of the storage
*/
/**
* Returns {@code true} if this storage supports backup and restore.
*
* @return {@code true} if this storage supports backup and restore.
*/
boolean supportsBackupAndRestore();
/**
* Creates a backup for this storage.
*
* @param backupConfig
* The configuration to use when performing the backup.
* @throws DirectoryException
* If a Directory Server error occurs.
*/
/**
* Removes a backup for this storage.
*
* @param backupDirectory
* The backup directory structure with which the specified backup is
* associated.
* @param backupID
* The backup ID for the backup to be removed.
* @throws DirectoryException
* If it is not possible to remove the specified backup.
*/
/**
* Restores a backup for this storage.
*
* @param restoreConfig
* The configuration to use when performing the restore.
* @throws DirectoryException
* If a Directory Server error occurs.
*/
/**
* Lists the trees that exist in this storage.
*
* @return a set of {@link TreeName}s representing the trees that exist in this storage
*/
void close();
}