org.opencms.scheduler
Class TestScheduledJob

java.lang.Object
  org.opencms.scheduler.TestScheduledJob

All Implemented Interfaces:

I_CmsScheduledJob

public class TestScheduledJob
extends Object
implements I_CmsScheduledJob

Test class for OpenCms scheduled jobs.

Constructor Summary

TestScheduledJob()
Default constructor.

Method Summary

String

launch(CmsObject cms, Map parameters) This method will be called when this scheduled job is executed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TestScheduledJob

public TestScheduledJob()

Default constructor.

Method Detail

launch

public String launch(CmsObject cms,
                     Map parameters)
              throws Exception

Description copied from 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.

Specified by:

launch in interface I_CmsScheduledJob

Parameters:

cms - will be initialized with the configured users cms context

parameters - the configured parameters

Returns:

a String that will be written to the OpenCms logfile

Throws:

Exception - if something goes wrong

See Also:

I_CmsScheduledJob.launch(CmsObject, Map)