/**********************************************************************************
* $URL: https://source.sakaiproject.org/svn/search/trunk/search-impl/impl/src/java/org/sakaiproject/search/journal/api/JournalStorage.java $
* $Id: JournalStorage.java 105078 2012-02-24 23:00:38Z ottenhoff@longsight.com $
***********************************************************************************
*
* Copyright (c) 2003, 2004, 2005, 2006, 2007, 2008 The Sakai Foundation
*
* Licensed under the Educational Community 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.opensource.org/licenses/ECL-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 org.sakaiproject.search.journal.api;
import java.io.IOException;
/**
* Journal storare provides bulk storage to the journal objects being stored.
*
* @author ieb
*/
public interface JournalStorage
{
/**
* Get a savePoint from the committed store into a permanent local space,
* indexed on the transaction or savePoint id
*
* @param savePoint
* @param workingSpace
* @throws IOException
*/
void retrieveSavePoint(long savePoint, String workingSpace) throws IOException;
/**
* prepare the current transaction for commit, 2PC
*
* @param location
* @param transactionId
* @return
* @throws IOException
*/
JournalStorageState prepareSave(String location, long transactionId)
throws IOException;
/**
* perform the commit on the transaction in jss
*
* @param jss
* @throws IOException
*/
void commitSave(JournalStorageState jss) throws IOException;
/**
* rollback the transaction in jss
*
* @param jss
*/
void rollbackSave(JournalStorageState jss);
}