prerna.engine.api.IStorageEngine 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;
import java.util.Properties;

public interface IStorageEngine extends IEngine {

	// this is what the FE sends for the type of storage we are creating
	// as a result, cannot be a key in the smss file
	String STORAGE_TYPE = "STORAGE_TYPE";
	
	/**
	 * 
	 * @return
	 */
	StorageTypeEnum getStorageType();
	
	/**
	 * 
	 * @param smssProp
	 */
	void open(Properties smssProp) throws Exception;


	/**
	 * 
	 * @param path
	 * @return
	 * @throws Exception 
	 */
	List list(String path) throws Exception;
	
	/**
	 * 
	 * @param path
	 * @return
	 * @throws IOException
	 * @throws InterruptedException
	 */
	List> listDetails(String path) throws Exception;
	
	/**
	 * 
	 * @param localPath
	 * @param storagePath
	 * @param metadata
	 * @throws Exception
	 */
	void syncLocalToStorage(String localPath, String storagePath, Map metadata) throws Exception;
	
	/**
	 * 
	 * @param storagePath
	 * @param localPath
	 * @throws Exception
	 */
	void syncStorageToLocal(String storagePath, String localPath) throws Exception;
	
	/**
	 * 
	 * @param localFilePath
	 * @param storageFolderPath
	 * @param metadata
	 * @throws Exception
	 */
	void copyToStorage(String localFilePath, String storageFolderPath, Map metadata) throws Exception;
	
	/**
	 * 
	 * @param storageFilePath
	 * @param localFolderPath
	 * @throws Exception
	 */
	void copyToLocal(String storageFilePath, String localFolderPath) throws Exception;

	/**
	 * 
	 * @param storageFilePath
	 * @throws Exception
	 */
	void deleteFromStorage(String storagePath) throws Exception;

	/**
	 * 
	 * @param storagePath
	 * @param leaveFolderStructure
	 * @throws Exception
	 */
	void deleteFromStorage(String storagePath, boolean leaveFolderStructure) throws Exception;

	/**
	 * 
	 * @param storageFolderPath
	 * @throws Exception
	 */
	void deleteFolderFromStorage(String storageFolderPath) throws Exception;
	
}