This project has retired. For details please refer to its Attic page.

org.apache.lenya.cms.scheduler
Class ServletJob

java.lang.Object
  org.apache.lenya.cms.scheduler.ServletJob

All Implemented Interfaces:

org.quartz.Job

Direct Known Subclasses:

TaskJob

public abstract class ServletJob
extends java.lang.Object
implements org.quartz.Job

Scheduling job that uses an HttpServletRequest to obtain its Job data.

Field Summary

static java.lang.String	ATTRIBUTE_CLASS
static java.lang.String	ATTRIBUTE_DOCUMENT_URL
static java.lang.String	ATTRIBUTE_ID
static java.lang.String	ATTRIBUTE_SERVLET_CONTEXT
static java.lang.String	ELEMENT_JOB
static java.lang.String	PARAMETER_DOCUMENT_URL

Constructor Summary

ServletJob()

Method Summary

org.quartz.JobDataMap	createJobData(javax.servlet.http.HttpServletRequest request) Creates the job data from an HTTP request.
java.lang.String	getDocumentUrl(org.quartz.JobDetail jobDetail) Returns the document URL of a certain job.
org.quartz.JobDetail	load(org.w3c.dom.Element element, java.lang.String jobGroup, java.lang.String servletContextPath) Loads the job data from an XML element.
org.w3c.dom.Element	save(NamespaceHelper helper, org.quartz.JobDetail jobDetail) Saves the job data to an XML element.
void	setDocumentUrl(org.quartz.JobDetail jobDetail, java.lang.String url) Sets the document URL of a job.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.quartz.Job

execute

Field Detail

ELEMENT_JOB

public static final java.lang.String ELEMENT_JOB

See Also:

Constant Field Values

ATTRIBUTE_ID

public static final java.lang.String ATTRIBUTE_ID

See Also:

Constant Field Values

ATTRIBUTE_CLASS

public static final java.lang.String ATTRIBUTE_CLASS

See Also:

Constant Field Values

ATTRIBUTE_DOCUMENT_URL

public static final java.lang.String ATTRIBUTE_DOCUMENT_URL

See Also:

Constant Field Values

ATTRIBUTE_SERVLET_CONTEXT

public static final java.lang.String ATTRIBUTE_SERVLET_CONTEXT

See Also:

Constant Field Values

PARAMETER_DOCUMENT_URL

public static final java.lang.String PARAMETER_DOCUMENT_URL

See Also:

Constant Field Values

Constructor Detail

ServletJob

public ServletJob()

Method Detail

createJobData

public org.quartz.JobDataMap createJobData(javax.servlet.http.HttpServletRequest request)
                                    throws org.quartz.SchedulerException

Creates the job data from an HTTP request.

Parameters:

request - The request.

Returns:

A job data map.

Throws:

org.quartz.SchedulerException - when something went wrong.

load

public org.quartz.JobDetail load(org.w3c.dom.Element element,
                                 java.lang.String jobGroup,
                                 java.lang.String servletContextPath)
                          throws org.quartz.SchedulerException

Loads the job data from an XML element.

Parameters:

element - An XML element.

jobGroup - The job group the job belongs to.

servletContextPath - The servlet context path.

Returns:

A job detail object.

Throws:

org.quartz.SchedulerException - when something went wrong.

save

public org.w3c.dom.Element save(NamespaceHelper helper,
                                org.quartz.JobDetail jobDetail)
                         throws org.quartz.SchedulerException

Saves the job data to an XML element.

Parameters:

helper - The namespace helper of the document the element shall belong to.

jobDetail - The job detail to save.

Returns:

An XML element.

Throws:

org.quartz.SchedulerException - when something went wrong.

getDocumentUrl

public java.lang.String getDocumentUrl(org.quartz.JobDetail jobDetail)

Returns the document URL of a certain job.

Parameters:

jobDetail - The job detail.

Returns:

A string.

setDocumentUrl

public void setDocumentUrl(org.quartz.JobDetail jobDetail,
                           java.lang.String url)

Sets the document URL of a job.

Parameters:

jobDetail - The job detail.

url - The URL.