prerna.engine.api.IRCloneStorage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of semoss Show documentation
SEMOSS
The newest version!
package prerna.engine.api;

import java.io.IOException;
import java.util.List;
import java.util.Map;

public interface IRCloneStorage extends IStorageEngine {

	/**
	 * Determine if a shared/created r clone config can be shared between methods
	 * @return
	 */
	boolean canReuseRcloneConfig();
	
	/**
	 * Set the folder path for writing the config files on execution
	 * @param folderPath
	 */
	void setRCloneConfigFolder(String folderPath);
	
	/**
	 * This method is responsible for creating the specific r clone configuration object for this storage type
	 * @throws IOException
	 * @throws InterruptedException
	 */
	String createRCloneConfig() throws IOException, InterruptedException;
	
	/**
	 * 
	 * @param rCloneConfig
	 * @throws IOException
	 * @throws InterruptedException
	 */
	void deleteRcloneConfig(String rCloneConfig) throws IOException, InterruptedException;
	
	/**
	 * Lists the folders and files for the relative path provided
	 * Note - not recursive
	 * @param path
	 * @param rCloneConfig
	 * @return
	 * @throws IOException
	 * @throws InterruptedException
	 */
	List list(String path, String rCloneConfig) throws IOException, InterruptedException;
	
	/**
	 * 
	 * @param path
	 * @return
	 * @throws IOException
	 * @throws InterruptedException
	 */
	List> listDetails(String path, String rCloneConfig) throws IOException, InterruptedException;

	/**
	 * 
	 * @param localPath
	 * @param storagePath
	 * @param rCloneConfig
	 * @param metadata
	 * @throws IOException
	 * @throws InterruptedException
	 */
	void syncLocalToStorage(String localPath, String storagePath, String rCloneConfig, Map metadata) throws IOException, InterruptedException;

	/**
	 * 
	 * @param storagePath
	 * @param localPath
	 * @param rCloneConfig
	 * @throws IOException
	 * @throws InterruptedException
	 */
	void syncStorageToLocal(String storagePath, String localPath, String rCloneConfig) throws IOException, InterruptedException;
	
	/**
	 * Copy (without deleting) the file to the storage engine
	 * @param localFilePath
	 * @param storageFolderPath
	 * @param rCloneConfig
	 * @param metadata
	 * @throws IOException
	 * @throws InterruptedException
	 */
	void copyToStorage(String localFilePath, String storageFolderPath, String rCloneConfig, Map metadata) throws IOException, InterruptedException;
	
	/**
	 * Copy (without deleting) the file to a local location
	 * @param storageFilePath
	 * @param localFolderPath
	 * @param rCloneConfig
	 * @throws IOException
	 * @throws InterruptedException
	 */
	void copyToLocal(String storageFilePath, String localFolderPath, String rCloneConfig) throws IOException, InterruptedException;

	/**
	 * Delete the folder or file from the storage engine
	 * Will delete the directory structure 
	 * @param storageFilePath
	 * @param rCloneConfig
	 * @throws IOException
	 * @throws InterruptedException
	 */
	void deleteFromStorage(String storageFilePath, String rCloneConfig) throws IOException, InterruptedException;

	/**
	 * Delete the folder or file from the storage engine
	 * @param storageFilePath
	 * @param leaveFolderStructure
	 * @param rCloneConfig
	 * @throws IOException
	 * @throws InterruptedException
	 */
	void deleteFromStorage(String storageFilePath, boolean leaveFolderStructure, String rCloneConfig) throws IOException, InterruptedException;
	
	/**
	 * 
	 * @param storageFolderPath
	 * @param rCloneConfig
	 * @throws IOException
	 * @throws InterruptedException
	 */
	void deleteFolderFromStorage(String storageFolderPath, String rCloneConfig) throws IOException, InterruptedException;
	
}