org.opencms.scheduler.I_CmsScheduledJob Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opencms-test Show documentation

OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.

There is a newer version: 18.0

Show newest version

/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
 *
 * This library 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 library 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.
 *
 * For further information about Alkacon Software GmbH & Co. KG, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.scheduler;

import org.opencms.file.CmsObject;

import java.util.Map;

/**
 * Identifies a class that can be scheduled with the OpenCms scheduler.
 *
 * Please read the documentation for {@link org.opencms.scheduler.CmsScheduledJobInfo}
 * to learn how to schedule a job in OpenCms.

 *
 * @since 6.0.0
 */
public interface I_CmsScheduledJob {

    /**
     * This method will be called when this scheduled job is executed.

     *
     * Depending on the configuration of this job, a new instance of
     * the configured class will be instantiated every time the job is launched,
     * or a new instance will be generated only the first time the
     * job is launched, and re-used afterwards.

     *
     * The result String will be written to the OpenCms logfile in the
     * org.opencms.scheduler.CmsScheduleManager channel,
     * on INFO log level.
     *
     * @param cms will be initialized with the configured users cms context
     * @param parameters the configured parameters
     *
     * @return a String that will be written to the OpenCms logfile
     *
     * @throws Exception if something goes wrong
     *
     * @see CmsScheduledJobInfo
     * @see CmsScheduledJobInfo#setReuseInstance(boolean)
     */
    String launch(CmsObject cms, Map parameters) throws Exception;
}