Package com.netscape.cms.jobs
Class RequestInQueueJob
java.lang.Object
com.netscape.cms.jobs.Job
com.netscape.cms.jobs.RequestInQueueJob
- All Implemented Interfaces:
IExtendedPluginInfo
,Runnable
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:
-
Field Summary
FieldsFields inherited from class com.netscape.cms.jobs.Job
engine, 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
Fields inherited from interface com.netscape.certsrv.base.IExtendedPluginInfo
HELP_TEXT, HELP_TOKEN
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionString[]
Returns a list of configuration parameter names.String[]
holds help text for this pluginvoid
init
(JobsScheduler scheduler, String id, String implName, JobConfig config) initialize from the configuration filevoid
run()
summarize the queue status and mail itvoid
runImpl()
Methods inherited from class com.netscape.cms.jobs.Job
buildContentParams, buildItemParams, buildItemParams, buildItemParams, getCMSEngine, getConfigStore, getId, getImplName, getJobCron, getTemplateContent, isEnabled, isStopped, mailSummary, setCMSEngine, setId, stop
-
Field Details
-
PROP_SUBSYSTEM_ID
- See Also:
-
mConfigParams
-
-
Constructor Details
-
RequestInQueueJob
public RequestInQueueJob()
-
-
Method Details
-
getExtendedPluginInfo
holds help text for this plugin- Specified by:
getExtendedPluginInfo
in interfaceIExtendedPluginInfo
-
init
public void init(JobsScheduler scheduler, String id, String implName, JobConfig config) throws EBaseException initialize from the configuration file- Overrides:
init
in classJob
- Parameters:
id
- String name of this instanceimplName
- string name of this implementationconfig
- configuration store for this instance- Throws:
EBaseException
-
run
public void run()summarize the queue status and mail it -
runImpl
- Throws:
Exception
-
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 classJob
- Returns:
- String array of configuration parameter names.
-