com.netscape.cms.jobs
Class RequestInQueueJob

java.lang.Object
  extended by com.netscape.cms.jobs.AJobBase
      extended by com.netscape.cms.jobs.RequestInQueueJob
All Implemented Interfaces:
IExtendedPluginInfo, IJob, java.lang.Runnable

public class RequestInQueueJob
extends AJobBase
implements 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 administrator

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

Version:
$Revision: 1211 $, $Date: 2010-08-18 10:15:37 -0700 (Wed, 18 Aug 2010) $
See Also:
IJob, AJobBase

Field Summary
protected static java.lang.String[] mConfigParams
           
protected static java.lang.String PROP_SUBSYSTEM_ID
           
 
Fields inherited from class com.netscape.cms.jobs.AJobBase
mConfig, mContentParams, mCron, mId, mImplName, mItemForm, mItemParams, mJobCron, mLogger, 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
RequestInQueueJob()
           
 
Method Summary
 java.lang.String[] getConfigParams()
          Returns a list of configuration parameter names.
 java.lang.String[] getExtendedPluginInfo(java.util.Locale locale)
          holds help text for this plugin
 void init(ISubsystem owner, java.lang.String id, java.lang.String implName, IConfigStore config)
          initialize from the configuration file
 void 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, log, log, mailSummary, setId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.netscape.certsrv.jobs.IJob
getConfigStore, getId, getImplName, getJobCron, isEnabled, setId
 

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
Constructor Detail

RequestInQueueJob

public RequestInQueueJob()
Method Detail

getExtendedPluginInfo

public java.lang.String[] getExtendedPluginInfo(java.util.Locale locale)
holds help text for this plugin

Specified by:
getExtendedPluginInfo in interface IExtendedPluginInfo

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 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 java.lang.Runnable
Specified by:
run in class AJobBase

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 interface IJob
Returns:
String array of configuration parameter names.