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.util.Map;
020
021import org.nuxeo.connect.update.PackageException;
022import org.nuxeo.connect.update.ValidationStatus;
023import org.nuxeo.connect.update.task.Command;
024import org.nuxeo.connect.update.task.Task;
025import org.nuxeo.connect.update.xml.XmlWriter;
026import org.w3c.dom.Element;
027
028/**
029 * Flush any cache held by the core. This should be used when document types are installed or removed.
030 * <p>
031 * The inverse of this command is itself.
032 *
033 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
034 */
035public class FlushJaasCachePlaceholder extends PostInstallCommand {
036
037    public static final String ID = "flush-jaas";
038
039    public FlushJaasCachePlaceholder() {
040        super(ID);
041    }
042
043    @Override
044    protected void doValidate(Task task, ValidationStatus status) throws PackageException {
045        // nothing to do
046    }
047
048    @Override
049    protected Command doRun(Task task, Map<String, String> prefs) throws PackageException {
050        // standalone mode: nothing to do
051        return new FlushJaasCachePlaceholder();
052    }
053
054    public void readFrom(Element element) throws PackageException {
055    }
056
057    public void writeTo(XmlWriter writer) {
058        writer.start(ID);
059        writer.end();
060    }
061}