org.ops4j.pax.exam.karaf.options

Class KarafDistributionOption

java.lang.Object

org.ops4j.pax.exam.karaf.options.KarafDistributionOption

public final class KarafDistributionOption
extends Object

Final class to provide an easy and intuitive way to configure the specific karaf distribution options.

Method Summary

Modifier and Type	Method and Description
static KarafDistributionConfigurationConsoleOption	configureConsole() Returns an option object which can be used to configure the -Dkaraf.startLocalConsole and -Dkaraf.startRemoteShell options.
static KarafDistributionConfigurationSecurityOption	configureSecurity() Returns an option object which can be used to configure the security, especially the MBeanServerBuilder.
static org.ops4j.pax.exam.Option	debugConfiguration() Activates debugging on the embedded Karaf container using the standard 5005 port and holds the vm till you've attached the debugger.
static org.ops4j.pax.exam.Option	debugConfiguration(String port, boolean hold) Returns an easy option to activate and configure remote debugging for the Karaf container.
static org.ops4j.pax.exam.Option	doNotModifyLogConfiguration() The karaf pax-logging configuration is typically not a file manipulated very often.
static org.ops4j.pax.exam.Option	editConfigurationFileExtend(ConfigurationPointer configurationPointer, Object value) This option allows to extend configurations in each configuration file based on the karaf.home location.
static org.ops4j.pax.exam.Option[]	editConfigurationFileExtend(String configurationFilePath, File source, String... keysToUseFromSource) This option allows to configure each configuration file based on the karaf.home location.
static org.ops4j.pax.exam.Option	editConfigurationFileExtend(String configurationFilePath, String key, Object value) This option allows to extend configurations in each configuration file based on the karaf.home location.
static org.ops4j.pax.exam.Option	editConfigurationFilePut(ConfigurationPointer configurationPointer, Object value) This option allows to configure each configuration file based on the karaf.home location.
static org.ops4j.pax.exam.Option[]	editConfigurationFilePut(String configurationFilePath, File source, String... keysToUseFromSource) This option allows to configure each configuration file based on the karaf.home location.
static org.ops4j.pax.exam.Option	editConfigurationFilePut(String configurationFilePath, String key, Object value) This option allows to configure each configuration file based on the karaf.home location.
static KarafFeaturesOption	features(String repositoryUrl, String... features) Creates a KarafFeaturesOption.
static KarafFeaturesOption	features(org.ops4j.pax.exam.options.UrlReference repositoryUrl, String... features) Creates a KarafFeaturesOption.
static KarafDistributionBaseConfigurationOption	karafDistributionConfiguration() Configures which distribution options to use.
static KarafDistributionBaseConfigurationOption	karafDistributionConfiguration(String frameworkURL, String name, String karafVersion) Configures which distribution options to use.
static org.ops4j.pax.exam.Option	keepRuntimeFolder() Per default the folder pax-exam is deleting the test directories after a test is over.
static LogLevelOption	logLevel() A very simple and convinient method to set a specific log level without the need of configure the specific option itself.
static org.ops4j.pax.exam.Option	logLevel(LogLevelOption.LogLevel logLevel) A very simple and convinient method to set a specific log level without the need of configure the specific option itself.
static OverrideJUnitBundlesOption	overrideJUnitBundles() A convenience method that disables the default Junit deployment.
static org.ops4j.pax.exam.Option	replaceConfigurationFile(String configurationFilePath, File source) This option allows to simply replace an entire configuration file with your own one.
static org.ops4j.pax.exam.Option	useOwnExamBundlesStartLevel(int startLevel) This option allows to configure the start level of the bundles in the exam features descriptor.
static org.ops4j.pax.exam.Option	useOwnKarafExamSystemConfiguration(String invoker) Provides an option to configure the internals of the PaxExamKaraf subsystem runner.

Methods inherited from class java.lang.Object

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

Method Detail

keepRuntimeFolder

public static org.ops4j.pax.exam.Option keepRuntimeFolder()

Per default the folder pax-exam is deleting the test directories after a test is over. If you want to keep those directories (for later evaluation) simply set this option.

Returns:

keep runtime folder option

useOwnKarafExamSystemConfiguration

public static org.ops4j.pax.exam.Option useOwnKarafExamSystemConfiguration(String invoker)

Provides an option to configure the internals of the PaxExamKaraf subsystem runner.

Parameters:

invoker - probe invoker name

Returns:

option

doNotModifyLogConfiguration

public static org.ops4j.pax.exam.Option doNotModifyLogConfiguration()

The karaf pax-logging configuration is typically not a file manipulated very often. Therefore we take the freedom of adding a console logger and changing the log level directly. IF you like to configure the file manually (or had so in your distribution) add this option to avoid any automatic modifications to this file!

Returns:

option

useOwnExamBundlesStartLevel

public static org.ops4j.pax.exam.Option useOwnExamBundlesStartLevel(int startLevel)

This option allows to configure the start level of the bundles in the exam features descriptor.

Parameters:

startLevel - bundle start level

Returns:

option

configureConsole

public static KarafDistributionConfigurationConsoleOption configureConsole()

Returns an option object which can be used to configure the -Dkaraf.startLocalConsole and -Dkaraf.startRemoteShell options. By default both are true.

Returns:

option

configureSecurity

public static KarafDistributionConfigurationSecurityOption configureSecurity()

Returns an option object which can be used to configure the security, especially the MBeanServerBuilder. By default, it's disabled.

Returns:

option

karafDistributionConfiguration

public static KarafDistributionBaseConfigurationOption karafDistributionConfiguration(String frameworkURL,
                                                                                      String name,
                                                                                      String karafVersion)

Configures which distribution options to use. Relevant are the frameworkURL, the frameworkName and the Karaf version since all of those params are relevant to decide which wrapper configurations to use.

Parameters:

frameworkURL - frameworkURL

name - framework name

karafVersion - Karaf version

Returns:

option

karafDistributionConfiguration

public static KarafDistributionBaseConfigurationOption karafDistributionConfiguration()

Configures which distribution options to use. Relevant are the frameworkURL, the frameworkName and the Karaf version since all of those params are relevant to decide which wrapper configurations to use.

Returns:

option

editConfigurationFilePut

public static org.ops4j.pax.exam.Option editConfigurationFilePut(String configurationFilePath,
                                                                 String key,
                                                                 Object value)

This option allows to configure each configuration file based on the karaf.home location. The value is "put". Which means it is either replaced or added.

If you like to extend an option (e.g. make a=b to a=b,c) please make use of the KarafDistributionConfigurationFileExtendOption.

Parameters:

configurationFilePath - configuration file path

key - property key

value - property value

Returns:

option

editConfigurationFilePut

public static org.ops4j.pax.exam.Option editConfigurationFilePut(ConfigurationPointer configurationPointer,
                                                                 Object value)

This option allows to configure each configuration file based on the karaf.home location. The value is "put". Which means it is either replaced or added.

If you like to extend an option (e.g. make a=b to a=b,c) please make use of the KarafDistributionConfigurationFileExtendOption.

Parameters:

configurationPointer - reference to configuration file

value - new value

Returns:

option

editConfigurationFilePut

public static org.ops4j.pax.exam.Option[] editConfigurationFilePut(String configurationFilePath,
                                                                   File source,
                                                                   String... keysToUseFromSource)

This option allows to configure each configuration file based on the karaf.home location. The value is "put" which means it is either replaced or added. For simpler configuration you can add a file source. If you want to put all values from this file do not configure any keysToUseFromSource; otherwise define them to use only those specific values.

Parameters:

configurationFilePath - configuration file path

source - configuration source file

keysToUseFromSource - configuration keys to be used

Returns:

option array

editConfigurationFileExtend

public static org.ops4j.pax.exam.Option editConfigurationFileExtend(String configurationFilePath,
                                                                    String key,
                                                                    Object value)

This option allows to extend configurations in each configuration file based on the karaf.home location. The value extends the current value (e.g. a=b to a=a,b) instead of replacing it. If there is no current value it is added.

If you would like to have add or replace functionality please use the KarafDistributionConfigurationFilePutOption instead.

Parameters:

configurationFilePath - configuration file path

key - property key

value - property value

Returns:

option

editConfigurationFileExtend

public static org.ops4j.pax.exam.Option editConfigurationFileExtend(ConfigurationPointer configurationPointer,
                                                                    Object value)

This option allows to extend configurations in each configuration file based on the karaf.home location. The value extends the current value (e.g. a=b to a=a,b) instead of replacing it. If there is no current value it is added.

If you would like to have add or replace functionality please use the KarafDistributionConfigurationFilePutOption instead.

Parameters:

configurationPointer - reference to configuration key

value - additional configuration value

Returns:

option

editConfigurationFileExtend

public static org.ops4j.pax.exam.Option[] editConfigurationFileExtend(String configurationFilePath,
                                                                      File source,
                                                                      String... keysToUseFromSource)

This option allows to configure each configuration file based on the karaf.home location. The value is "extend" which means it is either replaced or added. For simpler configuration you can add a file source. If you want to put all values from this file do not configure any keysToUseFromSource; otherwise define them to use only those specific values.

Parameters:

configurationFilePath - configuration file path

source - property key

keysToUseFromSource - property keys to be used

Returns:

option array

replaceConfigurationFile

public static org.ops4j.pax.exam.Option replaceConfigurationFile(String configurationFilePath,
                                                                 File source)

This option allows to simply replace an entire configuration file with your own one. Simply point to the configuration file you would like to have replaced and add the source file which should replace it.

Parameters:

configurationFilePath - path to configuration file

source - configuration file replacement

Returns:

option

debugConfiguration

public static org.ops4j.pax.exam.Option debugConfiguration()

Activates debugging on the embedded Karaf container using the standard 5005 port and holds the vm till you've attached the debugger.

Returns:

option

logLevel

public static org.ops4j.pax.exam.Option logLevel(LogLevelOption.LogLevel logLevel)

A very simple and convinient method to set a specific log level without the need of configure the specific option itself.

Parameters:

logLevel - log level

Returns:

option

logLevel

public static LogLevelOption logLevel()

A very simple and convinient method to set a specific log level without the need of configure the specific option itself.

Returns:

option

debugConfiguration

public static org.ops4j.pax.exam.Option debugConfiguration(String port,
                                                           boolean hold)

Returns an easy option to activate and configure remote debugging for the Karaf container.

Parameters:

port - remote debugger port

hold - should the VM wait for the debugger?

Returns:

option

features

public static KarafFeaturesOption features(String repositoryUrl,
                                           String... features)

Creates a KarafFeaturesOption.

Parameters:

repositoryUrl - url of features respository to be scanned

features - features to be scanned

Returns:

features option

features

public static KarafFeaturesOption features(org.ops4j.pax.exam.options.UrlReference repositoryUrl,
                                           String... features)

Creates a KarafFeaturesOption.

Parameters:

repositoryUrl - url of features respository to be scanned

features - features to be scanned

Returns:

features option

overrideJUnitBundles

public static OverrideJUnitBundlesOption overrideJUnitBundles()

A convenience method that disables the default Junit deployment.

Returns:

option