org.ow2.proactive.scheduler.common.job.factories

Class JobFactory

java.lang.Object

org.ow2.proactive.scheduler.common.job.factories.JobFactory

Direct Known Subclasses:

StaxJobFactory

@PublicAPI
public abstract class JobFactory
extends Object

JobFactory is used to parse XML Job descriptor. It can use different implementation of parsing.

Since:

ProActive Scheduling 0.9 $Id$

Field Summary

Fields

Modifier and Type	Field and Description
static String	ARCHIVE_DEFAULT_XMLFILE Archive special manifest directory, file, property
static String	ARCHIVE_MANIFEST_DIRECTORY
static String	ARCHIVE_MANIFEST_FILE
static String	ARCHIVE_MANIFEST_PROPERTY_XMLFILE
static String	JOBFACTORY_TMPDIR_PROPERTY Temp dir to store temporary archive content
static org.apache.log4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
JobFactory()

Method Summary

Modifier and Type	Method and Description
abstract Job	createJob(InputStream workflowStream)
abstract Job	createJob(InputStream workflowStream, Map<String,String> variables, Map<String,String> genericInfos)
abstract Job	createJob(InputStream workflowStream, Map<String,String> variables, Map<String,String> genericInfos, Scheduler scheduler, SchedulerSpaceInterface space, String sessionId)
abstract Job	createJob(String filePath) Creates a job using the given job descriptor.
abstract Job	createJob(String filePath, Map<String,String> variables, Map<String,String> genericInfos) Creates a job using the given job descriptor.
abstract Job	createJob(String filePath, Map<String,String> variables, Map<String,String> genericInfos, Scheduler scheduler, SchedulerSpaceInterface space, String sessionId) Creates a job using the given job descriptor with the scheduler instance for validating jobs.
abstract Job	createJob(URI filePath) Creates a job using the given job descriptor.
abstract Job	createJob(URI filePath, Map<String,String> variables, Map<String,String> genericInfos) Creates a job using the given job descriptor.
static JobFactory	getFactory() Try to instantiate the known factories.
static JobFactory	getFactory(boolean handleGlobalVariables) Try to instantiate the known factories.
static JobFactory	getFactory(String impl) Try to instantiate the given factory.
static JobFactory	getFactory(String impl, boolean handleGlobalVariables) Try to instantiate the given factory.

Methods inherited from class java.lang.Object

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

Field Detail

logger

public static final org.apache.log4j.Logger logger

JOBFACTORY_TMPDIR_PROPERTY

public static final String JOBFACTORY_TMPDIR_PROPERTY

Temp dir to store temporary archive content

See Also:

Constant Field Values

ARCHIVE_DEFAULT_XMLFILE

public static final String ARCHIVE_DEFAULT_XMLFILE

Archive special manifest directory, file, property

See Also:

Constant Field Values

ARCHIVE_MANIFEST_DIRECTORY

public static final String ARCHIVE_MANIFEST_DIRECTORY

See Also:

Constant Field Values

ARCHIVE_MANIFEST_FILE

public static final String ARCHIVE_MANIFEST_FILE

See Also:

Constant Field Values

ARCHIVE_MANIFEST_PROPERTY_XMLFILE

public static final String ARCHIVE_MANIFEST_PROPERTY_XMLFILE

See Also:

Constant Field Values

Constructor Detail

JobFactory

public JobFactory()

Method Detail

getFactory

public static JobFactory getFactory()

Try to instantiate the known factories. Return the created instance of the jobFactory. As it may instantiate built'in factories, this method rarely fails but a RuntimeException is raised if no factory can be found.

Returns:

the instance of the jobFactory.

getFactory

public static JobFactory getFactory(boolean handleGlobalVariables)

Try to instantiate the known factories. Return the created instance of the jobFactory. As it may instantiate built'in factories, this method rarely fails but a RuntimeException is raised if no factory can be found.

Parameters:

handleGlobalVariables - if global variables should be handled by the job factory

Returns:

the instance of the jobFactory.

getFactory

public static JobFactory getFactory(String impl)

Try to instantiate the given factory. Return the created instance of the jobFactory. If the factory is not found or not created, a runtime exception is raised.

Returns:

the instance of the required factory.

getFactory

public static JobFactory getFactory(String impl,
                                    boolean handleGlobalVariables)

Try to instantiate the given factory. Return the created instance of the jobFactory. If the factory is not found or not created, a runtime exception is raised.

Parameters:

handleGlobalVariables - if global variables should be handled by the job factory

Returns:

the instance of the required factory.

createJob

public abstract Job createJob(String filePath)
                       throws JobCreationException

Creates a job using the given job descriptor.

Parameters:

filePath - the path to an XML job descriptor.

Returns:

a Job instance created with the given XML file.

Throws:

JobCreationException - if an exception occurred during job creation.

createJob

public abstract Job createJob(String filePath,
                              Map<String,String> variables,
                              Map<String,String> genericInfos)
                       throws JobCreationException

Creates a job using the given job descriptor.

Parameters:

filePath - the path to an XML job descriptor.

variables - map of job submission variables

genericInfos - map of job submission generic infos

Returns:

a Job instance created with the given XML file.

Throws:

JobCreationException - if an exception occurred during job creation.

createJob

public abstract Job createJob(String filePath,
                              Map<String,String> variables,
                              Map<String,String> genericInfos,
                              Scheduler scheduler,
                              SchedulerSpaceInterface space,
                              String sessionId)
                       throws JobCreationException

Creates a job using the given job descriptor with the scheduler instance for validating jobs.

Parameters:

filePath - the path to an XML job descriptor

variables - map of job submission variables

genericInfos - map of job submission generic infos

scheduler - the Scheduler instance for validating jobs to access third-party credentials

space - the SchedulerSpaceInterface instance for validating jobs to access data spaces files

sessionId - current session for validating jobs with CATALOG_OBJECT variables

Returns:

a Job instance created with the given XML file

Throws:

JobCreationException - if an exception occurred during job creation

createJob

public abstract Job createJob(URI filePath)
                       throws JobCreationException

Creates a job using the given job descriptor.

Parameters:

filePath - the path to an XML job descriptor.

Returns:

a Job instance created with the given XML file.

Throws:

JobCreationException - if an exception occurred during job creation.

createJob

public abstract Job createJob(URI filePath,
                              Map<String,String> variables,
                              Map<String,String> genericInfos)
                       throws JobCreationException

Creates a job using the given job descriptor.

Parameters:

filePath - the path to an XML job descriptor.

variables - map of job submission variables

genericInfos - map of job submission generic infos

Returns:

a Job instance created with the given XML file.

Throws:

JobCreationException - if an exception occurred during job creation.

createJob

public abstract Job createJob(InputStream workflowStream)
                       throws JobCreationException

Throws:

JobCreationException

See Also:

createJob(String)

createJob

public abstract Job createJob(InputStream workflowStream,
                              Map<String,String> variables,
                              Map<String,String> genericInfos)
                       throws JobCreationException

Throws:

JobCreationException

createJob

public abstract Job createJob(InputStream workflowStream,
                              Map<String,String> variables,
                              Map<String,String> genericInfos,
                              Scheduler scheduler,
                              SchedulerSpaceInterface space,
                              String sessionId)
                       throws JobCreationException

Throws:

JobCreationException