01: /*
02: * File : $Source: /usr/local/cvs/opencms/src/org/opencms/scheduler/I_CmsScheduledJob.java,v $
03: * Date : $Date: 2008-02-27 12:05:33 $
04: * Version: $Revision: 1.12 $
05: *
06: * This library is part of OpenCms -
07: * the Open Source Content Management System
08: *
09: * Copyright (c) 2002 - 2008 Alkacon Software GmbH (http://www.alkacon.com)
10: *
11: * This library is free software; you can redistribute it and/or
12: * modify it under the terms of the GNU Lesser General Public
13: * License as published by the Free Software Foundation; either
14: * version 2.1 of the License, or (at your option) any later version.
15: *
16: * This library is distributed in the hope that it will be useful,
17: * but WITHOUT ANY WARRANTY; without even the implied warranty of
18: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19: * Lesser General Public License for more details.
20: *
21: * For further information about Alkacon Software GmbH, please see the
22: * company website: http://www.alkacon.com
23: *
24: * For further information about OpenCms, please see the
25: * project website: http://www.opencms.org
26: *
27: * You should have received a copy of the GNU Lesser General Public
28: * License along with this library; if not, write to the Free Software
29: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30: */
31:
32: package org.opencms.scheduler;
33:
34: import org.opencms.file.CmsObject;
35:
36: import java.util.Map;
37:
38: /**
39: * Identifies a class that can be scheduled with the OpenCms scheduler.<p>
40: *
41: * Please read the documentation for <code>{@link org.opencms.scheduler.CmsScheduledJobInfo}</code>
42: * to learn how to schedule a job in OpenCms.<p>
43: *
44: * @author Alexander Kandzior
45: *
46: * @version $Revision: 1.12 $
47: *
48: * @since 6.0.0
49: */
50: public interface I_CmsScheduledJob {
51:
52: /**
53: * This method will be called when this scheduled job is executed.<p>
54: *
55: * Depending on the configuration of this job, a new instance of
56: * the configured class will be instanciated every time the job is launched,
57: * or a new instance will be generated only the first time the
58: * job is launched, and re-used afterwards.<p>
59: *
60: * The result String will be written to the OpenCms logfile in the
61: * <code>org.opencms.scheduler.CmsScheduleManager</code> channel,
62: * on <code>INFO</code> log level.<p>
63: *
64: * @param cms will be initialized with the configured users cms context
65: * @param parameters the configured parameters
66: *
67: * @return a String that will be written to the OpenCms logfile
68: *
69: * @throws Exception if something goes wrong
70: *
71: * @see CmsScheduledJobInfo
72: * @see CmsScheduledJobInfo#setReuseInstance(boolean)
73: */
74: String launch(CmsObject cms, Map parameters) throws Exception;
75: }
|