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.scheduler;
029
030import org.opencms.file.CmsObject;
031
032import java.util.Map;
033
034/**
035 * Identifies a class that can be scheduled with the OpenCms scheduler.<p>
036 *
037 * Please read the documentation for <code>{@link org.opencms.scheduler.CmsScheduledJobInfo}</code>
038 * to learn how to schedule a job in OpenCms.<p>
039 *
040 * @since 6.0.0
041 */
042public interface I_CmsScheduledJob {
043
044    /**
045     * This method will be called when this scheduled job is executed.<p>
046     *
047     * Depending on the configuration of this job, a new instance of
048     * the configured class will be instantiated every time the job is launched,
049     * or a new instance will be generated only the first time the
050     * job is launched, and re-used afterwards.<p>
051     *
052     * The result String will be written to the OpenCms logfile in the
053     * <code>org.opencms.scheduler.CmsScheduleManager</code> channel,
054     * on <code>INFO</code> log level.<p>
055     *
056     * @param cms will be initialized with the configured users cms context
057     * @param parameters the configured parameters
058     *
059     * @return a String that will be written to the OpenCms logfile
060     *
061     * @throws Exception if something goes wrong
062     *
063     * @see CmsScheduledJobInfo
064     * @see CmsScheduledJobInfo#setReuseInstance(boolean)
065     */
066    String launch(CmsObject cms, Map<String, String> parameters) throws Exception;
067}