Class RequestInQueueJob

java.lang.Object
com.netscape.cms.jobs.Job
com.netscape.cms.jobs.RequestInQueueJob
All Implemented Interfaces:
IExtendedPluginInfo, Runnable

public class RequestInQueueJob extends Job 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:
  • Field Details

  • Constructor Details

    • RequestInQueueJob

      public RequestInQueueJob()
  • Method Details

    • getExtendedPluginInfo

      public String[] getExtendedPluginInfo()
      holds help text for this plugin
      Specified by:
      getExtendedPluginInfo in interface IExtendedPluginInfo
    • init

      public void init(JobsScheduler scheduler, String id, String implName, JobConfig config) throws EBaseException
      initialize from the configuration file
      Overrides:
      init in class Job
      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
    • runImpl

      public void runImpl() throws Exception
      Throws:
      Exception
    • 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 class Job
      Returns:
      String array of configuration parameter names.