001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software GmbH & Co. KG, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.publish;
029
030import org.opencms.util.CmsUUID;
031
032/**
033 * This interface listens to events for a specific publish job.<p>
034 *
035 * The life cycle of publish is following:
036 * <ul>
037 *   <li>created, getting immediatly
038 *   <li>enqueued, getting the state waiting
039 *   <li>during waiting it could be aborted, getting removed (only the abort event is triggered)
040 *   <li>started, getting the state running
041 *   <li>finished, getting the state finished
042 *   <li>removed
043 * </ul>
044 *
045 * During the waiting state a publish job can be aborted for shutdown.<p>
046 *
047 * @since 6.5.5
048 */
049public interface I_CmsPublishEventListener {
050
051    /**
052     * Called when the job is going to be aborted, this may happen during the shutdown
053     * And can only happen if the job is waiting.<p>
054     *
055     * @param userId the id of the user that aborted the job
056     * @param publishJob the publish job that is going to be aborted
057     */
058    void onAbort(CmsUUID userId, CmsPublishJobEnqueued publishJob);
059
060    /**
061     * Called once the job is going to be enqueued.<p>
062     *
063     * @param publishJob the publish job that is going to be enqueued
064     */
065    void onEnqueue(CmsPublishJobBase publishJob);
066
067    /**
068     * Called once the job has finished.<p>
069     *
070     * @param publishJob the publish job that has finished
071     */
072    void onFinish(CmsPublishJobRunning publishJob);
073
074    /**
075     * Called once the job is going to be removed from the history.<p>
076     *
077     * @param publishJob the publish job that is going to be removed from the history
078     */
079    void onRemove(CmsPublishJobFinished publishJob);
080
081    /**
082     * Called once the job is going to start.<p>
083     *
084     * @param publishJob the publish job that is going to start
085     */
086    void onStart(CmsPublishJobEnqueued publishJob);
087}