org.jvnet.hk2.testing.junit

Class HK2Runner

java.lang.Object

org.jvnet.hk2.testing.junit.HK2Runner

public class HK2Runner
extends Object

This class should be extended by test classes in order to get an automatically filled in ServiceLocator. By default the testLocator will inspect the package of the test to find any classes annotated with @Service. The locator will also be able to do second-chance advertisement of services that were injected. The default ServiceLocator will also have an error handler that causes any classloading failure to get rethrown up to the lookup call, since this can sometimes cause confusion.

The behavior of HK2Runner can be customized by annotating the class extending HK2Runner with Packages, Classes, Excludes or InhabitantFiles.

Packages gives the names of packages that will automatically be scanned for classes that should be added to testLocator as services. Classes gives an explicit set of classes that should be added to testLocator as services. Excludes gives a set of services that should not be automatically added to the testLocator. InhabitantFiles gives a set of inhabitant files to load in the classpath of the test.

This behavior can be customized by overriding the before method of the test and calling one of the initialize(String, List, List) methods. The annotations listed above are overridden by any values passed to the initialize methods

Author:

jwells

Field Summary

Fields

Modifier and Type	Field and Description
protected ServiceLocator	testLocator Test classes can use this service locator as their private test locator

Constructor Summary

Constructors

Constructor and Description
HK2Runner()

Method Summary

Modifier and Type	Method and Description
void	before() This will generate the default testLocator for this test class, which will search the package of the test itself for classes annotated with @Service.
void	initialize() This method initializes the service locator with services.
protected void	initialize(String name, List<String> packages, List<Class<?>> clazzes) This method initializes the service locator with services from the given list of packages (in "." format) and with the set of classes given.
protected void	initialize(String name, List<String> packages, List<Class<?>> clazzes, Set<String> excludes) This method initializes the service locator with services from the given list of packages (in "." format) and with the set of classes given.
protected void	initialize(String name, List<String> packages, List<Class<?>> clazzes, Set<String> excludes, Set<String> locatorFiles) This method initializes the service locator with services from the given list of packages (in "." format) and with the set of classes given.
protected void	setVerbosity(boolean verbose)

Methods inherited from class java.lang.Object

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

Field Detail

testLocator

protected ServiceLocator testLocator

Test classes can use this service locator as their private test locator

Constructor Detail

HK2Runner

public HK2Runner()

Method Detail

before

public void before()

This will generate the default testLocator for this test class, which will search the package of the test itself for classes annotated with @Service.

initialize

public void initialize()

This method initializes the service locator with services. The name of the locator will be the fully qualified name of the class. All other values will either be empty or will come from the annotations Packages, Classes, Excludes, @{link InhabitantFiles}

initialize

protected void initialize(String name,
                          List<String> packages,
                          List<Class<?>> clazzes)

This method initializes the service locator with services from the given list of packages (in "." format) and with the set of classes given.

Parameters:

name - The name of the service locator to create. If there is already a service locator of this name then the remaining fields will be ignored and the existing locator with this name will be returned. May not be null

packages - The list of packages (in "." format, i.e. "com.acme.test.services") that we should hunt through the classpath for in order to find services. If null this is considered to be the empty set

clazzes - A set of classes that should be analyzed as services, whether they declare @Service or not. If null this is considered to be the empty set

initialize

protected void initialize(String name,
                          List<String> packages,
                          List<Class<?>> clazzes,
                          Set<String> excludes)

This method initializes the service locator with services from the given list of packages (in "." format) and with the set of classes given.

Parameters:

name - The name of the service locator to create. If there is already a service locator of this name then the remaining fields will be ignored and the existing locator with this name will be returned. May not be null

packages - The list of packages (in "." format, i.e. "com.acme.test.services") that we should hunt through the classpath for in order to find services. If null this is considered to be the empty set

clazzes - A set of classes that should be analyzed as services, whether they declare @Service or not. If null this is considered to be the empty set

excludes - A set of implementations that should be excluded from being added. This list is NOT checked against the clazzes list (the explicit include wins), but instead against the set of things coming from packages or from the hk2-locator/default file

initialize

protected void initialize(String name,
                          List<String> packages,
                          List<Class<?>> clazzes,
                          Set<String> excludes,
                          Set<String> locatorFiles)

This method initializes the service locator with services from the given list of packages (in "." format) and with the set of classes given.

Parameters:

name - The name of the service locator to create. If there is already a service locator of this name then the remaining fields will be ignored and the existing locator with this name will be returned. May not be null

packages - The list of packages (in "." format, i.e. "com.acme.test.services") that we should hunt through the classpath for in order to find services. If null this is considered to be the empty set

clazzes - A set of classes that should be analyzed as services, whether they declare @Service or not. If null this is considered to be the empty set

excludes - A set of implementations that should be excluded from being added. This list is NOT checked against the clazzes list (the explicit include wins), but instead against the set of things coming from packages or from the hk2-locator/default file

locatorFiles - A set of locator inhabitant files to search the classpath for to load. If this value is null then only META-INF/hk2-locator/default files on the classpath will be searched. If this value is an empty set then no inhabitant files will be loaded. If this value contains values those will be searched as resources from the jars in the classpath to load the registry with

setVerbosity

protected void setVerbosity(boolean verbose)