Modified: felix/trunk/main/doc/apache-felix-usage-documentation.html URL: http://svn.apache.org/viewvc/felix/trunk/main/doc/apache-felix-usage-documentation.html?rev=811924&r1=811923&r2=811924&view=diff ============================================================================== --- felix/trunk/main/doc/apache-felix-usage-documentation.html (original) +++ felix/trunk/main/doc/apache-felix-usage-documentation.html Sun Sep 6 22:21:18 2009 @@ -25,404 +25,263 @@ <!-- ApacheCon Ad --> </p></li></ul> </div> <div class="main"> -<h1><a name="ApacheFelixUsageDocumentation-ApacheFelixUsageDocumentation"></a>Apache Felix Usage Documentation</h1> +<H1><A name="ApacheFelixFrameworkUsageDocumentation-ApacheFelixFrameworkUsageDocumentation"></A>Apache Felix Framework Usage Documentation</H1> -<ul> - <li><a href="#ApacheFelixUsageDocumentation-startingfelix" title="starting-felix on Apache Felix Usage Documentation">Starting Felix</a></li> - <li><a href="#ApacheFelixUsageDocumentation-felixshell" title="felix-shell on Apache Felix Usage Documentation">Felix Shell</a> - <ul> - <li><a href="#ApacheFelixUsageDocumentation-installingbundles" title="installing-bundles on Apache Felix Usage Documentation">Installing Bundles</a></li> - <li><a href="#ApacheFelixUsageDocumentation-installingbundlesproxies" title="installing-bundles-proxies on Apache Felix Usage Documentation">Web Proxy Issues when Installing Bundles</a></li> - </ul> - </li> - <li><a href="#ApacheFelixUsageDocumentation-configuringfelix" title="configuring-felix on Apache Felix Usage Documentation">Configuring Felix</a> - <ul> - <li><a href="#ApacheFelixUsageDocumentation-migrating" title="migrating on Apache Felix Usage Documentation">Migrating from Earlier Versions</a></li> - <li><a href="#ApacheFelixUsageDocumentation-propertysubstitution" title="property-substitution on Apache Felix Usage Documentation">System Property Substitution</a></li> - <li><a href="#ApacheFelixUsageDocumentation-defaultshell" title="default-shell on Apache Felix Usage Documentation">Changing the Command Shell User Interface</a></li> - </ul> - </li> - <li><a href="#ApacheFelixUsageDocumentation-configuringbundles" title="configuring-bundles on Apache Felix Usage Documentation">Configuring Bundles</a></li> - <li><a href="#ApacheFelixUsageDocumentation-feedback" title="feedback on Apache Felix Usage Documentation">Feedback</a></li> -</ul> - - -<p><a name="ApacheFelixUsageDocumentation-startingfelix"></a></p> - -<h2><a name="ApacheFelixUsageDocumentation-StartingFelix"></a>Starting Felix</h2> - -<p>Start Felix from the installation directory by typing:</p> - -<div class="preformatted"><div class="preformattedContent"> -<pre>java -jar bin/felix.jar -</pre> -</div></div> - -<p>After Felix starts, the text-based shell interface is started. It is possible to <a href="#ApacheFelixUsageDocumentation-defaultshell" title="default-shell on Apache Felix Usage Documentation">change your default shell user interface</a>. Felix stores all installed bundles into a bundle cache directory. By default, Felix creates a cache directory, called <tt>felix-cache</tt>, in your current working directory; this behavior is configurable, see the <a href="http://felix.apache.org/site/apache-felix-bundle-cache.html"; title="Apache Felix Bundle Cache">Apache Felix Bundle Cache</a> document for more details.</p> - -<p>If you want to start Felix using a different bundle cache directory, you can start Felix like this:</p> - -<div class="preformatted"><div class="preformattedContent"> -<pre>java -jar bin/felix.jar <cache-path> -</pre> -</div></div> - -<p>Where <tt><cache-path></tt> is the path you want to use as the -bundle cache. If you specify a relative cache path, then it will be -treated as relative to the current working directory.</p> - -<table class="infoMacro" align="center" border="0" cellpadding="5" cellspacing="8" width="85%"><colgroup><col width="24"><col></colgroup><tbody><tr><td valign="top"><img src="apache-felix-usage-documentation_files/information.gif" alt="" align="absmiddle" border="0" height="16" width="16"></td><td><b class="strong">Useful Information</b><br> -<p>Previous versions of Felix prompted for a profile name when executed. The profile name was used to create a directory inside <tt>.felix/</tt> -in the users home directory. This approach allowed user's to have -different sets of bundles for different purposes, e.g., testing, -production, etc. If this behavior is still desired, it is very easy to -mimic. Modify <tt>conf/config.properties</tt> to include "<tt>felix.cache.rootdir=${user.home}/.felix</tt>". Now, if you start Felix with something like "<tt>java -jar bin/felix.jar foo</tt>", it will use "<tt>${user.home}/.felix/foo/</tt>" -as the bundle cache directory, where "${user.home}" is automatically -substituted with the appropriate system property by the launcher.</p></td></tr></tbody></table> - -<p><a name="ApacheFelixUsageDocumentation-felixshell"></a></p> - -<h2><a name="ApacheFelixUsageDocumentation-FelixShell"></a>Felix Shell</h2> - -<p>The main way to interact with Felix is via its shell service. Felix' -shell service is implemented as an OSGi service that, be default, uses -a simple text-based user interface. After starting Felix, type <tt>help</tt> into the shell to see the list of the available commands; these are the default commands:</p> - -<div class="preformatted"><div class="preformattedContent"> -<pre>bundlelevel <level> <id> ... | <id> - set or get bundle start level. -cd [<base-URL>] - change or display base URL. -headers [<id> ...] - display bundle header properties. -help - display shell commands. -install <URL> [<URL> ...] - install bundle(s). -obr help - OSGi bundle repository. -packages [<id> ...] - list exported packages. -ps [-l | -u] - list installed bundles. -refresh - refresh packages. -services [-u] [-a] [<id> ...] - list registered or used services. -shutdown - shutdown Felix. -start <id> [<id> <URL> ...] - start bundle(s). -startlevel [<level>] - get or set framework start level. -stop <id> [<id> ...] - stop bundle(s). -uninstall <id> [<id> ...] - uninstall bundle(s). -update <id> [<URL>] - update bundle. -version - display version of framework. -</pre> -</div></div> - -<p>For a detailed description of how to install bundles into Felix refer to the next <a href="#ApacheFelixUsageDocumentation-installingbundles" title="installing-bundles on Apache Felix Usage Documentation">sub-section</a>; the remainder of this section briefly describes shell behavior.</p> - -<p>Despite the fact that the Felix shell tries to mimic a typical Unix-like shell, it is actually quite limited. The notion of <tt>cd</tt>, -for example, is only used to specify a default base URL in order to -save typing. To illustrate, assume that you want to install several -bundles from a directory on your disk, you could type:</p> - -<div class="preformatted"><div class="preformattedContent"> -<pre>cd file:/c:/projects/felix/bundle/ -</pre> -</div></div> - -<p>After issuing this <tt>cd</tt> command, you no longer need to type -the complete URL for bundles located in the above directory, only the -name of the bundle JAR file is necessary. It is not possible to perform -an equivalent <tt>ls</tt> command to list the contents of the current -base URL, since this operation is not possible with URLs. To view all -currently installed bundles, use the <tt>ps</tt> command.</p> - -<p>To exit the Felix shell, simply type <tt>stop 0</tt> to stop the -System Bundle; any installed bundles will automatically be reloaded the -next time you start the associated profile. Additionally, any active -bundles will be reactivated the next time you restart the framework -with the same bundle cache.</p> - -<p><a name="ApacheFelixUsageDocumentation-installingbundles"></a></p> - -<h3><a name="ApacheFelixUsageDocumentation-InstallingBundles"></a>Installing Bundles</h3> - -<p>A bundle is the OSGi term for a component for the OSGi framework. A -bundle is simply a JAR file containing a manifest and some combination -of Java classes, embedded JAR files, native code, and resources. A -bundle may provide some specific functionality for the user or it may -implement a service that other bundles can use; bundles can only use -functionality from other bundles through shared services and packages.</p> - -<p>Felix is packaged with four bundles, which are located in the <tt>bundle/</tt> -directory of the Felix installation directory. There are bundles for -the Felix shell service, a text-based shell service user interface, a -bundle repository service, and a simple example bundle. In addition to -these bundles, the bundle repository services provides access to many -other bundles for easy installation. The bundle repository service -provides a shell command, named <tt>obr</tt>, to access available bundles; refer to the <a href="http://felix.apache.org/site/apache-felix-osgi-bundle-repository.html"; title="Apache Felix OSGi Bundle Repository">Apache Felix OSGi Bundle Repository</a> for more information.</p> - -<p>Before installing any bundles, it is important to understand how -bundles are manually deployed into the framework. Bundles are deployed -in two stages; first they are installed, then they are started. To -install a bundle use the <tt>install</tt> shell command followed by a bundle URL. For example, to install the <tt>simple.jar</tt> bundle included with Felix you type (assuming you have started Felix from its installation directory):</p> - -<div class="preformatted"><div class="preformattedContent"> -<pre>install file:bundle/simple.jar -</pre> -</div></div> - -<p>Once a bundle is installed, it can then be started by using the <tt>start</tt> command and the bundle identifier of the desired bundle. The <tt>ps</tt> -shell command is used to list all installed bundles and to obtain the -bundle's identifier. The following Felix shell session capture -illustrates how to start the <tt>simple.jar</tt> bundle:</p> +<UL> + <LI><A href="#ApacheFelixFrameworkUsageDocumentation-downloadingframework">Downloading the Framework</A></LI> + <LI><A href="#ApacheFelixFrameworkUsageDocumentation-startingframework">Starting the Framework</A></LI> + <LI><A href="#ApacheFelixFrameworkUsageDocumentation-frameworkshell">Framework Shell</A> -<div class="preformatted"><div class="preformattedContent"> -<pre>-> install [file:bundle/simple] + <UL> + <LI><A href="#ApacheFelixFrameworkUsageDocumentation-installingbundles">Installing Bundles</A></LI> + <LI><A href="#ApacheFelixFrameworkUsageDocumentation-installingbundlesproxies">Web Proxy Issues when Installing Bundles</A></LI> + </UL> + </LI> + <LI><A href="#ApacheFelixFrameworkUsageDocumentation-configuringframework">Configuring the Framework</A> + <UL> + + <LI><A href="#ApacheFelixFrameworkUsageDocumentation-migrating">Migrating from Earlier Versions</A></LI> + <LI><A href="#ApacheFelixFrameworkUsageDocumentation-propertysubstitution">System Property Substitution</A></LI> + </UL> + </LI> + <LI><A href="#ApacheFelixFrameworkUsageDocumentation-configuringbundles">Configuring Bundles</A></LI> + <LI><A href="#ApacheFelixFrameworkUsageDocumentation-feedback">Feedback</A></LI> +</UL> + + +<P><A name="ApacheFelixFrameworkUsageDocumentation-downloadingframework"></A></P> + +<H2><A name="ApacheFelixFrameworkUsageDocumentation-DownloadingtheFramework"></A>Downloading the Framework</H2> + +<P>Go to the <A href="downloads.html" title="downloads">downloads</A> page and download the latest Felix framework distribution.</P> + +<P><A name="ApacheFelixFrameworkUsageDocumentation-startingframework"></A></P> + +<H2><A name="ApacheFelixFrameworkUsageDocumentation-StartingtheFramework"></A>Starting the Framework</H2> + +<P>Start the framework from the installation directory by typing:</P> + +<DIV class="preformatted panel" style="border-width: 1px;"><DIV class="preformattedContent panelContent"> +<PRE>java -jar bin/felix.jar +</PRE> +</DIV></DIV> + +<P>The framework launcher starts the framework and installs a bundles contained in the <TT>bundle</TT> directory of the current directory. By default, the bundle directory contains a simple text-based shell to interact with the framework. Bundles installed into the framework are copied into a bundle cache directory for subsequent executions. By default, the framework creates a cache directory, called <TT>felix-cache</TT>, in your current working directory; this behavior is configurable, see the <A href="apache-felix-framework-bundle-cache.html" title="Apache Felix Framework Bundle Cache">Apache Felix Framework Bundle Cache</A> document for more details.</P> + +<P>If you want to start the framework using a different bundle cache directory, you can do so like this:</P> + +<DIV class="preformatted panel" style="border-width: 1px;"><DIV class="preformattedContent panelContent"> +<PRE>java -jar bin/felix.jar <cache-path> +</PRE> +</DIV></DIV> + +<P>Where <TT><cache-path></TT> is the path you want to use as the bundle cache. If you specify a relative cache path, then it will be treated as relative to the current working directory.</P> + +<DIV class="panelMacro"><TABLE class="infoMacro"><COLGROUP><COL width="24"><COL></COLGROUP><TR><TD valign="top"><IMG src="http://cwiki.apache.org/confluence/images/icons/emoticons/information.gif"; width="16" height="16" align="absmiddle" alt="" border="0"></TD><TD><B>Useful Information</B><BR><P>Previous versions of the framework prompted for a profile name when executed. The profile name was used to create a directory inside <TT>.felix/</TT> in the user home directory. This approach allowed users to have different sets of bundles for different purposes, e.g., testing, production, etc. If this behavior is still desired, it is very easy to mimic. Modify <TT>conf/config.properties</TT> to include "<TT>felix.cache.rootdir=${user.home}/.felix</TT>". Now, if you start Felix with something like "<TT>java -jar bin/felix.jar foo</TT>", it will use "<TT>${user.home}/.felix/foo/</TT>" as the bundle cache directory, where "<TT>${user.home</TT>}" is automatically substituted with the appropriate system property by the launcher.</P></TD></TR></TABLE></DIV> + +<P><A name="ApacheFelixFrameworkUsageDocumentation-frameworkshell"></A></P> + +<H2><A name="ApacheFelixFrameworkUsageDocumentation-FrameworkShell"></A>Framework Shell</H2> + +<P>The main way to interact with the framework is via its shell. Felix' shell is implemented as an OSGi service that, be default, uses a simple text-based user interface. After starting the framework, type <TT>help</TT> into the shell to see the list of the available commands and <TT>help <command-name></TT> to get help for a specific command.</P> + +<P>To install bundles, use the <TT>install</TT> command, which is described in more detail in the next <A href="#ApacheFelixFrameworkUsageDocumentation-installingbundles">sub-section</A>. To view all currently installed bundles, use the <TT>ps</TT> command. To stop the framework type <TT>stop 0</TT> to stop the System Bundle; any installed bundles will automatically be reloaded (and potentially restarted) the next time you launch with the associated cache.</P> + +<P><A name="ApacheFelixFrameworkUsageDocumentation-installingbundles"></A></P> + +<H3><A name="ApacheFelixFrameworkUsageDocumentation-InstallingBundles"></A>Installing Bundles</H3> + +<P>A bundle is the OSGi term for a component for the OSGi framework. A bundle is simply a JAR file containing a manifest and some combination of Java classes, embedded JAR files, native code, and resources. A bundle may provide some specific functionality for the user or it may implement a service that other bundles can use; bundles can only use functionality from other bundles through shared services and packages.</P> + +<P>The Felix framework is packaged with three bundles, which are located in the <TT>bundle/</TT> directory of the framework installation directory. There are bundles for the Felix shell service, a text-based shell service user interface, and a bundle repository service. In addition to these bundles, the bundle repository services provides access to other bundles for easy installation. The bundle repository service provides a shell command, named <TT>obr</TT>, to access available bundles; refer to the <A href="apache-felix-osgi-bundle-repository.html" title="Apache Felix OSGi Bundle Repository">Apache Felix OSGi Bundle Repository</A> for more information.</P> + +<P>Before installing any bundles, it is important to understand how bundles are manually deployed into the framework. Bundles are deployed in two stages; first they are installed, then they are started. To install a bundle use the <TT>install</TT> shell command followed by a bundle URL. For example, to install a <TT>bundle.jar</TT> bundle you type (assuming you have started Felix from its installation directory):</P> + +<DIV class="preformatted panel" style="border-width: 1px;"><DIV class="preformattedContent panelContent"> +<PRE>install file:/path/to/bundle/bundle.jar +</PRE> +</DIV></DIV> + +<P>Once a bundle is installed, it can then be started by using the <TT>start</TT> command and the bundle identifier of the desired bundle. The <TT>ps</TT> shell command is used to list all installed bundles and to obtain the bundle's identifier. The following Felix shell session capture illustrates how to start the <TT>bundle.jar</TT> bundle:</P> + +<DIV class="preformatted panel" style="border-width: 1px;"><DIV class="preformattedContent panelContent"> +<PRE>-> install [file:bundle/simple] -> ps START LEVEL 1 ID State Level Name -[ 0] [Active ] [ 0] System Bundle (0.8.0) -[ 1] [Active ] [ 1] Shell Service (0.8.0) -[ 2] [Active ] [ 1] Shell TUI (0.8.0) -[ 3] [Active ] [ 1] Bundle Repository (0.8.0) -[ 4] [Installed ] [ 1] Simple (0.8.0) +[ 0] [Active ] [ 0] System Bundle (2.0.0) +[ 1] [Active ] [ 1] Shell Service (1.4.0) +[ 2] [Active ] [ 1] Shell TUI (1.4.0) +[ 3] [Active ] [ 1] Bundle Repository (1.4.0) +[ 4] [Installed ] [ 1] Bundle Example (1.0.0) -> start 4 -Simple bundle 4 has started. -From native: Hello! -From embedded JAR: Hello! -Entry: META-INF/ -Entry: org/ -Entry: libfoo.so -The 'javax.servlet.http' package is not available. -The 'javax.servlet' package is not available. +Hello from Bundle 4. -> -</pre> -</div></div> +</PRE> +</DIV></DIV> + +<P>The <TT>stop</TT> command is used to stop a bundle and the <TT>uninstall</TT> command is used to remove a bundle from the bundle cache. As an alternative to using the <TT>install</TT> and <TT>start</TT> commands explicitly, it is also possible to install and start a bundle in one step by using the <TT>start</TT> command with a bundle URL.</P> + +<P>Bundles can be updated using the <TT>update</TT> command. The update command allows you to specify an URL from which to retrieve the updated bundle, but if one is not specified it will try to update the bundle from the bundle's <TT>Bundle-UpdateLocation</TT> manifest attribute, if present, or the bundle's original location URL.</P> + +<P><B>Important:</B> When you <TT>update</TT> or <TT>uninstall</TT> a bundle, the changes appear to take effect immediately, but in reality the changes are only partially enacted. If a bundle is updated or uninstalled and it was exporting packages, these packages are not removed until the framework is refreshed using the <TT>PackageAdmin</TT> service. The Felix shell offers a convenient <TT>refresh</TT> command for this purpose.</P> + +<P>For an introduction to writing bundles and services, refer to the Felix bundle tutorial.</P> + +<P><A name="ApacheFelixFrameworkUsageDocumentation-installingbundlesproxies"></A></P> + +<H3><A name="ApacheFelixFrameworkUsageDocumentation-WebProxyIssueswhenInstallingBundles"></A>Web Proxy Issues when Installing Bundles</H3> + +<P>If you use a proxy for Web access, then you may run into difficulty using the Felix shell to install bundles from a remote URL. To remedy this situation, certain system properties must be set to make Felix work with your proxy. These properties are:</P> + +<UL> + <LI><TT>http.proxyHost</TT> - the name of the proxy host.</LI> + + <LI><TT>http.proxyPort</TT> - the port of the proxy host.</LI> + <LI><TT>http.proxyAuth</TT> - the user name and password to use when connecting to the proxy; this string should be the user name and password separated by a colon (e.g., <TT>rickhall:mypassword</TT>).</LI> +</UL> + + +<P>These system properties can be set directly on the command line when starting the JVM using the standard "<TT>-D<prop>=<value></TT>" syntax or you can put them in the <TT>lib/system.properties</TT> file of your Felix installation; see the next section on <A href="#ApacheFelixFrameworkUsageDocumentation-configuringframework">configuring Felix</A> for more information.</P> -<p>The <tt>stop</tt> command is used to stop a bundle and the <tt>uninstall</tt> command is used to remove a bundle from the bundle cache. As an alternative to using the <tt>install</tt> and <tt>start</tt> commands explicitly, it is also possible to install and start a bundle in one step by using the <tt>start</tt> command with a bundle URL.</p> +<P><A name="ApacheFelixFrameworkUsageDocumentation-configuringframework"></A></P> -<p>Bundles can be updated using the <tt>update</tt> command. The update -command allows you to specify an URL from which to retrieve the updated -bundle, but if one is not specified it will try to update the bundle -from the bundle's <tt>Bundle-UpdateLocation</tt> manifest attribute, if present, or the bundle's original location URL.</p> - -<p><b>Important:</b> When you <tt>update</tt> or <tt>uninstall</tt> a -bundle, the changes appear to take effect immediately, but in reality -the changes are only partially enacted. If a bundle is updated or -uninstalled and it was exporting packages, these packages are not -removed until the framework is refreshed using the <tt>PackageAdmin</tt> service. The Felix shell offers a convenient <tt>refresh</tt> command for this purpose.</p> - -<p>For an introduction to writing bundles and services, refer to the Felix bundle tutorial.</p> - -<p><a name="ApacheFelixUsageDocumentation-installingbundlesproxies"></a></p> - -<h3><a name="ApacheFelixUsageDocumentation-WebProxyIssueswhenInstallingBundles"></a>Web Proxy Issues when Installing Bundles</h3> - -<p>If you use a proxy for Web access, then you may run into difficulty -using the Felix shell to install bundles from a remote URL. To remedy -this situation, certain system properties must be set to make Felix -work with your proxy. These properties are:</p> - -<ul> - <li><tt>http.proxyHost</tt> - the name of the proxy host.</li> - <li><tt>http.proxyPort</tt> - the port of the proxy host.</li> - <li><tt>http.proxyAuth</tt> -- the user name and password to use when connecting to the proxy; this -string should be the user name and password separated by a colon (e.g., -<tt>rickhall:mypassword</tt>).</li> -</ul> - - -<p>These system properties can be set directly on the command line when starting the JVM using the standard "<tt>-D<prop>=<value></tt>" syntax or you can put them in the <tt>lib/system.properties</tt> file of your Felix installation; see the next section on <a href="#ApacheFelixUsageDocumentation-configuringfelix" title="configuring-felix on Apache Felix Usage Documentation">configuring Felix</a> for more information.</p> - -<p><a name="ApacheFelixUsageDocumentation-configuringfelix"></a></p> - -<h2><a name="ApacheFelixUsageDocumentation-ConfiguringFelix"></a>Configuring Felix</h2> - -<p>Felix uses properties to configure certain aspects of its behavior. The Felix launcher (i.e., <tt>java -jar bin/felix.jar</tt>) reads configuration properties from two different locations in the installation directory: <tt>conf/system.properties</tt> and <tt>conf/config.properties</tt>. Both files use standard Java property file syntax.</p> - -<p>The <tt>conf/system.properties</tt> file provides a convenient -mechanism for defining Java system properties, but it is largely -ignored by Felix, since Felix does not typically use system properties -for configuration purposes. Any properties placed in the <tt>conf/system.properties</tt> file are available at run time via <tt>System.getProperty()</tt> and <tt>BundleContext.getProperty()</tt>. It is also possible to specify a different location for the system properties file by using the <tt>felix.system.properties</tt> system property when executing Felix. For example:</p> - -<div class="preformatted"><div class="preformattedContent"> -<pre>java -Dfelix.system.properties=file:/home/rickhall/system.properties -jar bin/felix.jar -</pre> -</div></div> - -<p>Nearly all Felix configuration occurs using properties in the <tt>conf/config.properties</tt> file. It is possible to change the location of the configuration properties file by specifying a new location value using the <tt>felix.config.properties</tt> -system property. It is necessary to use a system property here since -Felix needs this value to start execution. As an example, the following -command could be used to specify a custom location for the -configuration properties file:</p> - -<div class="preformatted"><div class="preformattedContent"> -<pre>java -Dfelix.config.properties=file:/home/rickhall/config.properties -jar bin/felix.jar -</pre> -</div></div> - -<p>In this example the configuration properties will be read from the -specified URL. All remaining configuration properties should be defined -in the <tt>config.properties</tt> file itself. All configuration properties are accessible at run time via <tt>BundleContext.getProperty()</tt>.</p> - -<p>Some configuration properties are handled by Felix' launcher, while -others are handled by the Felix framework itself. Regardless, both -launcher and framework configuration properties are placed in the <tt>conf/config.properties</tt> files.</p> - -<p>The following are launcher configuration properties:</p> - -<ul> - <li><tt>felix.auto.install.<n></tt> - Space-delimited list of bundle URLs to automatically install when Felix is started, where <tt><n></tt> is the start level into which the bundle will be installed (e.g., <tt>felix.auto.install.2</tt>).</li> - <li><tt>felix.auto.start.<n></tt> - Space-delimited list of bundle URLs to automatically install and start when Felix is started, where <tt><n></tt> is the start level into which the bundle will be installed (e.g., <tt>felix.auto.start.2</tt>).</li> -</ul> - - -<p>The following are framework configuration properties (properties starting with "<tt>felix</tt>" are specific to Felix, while those starting with "<tt>org.osgi</tt>" are standard OSGi properties):</p> - -<ul> - <li><tt>org.osgi.framework.storage</tt> - Sets the directory to use as the bundle cache; by default bundle cache directory is <tt>felix-cache</tt> -in the current working directory. The value should be a valid directory -name. The directory name can be either absolute or relative. Relative -directory names are relative to the current working directory. The -specified directory will be created if it does not exist.</li> - <li><tt>org.osgi.framework.storage.clean</tt> - Determines whether the bundle cache is flushed. The value can either be "<tt>none</tt>" or "<tt>onFirstInit</tt>", where "<tt>none</tt>" does not flush the bundle cache and "<tt>onFirstInit</tt>" flushes the bundle cache when the framework instance is first initialized. The default value is "<tt>none</tt>".</li> - <li><tt>felix.cache.rootdir</tt> - Sets the root directory to use to calculate the bundle cache directory for relative directory names. If <tt>org.osgi.framework.storage</tt> -is set to a relative name, by default it is relative to the current -working directory. If this property is set, then it will be calculated -as being relative to the specified root directory.</li> - <li><tt>felix.cache.bufsize</tt> -- Sets the buffer size to be used by the cache; the default value is -4096. The integer value of this string provides control over the size -of the internal buffer of the disk cache for performance reasons.</li> - <li><tt>org.osgi.framework.system.packages</tt> -- Specifies a comma-delimited list of packages that should be exported -via the System Bundle from the parent class loader. The framework will -set this to a reasonable default. If the value is specified, it -replaces any default value.</li> - <li><tt>org.osgi.framework.system.packages.extra</tt> -- Specifies a comma-delimited list of packages that should be exported -via the System Bundle from the parent class loader in addition to the -packages in <tt>org.osgi.framework.system.packages</tt>. The default value is empty. If a value is specified, it is appended to the list of default or specified packages in <tt>org.osgi.framework.system.packages</tt>.</li> - <li><tt>org.osgi.framework.bootdelegation</tt> -- Specifies a comma-delimited list of packages that should be made -implicitly available to all bundles from the parent class loader. It is -recommended not to use this property since it breaks modularity. The -default value is empty.</li> - <li><tt>felix.systembundle.activators</tt> - A <tt>List</tt> of <tt>BundleActivator</tt> -instances that are started/stopped when the System Bundle is -started/stopped. The specified instances will receive the System -Bundle's <tt>BundleContext</tt> when invoked. (This property cannot be -set in the configuration file since it requires instances; it can only -be passed into Felix' constructor directly.)</li> - <li><tt>felix.log.logger</tt> - An instance of <tt>Logger</tt> -that the framework uses as its default logger. (This property cannot be -set in the configuration file since it requires an instance; it can -only be passed into Felix' constructor directly.)</li> - <li><tt>felix.log.level</tt> -- An integer value indicating the degree of logging reported by the -framework; the higher the value the more logging is reported. If zero -('0') is specified, then logging is turned off completely. The log -levels match those specified in the OSGi Log Service (i.e., 1 = error, -2 = warning, 3 = information, and 4 = debug). The default value is 1.</li> - <li><tt>org.osgi.framework.startlevel</tt> - The initial start level of the framework once it starts execution; the default value is 1.</li> - <li><tt>felix.startlevel.bundle</tt> - The default start level for newly installed bundles; the default value is 1.</li> - <li><tt>felix.service.urlhandlers</tt> - Flag to indicate whether to activate the URL Handlers service for the framework instance; the default value is "<tt>true</tt>". Activating the URL Handlers service will result in the <tt>URL.setURLStreamHandlerFactory()</tt> and <tt>URLConnection.setContentHandlerFactory()</tt> being called.</li> - <li><tt>felix.fragment.validation</tt> - Determines if installing unsupported fragment bundles throws an exception or logs a warning. Possible values are "<tt>exception</tt>" or "<tt>warning</tt>". The default value is "<tt>exception</tt>".</li> -</ul> - - -<p>The Felix installation contains a default <tt>conf/config.properties</tt> file for automatically starting the shell-related bundles.</p> - -<p><a name="ApacheFelixUsageDocumentation-migrating"></a></p> - -<h3><a name="ApacheFelixUsageDocumentation-MigratingfromEarlierVersions"></a>Migrating from Earlier Versions</h3> - -<p>The release of Felix <tt>1.4.0</tt> introduced some configuration property changes. This section describes the differences from older versions of Felix.</p> - -<ul> - <li><b>Removed</b> - <ul> - <li><tt>felix.embedded.execution</tt> - No longer needed, since the framework now never calls <tt>System.exit()</tt>; the creator of the framework is now always responsible for exiting the VM.</li> - <li><tt>felix.strict.osgi</tt> - No longer needed, since all non-specification features have been removed.</li> - <li><tt>felix.cache.dir</tt> - No longer needed, since Felix no longer uses bundle cache profiles for saving sets of bundles.</li> - <li><tt>felix.cache.profile</tt> - No longer needed, since Felix no longer uses bundle cache profiles for saving sets of bundles.</li> - </ul> - </li> - <li><b>Renamed</b> - <ul> - <li><tt>felix.cache.profiledir</tt> - The equivalent of this property is now named <tt>org.osgi.framework.storage</tt>.</li> - <li><tt>felix.startlevel.framework</tt> - The equivalent of this property is now named <tt>org.osgi.framework.startlevel</tt>.</li> - </ul> - </li> - <li><b>Introduced</b> - <ul> - <li><tt>org.osgi.framework.system.packages.extra</tt> - New property, as described above, added to align with standard framework API.</li> - <li><tt>org.osgi.framework.storage.clean</tt> - New property, as described above, added to align with standard framework API.</li> - <li><tt>felix.cache.rootdir</tt> - Introduced as a result of removing bundle profiles to help resolve relative bundle cache directories.</li> - <li><tt>felix.fragment.validation</tt> - Introduced to control fragment validation, since the default behavior introduced in <tt>1.2.0</tt> of throwing an exception for fragments using unsupported features was causing issues for some users.</li> - </ul> - </li> -</ul> - - -<p>For the most part, these changes are minor and previous behavior -achieved from older configuration properties is either easily attained -with the new properties or no longer necessary.</p> - -<p><a name="ApacheFelixUsageDocumentation-propertysubstitution"></a></p> - -<h3><a name="ApacheFelixUsageDocumentation-SystemPropertySubstituion"></a>System Property Substituion</h3> -<p>It is possible to use system properties to specify the values of properties in the <tt>conf/config.properties</tt> file. This is achieved through system property substitution, which is instigated by using <tt>${<property></tt>} syntax, where <tt><property></tt> -is the name of a system property to substitute. When such a property -value is retrieved by a bundle, the system property value will be -substituted into the bundle property value as appropriate. It is -possible to have nested system property substitution, in which case the -inner-most property is substituted first, then the next inner most, -until reaching the outer most.</p> - -<p><a name="ApacheFelixUsageDocumentation-defaultshell"></a></p> - -<h3><a name="ApacheFelixUsageDocumentation-ChangingtheCommandShellUserInterface"></a>Changing the Command Shell User Interface</h3> - -<p>Felix' shell service supports multiple user interface -implementations; the default shell user interface is text-based, but a -simple graphical shell is also available. To change the default shell -user interface, you must download the Shell GUI and Shell GUI Plugin -bundles. Then you must modify the <tt>felix.auto.start</tt> property in the <tt>conf/config.properties</tt> file of your Felix installation. For the text-based user interface, the property value should look like this:</p> +<H2><A name="ApacheFelixFrameworkUsageDocumentation-ConfiguringtheFramework"></A>Configuring the Framework</H2> -<div class="preformatted"><div class="preformattedContent"> -<pre>felix.auto.start.1=file:bundle/shell.jar file:bundle/shelltui.jar \ +<P>Both the Felix framework and the launcher use configuration properties to alter their default behavior. The framework can only be configured by passing properties into its constructor, but the launcher provides a mechanism to configure the framework via a property file. The launcher The Felix framework uses properties to configure certain aspects of its behavior. The framework launcher reads configuration properties from <TT>conf/config.properties</TT>. This file uses standard Java property file syntax.</P> + +<P>The launcher also supports setting system properties via the <TT>conf/system.properties</TT> file. This file is purely for convenience when you need to repeatedly set system properties when running the framework. While the framework itself does not look at system properties, the launcher does copy any framework configuration properties found in the system properties into the framework configuration map, also for your convenience.</P> + +<P>It is possible to specify a different locations for these property files for the system properties file by using the <TT>felix.config.properties</TT> and <TT>felix.system.properties</TT> system properties when executing the framework. For example:</P> + +<DIV class="preformatted panel" style="border-width: 1px;"><DIV class="preformattedContent panelContent"> +<PRE>java -Dfelix.config.properties=file:/home/rickhall/config.properties -jar bin/felix.jar +</PRE> +</DIV></DIV> + +<P>Configuration and system properties are accessible at run time via <TT>BundleContext.getProperty()</TT>, but configuration properties override system properties.</P> + +<P>The following configuration properties are specifically for the launcher:</P> + +<UL> + <LI><TT>felix.auto.deploy.dir</TT> - Specifies the auto-deploy directory from which bundles are automatically deploy at framework startup. The default is the <TT>bundle/</TT> directory of the current directory.</LI> + + <LI><TT>felix.auto.deploy.action</TT> - Specifies the auto-deploy actions to be found on bundle JAR files found in the auto-deploy directory. The possible actions are <TT>install</TT>, <TT>update</TT>, <TT>start</TT>, and <TT>uninstall</TT>. The default value is <TT>install</TT>, <TT>update</TT>, and <TT>start</TT>.</LI> + + <LI><TT>felix.auto.install.<n></TT> - Space-delimited list of bundle URLs to automatically install when Felix is started, where <TT><n></TT> is the start level into which the bundle will be installed (e.g., <TT>felix.auto.install.2</TT>).</LI> + <LI><TT>felix.auto.start.<n></TT> - Space-delimited list of bundle URLs to automatically install and start when Felix is started, where <TT><n></TT> is the start level into which the bundle will be installed (e.g., <TT>felix.auto.start.2</TT>).</LI> + + <LI><TT>felix.shutdown.hook</TT> - Specifies whether the launcher should install a shutdown hook to cleanly shutdown the framework on process exit. The default value is <TT>true</TT>.</LI> +</UL> + + +<P>The following are framework configuration properties (properties starting with "<TT>felix</TT>" are specific to Felix, while those starting with "<TT>org.osgi</TT>" are standard OSGi properties):</P> + +<UL> + <LI><TT>org.osgi.framework.storage</TT> - Sets the directory to use as the bundle cache; by default bundle cache directory is <TT>felix-cache</TT> in the current working directory. The value should be a valid directory name. The directory name can be either absolute or relative. Relative directory names are relative to the current working directory. The specified directory will be created if it does not exist.</LI> + <LI><TT>org.osgi.framework.storage.clean</TT> - Determines whether the bundle cache is flushed. The value can either be "<TT>none</TT>" or "<TT>onFirstInit</TT>", where "<TT>none</TT>" does not flush the bundle cache and "<TT>onFirstInit</TT>" flushes the bundle cache when the framework instance is first initialized. The default value is "<TT>none</TT>".</LI> + + <LI><TT>felix.cache.rootdir</TT> - Sets the root directory to use to calculate the bundle cache directory for relative directory names. If <TT>org.osgi.framework.storage</TT> is set to a relative name, by default it is relative to the current working directory. If this property is set, then it will be calculated as being relative to the specified root directory.</LI> + <LI><TT>felix.cache.bufsize</TT> - Sets the buffer size to be used by the cache; the default value is 4096. The integer value of this string provides control over the size of the internal buffer of the disk cache for performance reasons.</LI> + <LI><TT>org.osgi.framework.system.packages</TT> - Specifies a comma-delimited list of packages that should be exported via the System Bundle from the parent class loader. The framework will set this to a reasonable default. If the value is specified, it replaces any default value.</LI> + + <LI><TT>org.osgi.framework.system.packages.extra</TT> - Specifies a comma-delimited list of packages that should be exported via the System Bundle from the parent class loader in addition to the packages in <TT>org.osgi.framework.system.packages</TT>. The default value is empty. If a value is specified, it is appended to the list of default or specified packages in <TT>org.osgi.framework.system.packages</TT>.</LI> + <LI><TT>org.osgi.framework.bootdelegation</TT> - Specifies a comma-delimited list of packages that should be made implicitly available to all bundles from the parent class loader. It is recommended not to use this property since it breaks modularity. The default value is empty.</LI> + <LI><TT>felix.systembundle.activators</TT> - A <TT>List</TT> of <TT>BundleActivator</TT> instances that are started/stopped when the System Bundle is started/stopped. The specified instances will receive the System Bundle's <TT>BundleContext</TT> when invoked. (This property cannot be set in the configuration file since it requires instances; it can only be passed into Felix' constructor directly.)</LI> + + <LI><TT>felix.log.logger</TT> - An instance of <TT>Logger</TT> that the framework uses as its default logger. (This property cannot be set in the configuration file since it requires an instance; it can only be passed into Felix' constructor directly.)</LI> + <LI><TT>felix.log.level</TT> - An integer value indicating the degree of logging reported by the framework; the higher the value the more logging is reported. If zero ('0') is specified, then logging is turned off completely. The log levels match those specified in the OSGi Log Service (i.e., 1 = error, 2 = warning, 3 = information, and 4 = debug). The default value is 1.</LI> + <LI><TT>org.osgi.framework.startlevel.beginning</TT> - The initial start level of the framework once it starts execution; the default value is 1.</LI> + + <LI><TT>felix.startlevel.bundle</TT> - The default start level for newly installed bundles; the default value is 1.</LI> + <LI><TT>felix.service.urlhandlers</TT> - Flag to indicate whether to activate the URL Handlers service for the framework instance; the default value is "<TT>true</TT>". Activating the URL Handlers service will result in the <TT>URL.setURLStreamHandlerFactory()</TT> and <TT>URLConnection.setContentHandlerFactory()</TT> being called.</LI> + + <LI><TT>felix.fragment.validation</TT> - Determines if installing unsupported fragment bundles throws an exception or logs a warning. Possible values are "<TT>exception</TT>" or "<TT>warning</TT>". The default value is "<TT>exception</TT>".</LI> +</UL> + + +<P>The Felix installation contains a default <TT>conf/config.properties</TT> file for automatically starting the shell-related bundles.</P> + +<P><A name="ApacheFelixFrameworkUsageDocumentation-migrating"></A></P> + +<H3><A name="ApacheFelixFrameworkUsageDocumentation-MigratingfromEarlierVersions"></A>Migrating from Earlier Versions</H3> + +<P>Apache Felix Framework <TT>1.4.0</TT> introduced some configuration property changes. This section describes the differences from older versions of the framework.</P> + +<UL> + <LI><B>Removed</B> + <UL> + + <LI><TT>felix.embedded.execution</TT> - No longer needed, since the framework now never calls <TT>System.exit()</TT>; the creator of the framework is now always responsible for exiting the VM.</LI> + <LI><TT>felix.strict.osgi</TT> - No longer needed, since all non-specification features have been removed.</LI> + <LI><TT>felix.cache.dir</TT> - No longer needed, since Felix no longer uses bundle cache profiles for saving sets of bundles.</LI> + + <LI><TT>felix.cache.profile</TT> - No longer needed, since Felix no longer uses bundle cache profiles for saving sets of bundles.</LI> + </UL> + </LI> + <LI><B>Renamed</B> + <UL> + <LI><TT>felix.cache.profiledir</TT> - The equivalent of this property is now named <TT>org.osgi.framework.storage</TT>.</LI> + + <LI><TT>felix.startlevel.framework</TT> - The equivalent of this property is now named <TT>org.osgi.framework.startlevel.beginning</TT>.</LI> + </UL> + </LI> + <LI><B>Introduced</B> + <UL> + + <LI><TT>org.osgi.framework.system.packages.extra</TT> - New property, as described above, added to align with standard framework API.</LI> + <LI><TT>org.osgi.framework.storage.clean</TT> - New property, as described above, added to align with standard framework API.</LI> + <LI><TT>felix.cache.rootdir</TT> - Introduced as a result of removing bundle profiles to help resolve relative bundle cache directories.</LI> + + <LI><TT>felix.fragment.validation</TT> - Introduced to control fragment validation, since the default behavior introduced in <TT>1.2.0</TT> of throwing an exception for fragments using unsupported features was causing issues for some users.</LI> + </UL> + </LI> +</UL> + + +<P>For the most part, these changes are minor and previous behavior achieved from older configuration properties is either easily attained with the new properties or no longer necessary.</P> + +<P><A name="ApacheFelixFrameworkUsageDocumentation-propertysubstitution"></A></P> + +<H3><A name="ApacheFelixFrameworkUsageDocumentation-SystemPropertySubstituion"></A>System Property Substituion</H3> +<P>It is possible to use system properties to specify the values of properties in the <TT>conf/config.properties</TT> file. This is achieved through system property substitution, which is instigated by using <TT>${<property></TT>} syntax, where <TT><property></TT> is the name of a system property to substitute. When such a property value is retrieved by a bundle, the system property value will be substituted into the bundle property value as appropriate. It is possible to have nested system property substitution, in which case the inner-most property is substituted first, then the next inner most, until reaching the outer most.</P> + +<P><A name="ApacheFelixFrameworkUsageDocumentation-defaultshell"></A></P> + +<H3><A name="ApacheFelixFrameworkUsageDocumentation-ChangingtheCommandShellUserInterface"></A>Changing the Command Shell User Interface</H3> + +<P>Felix' shell service supports multiple user interface implementations; the default shell user interface is text-based, but a simple graphical shell is also available. To change the default shell user interface, you must download the Shell GUI and Shell GUI Plugin bundles. Then you must modify the <TT>felix.auto.start</TT> property in the <TT>conf/config.properties</TT> file of your framework installation. For the text-based user interface, the property value should look like this:</P> + +<DIV class="preformatted panel" style="border-width: 1px;"><DIV class="preformattedContent panelContent"> +<PRE>felix.auto.start.1=file:bundle/shell.jar file:bundle/shelltui.jar \ file:bundle/bundlerepository.jar -</pre> -</div></div> +</PRE> + +</DIV></DIV> -<p>This property value instructs Felix to automatically start the shell -service, the shell textual user interface, and the bundle repository. (<em>Note: -The "\" character at the end of the above line indicates that the -property value continues on the next line; it is also possible to -specify the property value on one line.</em>) For the GUI-based shell user interface, the property value should look something like this:</p> +<P>This property value instructs the framework launcher to automatically start the shell service, the shell textual user interface, and the bundle repository. (<EM>Note: The "\" character at the end of the above line indicates that the property value continues on the next line; it is also possible to specify the property value on one line.</EM>) For the GUI-based shell user interface, the property value should look something like this:</P> -<div class="preformatted"><div class="preformattedContent"> -<pre>felix.auto.start.1=file:bundle/shell.jar file:bundle/bundlerepository.jar \ +<DIV class="preformatted panel" style="border-width: 1px;"><DIV class="preformattedContent panelContent"> +<PRE>felix.auto.start.1=file:bundle/shell.jar file:bundle/bundlerepository.jar \ file:bundle/shellgui.jar file:bundle/shellplugin.jar -</pre> -</div></div> +</PRE> +</DIV></DIV> -<p>This property value instructs Felix to automatically start the shell -service, the bundle repository, the shell GUI, and the shell GUI -plugins.</p> +<P>This property value instructs the framework launcher to automatically start the shell service, the bundle repository, the shell GUI, and the shell GUI plugins.</P> -<p><a name="ApacheFelixUsageDocumentation-configuringbundles"></a></p> +<P><A name="ApacheFelixFrameworkUsageDocumentation-configuringbundles"></A></P> -<h2><a name="ApacheFelixUsageDocumentation-ConfiguringBundles"></a>Configuring Bundles</h2> +<H2><A name="ApacheFelixFrameworkUsageDocumentation-ConfiguringBundles"></A>Configuring Bundles</H2> -<p>Some bundles use properties to configure certain aspects of their behavior. As an example, the default URL for the <tt>cd</tt> command of the shell service can be specified using the property <tt>felix.shell.baseurl</tt>. -It is a good idea, when implementing bundles, to parameterize them with -properties where appropriate. To learn about the configuration options -for specific bundles, refer to the documentation that accompanies them.</p> +<P>Some bundles use properties to configure certain aspects of their behavior. As an example, the default URL for the <TT>cd</TT> command of the shell service can be specified using the property <TT>felix.shell.baseurl</TT>. It is a good idea, when implementing bundles, to parameterize them with properties where appropriate. To learn about the configuration options for specific bundles, refer to the documentation that accompanies them.</P> -<p>Bundle properties are also defined in the <tt>conf/config.properties</tt> property file. Any property placed in this file will be accessible via <tt>BundleContext.getProperty()</tt> -at run time. The property file uses the standard Java property file -syntax (i.e., attribute-value pairs). For information on changing the -default location of this file, refer to the section on <a href="#ApacheFelixUsageDocumentation-configuringfelix" title="configuring-felix on Apache Felix Usage Documentation">configuring Felix</a>.</p> +<P>Bundle properties are also defined in the <TT>conf/config.properties</TT> property file. Any property placed in this file will be accessible via <TT>BundleContext.getProperty()</TT> at run time. The property file uses the standard Java property file syntax (i.e., attribute-value pairs). For information on changing the default location of this file, refer to the section on <A href="#ApacheFelixFrameworkUsageDocumentation-configuringframework">configuring Felix</A>.</P> -<p><a name="ApacheFelixUsageDocumentation-feedback"></a></p> +<P><A name="ApacheFelixFrameworkUsageDocumentation-feedback"></A></P> -<h2><a name="ApacheFelixUsageDocumentation-Feedback"></a>Feedback</h2> +<H2><A name="ApacheFelixFrameworkUsageDocumentation-Feedback"></A>Feedback</H2> -<p>Subscribe to the Felix users mailing list by sending a message to <span class="nobr"><a href="mailto:[email protected]"; title="Send mail to [email protected]" rel="nofollow">[email protected]<sup><img class="rendericon" src="apache-felix-usage-documentation_files/mail_small.gif" alt="" align="absmiddle" border="0" height="12" width="13"></sup></a></span>; after subscribing, email questions or feedback to <span class="nobr"><a href="mailto:[email protected]"; title="Send mail to [email protected]" rel="nofollow">[email protected]<sup><img class="rendericon" src="apache-felix-usage-documentation_files/mail_small.gif" alt="" align="absmiddle" border="0" height="12" width="13"></sup></a></span>.</p> +<P>Subscribe to the Felix users mailing list by sending a message to <A href="mailto:[email protected]"; rel="nofollow">[email protected]</A>; after subscribing, email questions or feedback to <A href="mailto:[email protected]"; rel="nofollow">[email protected]</A>.</P> + </div> - </body></html> \ No newline at end of file + </body></html>
Modified: felix/trunk/main/doc/changelog.txt URL: http://svn.apache.org/viewvc/felix/trunk/main/doc/changelog.txt?rev=811924&r1=811923&r2=811924&view=diff ============================================================================== --- felix/trunk/main/doc/changelog.txt (original) +++ felix/trunk/main/doc/changelog.txt Sun Sep 6 22:21:18 2009 @@ -1,3 +1,9 @@ +Changes from 1.8.1 to 2.0.0 +--------------------------- + +** Improvement + * Update to latest framework version 2.0.0 + Changes form 1.6.1 to 1.8.0 ---------------------------
![http://cwiki.apache.org/confluence/images/icons/emoticons/information.gif"](http://cwiki.apache.org/confluence/images/icons/emoticons/information.gif"){kind=link}