Class RequestInQueueJob

java.lang.Object

com.netscape.cms.jobs.AJobBase

com.netscape.cms.jobs.RequestInQueueJob

All Implemented Interfaces:

IExtendedPluginInfo, IJob, Runnable

public class RequestInQueueJob
extends AJobBase
implements IExtendedPluginInfo

A job for the Jobs Scheduler. This job checks in the internal ldap db for requests currently in the request queue and send a summary report to the administrator

the $TOKENS that are available for the this jobs's summary outer form are:

$InstanceID $SummaryTotalNum $ExecutionTime

Version:

$Revision$, $Date$

See Also:

• IJob
• AJobBase

Field Summary

Fields

Modifier and Type	Field	Description
protected static String[]	mConfigParams
protected static final String	PROP_SUBSYSTEM_ID

Fields inherited from class AJobBase

logger, mConfig, mContentParams, mCron, mId, mImplName, mItemForm, mItemParams, mJobCron, mMailForm, mMailHTML, mSummaryMailSubject, mSummaryReceiverEmail, mSummarySenderEmail, PROP_EMAIL_SUBJECT, PROP_EMAIL_TEMPLATE, PROP_ENABLED, PROP_ITEM_TEMPLATE, PROP_RECEIVER_EMAIL, PROP_SENDER_EMAIL, PROP_SUMMARY, STATUS_FAILURE, STATUS_SUCCESS

Modifier and Type	Field	Description
static org.slf4j.Logger	logger
protected IConfigStore	mConfig
protected Hashtable<String,Object>	mContentParams
protected String	mCron
protected String	mId
protected String	mImplName
protected String	mItemForm
protected Hashtable<String,Object>	mItemParams
protected IJobCron	mJobCron
protected String	mMailForm
protected boolean	mMailHTML
protected String	mSummaryMailSubject
protected String	mSummaryReceiverEmail
protected String	mSummarySenderEmail
protected static final String	PROP_EMAIL_SUBJECT
protected static final String	PROP_EMAIL_TEMPLATE
protected static final String	PROP_ENABLED
protected static final String	PROP_ITEM_TEMPLATE
protected static final String	PROP_RECEIVER_EMAIL
protected static final String	PROP_SENDER_EMAIL
protected static final String	PROP_SUMMARY
protected static final String	STATUS_FAILURE
protected static final String	STATUS_SUCCESS

Fields inherited from interface IExtendedPluginInfo

HELP_TEXT, HELP_TOKEN

Modifier and Type	Field	Description
static final String	HELP_TEXT
static final String	HELP_TOKEN

Constructor Summary

Constructors

Constructor	Description
RequestInQueueJob()

Method Summary

Modifier and Type	Method	Description
String[]	getConfigParams()	Returns a list of configuration parameter names.
String[]	getExtendedPluginInfo(Locale locale)	holds help text for this plugin
void	init(ISubsystem owner, String id, String implName, IConfigStore config)	initialize from the configuration file
void	run()	summarize the queue status and mail it

Methods inherited from class AJobBase

buildContentParams, buildItemParams, buildItemParams, buildItemParams, getConfigStore, getId, getImplName, getJobCron, getTemplateContent, isEnabled, isStopped, mailSummary, setId, stop

Modifier and Type	Method	Description
protected void	buildContentParams(String name, String val)
protected void	buildItemParams(IRequest r)
protected void	buildItemParams(String name, String val)
protected void	buildItemParams(org.mozilla.jss.netscape.security.x509.X509CertImpl cert)
IConfigStore	getConfigStore()	Gets the configuration substore used by this job
String	getId()	get instance id.
String	getImplName()	gets the plugin name of this job.
IJobCron	getJobCron()	get cron string associated with this job
protected String	getTemplateContent(String templatePath)
boolean	isEnabled()	tells if the job is enabled
boolean	isStopped()	Check whether the job has been asked to stop.
protected void	mailSummary(String content)
void	setId(String id)	set instance id.
void	stop()	Request the job to stop gracefully.

Methods inherited from class Object

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

Field Details

PROP_SUBSYSTEM_ID

protected static final String PROP_SUBSYSTEM_ID

See Also:

• Constant Field Values

mConfigParams

protected static String[] mConfigParams

Constructor Details

RequestInQueueJob

public RequestInQueueJob()

Method Details

getExtendedPluginInfo

public String[] getExtendedPluginInfo(Locale locale)

holds help text for this plugin

Specified by:

getExtendedPluginInfo in interface IExtendedPluginInfo

init

public void init(ISubsystem owner,
 String id,
 String implName,
 IConfigStore config)
          throws EBaseException

initialize from the configuration file

Specified by:

init in interface IJob

Specified by:

init in class AJobBase

Parameters:

id - String name of this instance

implName - string name of this implementation

config - configuration store for this instance

Throws:

EBaseException

run

public void run()

summarize the queue status and mail it

Specified by:

run in interface Runnable

Specified by:

run in class AJobBase

getConfigParams

public String[] getConfigParams()

Returns a list of configuration parameter names. The list is passed to the configuration console so instances of this implementation can be configured through the console.

Specified by:

getConfigParams in interface IJob

Returns:

String array of configuration parameter names.