Package com.netscape.cms.jobs
Class RequestInQueueJob
- java.lang.Object
-
- com.netscape.cms.jobs.AJobBase
-
- com.netscape.cms.jobs.RequestInQueueJob
-
- All Implemented Interfaces:
IExtendedPluginInfo
,com.netscape.certsrv.jobs.IJob
,java.lang.Runnable
public class RequestInQueueJob extends AJobBase implements com.netscape.certsrv.jobs.IJob, java.lang.Runnable, 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 administratorthe $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 java.lang.String[]
mConfigParams
protected static java.lang.String
PROP_SUBSYSTEM_ID
-
Fields 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 Constructor Description RequestInQueueJob()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String[]
getConfigParams()
Returns a list of configuration parameter names.java.lang.String[]
getExtendedPluginInfo(java.util.Locale locale)
holds help text for this pluginvoid
init(ISubsystem owner, java.lang.String id, java.lang.String implName, IConfigStore config)
initialize from the configuration filevoid
run()
summarize the queue status and mail it-
Methods inherited from class com.netscape.cms.jobs.AJobBase
buildContentParams, buildItemParams, buildItemParams, buildItemParams, getConfigStore, getId, getImplName, getJobCron, getTemplateContent, isEnabled, isStopped, mailSummary, setId, stop
-
-
-
-
Field Detail
-
PROP_SUBSYSTEM_ID
protected static final java.lang.String PROP_SUBSYSTEM_ID
- See Also:
- Constant Field Values
-
mConfigParams
protected static java.lang.String[] mConfigParams
-
-
Method Detail
-
getExtendedPluginInfo
public java.lang.String[] getExtendedPluginInfo(java.util.Locale locale)
holds help text for this plugin- Specified by:
getExtendedPluginInfo
in interfaceIExtendedPluginInfo
-
init
public void init(ISubsystem owner, java.lang.String id, java.lang.String implName, IConfigStore config) throws EBaseException
initialize from the configuration file- Specified by:
init
in interfacecom.netscape.certsrv.jobs.IJob
- 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
public java.lang.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 interfacecom.netscape.certsrv.jobs.IJob
- Returns:
- String array of configuration parameter names.
-
-