ModuleManagerRemote.java

/**
 * Copyright (C) 2013 Colorado School of Mines
 *
 * This file is part of the Interface Software Development Kit (SDK).
 *
 * The InterfaceSDK is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * The InterfaceSDK 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 the InterfaceSDK.  If not, see <http://www.gnu.org/licenses/>.
 */
package edu.mines.acmX.exhibit.module_management;

import java.io.InputStream;
import java.rmi.Remote;
import java.rmi.RemoteException;
import java.util.Map;

import edu.mines.acmX.exhibit.module_management.loaders.ManifestLoadException;
import edu.mines.acmX.exhibit.module_management.loaders.ModuleLoadException;
import edu.mines.acmX.exhibit.module_management.metas.ModuleMetaData;
import edu.mines.acmX.exhibit.module_management.modules.CommandlineModule;
import edu.mines.acmX.exhibit.module_management.modules.ProcessingModule;

/**
 * The ModuleManagerRemote class defines the interaction between ModuleManager
 * and its modules. This interface will be used to define the stub for Remote
 * Method Invocation (RMI).
 * 
 * Note the ScannerInterface was added to make it possible to delegate actions
 * with System.in to the ModuleManager so that we can execute in separate
 * processes (see CLIModuleLauncher (cltest))
 * 
 * WARNING
 * 
 * Please be careful modifying this interface as the module delegators (
 * {@link ProcessingModule}, {@link CommandlineModule}, etc) are vulnerable to
 * not stopping java from compiling successfully even though a new method has
 * been added to one of the interfaces. So, if you modify any of the interfaces
 * relevant to the module delegators, please check to make sure that you have
 * added the proper method to EACH of the delegators
 * 
 * @author andrew
 * 
 */
public interface ModuleManagerRemote extends Remote, ScannerInterface {
	public boolean setNextModule(String name) throws RemoteException;

	public ModuleMetaData getDefaultModuleMetaData() throws RemoteException;

	public String[] getAllAvailableModules() throws RemoteException;

	public String getCurrentModulePackageName() throws RemoteException;

	public ModuleMetaData getModuleMetaData(String packageName)
			throws RemoteException;

	public Map<String,String> getConfigurations() throws RemoteException;

	public String getPathToModules() throws RemoteException;

}