StorageEngine.java

/**
 * Copyright 2013 Benjamin Lerer
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.horizondb.db;

import io.horizondb.db.commitlog.ReplayPosition;
import io.horizondb.db.databases.DatabaseManager;
import io.horizondb.io.ReadableBuffer;
import io.horizondb.model.protocol.Msg;

import java.io.IOException;

import com.google.common.util.concurrent.ListenableFuture;

/**
 * The storage engine used to persist an retrieve data.
 * 
 */
public interface StorageEngine extends Component {

    /**
     * Returns the database manager
     * @return the database manager
     */
    DatabaseManager getDatabaseManager();

    /**
     * Executes the operation requested by the specified message 
     *  
     * @param request the message
     * @param future the commit log future or <code>null</code> if the message was not a mutation.
     * @return the message response
     * @throws IOException if an I/O problem occurs
     * @throws HorizonDBException if a problem occurs while processing the request
     */
    Object execute(Msg<?> request, ListenableFuture<ReplayPosition> future) throws IOException, HorizonDBException;

    /**
     * Flush to the disk all the data that have not been persisted yet and that come from the 
     * segment with the specified ID.
     * 
     * @param id the segment id
     * @return a <code>ListenableFuture</code> that will return when all the data have been flushed to disk.
     * @throws InterruptedException if the thread is interrupted
     */
    ListenableFuture<Boolean> forceFlush(long id) throws InterruptedException;

    /**
     * Replays the specified message. 
     * 
     * @param replayPosition the replay position associated with the message
     * @param buffer the message in its binary form
     * @throws IOException if an I/O problem occurs during the replay
     */
    void replay(ReplayPosition replayPosition, ReadableBuffer buffer) throws IOException;
}