Class AJobBase

java.lang.Object
com.netscape.cms.jobs.AJobBase
All Implemented Interfaces:
IJob, Runnable
Direct Known Subclasses:
RequestInQueueJob
public abstract class AJobBase extends Object implements IJob, Runnable
This abstract class is a base job for real job extentions for the Jobs Scheduler.
Version:
$Revision$, $Date$
See Also:

  • Field Details

  • Constructor Details

    • AJobBase

      public AJobBase()

  • Method Details

    • isEnabled

      public boolean isEnabled()
      tells if the job is enabled
      Specified by:
      isEnabled in interface IJob
      Returns:
      a boolean value indicating whether the job is enabled or not

    • init

      public abstract void init(ISubsystem owner, String id, String implName, IConfigStore config) throws EBaseException
      abstract methods
      Specified by:
      init in interface IJob
      Parameters:
      id - String name of this instance
      implName - string name of this implementation
      config - configuration store for this instance
      Throws:
      EBaseException - any initilization failure

    • run

      public abstract void run()
      Specified by:
      run in interface Runnable

    • getId

      public String getId()
      get instance id.
      Specified by:
      getId in interface IJob
      Returns:
      a String identifier

    • setId

      public void setId(String id)
      set instance id.
      Specified by:
      setId in interface IJob
      Parameters:
      id - String id of the instance

    • getJobCron

      public IJobCron getJobCron()
      get cron string associated with this job
      Specified by:
      getJobCron in interface IJob
      Returns:
      a JobCron object that represents the schedule of this job

    • getImplName

      public String getImplName()
      gets the plugin name of this job.
      Specified by:
      getImplName in interface IJob
      Returns:
      a String that is the name of this implementation

    • getConfigStore

      public IConfigStore getConfigStore()
      Gets the configuration substore used by this job
      Specified by:
      getConfigStore in interface IJob
      Returns:
      configuration store

    • getTemplateContent

      protected String getTemplateContent(String templatePath)

    • mailSummary

      protected void mailSummary(String content)

    • buildItemParams

      protected void buildItemParams(org.mozilla.jss.netscape.security.x509.X509CertImpl cert)

    • buildItemParams

      protected void buildItemParams(IRequest r)

    • buildItemParams

      protected void buildItemParams(String name, String val)

    • buildContentParams

      protected void buildContentParams(String name, String val)

    • stop

      public void stop()
      Description copied from interface: IJob
      Request the job to stop gracefully. The job may not stop immediately.
      Specified by:
      stop in interface IJob

    • isStopped

      public boolean isStopped()
      Description copied from interface: IJob
      Check whether the job has been asked to stop. Long running jobs should call this method occasionally inside the run() method and exit gracefully if it returns true.
      Specified by:
      isStopped in interface IJob