/*
|
* The contents of this file are subject to the terms of the Common Development and
|
* Distribution License (the License). You may not use this file except in compliance with the
|
* License.
|
*
|
* You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
|
* specific language governing permission and limitations under the License.
|
*
|
* When distributing Covered Software, include this CDDL Header Notice in each file and include
|
* the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
|
* Header, with the fields enclosed by brackets [] replaced by your own identifying
|
* information: "Portions Copyright [year] [name of copyright owner]".
|
*
|
* Copyright 2014-2015 ForgeRock AS.
|
* Portions Copyright 2026 3A Systems, LLC.
|
*/
|
package org.opends.server.backends.pluggable.spi;
|
|
/**
|
* Function performing a read operation.
|
*
|
* @param <T>
|
* type of the value that is read and returned by this read operation
|
*/
|
// @FunctionalInterface
|
public interface ReadOperation<T>
|
{
|
/**
|
* Executes a read operation, and returns the read value.
|
* <p>
|
* Implementations need not be idempotent: unlike {@link WriteOperation}, a read operation is never replayed by
|
* {@link Storage#read(ReadOperation)}, so it is free to print, to write to a stream, or to accumulate state
|
* outside of the transaction.
|
*
|
* @param txn
|
* the read transaction where to execute the read operation
|
* @return the read value
|
* @throws Exception
|
* if a problem occurs with the underlying storage engine
|
*/
|
T run(ReadableTransaction txn) throws Exception;
|
}
|
