de.innovationgate.wgpublisher.scheduler

Class JobContext

java.lang.Object

de.innovationgate.wgpublisher.scheduler.JobContext

public class JobContext
extends java.lang.Object

This object is passed to WGA jobs to provide access to WGA resources.

Constructor Summary

Constructors

Constructor and Description
JobContext(Job currentJob, org.quartz.JobExecutionContext quartzContext, WGACore wgaCore, org.apache.log4j.Logger log) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	breakIfCancelled() Throws a JobFailedException if the Job has been cancelled.
de.innovationgate.webgate.api.WGDatabase	db(java.lang.String dbkey) Deprecated. Use WGA object to access WGA global resources like these
void	dbUpdated(de.innovationgate.webgate.api.WGDatabase db)
Job	getCurrentJob() Returns the object representing the current job
Task	getCurrentTask() Returns the object representing the current task
java.util.Map<java.lang.String,java.lang.Object>	getCustomOptions() Returns custom options that have been added to this runtime of the job Use this method especially to retrieve custom options that are not of String value
java.util.Set<java.lang.String>	getDatabaseKeys() Deprecated. Use WGA object to access WGA global resources like these
org.apache.log4j.Logger	getLog() Returns a logger object to log output to the WGA application log
java.lang.String	getOption(java.lang.String name) Returns a task option.
java.lang.String	getOption(java.lang.String name, java.lang.String defaultValue) Returns a task option
java.util.Map<java.lang.String,java.lang.String>	getOptions() Deprecated. Use getOption(String) to read an option no matter where it is defined
java.lang.Object	getPreviousResult() Returns the result of the previous task in this Job, if any.
org.quartz.JobExecutionContext	getQuartzContext() Returns the schedulers Quartz context.
java.lang.Object	getResult() Returns the result of this task
WGACore	getWgaCore() Deprecated. Use WGA object to access WGA global resources like these
boolean	isCancelable()
boolean	isCancelled() Returns if this Job was cancelled
void	setCancelable(boolean cancelable)
void	setResult(java.lang.Object object) Sets the result of this task

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JobContext

public JobContext(Job currentJob,
          org.quartz.JobExecutionContext quartzContext,
          WGACore wgaCore,
          org.apache.log4j.Logger log)

Constructor.

Parameters:

quartzContext -

wgaCore -

log -

Method Detail

getOptions

public java.util.Map<java.lang.String,java.lang.String> getOptions()

Deprecated. Use getOption(String) to read an option no matter where it is defined

Provides the options defined on the job

getOption

public java.lang.String getOption(java.lang.String name)

Returns a task option.

Parameters:

name - Name of the option

Returns:

The option string value

getOption

public java.lang.String getOption(java.lang.String name,
                         java.lang.String defaultValue)

Returns a task option

Parameters:

name - Name of the option

defaultValue - Value to return if the option does not exist

Returns:

The option string value

getQuartzContext

public org.quartz.JobExecutionContext getQuartzContext()

Returns the schedulers Quartz context. NOT IMPLEMENTED YET!

getWgaCore

public WGACore getWgaCore()

Deprecated. Use WGA object to access WGA global resources like these

Returns the WGA core object

getResult

public java.lang.Object getResult()

Returns the result of this task

setResult

public void setResult(java.lang.Object object)

Sets the result of this task

Parameters:

object - The tasks result

getLog

public org.apache.log4j.Logger getLog()

Returns a logger object to log output to the WGA application log

getCustomOptions

public java.util.Map<java.lang.String,java.lang.Object> getCustomOptions()

Returns custom options that have been added to this runtime of the job Use this method especially to retrieve custom options that are not of String value

getPreviousResult

public java.lang.Object getPreviousResult()

Returns the result of the previous task in this Job, if any.

getCurrentJob

public Job getCurrentJob()

Returns the object representing the current job

getCurrentTask

public Task getCurrentTask()

Returns the object representing the current task

db

public de.innovationgate.webgate.api.WGDatabase db(java.lang.String dbkey)
                                            throws de.innovationgate.webgate.api.WGAPIException

Deprecated. Use WGA object to access WGA global resources like these

Returns the WGDatabase object of the application / data source with the given database key

Parameters:

dbkey - The database key

Returns:

The database object or null if no database of this key is connected

Throws:

de.innovationgate.webgate.api.WGAPIException

getDatabaseKeys

public java.util.Set<java.lang.String> getDatabaseKeys()

Deprecated. Use WGA object to access WGA global resources like these

Returns the database keys of all web applications and data sources that are connected

isCancelled

public boolean isCancelled()

Returns if this Job was cancelled

breakIfCancelled

public void breakIfCancelled()
                      throws JobCancelledException

Throws a JobFailedException if the Job has been cancelled. Use this call inside a Jobs code at a place where the Job can be safely cancelled without leaving any data inconsistent.

Throws:

JobFailedException

JobCancelledException

isCancelable

public boolean isCancelable()

setCancelable

public void setCancelable(boolean cancelable)

dbUpdated

public void dbUpdated(de.innovationgate.webgate.api.WGDatabase db)
               throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException