org.ops4j.pax.exam

Class CoreOptions

java.lang.Object

org.ops4j.pax.exam.CoreOptions

public class CoreOptions
extends Object

Factory methods for core options.

Since:

0.3.0, December 08, 2008

Author:

Alin Dreghiciu (adreghiciu@gmail.com), Toni Menzel (toni@okidokiteam.com, Harald Wellmann

Method Summary

Modifier and Type	Method and Description
static Option	bootClasspathLibraries(BootClasspathLibraryOption... libraries) Creates a composite option of BootClasspathLibraryOptions.
static Option	bootClasspathLibraries(String... urls) Creates a composite option of BootClasspathLibraryOptions.
static BootClasspathLibraryOption	bootClasspathLibrary(String libraryUrl) Creates a BootClasspathLibraryOption.
static BootClasspathLibraryOption	bootClasspathLibrary(UrlReference libraryUrl) Creates a BootClasspathLibraryOption.
static BootDelegationOption	bootDelegationPackage(String pkg) Creates a BootDelegationOption.
static Option	bootDelegationPackages(BootDelegationOption... packages) Creates a composite option of BootDelegationOptions.
static Option	bootDelegationPackages(String... packages) Creates a composite option of BootDelegationOptions.
static UrlProvisionOption	bundle(String url) Creates a UrlProvisionOption.
static BundleStartLevelOption	bundleStartLevel(int startLevel) Creates an BundleStartLevelOption.
static CleanCachesOption	cleanCaches() Creates a CleanCachesOption.
static CleanCachesOption	cleanCaches(boolean value) Creates a CleanCachesOption.
static ModifiableCompositeOption	composite(Option... options) Convenience method (more to be used for a nice fluent api) for creating a composite option.
static Option	environment(EnvironmentOption... environmentOptions) Creates a composite option of EnvironmentOptions.
static Option	environment(String... environmentVariables) Creates a composite option of EnvironmentOptions.
static EnvironmentOption	environment(String environmentVariable) Creates a EnvironmentOption.
static Option	frameworkProperties(FrameworkPropertyOption... frameworkProperties) Creates a composite option of FrameworkPropertyOptions.
static FrameworkPropertyOption	frameworkProperty(String key) Creates a FrameworkPropertyOption.
static FrameworkStartLevelOption	frameworkStartLevel(int startLevel) Creates an FrameworkStartLevelOption.
static UrlDeploymentOption	jar(String url) Deploys a JAR from the given URL.
static JarProbeOption	jarProbe() Creates an option for a user-defined JAR probe.
static CompositeOption	junitBundles() Creates a JUnitBundlesOption.
static CleanCachesOption	keepCaches() Creates a CleanCachesOption.
static UrlProvisionOption	linkBundle(String symbolicName) Creates a bundle option for a bundle link generated by the exam-maven-plugin.
static MavenArtifactUrlReference	maven() Creates a MavenArtifactUrlReference.
static MavenArtifactUrlReference	maven(String groupId, String artifactId) Convenience method (shorter) for referencing an maven artifact based on groupId/artifactId.
static MavenArtifactUrlReference	maven(String groupId, String artifactId, String version) Convenience method (shorter) for referencing a maven artifact based on groupId/artifactId/version.
static MavenArtifactProvisionOption	mavenBundle() Creates a MavenArtifactProvisionOption.
static MavenArtifactProvisionOption	mavenBundle(MavenArtifactUrlReference artifact) Convenience factory method for adding a maven bundle based on a meven artifact.
static MavenArtifactProvisionOption	mavenBundle(String groupId, String artifactId) Convenience method (shorter) for adding a maven bundle based on groupId/artifactId.
static MavenArtifactProvisionOption	mavenBundle(String groupId, String artifactId, String version) Convenience method (shorter) for adding a maven bundle based on groupId/artifactId/version.
static MavenArtifactDeploymentOption	mavenJar(String groupId, String artifactId, String version) Deploys a Maven JAR artifact with the given Maven coordinates.
static MavenArtifactDeploymentOption	mavenRar(String groupId, String artifactId, String version) Deploys a Maven RAR artifact with the given Maven coordinates.
static MavenArtifactDeploymentOption	mavenWar() Deploys a Maven WAR artifact.
static MavenArtifactDeploymentOption	mavenWar(String groupId, String artifactId, String version) Deploys a Maven WAR artifact with the given Maven coordinates.
static Option[]	options(Option... options) Convenience method (more to be used for a nice fluent api) for creating an array of options.
static Option	propagateSystemProperties(String... keys) Propagates a list of system properties from the driver VM to the container VM.
static PropagateSystemPropertyOption	propagateSystemProperty(String key) Propagates a system property from the driver VM to the container VM.
static Option	provision(InputStream... streams) Creates a composite option of ProvisionOptions.
static Option	provision(ProvisionOption<?>... urls) Creates a composite option of ProvisionOptions.
static Option	provision(String... urls) Creates a composite option of ProvisionOptions.
static UrlDeploymentOption	rar(String url) Deploys a resource adapter archive (RAR) from the given URL.
static Option	repositories(RepositoryOption... repositoryOptions) Creates a composite option of RepositoryOptions.
static Option	repositories(String... repositoryUrls) Creates a composite option of RepositoryOptions.
static RepositoryOption	repository(String repositoryUrl) Creates a RepositoryOption.
static Option	serverMode() Creates a CleanCachesOption.value(false) + workingDirectory(folder) options.
static UrlProvisionOption	streamBundle(InputStream stream)
static SystemPackageOption	systemPackage(String pkg) Creates a SystemPackageOption.
static Option	systemPackages(String... packages) Creates a composite option of SystemPackageOptions.
static Option	systemPackages(SystemPackageOption... packages) Creates a composite option of SystemPackageOptions.
static Option	systemProperties(SystemPropertyOption... systemProperties) Creates a composite option of SystemPropertyOptions.
static SystemPropertyOption	systemProperty(String key) Creates a SystemPropertyOption.
static TimeoutOption	systemTimeout(long timeoutInMillis) Creates a TimeoutOption for a number of millis.
static UrlProvisionOption	url(String url) Creates a UrlProvisionOption.
static VMOption	vmOption(String vmOption) Creates a VMOption.
static Option	vmOptions(String... vmOptions) Creates a composite option of VMOptions.
static Option	vmOptions(VMOption... vmOptions) Creates a composite option of VMOptions.
static UrlDeploymentOption	war(String url) Deploys a WAR from the given URL.
static WarProbeOption	warProbe() Creates an option for a user-defined WAR probe.
static OptionalCompositeOption	when(boolean condition) Creates a OptionalCompositeOption.
static OptionalCompositeOption	when(OptionalCompositeOption.Condition condition) Creates a OptionalCompositeOption.
static WorkingDirectoryOption	workingDirectory(String directory) Creates a WorkingDirectoryOption.
static WrappedUrlProvisionOption	wrappedBundle(String jarToWrapUrl) Creates a WrappedUrlProvisionOption.
static WrappedUrlProvisionOption	wrappedBundle(UrlReference jarToWrapUrl) Creates a WrappedUrlProvisionOption.

Methods inherited from class java.lang.Object

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

Method Detail

options

public static Option[] options(Option... options)

Convenience method (more to be used for a nice fluent api) for creating an array of options. It also expands the composite options.

Parameters:

options - to be used.

Returns:

provided options, expanded

See Also:

OptionUtils.expand(Option...)

composite

public static ModifiableCompositeOption composite(Option... options)

Convenience method (more to be used for a nice fluent api) for creating a composite option.

Parameters:

options - options

Returns:

provided options

provision

public static Option provision(String... urls)

Creates a composite option of ProvisionOptions.

Parameters:

urls - provision urls (cannot be null or containing null entries)

Returns:

composite option of provision options

Throws:

IllegalArgumentException - - If urls array is null or contains null entries

provision

public static Option provision(InputStream... streams)

Creates a composite option of ProvisionOptions. This is handy when bundles are built on the fly via TinyBundles.

Parameters:

streams - provision sources

Returns:

composite option of provision options

Throws:

IllegalArgumentException - - If a problem occured while flushing streams

provision

public static Option provision(ProvisionOption<?>... urls)

Creates a composite option of ProvisionOptions.

Parameters:

urls - provision options

Returns:

composite option of provision options

streamBundle

public static UrlProvisionOption streamBundle(InputStream stream)

url

public static UrlProvisionOption url(String url)

Creates a UrlProvisionOption.

Parameters:

url - url as a string

Returns:

url reference

bundle

public static UrlProvisionOption bundle(String url)

Creates a UrlProvisionOption.

Parameters:

url - bundle url

Returns:

url provisioning option

maven

public static MavenArtifactUrlReference maven()

Creates a MavenArtifactUrlReference.

Returns:

maven artifact url

maven

public static MavenArtifactUrlReference maven(String groupId,
                                              String artifactId)

Convenience method (shorter) for referencing an maven artifact based on groupId/artifactId.

Parameters:

groupId - artifact group id

artifactId - artifact id

Returns:

maven artifact url

maven

public static MavenArtifactUrlReference maven(String groupId,
                                              String artifactId,
                                              String version)

Convenience method (shorter) for referencing a maven artifact based on groupId/artifactId/version.

Parameters:

groupId - artifact group id

artifactId - artifact id

version - artifact version

Returns:

maven artifact url

mavenBundle

public static MavenArtifactProvisionOption mavenBundle()

Creates a MavenArtifactProvisionOption.

Returns:

maven specific provisioning option

mavenBundle

public static MavenArtifactProvisionOption mavenBundle(String groupId,
                                                       String artifactId)

Convenience method (shorter) for adding a maven bundle based on groupId/artifactId.

Parameters:

groupId - artifact group id

artifactId - artifact id

Returns:

maven specific provisioning option

mavenBundle

public static MavenArtifactProvisionOption mavenBundle(String groupId,
                                                       String artifactId,
                                                       String version)

Convenience method (shorter) for adding a maven bundle based on groupId/artifactId/version.

Parameters:

groupId - artifact group id

artifactId - artifact id

version - artifact version

Returns:

maven specific provisioning option

mavenBundle

public static MavenArtifactProvisionOption mavenBundle(MavenArtifactUrlReference artifact)

Convenience factory method for adding a maven bundle based on a meven artifact.

Parameters:

artifact - maven artifact

Returns:

maven specific provisioning option

wrappedBundle

public static WrappedUrlProvisionOption wrappedBundle(String jarToWrapUrl)

Creates a WrappedUrlProvisionOption.

Parameters:

jarToWrapUrl - url of jar to be wrapped

Returns:

wrap specific provisioning option

wrappedBundle

public static WrappedUrlProvisionOption wrappedBundle(UrlReference jarToWrapUrl)

Creates a WrappedUrlProvisionOption.

Parameters:

jarToWrapUrl - url of jar to be wrapped

Returns:

wrap specific provisioning option

bootDelegationPackages

public static Option bootDelegationPackages(String... packages)

Creates a composite option of BootDelegationOptions.

Parameters:

packages - boot delegation packages (cannot be null or containing null entries)

Returns:

composite option of boot delegation package options

Throws:

IllegalArgumentException - - If urls array is null or contains null entries

bootDelegationPackages

public static Option bootDelegationPackages(BootDelegationOption... packages)

Creates a composite option of BootDelegationOptions.

Parameters:

packages - boot delegation package options

Returns:

composite option of boot delegation package options

bootDelegationPackage

public static BootDelegationOption bootDelegationPackage(String pkg)

Creates a BootDelegationOption.

Parameters:

pkg - boot delegation package

Returns:

boot delegation package option

bootClasspathLibraries

public static Option bootClasspathLibraries(String... urls)

Creates a composite option of BootClasspathLibraryOptions.

Parameters:

urls - boot classpath library urls (cannot be null or containing null entries)

Returns:

composite option of boot classpath options

Throws:

IllegalArgumentException - - If urls array is null or contains null entries

bootClasspathLibraries

public static Option bootClasspathLibraries(BootClasspathLibraryOption... libraries)

Creates a composite option of BootClasspathLibraryOptions.

Parameters:

libraries - boot classpath library options

Returns:

composite option of boot classpath library options

bootClasspathLibrary

public static BootClasspathLibraryOption bootClasspathLibrary(String libraryUrl)

Creates a BootClasspathLibraryOption.

Parameters:

libraryUrl - boot classpath library url

Returns:

boot classpath option

bootClasspathLibrary

public static BootClasspathLibraryOption bootClasspathLibrary(UrlReference libraryUrl)

Creates a BootClasspathLibraryOption.

Parameters:

libraryUrl - boot classpath library url

Returns:

boot classpath option

systemPackages

public static Option systemPackages(String... packages)

Creates a composite option of SystemPackageOptions.

Parameters:

packages - system packages (cannot be null or containing null entries)

Returns:

composite option of system package options

Throws:

IllegalArgumentException - - If urls array is null or contains null entries

systemPackages

public static Option systemPackages(SystemPackageOption... packages)

Creates a composite option of SystemPackageOptions.

Parameters:

packages - system package options

Returns:

composite option of system package options

systemPackage

public static SystemPackageOption systemPackage(String pkg)

Creates a SystemPackageOption.

Parameters:

pkg - system package

Returns:

system package option

systemProperties

public static Option systemProperties(SystemPropertyOption... systemProperties)

Creates a composite option of SystemPropertyOptions.

Parameters:

systemProperties - system property options

Returns:

composite option of system property options

systemProperty

public static SystemPropertyOption systemProperty(String key)

Creates a SystemPropertyOption.

Parameters:

key - system property key

Returns:

framework property option

propagateSystemProperty

public static PropagateSystemPropertyOption propagateSystemProperty(String key)

Propagates a system property from the driver VM to the container VM. Only meaningful for remote containers.

If the given system property is set in the driver VM, Pax Exam will set the system property with the same key to the same value in the container VM.

Parameters:

key - system property key

Returns:

option that propagates system properties

propagateSystemProperties

public static Option propagateSystemProperties(String... keys)

Propagates a list of system properties from the driver VM to the container VM. Only meaningful for remote containers.

For each given system property which is set in the driver VM, Pax Exam will set the system property with the same key to the same value in the container VM.

Parameters:

keys - list of system property keys

Returns:

option that propagates system properties

frameworkProperty

public static FrameworkPropertyOption frameworkProperty(String key)

Creates a FrameworkPropertyOption.

Parameters:

key - framework property key

Returns:

framework property option

frameworkProperties

public static Option frameworkProperties(FrameworkPropertyOption... frameworkProperties)

Creates a composite option of FrameworkPropertyOptions.

Parameters:

frameworkProperties - framework property options

Returns:

composite option of framework property options

when

public static OptionalCompositeOption when(boolean condition)

Creates a OptionalCompositeOption.

Parameters:

condition - boolean condition to evaluate

Returns:

optional composite option

when

public static OptionalCompositeOption when(OptionalCompositeOption.Condition condition)

Creates a OptionalCompositeOption.

Parameters:

condition - condition to evaluate

Returns:

optional composite option

frameworkStartLevel

public static FrameworkStartLevelOption frameworkStartLevel(int startLevel)

Creates an FrameworkStartLevelOption.

Parameters:

startLevel - framework start level (must be bigger then zero)

Returns:

framework start level option

bundleStartLevel

public static BundleStartLevelOption bundleStartLevel(int startLevel)

Creates an BundleStartLevelOption.

Parameters:

startLevel - initial bundle start level (must be bigger then zero)

Returns:

bundle start level option

systemTimeout

public static TimeoutOption systemTimeout(long timeoutInMillis)

Creates a TimeoutOption for a number of millis.

Parameters:

timeoutInMillis - timeout in millis

Returns:

timeout option

junitBundles

public static CompositeOption junitBundles()

Creates a JUnitBundlesOption.

Returns:

junit bundles option

cleanCaches

public static CleanCachesOption cleanCaches(boolean value)

Creates a CleanCachesOption.

Parameters:

value - should caches be cleaned?

Returns:

clean caches option

cleanCaches

public static CleanCachesOption cleanCaches()

Creates a CleanCachesOption.

Returns:

clean caches option

keepCaches

public static CleanCachesOption keepCaches()

Creates a CleanCachesOption.

Returns:

clean caches option

serverMode

public static Option serverMode()

Creates a CleanCachesOption.value(false) + workingDirectory(folder) options.

Returns:

options set so it should just be used to kick a single process. Not for test runners. (they would interfere).

vmOptions

public static Option vmOptions(String... vmOptions)

Creates a composite option of VMOptions.

Parameters:

vmOptions - virtual machine options (cannot be null or containing null entries)

Returns:

composite option of virtual machine options

Throws:

IllegalArgumentException - - If urls array is null or contains null entries

vmOptions

public static Option vmOptions(VMOption... vmOptions)

Creates a composite option of VMOptions.

Parameters:

vmOptions - virtual machine options

Returns:

composite option of virtual machine options

vmOption

public static VMOption vmOption(String vmOption)

Creates a VMOption.

Parameters:

vmOption - virtual machine option

Returns:

virtual machine option

repositories

public static Option repositories(String... repositoryUrls)

Creates a composite option of RepositoryOptions.

Parameters:

repositoryUrls - Maven repository URLs

Returns:

composite option of repository options

Throws:

IllegalArgumentException - - If urls array is null or contains null entries

repositories

public static Option repositories(RepositoryOption... repositoryOptions)

Creates a composite option of RepositoryOptions.

Parameters:

repositoryOptions - repository options

Returns:

composite option of repository options

repository

public static RepositoryOption repository(String repositoryUrl)

Creates a RepositoryOption.

Parameters:

repositoryUrl - repository url

Returns:

repository option

workingDirectory

public static WorkingDirectoryOption workingDirectory(String directory)

Creates a WorkingDirectoryOption.

Parameters:

directory - url of the bundle to be scanned

Returns:

working directory option

war

public static UrlDeploymentOption war(String url)

Deploys a WAR from the given URL.

Parameters:

url - URL of a WAR

Returns:

deployment option

jar

public static UrlDeploymentOption jar(String url)

Deploys a JAR from the given URL.

Parameters:

url - URL of a JAR

Returns:

deployment option

rar

public static UrlDeploymentOption rar(String url)

Deploys a resource adapter archive (RAR) from the given URL.

Parameters:

url - URL of a RAR

Returns:

deployment option

mavenWar

public static MavenArtifactDeploymentOption mavenWar()

Deploys a Maven WAR artifact. The Maven coordinates need to be added in fluent syntax.

Returns:

Maven artifact option

mavenWar

public static MavenArtifactDeploymentOption mavenWar(String groupId,
                                                     String artifactId,
                                                     String version)

Deploys a Maven WAR artifact with the given Maven coordinates.

Parameters:

groupId - group ID

artifactId - artifact ID

version - artifact version

Returns:

Maven artifact option

mavenJar

public static MavenArtifactDeploymentOption mavenJar(String groupId,
                                                     String artifactId,
                                                     String version)

Deploys a Maven JAR artifact with the given Maven coordinates.

Parameters:

groupId - group ID

artifactId - artifact ID

version - artifact version

Returns:

Maven artifact option

mavenRar

public static MavenArtifactDeploymentOption mavenRar(String groupId,
                                                     String artifactId,
                                                     String version)

Deploys a Maven RAR artifact with the given Maven coordinates.

Parameters:

groupId - group ID

artifactId - artifact ID

version - artifact version

Returns:

Maven artifact option

warProbe

public static WarProbeOption warProbe()

Creates an option for a user-defined WAR probe. This option needs to be customized in fluent syntax.

Returns:

WAR probe option

jarProbe

public static JarProbeOption jarProbe()

Creates an option for a user-defined JAR probe. This option needs to be customized in fluent syntax.

Returns:

JAR probe option

linkBundle

public static UrlProvisionOption linkBundle(String symbolicName)

Creates a bundle option for a bundle link generated by the exam-maven-plugin.

Parameters:

symbolicName - bundle symbolic name

Returns:

bundle provisioning option

environment

public static Option environment(String... environmentVariables)

Creates a composite option of EnvironmentOptions.

Parameters:

environmentVariables - process environment variables (cannot be null or containing null entries)

Returns:

composite option of environment variables

Throws:

IllegalArgumentException - - If environmentVariables array is null or contains null entries

environment

public static Option environment(EnvironmentOption... environmentOptions)

Creates a composite option of EnvironmentOptions.

Parameters:

environmentOptions - process environment variable options

Returns:

composite option of process environment variable options

environment

public static EnvironmentOption environment(String environmentVariable)

Creates a EnvironmentOption.

Parameters:

environmentVariable - process environment variable

Returns:

process environment variable option