Module org.glassfish.hk2.api

Package org.glassfish.hk2.utilities

Class ClasspathDescriptorFileFinder

java.lang.Object

org.glassfish.hk2.utilities.ClasspathDescriptorFileFinder

All Implemented Interfaces:

DescriptorFileFinder, DescriptorFileFinderInformation

public class ClasspathDescriptorFileFinder
extends Object
implements DescriptorFileFinder, DescriptorFileFinderInformation

This is an implementation of DescriptorFileFinder that uses a particular classloader in order to find descriptor files.

Author:

jwells

Field Summary

Fields inherited from interface org.glassfish.hk2.api.DescriptorFileFinder

RESOURCE_BASE

Constructor Summary

Constructors

Constructor	Description
ClasspathDescriptorFileFinder()	If this constructor is used then HK2 descriptor files will be found by looking in the classpath of the process.
ClasspathDescriptorFileFinder(ClassLoader cl)	This constructor can be used to select the particular classloader to search for HK2 descriptor files.
ClasspathDescriptorFileFinder(ClassLoader cl, String... names)	This constructor can be used to select the particular classloader to search for HK2 descriptor files.
ClasspathDescriptorFileFinder(String resourceBase, ClassLoader cl)	This constructor can be used to select the particular classloader to search for all files from the given locator directory.

Method Summary

Modifier and Type	Method	Description
List<InputStream>	findDescriptorFiles()	Simple implementation of the findDescriptorFiles which does a simple getResources on the classloader in order to find the hk2 descriptor files
List<String>	getDescriptorFileInformation()	This list must have the same cardinality as DescriptorFileFinder.findDescriptorFiles().
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ClasspathDescriptorFileFinder

public ClasspathDescriptorFileFinder()

If this constructor is used then HK2 descriptor files will be found by looking in the classpath of the process. The classloader used will be the classloader for this class itself. The names of the files found will be META-INF/hk2-locator/default.

This is most commonly used when using HK2 from a stand-alone client in which all the JAR files are on a single classpath

ClasspathDescriptorFileFinder

public ClasspathDescriptorFileFinder(ClassLoader cl)

This constructor can be used to select the particular classloader to search for HK2 descriptor files. The names of the the files found in this classloader will be META-INF/hk2-locator/default.

This is commonly used in more complex classloading scenarios where the HK2 descriptor files are not necessarily on the system classpath.

Parameters:

cl - May not be null and must be the classloader to use when searching for HK2 descriptor files

ClasspathDescriptorFileFinder

public ClasspathDescriptorFileFinder(ClassLoader cl,
 String... names)

This constructor can be used to select the particular classloader to search for HK2 descriptor files. The names of the the files found in this classloader will be META-INF/hk2-locator/name.

Parameters:

cl - May not be null and must be the classloader to use when searching for HK2 descriptor files

names - May not be null and must be the name of the files to search for in the META-INF/hk2-locator directory

ClasspathDescriptorFileFinder

public ClasspathDescriptorFileFinder(String resourceBase,
 ClassLoader cl)

This constructor can be used to select the particular classloader to search for all files from the given locator directory. By using this constructor, all files in the given directory are assumed to be HK2 descriptor files.

Parameters:

resourceBase - The directory of locator files, the class loader will search from

cl - May not be null and must be the classloader to use when searching for HK2 descriptor files

Method Details

findDescriptorFiles

public List<InputStream> findDescriptorFiles()
                                      throws IOException

Simple implementation of the findDescriptorFiles which does a simple getResources on the classloader in order to find the hk2 descriptor files

Specified by:

findDescriptorFiles in interface DescriptorFileFinder

Returns:

A non-null (but possibly empty) list of InputStreams for hk2 inhabitant files

Throws:

IOException - If there was an error finding the hk2 inhabitant files

getDescriptorFileInformation

public List<String> getDescriptorFileInformation()

Description copied from interface: DescriptorFileFinderInformation

This list must have the same cardinality as DescriptorFileFinder.findDescriptorFiles(). The Strings returned from this list must give identifying information about the InputStream with the same index. For example, if the InputStream is from a URL then the toString of the URL would be appropriate. If the InputStream is from a File then the Absolute path to that file might be appropriate

Specified by:

getDescriptorFileInformation in interface DescriptorFileFinderInformation

Returns:

Identifying information about the InputStream returned by DescriptorFileFinder.findDescriptorFiles() correlated by index

toString

public String toString()

Overrides:

toString in class Object