001/*
002 * (C) Copyright 2006-2010 Nuxeo SAS (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     bstefanescu
016 */
017package org.nuxeo.connect.update.task.standalone.commands;
018
019import java.io.File;
020import java.util.Map;
021
022import org.nuxeo.connect.update.PackageException;
023import org.nuxeo.connect.update.ValidationStatus;
024import org.nuxeo.connect.update.task.Command;
025import org.nuxeo.connect.update.task.Task;
026import org.nuxeo.connect.update.xml.XmlWriter;
027import org.w3c.dom.Element;
028
029/**
030 * Deploy an OSGi bundle into the running platform. The bundle is specified using the absolute bundle file path. The
031 * inverse of this command is the Undeploy command.
032 *
033 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
034 */
035public class InstallPlaceholder extends AbstractCommand {
036
037    public static final String ID = "install";
038
039    protected File file;
040
041    public InstallPlaceholder() {
042        super(ID);
043    }
044
045    public InstallPlaceholder(File file) {
046        super(ID);
047        this.file = file;
048    }
049
050    @Override
051    protected void doValidate(Task task, ValidationStatus status) throws PackageException {
052        if (file == null) {
053            status.addError("Invalid install syntax: No file specified");
054        }
055    }
056
057    @Override
058    protected Command doRun(Task task, Map<String, String> prefs) throws PackageException {
059        // standalone mode: nothing to do
060        return new UninstallPlaceholder(file);
061    }
062
063    public void readFrom(Element element) throws PackageException {
064        String v = element.getAttribute("file");
065        if (v.length() > 0) {
066            file = new File(v);
067            guardVars.put("file", file);
068        }
069    }
070
071    public void writeTo(XmlWriter writer) {
072        writer.start(ID);
073        if (file != null) {
074            writer.attr("file", file.getAbsolutePath());
075        }
076        writer.end();
077    }
078}