/*
* Copyright (C) 2009 eXo Platform SAS.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.exoplatform.jcr.backupconsole;
import java.io.IOException;
import java.io.InputStream;
/**
* Created by The eXo Platform SAS. <br>Date:
*
* @author <a href="karpenko.sergiy@gmail.com">Karpenko Sergiy</a>
* @version $Id: BackupClient.java 111 2008-11-11 11:11:11Z serg $
*/
public interface BackupClient
{
/**
* Start backup of repository or workspace.
* If workspaceName is 'null', then repository backup will be started.
*
* @param repositoryName
* String, the repository name.
* @param workspaceName
* String, the workspace name.
* @param backupDir
* path to backup folder on remote server
* @return String
* result
* @throws IOException
* transport exception.
* @throws BackupExecuteException
* backup client internal exception.
*/
String startBackUp(String repositoryName, String workspaceName, String backupDir) throws IOException,
BackupExecuteException;
/**
* Start Incremental Backup of repository or workspace.
* If workspaceName is 'null', then repository backup will be started.
*
* @param repositoryName
* String, the repository name
* @param workspaceName
* String, the workspace name
* @param incr
* incremental job period.
* @param backupDir
* path to backup folder on remote server
* @return String
* result
* @throws IOException
* transport exception
* @throws BackupExecuteException
* backup client internal exception
*/
String startIncrementalBackUp(String repositoryName, String workspaceName, String backupDir, long incr)
throws IOException, BackupExecuteException;
/**
* Get Status of backup.
*
* @param backupId
* the backup identifier.
* @return String
* result.
* @throws IOException
* transport exception.
* @throws BackupExecuteException
* backup client internal exception.
*/
String status(String backupId) throws IOException, BackupExecuteException;
/**
* Get information about backup service.
*
* @return String
* result
* @throws IOException
* transport exception
* @throws BackupExecuteException
* backup client internal exception
*/
String info() throws IOException, BackupExecuteException;
/**
* Get information about current restores of repository or workspace.
* If workspaceName is 'null', then will be get status of repository backup.
*
* @param repositoryName
* String, the repository name
* @param workspaceName
* String, the workspace name
* @return String
* result
* @throws IOException
* transport exception
* @throws BackupExecuteException
* backup client internal exception
*/
String restores(String repositoryName, String workspaceName) throws IOException, BackupExecuteException;
/**
* Restore repository or workspace from backup file.
* If workspaceName is 'null', then will be run restore of repository.
*
* @param repositoryName
* String, the repository name
* @param workspaceName
* String, the workspace name
* @param backupId
* the backup identifier
* @param config
* InputStream contains workspace configuration
* @param backupSetPath
* String, path to backup set directory on server side
* @param removeExosts
* boolean. if 'true' then will be removed(clean db, value storage, index) existed repository/workspace.
* @return String
* result
* @throws IOException
* transport exception
* @throws BackupExecuteException
* backup client internal exception
*/
String restore(String repositoryName, String workspaceName, String backupId, InputStream config,
String backupSetPath, boolean removeExosts)
throws IOException,
BackupExecuteException;
/**
* Stop backup.
*
* @param backupId
* the backup identifier
* @return String
* result
* @throws IOException
* transport exception
* @throws BackupExecuteException
* backup client internal exception
*/
String stop(String backupId) throws IOException, BackupExecuteException;
/**
* Drop workspace or repository.
* If workspaceName is 'null', then repository will be dropped.
*
* @param forceClose
* force sessions close on repository or workspace
* @param repositoryName
* String, the repository name
* @param workspaceName
* String, the workspace name
* @return String
* result
* @throws IOException
* transport exception
* @throws BackupExecuteException
* backup client internal exception
*/
String drop(boolean forceClose, String repositoryName, String workspaceName) throws IOException,
BackupExecuteException;
/**
* Get information about the current backups (in progress).
*
* @return String
* result
* @throws IOException
* transport exception
* @throws BackupExecuteException
* backup client internal exception
*/
String list() throws IOException, BackupExecuteException;
/**
* Get information about the completed (ready to restore) backups.
*
* @return String
* result
* @throws IOException
* transport exception
* @throws BackupExecuteException
* backup client internal exception
*/
String listCompleted() throws IOException, BackupExecuteException;
}