org.jberet.spi

Interface JobXmlResolver

All Known Implementing Classes:

AbstractJobXmlResolver, ChainedJobXmlResolver, ClassPathJobXmlResolver, MetaInfBatchJobsJobXmlResolver

public interface JobXmlResolver

An interface used to resolve job XML content.

Both the getJobXmlNames(ClassLoader) and resolveJobName(String, ClassLoader) methods are optional. The intention is implementations can use the values returned to query information about specific the job XML files.

Author:

James R. Perkins

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_PATH The default META-INF/batch-jobs/ path.

Method Summary

Modifier and Type	Method and Description
Collection<String>	getJobXmlNames(ClassLoader classLoader) Optionally returns a list of job XML names that are allowed to be used.
String	resolveJobName(String jobXml, ClassLoader classLoader) Optionally resolves the job name from the job XML.
InputStream	resolveJobXml(String jobXml, ClassLoader classLoader) Locates the job XML and creates a stream to the contents.

Field Detail

DEFAULT_PATH

static final String DEFAULT_PATH

The default META-INF/batch-jobs/ path.

See Also:

Constant Field Values

Method Detail

resolveJobXml

InputStream resolveJobXml(String jobXml,
                          ClassLoader classLoader)
                   throws IOException

Locates the job XML and creates a stream to the contents.

Parameters:

jobXml - the name of the job XML with a .xml suffix

classLoader - the class loader for the application

Returns:

a stream of the job XML or null if the job XML content was not found

Throws:

IOException - if an error occurs creating the stream

getJobXmlNames

Collection<String> getJobXmlNames(ClassLoader classLoader)

Optionally returns a list of job XML names that are allowed to be used.

An empty collection should be returned if job names can not be resolved.

Parameters:

classLoader - the class loader for the application

Returns:

the job XML names or an empty collection

resolveJobName

String resolveJobName(String jobXml,
                      ClassLoader classLoader)

Optionally resolves the job name from the job XML.

A null value can be returned if the name cannot be resolved.

Parameters:

jobXml - the name of the xml XML with a .xml suffix

classLoader - the class loader for the application

Returns:

the name of the job if found or null if not found