ArtifactInstaller.java

/*
 * Copyright (C) 2007 Rob Manning
 * manningr@users.sourceforge.net
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
package net.sourceforge.squirrel_sql.client.update.gui.installer;


import java.io.FileNotFoundException;
import java.io.IOException;

import net.sourceforge.squirrel_sql.client.update.gui.installer.event.InstallStatusListener;
import net.sourceforge.squirrel_sql.client.update.xmlbeans.ChangeListXmlBean;
import net.sourceforge.squirrel_sql.fw.util.FileWrapper;

/**
 * Interface for the class that applies changes given in a ChangeListXmlBean to the actual installed files,
 * using the download files. Provision for backing up current version of files and restoring is also provided.
 */
public interface ArtifactInstaller
{

	/**
	 * Adds the specified InstallStatusListener for the purpose of notification using InstallStatusEvents.
	 * 
	 * @param listener the listener to add.
	 */
	void addListener(InstallStatusListener listener);

	/**
	 * 
	 * @return
	 * @throws FileNotFoundException
	 * @throws IOException
	 */
	boolean backupFiles() throws FileNotFoundException, IOException;

	/**
	 * 
	 * @throws FileNotFoundException
	 * @throws IOException
	 */
	void installFiles() throws FileNotFoundException, IOException;

	/**
	 * 
	 * @throws FileNotFoundException
	 * @throws IOException
	 */
	boolean restoreBackupFiles() throws FileNotFoundException, IOException;
		
	/**
	 * @param changeList
	 * @throws FileNotFoundException
	 */
	void setChangeList(ChangeListXmlBean changeList) throws FileNotFoundException;

	/**
	 * @return the changeListFile
	 */
	FileWrapper getChangeListFile();

	/**
	 * @param changeListFile the changeListFile to set
	 */
	void setChangeListFile(FileWrapper changeListFile);


}