org.finra.herd.service.systemjobs

Class AbstractSystemJob

java.lang.Object

org.springframework.scheduling.quartz.QuartzJobBean

org.finra.herd.service.systemjobs.AbstractSystemJob

All Implemented Interfaces:

org.quartz.Job

Direct Known Subclasses:

BusinessObjectDataFinalizeRestoreJob, CleanupDestroyedBusinessObjectDataJob, Ec2OnDemandPricingUpdateSystemJob, ExpireRestoredBusinessObjectDataJob, FileUploadCleanupJob, JmsPublishingJob, RelationalTableSchemaUpdateSystemJob, StoragePolicySelectorJob

public abstract class AbstractSystemJob
extends org.springframework.scheduling.quartz.QuartzJobBean

This is an abstract class that represents a scheduled system job.

Field Summary

Fields

Modifier and Type	Field and Description
protected ConfigurationHelper	configurationHelper
static String	CRON_TRIGGER_SUFFIX
protected Map<String,String>	parameters
static String	RUN_ONCE_TRIGGER_SUFFIX
static String	SYSTEM_JOB_PARAMETERS

Constructor Summary

Constructors

Constructor and Description
AbstractSystemJob()

Method Summary

Modifier and Type	Method and Description
abstract String	getCronExpression() Gets a cron expression for the system job.
abstract org.quartz.JobDataMap	getJobDataMap() Gets a job data map.
protected org.quartz.JobDataMap	getJobDataMap(ConfigurationValue... configurationValues) Returns a job data map that contains a single hash map that is loaded with name-value pairs as per specified list of configuration values.
org.quartz.JobDataMap	getJobDataMap(List<Parameter> parameters) Returns a job data map that contains a single hash map that is loaded with name-value pairs as per specified list of parameters.
protected org.quartz.JobDataMap	getJobDataMapWithoutParameters() Returns a job data map that contains a single hash map without any parameters.
void	setParameters(Map<String,String> parameters) Setter called after a system job is instantiated with the value from the JobDetailFactoryBean.
abstract void	validateParameters(List<Parameter> parameters) Validates parameters passed to the system job.

Methods inherited from class org.springframework.scheduling.quartz.QuartzJobBean

execute, executeInternal

Methods inherited from class java.lang.Object

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

Field Detail

SYSTEM_JOB_PARAMETERS

public static final String SYSTEM_JOB_PARAMETERS

See Also:

Constant Field Values

CRON_TRIGGER_SUFFIX

public static final String CRON_TRIGGER_SUFFIX

See Also:

Constant Field Values

RUN_ONCE_TRIGGER_SUFFIX

public static final String RUN_ONCE_TRIGGER_SUFFIX

See Also:

Constant Field Values

parameters

protected Map<String,String> parameters

configurationHelper

@Autowired
protected ConfigurationHelper configurationHelper

Constructor Detail

AbstractSystemJob

public AbstractSystemJob()

Method Detail

setParameters

public void setParameters(Map<String,String> parameters)

Setter called after a system job is instantiated with the value from the JobDetailFactoryBean.

validateParameters

public abstract void validateParameters(List<Parameter> parameters)

Validates parameters passed to the system job. This method assumes that parameter names are stored in lower case.

Parameters:

parameters - the list of parameters to be validated

getCronExpression

public abstract String getCronExpression()

Gets a cron expression for the system job.

Returns:

the cron expression for the system job

getJobDataMap

public abstract org.quartz.JobDataMap getJobDataMap()

Gets a job data map.

Returns:

the job data map

getJobDataMap

public org.quartz.JobDataMap getJobDataMap(List<Parameter> parameters)

Returns a job data map that contains a single hash map that is loaded with name-value pairs as per specified list of parameters. The parameter names are loaded/stored in lowercase.

Parameters:

parameters - the list of parameters

Returns:

the job data map that contains a single hash map loaded with job parameters

getJobDataMapWithoutParameters

protected org.quartz.JobDataMap getJobDataMapWithoutParameters()

Returns a job data map that contains a single hash map without any parameters.

Returns:

the job data map that contains a single hash map loaded with job parameters

getJobDataMap

protected org.quartz.JobDataMap getJobDataMap(ConfigurationValue... configurationValues)

Returns a job data map that contains a single hash map that is loaded with name-value pairs as per specified list of configuration values. The parameter names are loaded/stored in lowercase.

Parameters:

configurationValues - the list of configuration values

Returns:

the job data map that contains a single hash map loaded with job parameters