/*
 * Copyright (C) 2003-2010 eXo Platform SAS.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Affero General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see<http://www.gnu.org/licenses/>.
 */
package org.exoplatform.services.jcr.impl.core.query;

import java.io.InputStream;
import java.util.List;

import javax.jcr.RepositoryException;

/**
 * Created by The eXo Platform SAS.
 *
 * Date: 16.02.2011
 * 
 * @author <a href="mailto:anatoliy.bazko@exoplatform.com.ua">Anatoliy Bazko</a>
 * @version $Id: IndexRecovery.java 34360 2010-11-11 11:11:11Z tolusha $
 */
public interface IndexRecovery
{

   /**
    * Switch index offline.
    *
    * @throws RepositoryException
    *          if any exception occurred
    */
   public void setIndexOffline() throws RepositoryException;

   /**
    * Switch index online.
    *
    * @throws RepositoryException
    *          if any exception occurred
    */
   public void setIndexOnline() throws RepositoryException;

   /**
    * Get list of relative paths of all files from index directory.
    * 
    * @return List
    * @throws RepositoryException
    *          if any exception occurred
    */
   public List<String> getIndexList() throws RepositoryException;

   /**
    * Get coordinator address
    *
    * @return String coordinator address
    * @throws RepositoryException
    *          if any exception occurred
    */
   public String getCoordinatorAddress() throws RepositoryException;

   /**
    * Get input stream of index file.
    * @param filePath
    *         String, relative file path
    * @return InputStream
    * @throws RepositoryException
    *          if any exception occurred
    */
   public InputStream getIndexFile(String filePath) throws RepositoryException;
   
   /**
    * Check if index is ready and can be retrieved.
    * 
    * @return
    * @throws RepositoryException if error occurs.
    */
   public boolean checkIndexReady() throws RepositoryException;

   /**
    * Frees resources associated with index recovery.
    */
   public void close();
}
