org.jberet.tools

Class ChainedJobXmlResolver

java.lang.Object

org.jberet.tools.ChainedJobXmlResolver

All Implemented Interfaces:

JobXmlResolver

public class ChainedJobXmlResolver
extends Object
implements JobXmlResolver

A job XML resolver for chaining resolvers.

Author:

James R. Perkins

Field Summary

Fields inherited from interface org.jberet.spi.JobXmlResolver

DEFAULT_PATH

Constructor Summary

Constructors

Constructor and Description
ChainedJobXmlResolver(Collection<JobXmlResolver> resolvers) Creates a new chained job XML resolver.
ChainedJobXmlResolver(Iterable<JobXmlResolver> resolvers) Creates a new chained job XML resolver.
ChainedJobXmlResolver(Iterable<JobXmlResolver> resolvers, JobXmlResolver... additionalResolvers) Creates a new chained job XML resolver.
ChainedJobXmlResolver(JobXmlResolver... resolvers) Creates a new chained job XML resolver.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChainedJobXmlResolver

public ChainedJobXmlResolver(JobXmlResolver... resolvers)

Creates a new chained job XML resolver.

Parameters:

resolvers - the resolvers to use

ChainedJobXmlResolver

public ChainedJobXmlResolver(Iterable<JobXmlResolver> resolvers)

Creates a new chained job XML resolver.

Parameters:

resolvers - the resolvers to use

ChainedJobXmlResolver

public ChainedJobXmlResolver(Iterable<JobXmlResolver> resolvers,
                             JobXmlResolver... additionalResolvers)

Creates a new chained job XML resolver.

Parameters:

resolvers - the resolvers to use

additionalResolvers - any additional resolvers to use

ChainedJobXmlResolver

public ChainedJobXmlResolver(Collection<JobXmlResolver> resolvers)

Creates a new chained job XML resolver.

Parameters:

resolvers - the resolvers to use

Method Detail

resolveJobXml

public InputStream resolveJobXml(String jobXml,
                                 ClassLoader classLoader)
                          throws IOException

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

Each resolver is checked until the first one returns a non-null value after which no other resolvers are checked. If no resolver finds the content null will be returned.

Specified by:

resolveJobXml in interface JobXmlResolver

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

public 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.

Gets the names for each resolver and returns all the names found.

Specified by:

getJobXmlNames in interface JobXmlResolver

Parameters:

classLoader - the class loader for the application

Returns:

the job XML names or an empty collection

resolveJobName

public 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.

Checks each resolver until a non-null value is found. If the name could not be resolved by any resolver null is returned.

Specified by:

resolveJobName in interface JobXmlResolver

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