prerna.io.connector.secrets.ISecrets 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.io.connector.secrets;

import java.util.Map;

import prerna.engine.api.IEngine;

public interface ISecrets {

	String SECRETS_DB_PATH = "SECRETS_DB_PATH";
	String SECRETS_STORAGE_PATH = "SECRETS_STORAGE_PATH";
	String SECRETS_MODEL_PATH = "SECRETS_MODEL_PATH";
	String SECRETS_VECTOR_PATH = "SECRETS_VECTOR_PATH";
	String SECRETS_FUNCTION_PATH = "SECRETS_FUNCTION_PATH";
	String SECRETS_PROJECT_PATH = "SECRETS_PROJECT_PATH";
	String SECRETS_VENV_PATH = "SECRETS_VENV_PATH";
	
	String INSIGHT_ENCRYPTION_NAME = "insightencrypt";
	
	String AZURE_KEYVAULT = "AZURE_KEYVAULT";
	String HASHICORP_VAULT = "HASHICORP_VAULT";
	String IV = "iv";
	String SECRET = "secret";
	String SALT = "salt";
	
	
	/**
	 * 
	 * @param eType
	 * @param engineId
	 * @param engineName
	 * @return
	 */
	Map getEngineSecrets(IEngine.CATALOG_TYPE eType, String engineId, String engineName);
	
	/**
	 * Get the secrets associated with an insight
	 * @param projectId
	 * @param projectName
	 * @param insightId
	 * @return
	 */
	Map getInsightSecrets(String projectId, String projectName, String insightId);

	/**
	 * Get the insight encryption key
	 * @param projectId
	 * @param projectName
	 * @param insightId
	 * @return
	 */
	Map getInsightEncryptionSecrets(String projectId, String projectName, String insightId);
	
	/**
	 * Write a secret key-value pair for an engine
	 * @param eType
	 * @param engineId
	 * @param engineName
	 * @param key
	 * @param value
	 * @return
	 */
	boolean writeEngineSecret(IEngine.CATALOG_TYPE eType, String engineId, String engineName, String key, Object value);

	/**
	 * Write a set of secret key-value pairs for an engine
	 * @param eType
	 * @param engineId
	 * @param engineName
	 * @param nameValuePairs
	 * @return
	 */
	boolean writeEngineSecrets(IEngine.CATALOG_TYPE eType, String engineId, String engineName, Map nameValuePairs);

	/**
	 * Write a secret key-value pair for a insight
	 * @param projectId
	 * @param projectName
	 * @param insightId
	 * @param key
	 * @param value
	 * @return
	 */
	boolean writeInsightSecret(String projectId, String projectName, String insightId, String key, Object value);

	/**
	 * Write a set of secret key-value pairs for a insight
	 * @param projectId
	 * @param projectName
	 * @param insightId
	 * @param nameValuePairs
	 * @return
	 */
	boolean writeInsightSecrets(String projectId, String projectName, String insightId, Map nameValuePairs);

	/**
	 * Write the secret for the insight encryption
	 * @param projectId
	 * @param projectName
	 * @param insightId
	 * @param nameValuePairs
	 * @return
	 */
	boolean writeInsightEncryptionSecrets(String projectId, String projectName, String insightId, Map nameValuePairs);

}