org.codehaus.plexus.scheduler
Class AbstractJob

java.lang.Object
  extended byorg.codehaus.plexus.scheduler.AbstractJob
All Implemented Interfaces:
org.quartz.InterruptableJob, org.quartz.Job

public abstract class AbstractJob
extends java.lang.Object
implements org.quartz.InterruptableJob

Base class from which all Jobs running in the scheduler should be derived from if they want access to the ServiceBroker.

Version:
$Id: AbstractJob.java 2981 2006-01-05 21:56:33Z evenisse $
Author:
Jason van Zyl

Field Summary
static java.lang.String CONTEXT
          JobDataMap tag for the job's context.
static java.lang.String EXECUTION_CONFIGURATION
          JobDataMap tag for the job's configuration.
static java.lang.String LOGGER
          JobDataMap tag for the job's logger.
static java.lang.String SERVICE_MANAGER
          JobDataMap tag for the job's service broker.
 
Constructor Summary
AbstractJob()
           
 
Method Summary
abstract  void execute(org.quartz.JobExecutionContext context)
          Execute the Job.
 org.codehaus.plexus.configuration.PlexusConfiguration getConfiguration()
          Get the Configuration.
 org.codehaus.plexus.context.Context getContext()
          Get the Context.
 org.quartz.JobDataMap getJobDataMap()
          Get Job Data Map
 org.codehaus.plexus.logging.Logger getLogger()
          Get the Logger.
 void interrupt()
           
 boolean isInterrupted()
           
 void setJobDataMap(org.quartz.JobDataMap jobDataMap)
          Set Job Data Map
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LOGGER

public static final java.lang.String LOGGER
JobDataMap tag for the job's logger.

See Also:
Constant Field Values

CONTEXT

public static final java.lang.String CONTEXT
JobDataMap tag for the job's context.

See Also:
Constant Field Values

SERVICE_MANAGER

public static final java.lang.String SERVICE_MANAGER
JobDataMap tag for the job's service broker.

See Also:
Constant Field Values

EXECUTION_CONFIGURATION

public static final java.lang.String EXECUTION_CONFIGURATION
JobDataMap tag for the job's configuration.

See Also:
Constant Field Values
Constructor Detail

AbstractJob

public AbstractJob()
Method Detail

setJobDataMap

public void setJobDataMap(org.quartz.JobDataMap jobDataMap)
Set Job Data Map


getJobDataMap

public org.quartz.JobDataMap getJobDataMap()
Get Job Data Map


getLogger

public org.codehaus.plexus.logging.Logger getLogger()
Get the Logger.


getContext

public org.codehaus.plexus.context.Context getContext()
Get the Context.


getConfiguration

public org.codehaus.plexus.configuration.PlexusConfiguration getConfiguration()
Get the Configuration.


execute

public abstract void execute(org.quartz.JobExecutionContext context)
                      throws org.quartz.JobExecutionException
Execute the Job.

Specified by:
execute in interface org.quartz.Job
Throws:
org.quartz.JobExecutionException

isInterrupted

public boolean isInterrupted()

interrupt

public void interrupt()
               throws org.quartz.UnableToInterruptJobException
Specified by:
interrupt in interface org.quartz.InterruptableJob
Throws:
org.quartz.UnableToInterruptJobException


Copyright © 2001-2007 Codehaus. All Rights Reserved.