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 * Install bundle, flush any application cache and perform Nuxeo preprocessing on the bundle.
031 * <p>
032 * The inverse of this command is Undeploy.
033 *
034 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
035 */
036public class DeployPlaceholder extends AbstractCommand {
037
038    public static final String ID = "deploy";
039
040    protected File file;
041
042    public DeployPlaceholder() {
043        super(ID);
044    }
045
046    public DeployPlaceholder(File file) {
047        super(ID);
048        this.file = file;
049    }
050
051    @Override
052    protected void doValidate(Task task, ValidationStatus status) throws PackageException {
053        // nothing to do
054    }
055
056    @Override
057    protected Command doRun(Task task, Map<String, String> prefs) throws PackageException {
058        if (!file.isFile()) {
059            // avoid throwing errors - this may happen at uninstall for broken
060            // packages
061            return null;
062        }
063        // standalone mode: nothing to do
064        return new UndeployPlaceholder(file);
065    }
066
067    public void readFrom(Element element) throws PackageException {
068        String v = element.getAttribute("file");
069        if (v.length() > 0) {
070            file = new File(v);
071            guardVars.put("file", file);
072        }
073    }
074
075    public void writeTo(XmlWriter writer) {
076        writer.start(ID);
077        if (file != null) {
078            writer.attr("file", file.getAbsolutePath());
079        }
080        writer.end();
081    }
082}