org.ops4j.pax.exam.options

Class JarProbeOption

java.lang.Object

org.ops4j.pax.exam.options.JarProbeOption

All Implemented Interfaces:

Option

public class JarProbeOption
extends Object
implements Option

This option can be used to define the contents of a JAR probe for CDI test containers. When a JAR probe option is present, the test container builds a JAR on the fly, creates a classloader for this JAR and uses this as thread context classloader while the container is running.

Otherwise, when no JAR probe option is present, the CDI test container simply uses the system classloader.

Users should create instances of this class using CoreOptions.jarProbe() and then invoke methods of this class in fluent syntax to configure the JAR probe.

Author:

Harald Wellmann

Constructor Summary

Constructors

Constructor and Description
JarProbeOption() Creates an empty JAR probe option.

Method Summary

Modifier and Type	Method and Description
JarProbeOption	classes(Class<?>... klass) Adds the given classes to the JAR.
List<Class<?>>	getClasses() Returns the classes of this JAR.
List<String>	getMetaInfResources() Returns the META-INF resources.
String	getName() Returns the base name of this JAR.
List<String>	getResources() Returns the classpath resources.
JarProbeOption	metaInfResource(String resourcePath) Adds the given resources from the current class path to the WAR in META-INF/.
JarProbeOption	name(String _name) Sets the base name of this JAR.
JarProbeOption	resources(String... resourcePaths) Adds the given resources from the current class path to the JAR.

Methods inherited from class java.lang.Object

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

Constructor Detail

JarProbeOption

public JarProbeOption()

Creates an empty JAR probe option. Application code should not invoke this constructor. Use CoreOptions.warProbe() instead.

Method Detail

name

public JarProbeOption name(String _name)

Sets the base name of this JAR.

Parameters:

_name - base name

Returns:

this for fluent syntax

classes

public JarProbeOption classes(Class<?>... klass)

Adds the given classes to the JAR.

Parameters:

klass - list of classes

Returns:

this for fluent syntax

resources

public JarProbeOption resources(String... resourcePaths)

Adds the given resources from the current class path to the JAR.

Parameters:

resourcePaths - list of resource paths, relative to the class path root

Returns:

this for fluent syntax

metaInfResource

public JarProbeOption metaInfResource(String resourcePath)

Adds the given resources from the current class path to the WAR in META-INF/.

Parameters:

resourcePath - resource path, relative to the class path root

Returns:

this for fluent syntax

getName

public String getName()

Returns the base name of this JAR.

Internal API, do no use in application code.

Returns:

application name

getMetaInfResources

public List<String> getMetaInfResources()

Returns the META-INF resources.

Internal API, do no use in application code.

Returns:

resources (possibly empty but not null)

getResources

public List<String> getResources()

Returns the classpath resources.

Internal API, do no use in application code.

Returns:

resources (possibly empty but not null)

getClasses

public List<Class<?>> getClasses()

Returns the classes of this JAR.

Internal API, do no use in application code.

Returns:

classes (possibly empty but not null)