Package org.opencms.configuration

Class CmsSchedulerConfiguration

java.lang.Object

org.opencms.configuration.A_CmsXmlConfiguration

org.opencms.configuration.CmsSchedulerConfiguration

All Implemented Interfaces:

I_CmsConfigurationParameterHandler, I_CmsXmlConfiguration

public class CmsSchedulerConfiguration
extends A_CmsXmlConfiguration

Scheduled jobs configuration class.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CONFIGURATION_DTD_NAME	The name of the DTD for this configuration.
static java.lang.String	DEFAULT_XML_FILE_NAME	The name of the default XML file for this configuration.
static java.lang.String	N_ACTIVE	The node name for the job "active" value.
static java.lang.String	N_CLASS	The node name for a job class.
static java.lang.String	N_CONTEXT	The node name for the job context.
static java.lang.String	N_CRONEXPRESSION	The node name for the job cron expression.
static java.lang.String	N_ENCODING	The node name for the context encoding.
static java.lang.String	N_JOB	The node name for a job.
static java.lang.String	N_LOCALE	The node name for individual locales.
static java.lang.String	N_PARAMETERS	The node name for the job parameters.
static java.lang.String	N_PROJECT	The node name for the context project name.
static java.lang.String	N_REMOTEADDR	The node name for the context remote addr.
static java.lang.String	N_REQUESTEDURI	The node name for the context requested uri.
static java.lang.String	N_REUSEINSTANCE	The node name for the job "reuseinstance" value.
static java.lang.String	N_SCHEDULER	The node name for the scheduler.
static java.lang.String	N_SITEROOT	The node name for the context site root.
static java.lang.String	N_USERNAME	The node name for the context user name.

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Fields inherited from interface org.opencms.configuration.I_CmsXmlConfiguration

A_ALIAS, A_CLASS, A_COUNT, A_DEFAULT, A_DESTINATION, A_ENABLED, A_FROM, A_HANDLER, A_ICON, A_ID, A_KEY, A_MODE, A_NAME, A_ORDER, A_PASSWORD, A_PORT, A_PROTOCOL, A_SUFFIX, A_TO, A_TYPE, A_URI, A_USER, A_VALUE, N_EXPORTPOINT, N_EXPORTPOINTS, N_NAME, N_PARAM, N_PROPERTY, N_RESOURCE, N_SITE, N_VALUE

Constructor Summary

Constructors

Constructor	Description
CmsSchedulerConfiguration()

Method Summary

Modifier and Type	Method	Description
void	addJobFromConfiguration(CmsScheduledJobInfo jobInfo)	Adds a new job description for the scheduler.
void	addScheduleManager()	Generates the schedule manager.
void	addXmlDigesterRules(org.apache.commons.digester3.Digester digester)	Digests an XML node and creates an instance of this configurable class.
org.dom4j.Element	generateXml(org.dom4j.Element parent)	Generates the XML element for this configurable class.
java.lang.String	getDtdFilename()	Returns the name of the DTD file for this XML configuration, e.g.
CmsScheduleManager	getScheduleManager()	Returns the configured schedule manager.
protected void	initMembers()	Initializes member variables.

Methods inherited from class org.opencms.configuration.A_CmsXmlConfiguration

addConfigurationParameter, getConfiguration, getDtdSystemLocation, getDtdUrlPrefix, getXmlFileName, initConfiguration, setXmlFileName

Methods inherited from class java.lang.Object

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

Field Detail

CONFIGURATION_DTD_NAME

public static final java.lang.String CONFIGURATION_DTD_NAME

The name of the DTD for this configuration.

See Also:

Constant Field Values

DEFAULT_XML_FILE_NAME

public static final java.lang.String DEFAULT_XML_FILE_NAME

The name of the default XML file for this configuration.

See Also:

Constant Field Values

N_ACTIVE

public static final java.lang.String N_ACTIVE

The node name for the job "active" value.

See Also:

Constant Field Values

N_CLASS

public static final java.lang.String N_CLASS

The node name for a job class.

See Also:

Constant Field Values

N_CONTEXT

public static final java.lang.String N_CONTEXT

The node name for the job context.

See Also:

Constant Field Values

N_CRONEXPRESSION

public static final java.lang.String N_CRONEXPRESSION

The node name for the job cron expression.

See Also:

Constant Field Values

N_ENCODING

public static final java.lang.String N_ENCODING

The node name for the context encoding.

See Also:

Constant Field Values

N_JOB

public static final java.lang.String N_JOB

The node name for a job.

See Also:

Constant Field Values

N_LOCALE

public static final java.lang.String N_LOCALE

The node name for individual locales.

See Also:

Constant Field Values

N_PARAMETERS

public static final java.lang.String N_PARAMETERS

The node name for the job parameters.

See Also:

Constant Field Values

N_PROJECT

public static final java.lang.String N_PROJECT

The node name for the context project name.

See Also:

Constant Field Values

N_REMOTEADDR

public static final java.lang.String N_REMOTEADDR

The node name for the context remote addr.

See Also:

Constant Field Values

N_REQUESTEDURI

public static final java.lang.String N_REQUESTEDURI

The node name for the context requested uri.

See Also:

Constant Field Values

N_REUSEINSTANCE

public static final java.lang.String N_REUSEINSTANCE

The node name for the job "reuseinstance" value.

See Also:

Constant Field Values

N_SCHEDULER

public static final java.lang.String N_SCHEDULER

The node name for the scheduler.

See Also:

Constant Field Values

N_SITEROOT

public static final java.lang.String N_SITEROOT

The node name for the context site root.

See Also:

Constant Field Values

N_USERNAME

public static final java.lang.String N_USERNAME

The node name for the context user name.

See Also:

Constant Field Values

Constructor Detail

CmsSchedulerConfiguration

public CmsSchedulerConfiguration()

Method Detail

addJobFromConfiguration

public void addJobFromConfiguration(CmsScheduledJobInfo jobInfo)

Adds a new job description for the scheduler.

Parameters:

jobInfo - the job description to add

addScheduleManager

public void addScheduleManager()

Generates the schedule manager.

addXmlDigesterRules

public void addXmlDigesterRules(org.apache.commons.digester3.Digester digester)

Description copied from interface: I_CmsXmlConfiguration

Digests an XML node and creates an instance of this configurable class.

Parameters:

digester - the digester to use

See Also:

I_CmsXmlConfiguration.addXmlDigesterRules(org.apache.commons.digester3.Digester)

generateXml

public org.dom4j.Element generateXml(org.dom4j.Element parent)

Description copied from interface: I_CmsXmlConfiguration

Generates the XML element for this configurable class.

Parameters:

parent - the parent element in the XML tree

Returns:

the XML element for this configurable class

See Also:

I_CmsXmlConfiguration.generateXml(org.dom4j.Element)

getDtdFilename

public java.lang.String getDtdFilename()

Description copied from interface: I_CmsXmlConfiguration

Returns the name of the DTD file for this XML configuration, e.g. opencms-configuration.dtd.

Returns:

the name of the DTD file for this XML configuration

See Also:

I_CmsXmlConfiguration.getDtdFilename()

getScheduleManager

public CmsScheduleManager getScheduleManager()

Returns the configured schedule manager.

Returns:

the configured schedule manager

initMembers

protected void initMembers()

Description copied from class: A_CmsXmlConfiguration

Initializes member variables.

Specified by:

initMembers in class A_CmsXmlConfiguration

See Also:

A_CmsXmlConfiguration.initMembers()