org.ops4j.pax.exam.karaf.options

Class KarafDistributionBaseConfigurationOption

java.lang.Object

org.ops4j.pax.exam.karaf.options.KarafDistributionBaseConfigurationOption

All Implemented Interfaces:

org.ops4j.pax.exam.Option

Direct Known Subclasses:

KarafDistributionConfigurationOption, KarafDistributionKitConfigurationOption

public class KarafDistributionBaseConfigurationOption
extends Object
implements org.ops4j.pax.exam.Option

Field Summary

Fields

Modifier and Type	Field and Description
protected String	frameworkURL
protected org.ops4j.pax.exam.options.MavenUrlReference	frameworkURLReference
protected String	karafData
protected String	karafEtc
protected String	karafMain
protected String	karafVersion
protected String	name
protected boolean	runEmbedded
protected File	unpackDirectory
protected boolean	useDeployFolder

Constructor Summary

Constructors

Constructor and Description
KarafDistributionBaseConfigurationOption()
KarafDistributionBaseConfigurationOption(KarafDistributionBaseConfigurationOption base) Simply clones the inserted KarafDistributionConfigurationOption
KarafDistributionBaseConfigurationOption(org.ops4j.pax.exam.options.MavenUrlReference frameworkURLReference)
KarafDistributionBaseConfigurationOption(org.ops4j.pax.exam.options.MavenUrlReference frameworkURLReference, String name, String karafVersion)
KarafDistributionBaseConfigurationOption(String frameworkURL, String name, String karafVersion)

Method Summary

Modifier and Type	Method and Description
KarafDistributionBaseConfigurationOption	frameworkUrl(org.ops4j.pax.exam.options.MavenUrlReference _frameworkURL) Sets the URL of the frameworks as a maven reference.
KarafDistributionBaseConfigurationOption	frameworkUrl(String _frameworkURL) Sets the URL of the framework as a String (for example a file).
String	getFrameworkURL()
String	getKarafData()
String	getKarafEtc()
String	getKarafMain()
String	getKarafVersion()
String	getName()
File	getUnpackDirectory()
boolean	isRunEmbedded()
boolean	isUseDeployFolder()
KarafDistributionBaseConfigurationOption	karafData(String _karafData) Sets the location of karaf.data relative to the installation.
KarafDistributionBaseConfigurationOption	karafEtc(String _karafEtc) Sets the location of karaf.etc relative to the installation.
KarafDistributionBaseConfigurationOption	karafMain(String _karafMain) The main entry-point used by the framework.
KarafDistributionBaseConfigurationOption	karafVersion(String _karafVersion) The version of karaf used by the framework.
KarafDistributionBaseConfigurationOption	name(String _name) Sets the name of the framework.
KarafDistributionBaseConfigurationOption	runEmbedded(boolean _runEmbedded) Per default the framework will run Karaf as forked Java process.
KarafDistributionBaseConfigurationOption	unpackDirectory(File _unpackDirectory) Define the unpack directory for the karaf distribution.
KarafDistributionBaseConfigurationOption	useDeployFolder(boolean _useDeployFolder) Per default the framework simply copies all referenced artifacts (via Pax Exam DistributionOption) to the deploy folder of the karaf (based) distribution.

Methods inherited from class java.lang.Object

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

Field Detail

frameworkURL

protected String frameworkURL

frameworkURLReference

protected org.ops4j.pax.exam.options.MavenUrlReference frameworkURLReference

name

protected String name

karafVersion

protected String karafVersion

karafMain

protected String karafMain

karafData

protected String karafData

karafEtc

protected String karafEtc

unpackDirectory

protected File unpackDirectory

useDeployFolder

protected boolean useDeployFolder

runEmbedded

protected boolean runEmbedded

Constructor Detail

KarafDistributionBaseConfigurationOption

public KarafDistributionBaseConfigurationOption()

KarafDistributionBaseConfigurationOption

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

KarafDistributionBaseConfigurationOption

public KarafDistributionBaseConfigurationOption(org.ops4j.pax.exam.options.MavenUrlReference frameworkURLReference,
                                                String name,
                                                String karafVersion)

KarafDistributionBaseConfigurationOption

public KarafDistributionBaseConfigurationOption(org.ops4j.pax.exam.options.MavenUrlReference frameworkURLReference)

KarafDistributionBaseConfigurationOption

public KarafDistributionBaseConfigurationOption(KarafDistributionBaseConfigurationOption base)

Simply clones the inserted KarafDistributionConfigurationOption

Parameters:

base - option to be cloned

Method Detail

frameworkUrl

public KarafDistributionBaseConfigurationOption frameworkUrl(String _frameworkURL)

Sets the URL of the framework as a String (for example a file).

Parameters:

_frameworkURL - framework URL

Returns:

this for fluent syntax

frameworkUrl

public KarafDistributionBaseConfigurationOption frameworkUrl(org.ops4j.pax.exam.options.MavenUrlReference _frameworkURL)

Sets the URL of the frameworks as a maven reference.

Parameters:

_frameworkURL - framework URL

Returns:

this for fluent syntax

name

public KarafDistributionBaseConfigurationOption name(String _name)

Sets the name of the framework. This is only used for logging.

Parameters:

_name - framework name

Returns:

this for fluent syntax

karafVersion

public KarafDistributionBaseConfigurationOption karafVersion(String _karafVersion)

The version of karaf used by the framework. That one is required since there is the high possibility that configuration is different between various karaf versions.

Parameters:

_karafVersion - Karaf version

Returns:

this for fluent syntax

karafMain

public KarafDistributionBaseConfigurationOption karafMain(String _karafMain)

The main entry-point used by the framework. Defaults to "org.apache.karaf.main.Main".

Parameters:

_karafMain - Karaf main

Returns:

this for fluent syntax

karafData

public KarafDistributionBaseConfigurationOption karafData(String _karafData)

Sets the location of karaf.data relative to the installation. Defaults to "data".

Parameters:

_karafData - Karaf data

Returns:

this for fluent syntax

karafEtc

public KarafDistributionBaseConfigurationOption karafEtc(String _karafEtc)

Sets the location of karaf.etc relative to the installation. Defaults to "etc".

Parameters:

_karafEtc - Karaf etc

Returns:

this for fluent syntax

unpackDirectory

public KarafDistributionBaseConfigurationOption unpackDirectory(File _unpackDirectory)

Define the unpack directory for the karaf distribution. In this directory a UUID named directory will be created for each environment.

Parameters:

_unpackDirectory - unpack directory

Returns:

this for fluent syntax

useDeployFolder

public KarafDistributionBaseConfigurationOption useDeployFolder(boolean _useDeployFolder)

Per default the framework simply copies all referenced artifacts (via Pax Exam DistributionOption) to the deploy folder of the karaf (based) distribution. If you don't have such a folder (for any reason) you can set this option to false. PaxExam Karaf will then try to add those deployment urls directly to a features xml instead of copying those files to the deploy folder.

Parameters:

_useDeployFolder - shall artifacts be copied to deploy folder?

Returns:

this for fluent syntax

runEmbedded

public KarafDistributionBaseConfigurationOption runEmbedded(boolean _runEmbedded)

Per default the framework will run Karaf as forked Java process. This can be used to switch to run Karaf as embedded instance.

Parameters:

_runEmbedded - shall Karaf be run as embedded instance.

Returns:

this for fluent syntax

getFrameworkURL

public String getFrameworkURL()

getName

public String getName()

getKarafVersion

public String getKarafVersion()

getKarafMain

public String getKarafMain()

getKarafData

public String getKarafData()

getKarafEtc

public String getKarafEtc()

getUnpackDirectory

public File getUnpackDirectory()

isUseDeployFolder

public boolean isUseDeployFolder()

isRunEmbedded

public boolean isRunEmbedded()