Package com.netscape.cms.jobs
Class RequestInQueueJob
java.lang.Object
com.netscape.cms.jobs.AJobBase
com.netscape.cms.jobs.RequestInQueueJob
- All Implemented Interfaces:
IExtendedPluginInfo
,IJob
,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
-
Field Summary
FieldsFields inherited from class com.netscape.cms.jobs.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
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
(ISubsystem owner, String id, String implName, ConfigStore config) initialize from the configuration filevoid
run()
summarize the queue status and mail itMethods inherited from class com.netscape.cms.jobs.AJobBase
buildContentParams, buildItemParams, buildItemParams, buildItemParams, getConfigStore, getId, getImplName, getJobCron, getTemplateContent, isEnabled, isStopped, mailSummary, 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(ISubsystem owner, String id, String implName, ConfigStore config) throws EBaseException initialize from the configuration file- Specified by:
init
in interfaceIJob
- Specified by:
init
in classAJobBase
- 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 -
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 interfaceIJob
- Returns:
- String array of configuration parameter names.
-