001/*
002 * (C) Copyright 2006-2010 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     bstefanescu
018 */
019package org.nuxeo.connect.update.task.standalone.commands;
020
021import java.util.Map;
022
023import org.nuxeo.connect.update.PackageException;
024import org.nuxeo.connect.update.ValidationStatus;
025import org.nuxeo.connect.update.task.Command;
026import org.nuxeo.connect.update.task.Task;
027import org.nuxeo.connect.update.xml.XmlWriter;
028import org.w3c.dom.Element;
029
030/**
031 * Flush any cache held by the core. This should be used when document types are installed or removed.
032 * <p>
033 * The inverse of this command is itself.
034 *
035 * @author <a href="mailto:[email protected]">Bogdan Stefanescu</a>
036 */
037public class FlushJaasCachePlaceholder extends PostInstallCommand {
038
039    public static final String ID = "flush-jaas";
040
041    public FlushJaasCachePlaceholder() {
042        super(ID);
043    }
044
045    @Override
046    protected void doValidate(Task task, ValidationStatus status) throws PackageException {
047        // nothing to do
048    }
049
050    @Override
051    protected Command doRun(Task task, Map<String, String> prefs) throws PackageException {
052        // standalone mode: nothing to do
053        return new FlushJaasCachePlaceholder();
054    }
055
056    public void readFrom(Element element) throws PackageException {
057    }
058
059    public void writeTo(XmlWriter writer) {
060        writer.start(ID);
061        writer.end();
062    }
063}