DistributionManager.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This 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 software 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 software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.extension.distribution.internal;

import org.xwiki.component.annotation.Role;
import org.xwiki.extension.CoreExtension;
import org.xwiki.extension.ExtensionId;
import org.xwiki.extension.distribution.internal.job.DefaultDistributionJob;
import org.xwiki.extension.distribution.internal.job.DistributionJob;
import org.xwiki.extension.distribution.internal.job.DistributionJobStatus;

/**
 * @version $Id: d00ab7d06a8d5318cea6fa0c24420a5290dc4ac5 $
 * @since 4.2M3
 */
@Role
public interface DistributionManager
{
    /**
     * The possible distribution states.
     */
    enum DistributionState
    {
        /** The distribution did not changed. */
        SAME,

        /** No distribution information can be found. */
        NONE,

        /**
         * No previous state.
         */
        NEW,

        /**
         * Previous state is an older version of the same distribution.
         */
        UPGRADE,

        /**
         * Previous state is a newer version of the same distribution.
         */
        DOWNGRADE,

        /**
         * Previous state is a different distribution.
         */
        DIFFERENT
    }

    /**
     * @return the current distribution state for the farm
     * @since 5.0RC1
     */
    DistributionState getFarmDistributionState();

    /**
     * @param wiki the wiki for which to get the distribution state
     * @return the current distribution state for the passed wiki
     * @since 5.0RC1
     */
    DistributionState getWikiDistributionState(String wiki);

    /**
     * @return the extension that defines the current distribution
     */
    CoreExtension getDistributionExtension();

    /**
     * @return the recommended user interface for main wikis
     * @since 5.0RC1
     */
    ExtensionId getMainUIExtensionId();

    /**
     * @return the recommended user interface for sub wikis
     * @since 5.0RC1
     */
    ExtensionId getWikiUIExtensionId();

    /**
     * @return the previous status of the distribution job (e.g. from last time the distribution was upgraded)
     * @since 5.0RC1
     */
    DistributionJobStatus getPreviousFarmJobStatus();

    /**
     * @param wiki the wiki form which to get the distribution status
     * @return the previous status of the distribution job (e.g. from last time the distribution was upgraded)
     * @since 5.0RC1
     */
    DistributionJobStatus getPreviousWikiJobStatus(String wiki);

    /**
     * @param wiki the wiki for which to delete the status
     * @since 5.1
     */
    void deletePreviousWikiJobStatus(String wiki);

    /**
     * Copy the wiki distribution status from one wiki to another.
     * 
     * @param sourceWiki the source wiki
     * @param targetWiki the target wiki
     * @since 5.1
     */
    void copyPreviousWikiJobStatus(String sourceWiki, String targetWiki);

    /**
     * Starts the distribution job.
     * 
     * @return the distribution job object that can be used to get information like the job status
     * @since 5.0RC1
     */
    DefaultDistributionJob startFarmJob();

    /**
     * Starts the distribution job.
     * 
     * @param wiki the wiki associated to the distribution wyzard
     * @return the distribution job object that can be used to get information like the job status
     * @since 5.0RC1
     */
    DistributionJob startWikiJob(String wiki);

    /**
     * @return the distribution job object that can be used to get information like the job status
     * @since 5.0RC1
     */
    DefaultDistributionJob getFarmJob();

    /**
     * @param wiki the wiki for which to get the job
     * @return the distribution job object that can be used to get information like the job status
     * @since 5.0RC1
     */
    DistributionJob getWikiJob(String wiki);

    /**
     * @return the current distribution job
     * @since 5.0RC1
     */
    DistributionJob getCurrentDistributionJob();

    /**
     * @return true if it's allowed to display the Distribution Wizard in the current context
     */
    boolean canDisplayDistributionWizard();
}