org.ops4j.pax.runner.platform
Interface Configuration

All Known Implementing Classes:
ConfigurationImpl

public interface Configuration

PlatformImpl configuration.

Since:
August 19, 2007
Author:
Alin Dreghiciu

Method Summary
 java.lang.String getBootDelegation()
          Returns a comma separated list of boot delegation packages according to OSGi core specs 3.2.3 (in 4.0.1).
 java.lang.Integer getBundleStartLevel()
          Returns the installed bundles start level option - optional; the platform start level.
 java.lang.String getClasspath()
          Returns the classpatch option - optional; a File.pathSeparator separated list of classpath entries to be appended to the framework classpath which consists out of the framework system jar.
 java.net.URL getDefinitionURL()
          Returns the definition url option - optional; url to the xml file containing the definition of the platform (system bundle, profiles).
 java.lang.String getExecutionEnvironment()
          Returns the java version option - optional; the targeted version for the platform.
 java.lang.String getFrameworkProfile()
          Returns the framework profile option - optional; name of the framework profile to use.
 java.lang.String getJavaHome()
          Returns the java home option - optional; If no version was specified then first the value of system property "JAVA_HOME" is used.
 java.lang.String getProfiles()
          Returns the profiles option - optional; a comma separated list of profiles to be used.
 java.lang.Integer getProfileStartLevel()
          Returns the platform bundles start level option - optional; the start level at which the platform bundles will be started.
 java.lang.String getProperty(java.lang.String name)
          Returns a raw configuration property by name.
 java.lang.Integer getStartLevel()
          Returns the platform start level option - optional; the platform start level.
 java.lang.String getSystemPackages()
          Returns the system packages option - optional; a comma separated list of packages that should be exported by the framework bundles, in addition to the standard packages list.
 java.lang.String[] getVMOptions()
          Returns the virtual machine options option - optional; virtual machine options to be used for the VM that will be used for the platform.
 java.lang.String getWorkingDirectory()
          Returns the working directory option - ptional; a file path where the platform specific artifacts will be stored.
 java.lang.Boolean isAutoWrap()
          Returns true if not osgi compliant jars should be automatically wrapped (transformed to osgi compliant).
 java.lang.Boolean isDebugClassLoading()
          Returns true if the platform should print debug messages about class loading.
 java.lang.Boolean isDownloadFeedback()
          Returns true if detailed information about downloading process should be displayed.
 java.lang.Boolean isOverwrite()
          Returns true if the already downloaded bundles from a previous run must be overwritten.
 java.lang.Boolean isOverwriteSystemBundles()
          Returns true if the already downloaded system bundles from a previous run must be overwritten.
 java.lang.Boolean isOverwriteUserBundles()
          Returns true if the already downloaded user bundles from a previous run must be overwritten.
 java.lang.Boolean keepOriginalUrls()
          Returns true if the provisioning urls should be the ones provided by scanners or the local cashed ones.
 java.lang.Boolean skipInvalidBundles()
          Returns true if the invalid bundles should be skipped from provisioning.
 java.lang.Boolean startConsole()
          Returns the start console option - true/false; whether the platform console should be started.
 java.lang.Boolean useAbsoluteFilePaths()
          Returns true if the file paths used in frameworks configuration files and properties should be absolute.
 java.lang.Boolean usePersistedState()
          Returns true if persisted platform state (platform specific) should be used on start up.
 java.lang.Boolean validateBundles()
          Returns true if the bundles should be validated, meaning that they have the required OSGi headers.
 

Method Detail

getDefinitionURL

java.net.URL getDefinitionURL()
                              throws java.net.MalformedURLException
Returns the definition url option - optional; url to the xml file containing the definition of the platform (system bundle, profiles).

Returns:
value of definition url option
Throws:
java.net.MalformedURLException - if the definition url is malformed

getWorkingDirectory

java.lang.String getWorkingDirectory()
Returns the working directory option - ptional; a file path where the platform specific artifacts will be stored. Default value "runner".

Returns:
value of working directory option

getVMOptions

java.lang.String[] getVMOptions()
Returns the virtual machine options option - optional; virtual machine options to be used for the VM that will be used for the platform.

Returns:
value of virtual machine options option

getClasspath

java.lang.String getClasspath()
Returns the classpatch option - optional; a File.pathSeparator separated list of classpath entries to be appended to the framework classpath which consists out of the framework system jar.

Returns:
value of classpath option

getSystemPackages

java.lang.String getSystemPackages()
Returns the system packages option - optional; a comma separated list of packages that should be exported by the framework bundles, in addition to the standard packages list.

Returns:
value of system packages option

getExecutionEnvironment

java.lang.String getExecutionEnvironment()
Returns the java version option - optional; the targeted version for the platform. Default is the same version as the runner is working on.

Returns:
value of java version option

getJavaHome

java.lang.String getJavaHome()
Returns the java home option - optional; If no version was specified then first the value of system property "JAVA_HOME" is used. If that is not set then teh value of system property "java.home" will be used (=same with the home in which runner is running).

Returns:
value of java home option

usePersistedState

java.lang.Boolean usePersistedState()
Returns true if persisted platform state (platform specific) should be used on start up. Default value is false.

Returns:
true if persisted platform state (platform specific) should be used on start up

getProfileStartLevel

java.lang.Integer getProfileStartLevel()
Returns the platform bundles start level option - optional; the start level at which the platform bundles will be started. Default value is 1.

Returns:
value of platform bundles start level option.

getStartLevel

java.lang.Integer getStartLevel()
Returns the platform start level option - optional; the platform start level. Default value is "6".

Returns:
value of platform start level option.

getBundleStartLevel

java.lang.Integer getBundleStartLevel()
Returns the installed bundles start level option - optional; the platform start level. Default value is "5".

Returns:
value of installed bundles start level option.

startConsole

java.lang.Boolean startConsole()
Returns the start console option - true/false; whether the platform console should be started. Default value is "true".

Returns:
value of start console option

isOverwrite

java.lang.Boolean isOverwrite()
Returns true if the already downloaded bundles from a previous run must be overwritten. Default value is "false".

Returns:
value of overwrite option

getProfiles

java.lang.String getProfiles()
Returns the profiles option - optional; a comma separated list of profiles to be used. Default value is "minimal".

Returns:
value of profiles option

getFrameworkProfile

java.lang.String getFrameworkProfile()
Returns the framework profile option - optional; name of the framework profile to use.

Returns:
value of framework profile

isOverwriteUserBundles

java.lang.Boolean isOverwriteUserBundles()
Returns true if the already downloaded user bundles from a previous run must be overwritten. Default value is "false".

Returns:
value of overwrite user bundles option

isOverwriteSystemBundles

java.lang.Boolean isOverwriteSystemBundles()
Returns true if the already downloaded system bundles from a previous run must be overwritten. Default value is "false".

Returns:
value of overwrite system bundles option

isDebugClassLoading

java.lang.Boolean isDebugClassLoading()
Returns true if the platform should print debug messages about class loading. Default value is "false".

Returns:
value of debug class loading option

isDownloadFeedback

java.lang.Boolean isDownloadFeedback()
Returns true if detailed information about downloading process should be displayed. Default value is true.

Returns:
value of download feedback option

getBootDelegation

java.lang.String getBootDelegation()
Returns a comma separated list of boot delegation packages according to OSGi core specs 3.2.3 (in 4.0.1). If not set it should return null. The returned value should not be an empty string and should not end with a comma (",").

Returns:
value of boot delegation option

isAutoWrap

java.lang.Boolean isAutoWrap()
Returns true if not osgi compliant jars should be automatically wrapped (transformed to osgi compliant). Default value is false.

Returns:
value of auto wrap option

keepOriginalUrls

java.lang.Boolean keepOriginalUrls()
Returns true if the provisioning urls should be the ones provided by scanners or the local cashed ones. Default value is "false".

Returns:
value of use original urls option

validateBundles

java.lang.Boolean validateBundles()
Returns true if the bundles should be validated, meaning that they have the required OSGi headers. Default value is "true".

Returns:
value of validate bundles option

skipInvalidBundles

java.lang.Boolean skipInvalidBundles()
Returns true if the invalid bundles should be skipped from provisioning. Default value is "false".

Returns:
value of skip invalid bundles option

useAbsoluteFilePaths

java.lang.Boolean useAbsoluteFilePaths()
Returns true if the file paths used in frameworks configuration files and properties should be absolute. Default value is "false".

Returns:
value of use absolute paths options

getProperty

java.lang.String getProperty(java.lang.String name)
Returns a raw configuration property by name.

Parameters:
name - property name
Returns:
property value, null if not defined


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