Package com.polarion.platform.jobs.spi

Class GenericJobUnitFactory

java.lang.Object

com.polarion.platform.jobs.spi.GenericJobUnitFactory

All Implemented Interfaces:

IJobUnitFactory

public class GenericJobUnitFactory
extends Object
implements IJobUnitFactory

Simple and easy-to-reuse implementation of IJobUnitFactory.

Returns hidden job descriptor (see IJobDescriptor.isHidden()) from getJobDescriptor(IJobUnit).

Version:

$Revision$ $Date$

Author:

Stepan Roh, Polarion Software

Constructor Summary

Constructors

Constructor	Description
GenericJobUnitFactory(String jobFactoryName, String jobLabel, Class jobUnitClass)	Constructor.

Method Summary

Modifier and Type	Method	Description
IJobUnit	createJobUnit(String name)	Create job unit with given name.
IJobDescriptor	getJobDescriptor(IJobUnit jobUnit)	Job descriptor.
String	getName()	Job factory name.

Methods inherited from class java.lang.Object

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

Constructor Details

GenericJobUnitFactory

public GenericJobUnitFactory(String jobFactoryName,
 String jobLabel,
 Class jobUnitClass)

Constructor.

Parameters:

jobFactoryName - job factory name (see getName())

jobLabel - job label (see IJobDescriptor.getLabel())

jobUnitClass - job unit class (implementing IJobUnit)

Throws:

IllegalArgumentException - if jobName is null

IllegalArgumentException - if jobLabel is null

IllegalArgumentException - if jobUnitClass is null

IllegalArgumentException - if jobUnitClass does not implement IJobUnit

Method Details

createJobUnit

public IJobUnit createJobUnit(String name)
                       throws GenericJobException

Description copied from interface: IJobUnitFactory

Create job unit with given name.

Given label will be returned from IJobUnit.getName().

Specified by:

createJobUnit in interface IJobUnitFactory

Parameters:

name - job name

Returns:

created job unit (not null)

Throws:

GenericJobException - if for some reason creation fails

getJobDescriptor

public IJobDescriptor getJobDescriptor(IJobUnit jobUnit)

Description copied from interface: IJobUnitFactory

Job descriptor.

May return dynamic job descriptor if and only if given job unit is not null. It is not required to provide dynamic descriptor even though user wants it, however if user has given some job unit, descriptor must return it from IJobDescriptor.getJobUnit().

Specified by:

getJobDescriptor in interface IJobUnitFactory

Parameters:

jobUnit - job unit used for dynamic configuration changes (may be null)

Returns:

job descriptor (not null)

getName

public String getName()

Description copied from interface: IJobUnitFactory

Job factory name.

Something like job unit class name (but shorter), normally used for IJobUnitRepository.getJobUnitFactory(String).

Specified by:

getName in interface IJobUnitFactory

Returns:

name (not null)