Package org.opencms.site.xmlsitemap

Class CmsUpdateXmlSitemapCacheJob

java.lang.Object

org.opencms.site.xmlsitemap.CmsUpdateXmlSitemapCacheJob

All Implemented Interfaces:

I_CmsScheduledJob

public class CmsUpdateXmlSitemapCacheJob
extends java.lang.Object
implements I_CmsScheduledJob

Scheduled job for updating the XML sitemap cache.

Constructor Summary

Constructors

Constructor	Description
CmsUpdateXmlSitemapCacheJob()

Method Summary

Modifier and Type	Method	Description
java.lang.String	launch(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> 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

CmsUpdateXmlSitemapCacheJob

public CmsUpdateXmlSitemapCacheJob()

Method Detail

launch

public java.lang.String launch(CmsObject cms,
                               java.util.Map<java.lang.String,java.lang.String> parameters)
                        throws java.lang.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:

java.lang.Exception - if something goes wrong

See Also:

I_CmsScheduledJob.launch(org.opencms.file.CmsObject, java.util.Map)