org.ops4j.pax.exam.container.def
Class PaxRunnerOptions

java.lang.Object
  extended by org.ops4j.pax.exam.container.def.PaxRunnerOptions

public class PaxRunnerOptions
extends java.lang.Object

Factory methods for Pax Runner options.

Since:
0.3.0, December 08, 2008
Author:
Alin Dreghiciu (adreghiciu@gmail.com)

Method Summary
static AutoWrapOption autoWrap()
          Creates a AutoWrapOption.
static CleanCachesOption cleanCaches()
          Creates a CleanCachesOption.
static ProfileOption compendiumProfile()
          Creates a Log Service ProfileOption (--profiles=compendium).
static ProfileOption configProfile()
          Creates a Configuration Admin Service ProfileOption (--profiles=config).
static ProfileOption dsProfile()
          Creates a Declarative Service ProfileOption (--profiles=ds).
static ExcludeDefaultRepositoriesOption excludeDefaultRepositories()
          Creates a ExcludeDefaultRepositoriesOption.
static LocalRepositoryOption localRepository(java.lang.String path)
          Creates a LocalRepositoryOption.
static ProfileOption logProfile()
          Creates a Log Service ProfileOption (--profiles=log).
static ProfileOption profile(java.lang.String name)
          Creates a ProfileOption by profile name.
static ProfileOption profile(java.lang.String name, java.lang.String version)
          Creates a ProfileOption by profile name and version.
static Option profiles(ProfileOption... profiles)
          Creates a composite option of ProfileOption.
static RawPaxRunnerOptionOption rawPaxRunnerOption(java.lang.String option)
          Creates a RawPaxRunnerOptionOption.
static RawPaxRunnerOptionOption rawPaxRunnerOption(java.lang.String key, java.lang.String value)
          Creates a RawPaxRunnerOptionOption.
static Option repositories(RepositoryOption... repositoryOptions)
          Creates a composite option of RepositoryOptions.
static Option repositories(java.lang.String... repositoryUrls)
          Creates a composite option of RepositoryOptions.
static RepositoryOption repository(java.lang.String repositoryUrl)
          Creates a RepositoryOption.
static RawScannerProvisionOption scan(java.lang.String provisionSpec)
          Creates a RawScannerProvisionOption.
static BundleScannerProvisionOption scanBundle(java.lang.String bundleUrl)
          Creates a BundleScannerProvisionOption.
static BundleScannerProvisionOption scanBundle(UrlReference bundleUrl)
          Creates a BundleScannerProvisionOption.
static CompositeScannerProvisionOption scanComposite(java.lang.String fileUrl)
          Creates a CompositeScannerProvisionOption.
static CompositeScannerProvisionOption scanComposite(UrlReference fileUrl)
          Creates a CompositeScannerProvisionOption.
static DirScannerProvisionOption scanDir(java.lang.String directory)
          Creates a DirScannerProvisionOption.
static FeaturesScannerProvisionOption scanFeatures(java.lang.String repositoryUrl, java.lang.String... features)
          Creates a FeaturesScannerProvisionOption.
static FeaturesScannerProvisionOption scanFeatures(UrlReference repositoryUrl, java.lang.String... features)
          Creates a FileScannerProvisionOption.
static FileScannerProvisionOption scanFile(java.lang.String fileUrl)
          Creates a FileScannerProvisionOption.
static FileScannerProvisionOption scanFile(UrlReference fileUrl)
          Creates a FileScannerProvisionOption.
static PomScannerProvisionOption scanPom()
          Creates a PomScannerProvisionOption.
static PomScannerProvisionOption scanPom(java.lang.String url)
          Creates a PomScannerProvisionOption.
static VMOption vmOption(java.lang.String vmOption)
          Creates a VMOption.
static Option vmOptions(java.lang.String... vmOptions)
          Creates a composite option of VMOptions.
static Option vmOptions(VMOption... vmOptions)
          Creates a composite option of VMOptions.
static RBCLookupTimeoutOption waitForRBCFor(java.lang.Integer timeoutInMillis)
          Creates a RBCLookupTimeoutOption.
static ProfileOption webProfile()
          Creates a Http Service ProfileOption (--profiles=web).
static WorkingDirectoryOption workingDirectory(java.lang.String directory)
          Creates a WorkingDirectoryOption.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

profiles

public static Option profiles(ProfileOption... profiles)
Creates a composite option of ProfileOption.

Parameters:
profiles - profile options
Returns:
composite option of profiles options

profile

public static ProfileOption profile(java.lang.String name)
Creates a ProfileOption by profile name.

Parameters:
name - profile name
Returns:
profile option

profile

public static ProfileOption profile(java.lang.String name,
                                    java.lang.String version)
Creates a ProfileOption by profile name and version.

Parameters:
name - profile name
version - profile version
Returns:
profile option

webProfile

public static ProfileOption webProfile()
Creates a Http Service ProfileOption (--profiles=web).

Returns:
web profile option

logProfile

public static ProfileOption logProfile()
Creates a Log Service ProfileOption (--profiles=log).

Returns:
log profile option

configProfile

public static ProfileOption configProfile()
Creates a Configuration Admin Service ProfileOption (--profiles=config).

Returns:
config profile option

dsProfile

public static ProfileOption dsProfile()
Creates a Declarative Service ProfileOption (--profiles=ds).

Returns:
ds profile option

compendiumProfile

public static ProfileOption compendiumProfile()
Creates a Log Service ProfileOption (--profiles=compendium).

Returns:
log profile option

cleanCaches

public static CleanCachesOption cleanCaches()
Creates a CleanCachesOption.

Returns:
clean caches option

waitForRBCFor

public static RBCLookupTimeoutOption waitForRBCFor(java.lang.Integer timeoutInMillis)
Creates a RBCLookupTimeoutOption.

Parameters:
timeoutInMillis - timeout in millis
Returns:
timeout option

vmOptions

public static Option vmOptions(java.lang.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:
java.lang.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(java.lang.String vmOption)
Creates a VMOption.

Parameters:
vmOption - virtual machine option
Returns:
virtual machine option

rawPaxRunnerOption

public static RawPaxRunnerOptionOption rawPaxRunnerOption(java.lang.String key,
                                                          java.lang.String value)
Creates a RawPaxRunnerOptionOption.

Parameters:
key - option name (key)
value - option value
Returns:
a PaxRunner Option instance.

rawPaxRunnerOption

public static RawPaxRunnerOptionOption rawPaxRunnerOption(java.lang.String option)
Creates a RawPaxRunnerOptionOption.

Parameters:
option - full Pax Runner option (including --)
Returns:
a PaxRunner Option instance.

repositories

public static Option repositories(java.lang.String... repositoryUrls)
Creates a composite option of RepositoryOptions.

Parameters:
repositoryUrls - virtual machine options (cannot be null or containing null entries)
Returns:
composite option of virtual machine options
Throws:
java.lang.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

localRepository

public static LocalRepositoryOption localRepository(java.lang.String path)
Creates a LocalRepositoryOption.

Parameters:
path - localRepository path or url
Returns:
localRepository option

repository

public static RepositoryOption repository(java.lang.String repositoryUrl)
Creates a RepositoryOption.

Parameters:
repositoryUrl - repository url
Returns:
repository option

excludeDefaultRepositories

public static ExcludeDefaultRepositoriesOption excludeDefaultRepositories()
Creates a ExcludeDefaultRepositoriesOption.

Returns:
option

scan

public static RawScannerProvisionOption scan(java.lang.String provisionSpec)
Creates a RawScannerProvisionOption.

Parameters:
provisionSpec - raw provisioning spec
Returns:
raw scanner option

scanDir

public static DirScannerProvisionOption scanDir(java.lang.String directory)
Creates a DirScannerProvisionOption.

Parameters:
directory - directory to be scanned
Returns:
directory scanner option

scanPom

public static PomScannerProvisionOption scanPom(java.lang.String url)
Creates a PomScannerProvisionOption.

Parameters:
url - to pom
Returns:
pom scanner option

scanPom

public static PomScannerProvisionOption scanPom()
Creates a PomScannerProvisionOption.

Returns:
pom scanner option

scanFile

public static FileScannerProvisionOption scanFile(java.lang.String fileUrl)
Creates a FileScannerProvisionOption.

Parameters:
fileUrl - url of the file to be scanned
Returns:
file scanner option

scanFile

public static FileScannerProvisionOption scanFile(UrlReference fileUrl)
Creates a FileScannerProvisionOption.

Parameters:
fileUrl - url of the file to be scanned
Returns:
file scanner option

scanFeatures

public static FeaturesScannerProvisionOption scanFeatures(java.lang.String repositoryUrl,
                                                          java.lang.String... features)
Creates a FeaturesScannerProvisionOption.

Parameters:
repositoryUrl - url of features respository to be scanned
features - features to be scanned
Returns:
file scanner option

scanFeatures

public static FeaturesScannerProvisionOption scanFeatures(UrlReference repositoryUrl,
                                                          java.lang.String... features)
Creates a FileScannerProvisionOption.

Parameters:
repositoryUrl - url of features respository to be scanned
features - features to be scanned
Returns:
file scanner option

scanComposite

public static CompositeScannerProvisionOption scanComposite(java.lang.String fileUrl)
Creates a CompositeScannerProvisionOption.

Parameters:
fileUrl - url of the file to be scanned
Returns:
composite scanner option

scanComposite

public static CompositeScannerProvisionOption scanComposite(UrlReference fileUrl)
Creates a CompositeScannerProvisionOption.

Parameters:
fileUrl - url of the file to be scanned
Returns:
composite scanner option

autoWrap

public static AutoWrapOption autoWrap()
Creates a AutoWrapOption.

Returns:
AutoWrapOption

scanBundle

public static BundleScannerProvisionOption scanBundle(java.lang.String bundleUrl)
Creates a BundleScannerProvisionOption.

Parameters:
bundleUrl - url of the bundle to be scanned
Returns:
bundle scanner option

scanBundle

public static BundleScannerProvisionOption scanBundle(UrlReference bundleUrl)
Creates a BundleScannerProvisionOption.

Parameters:
bundleUrl - url of the bundle to be scanned
Returns:
bundle scanner option

workingDirectory

public static WorkingDirectoryOption workingDirectory(java.lang.String directory)
Creates a WorkingDirectoryOption.

Parameters:
directory - url of the bundle to be scanned
Returns:
working directory option


Copyright © 2006-2012 OPS4J - Open Participation Software for Java. All Rights Reserved.