ProjectScavenger.java

/*
 * Copyright (c) 2012 Data Harmonisation Panel
 * 
 * All rights reserved. This program and the accompanying materials are made
 * available under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the License,
 * or (at your option) any later version.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution. If not, see <http://www.gnu.org/licenses/>.
 * 
 * Contributors:
 *     Data Harmonisation Panel <http://www.dhpanel.eu>
 */

package eu.esdihumboldt.hale.server.projects;

import java.io.File;

import eu.esdihumboldt.hale.common.core.io.project.ProjectInfo;
import eu.esdihumboldt.hale.common.headless.EnvironmentManager;
import eu.esdihumboldt.hale.common.headless.TransformationEnvironment;
import eu.esdihumboldt.hale.server.projects.impl.ProjectHandler;
import eu.esdihumboldt.util.scavenger.ResourceScavenger;

/**
 * Service that scans for projects in a directory. Manages if projects are
 * active and in that case publishes them as {@link TransformationEnvironment}s
 * to an {@link EnvironmentManager}.
 * 
 * @author Simon Templer
 */
public interface ProjectScavenger extends ResourceScavenger<ProjectHandler> {

	/**
	 * Project states
	 */
	public enum Status {
		/** This project does not exist */
		NOT_AVAILABLE,
		/** The project exists but cannot be loaded */
		BROKEN,
		/** The project is deactivated */
		INACTIVE,
		/** The project is loaded and enabled */
		ACTIVE
	}

	/**
	 * Get the status of the project with the given identifier.
	 * 
	 * @param projectId the project identifier
	 * @return the project status
	 */
	public Status getStatus(String projectId);

	/**
	 * Get the file where the reports form loading the project are stored. The
	 * file may not be changed, deleted, etc.
	 * 
	 * @param projectId the project identifier
	 * @return the log file or <code>null</code> if the project with the given
	 *         identifier does not exist
	 */
	public File getLoadReports(String projectId);

	/**
	 * Get the project info for the project with the given identifier, if
	 * available.
	 * 
	 * @param projectId the project identifier
	 * @return the project info or <code>null</code>
	 */
	public ProjectInfo getInfo(String projectId);

	/**
	 * Activate the project with the given identifier.
	 * 
	 * @param projectId the project identifier
	 */
	public void activate(String projectId);

	/**
	 * Activate the project with the given identifier.
	 * 
	 * @param projectId the project identifier
	 */
	public void deactivate(String projectId);

}