net.greghaines.jesque.worker

Class MapBasedJobFactory

java.lang.Object

net.greghaines.jesque.worker.MapBasedJobFactory

All Implemented Interfaces:

JobFactory

public class MapBasedJobFactory
extends Object
implements JobFactory

MapBasedJobFactory uses a map of job names and types to materialize jobs.

Constructor Summary

Constructors

Constructor and Description
MapBasedJobFactory(Map<String,? extends Class<?>> jobTypes) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addJobType(String jobName, Class<?> jobType) Allow the given job type to be executed.
protected void	checkJobType(String jobName, Class<?> jobType) Determine if a job name and job type are valid.
protected void	checkJobTypes(Map<String,? extends Class<?>> jobTypes) Verify the given job types are all valid.
Map<String,Class<?>>	getJobTypes() The allowed job names and types that this JobExecutor will execute.
Object	materializeJob(Job job) Materializes a job.
void	removeJobName(String jobName) Disallow the job name from being executed.
void	removeJobType(Class<?> jobType) Disallow the job type from being executed.
void	setJobTypes(Map<String,? extends Class<?>> jobTypes) Clear any current allowed job types and use the given set.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapBasedJobFactory

public MapBasedJobFactory(Map<String,? extends Class<?>> jobTypes)

Constructor.

Parameters:

jobTypes - the map of job names and types to execute

Method Detail

materializeJob

public Object materializeJob(Job job)
                      throws Exception

Materializes a job.

Specified by:

materializeJob in interface JobFactory

Parameters:

job - the job to materialize

Returns:

the materialized job

Throws:

Exception - if there was an exception creating the object

getJobTypes

public Map<String,Class<?>> getJobTypes()

The allowed job names and types that this JobExecutor will execute.

Returns:

an unmodifiable view of the allowed job names and types

addJobType

public void addJobType(String jobName,
                       Class<?> jobType)

Allow the given job type to be executed.

Parameters:

jobName - the job name as seen

jobType - the job type to allow

removeJobType

public void removeJobType(Class<?> jobType)

Disallow the job type from being executed.

Parameters:

jobType - the job type to disallow

removeJobName

public void removeJobName(String jobName)

Disallow the job name from being executed.

Parameters:

jobName - the job name to disallow

setJobTypes

public void setJobTypes(Map<String,? extends Class<?>> jobTypes)

Clear any current allowed job types and use the given set.

Parameters:

jobTypes - the job types to allow

checkJobTypes

protected void checkJobTypes(Map<String,? extends Class<?>> jobTypes)

Verify the given job types are all valid.

Parameters:

jobTypes - the given job types

Throws:

IllegalArgumentException - if any of the job types are invalid

See Also:

checkJobType(String, Class)

checkJobType

protected void checkJobType(String jobName,
                            Class<?> jobType)

Determine if a job name and job type are valid.

Parameters:

jobName - the name of the job

jobType - the class of the job

Throws:

IllegalArgumentException - if the name or type are invalid