Index: manual/src/main/webapp/users-guide/remote-console.conf =================================================================== --- manual/src/main/webapp/users-guide/remote-console.conf (revision 1141702) +++ manual/src/main/webapp/users-guide/remote-console.conf (working copy) @@ -4,9 +4,9 @@ It does not always make sense to manage an instance of Karaf using its local console. You can manage Karaf remotely using a remote console. -When you start Karaf, it enables a remote console that can be accessed over SSH from any other Karaf conolse or plain SSH client. The remote console provides all the features of the local console and gives a remote user complete control over the container and services running inside of it. +When you start Karaf, it enables a remote console that can be accessed over SSH from any other Karaf console or plain SSH client. The remote console provides all the features of the local console and gives a remote user complete control over the container and services running inside of it. -The SSH hostname and port number is configured in the {{\[karaf_install_dir\]/etc/org.apache.karaf.shell.cfg}} configuration file with the following defaults values: +The SSH hostname and port number is configured in the {{\[karaf_install_dir\]/etc/org.apache.karaf.shell.cfg}} configuration file with the following default values: {code} sshPort=8101 @@ -15,7 +15,7 @@ hostKey=${karaf.base}/etc/host.key {code} -You can change this configuration using the [config commands|configuration] or by editing the above file, but you need to restart the ssh console in order for it to use the new parameters. +You can change this configuration using the [config commands|configuration] or by editing the above file, but you'll need to restart the ssh console in order for it to use the new parameters. {code} # define helper functions @@ -40,7 +40,7 @@ {code} {warning} -The default password is {{karaf}} but we recommend to change it. See the [security] section for more informations. +The default password is {{karaf}} but we recommend changing it. See the [security] section for more information. {warning} To confirm that you have connected to the correct Karaf instance, type [{{shell:info}}|/commands/shell-info] at the {{karaf>}} prompt. Information about the currently connected instance is returned, as shown. @@ -55,7 +55,7 @@ ... {code} -h3. Using the karaf client +h3. Using the Karaf client The Karaf client allows you to securely connect to a remote Karaf instance without having to launch a Karaf instance locally. @@ -64,7 +64,7 @@ bin/client {code} -More usually, you would provide a hostname, port, username and password to connect to a remote instance. And, if you were using the client within a larger script, you could append console commands as follows: +More commonly, you would provide a hostname, port, username and password to connect to a remote instance. And, if you were using the client within a larger script, you could append console commands as follows: {code} bin/client -a 8101 -h hostname -u karaf -p karaf features:install wrapper {code} @@ -99,8 +99,8 @@ h3. Using a JConsole or Java VisualVM -Another way of configuring or controlling your running Karaf is to use JConsoel or Java VisualVM. -To connect to your running Karaf via JMX you can use the following URL: +Another way of configuring or controlling your running Karaf is to use JConsole or Java VisualVM. +To connect to your running Karaf instance via JMX you can use the following URL: {code} service:jmx:rmi://localhost:44444/jndi/rmi://localhost:1099/karaf-root {code} @@ -112,7 +112,7 @@ service:jmx:rmi://localhost:${rmiServerPort}/jndi/rmi://localhost:${rmiRegistryPort}/karaf-${karaf.name} {code} -The ports and the karaf instance name are configured in the org.apache.karaf.managment.cfg file in /etc. +The ports and the Karaf instance name are configured in the org.apache.karaf.managment.cfg file in /etc. h2. Stopping a remote instance Index: manual/src/main/webapp/users-guide/installation.conf =================================================================== --- manual/src/main/webapp/users-guide/installation.conf (revision 1141702) +++ manual/src/main/webapp/users-guide/installation.conf (working copy) @@ -1,7 +1,7 @@ h1. Installation -This chapter describes how to install Apache Karaf for both Unix and Windows' platforms. -Here you will find information about what are pre requisite software, where to download Karaf from and how to install it. +This chapter describes how to install Apache Karaf for both Unix and Windows platforms, including +prerequisite software and necessary download links. h2. Pre-Installation Requirements @@ -24,7 +24,7 @@ * 200 MB of free disk space for the Apache Karaf x.y source distributions or SVN checkout, the Maven build and the dependencies Maven downloads. *Environment:* -* Java SE Developement Kit 1.6.x or greater ([http://www.oracle.com/technetwork/java/javase/]). +* Java SE Development Kit 1.6.x or greater ([http://www.oracle.com/technetwork/java/javase/]). * Apache Maven 3.0.3 ([http://maven.apache.org/download.html]). h3. Building on Windows @@ -114,5 +114,5 @@ h2. Post-Installation steps Thought it is not always required, it is strongly advised to set up the {{JAVA_HOME}} environment property to point to the JDK you want Karaf to use before starting it. -This property is used to locate the {{java}} executable and should be configured to point to the home directory of the Java SE 5 or 6 installation. +This property is used to locate the {{java}} executable and should be configured to point to the home directory of the Java SE 6 installation. Index: manual/src/main/webapp/users-guide/web-applications.conf =================================================================== --- manual/src/main/webapp/users-guide/web-applications.conf (revision 1141702) +++ manual/src/main/webapp/users-guide/web-applications.conf (working copy) @@ -21,7 +21,7 @@ {noformat} karaf@root> features:install war {noformat} -NB: you can use the -v or --verbose to see exactly what Karaf does +Note: you can use the -v or --verbose option to see exactly what Karaf does {noformat} karaf@root> features:install -v war Installing feature war 2.99.99-SNAPSHOT Index: manual/src/main/webapp/users-guide/security.conf =================================================================== --- manual/src/main/webapp/users-guide/security.conf (revision 1141702) +++ manual/src/main/webapp/users-guide/security.conf (working copy) @@ -6,7 +6,7 @@ The default user name is {{karaf}} and the associated password is {{karaf}} too. We strongly encourage you to change the default password by editing the above file before moving Karaf into production. -The users are currenly used in three different places in Karaf: +The users are currently used in three different places in Karaf: * access to the SSH console * access to the JMX management layer * access to the Web console @@ -53,13 +53,13 @@ h2. Managing realms -More informations about modifying the default realm or deploying new realms is provided in the [developers guide|/developers-guide/security-framework]. +More information about modifying the default realm or deploying new realms is provided in the [developers guide|/developers-guide/security-framework]. h2. Deploying security providers Some applications require specific security providers to be available, such as [BouncyCastle|http://www.bouncycastle.org]. The JVM impose some restrictions about the use of such jars: they have to be signed and be available on the boot classpath. One way to deploy those providers is to put them in the JRE folder at {{$JAVA_HOME/jre/lib/ext}} and modify the security policy configuration ({{$JAVA_HOME/jre/lib/security/java.security}}) in order to register such providers. -While this approach works fine, it has a global effect and require you to configure all your servers accordingly. +While this approach works fine, it has a global effect and requires you to configure all your servers accordingly. Karaf offers a simple way to configure additional security providers: * put your provider jar in {{[karaf-install-dir]/lib/ext}} Index: manual/src/main/webapp/users-guide/failover.conf =================================================================== --- manual/src/main/webapp/users-guide/failover.conf (revision 1141702) +++ manual/src/main/webapp/users-guide/failover.conf (working copy) @@ -15,7 +15,7 @@ karaf.lock.delay=10 {noformat} -*Note*: Ensure that the {{karaf.lock.dir}} property points to the same directory for both the master and slave instance, so that the slave can only acquire the lock when the master releases it. +*Note*: Ensure that the {{karaf.lock.dir}} property points to the same directory for both the master and slave instance, so that the slave can acquire the lock only when the master releases it. h2. JDBC locking @@ -25,7 +25,7 @@ To use this feature, do the following on each system in the master/slave setup: * Update the classpath to include the JDBC driver -* Update the {{$KARAF_HOME/bin/karaf}} script to have unique JMX remote port set if instances reside on the same host +* Update the {{$KARAF_HOME/bin/karaf}} script to have a unique JMX remote port set if instances reside on the same host * Update the {{$KARAF_HOME/etc/system.properties}} file as follows: {noformat} @@ -44,14 +44,14 @@ *Note*: -* Will fail if JDBC driver is not on classpath. -* The database name "sample" will be created if it does not exist on the database. +* This process will fail if a JDBC driver is not on the classpath. +* The "sample" database referred to above will be created if it does not exist. * The first Karaf instance to acquire the locking table is the master instance. -* If the connection to the database is lost, the master instance tries to gracefully shutdown, allowing a slave instance to become master when the database service is restored. The former master will require manual restart. +* If the connection to the database is lost, the master instance tries to gracefully shutdown, allowing a slave instance to become master when the database service is restored. The former master will require a manual restart. h3. JDBC locking on Oracle -If you are using Oracle as your database in a JDBC locking scenario, the {{karaf.lock.class}} property in the {{$KARAF_HOME/etc/system.properties}} file must point to {{org.apache.karaf.main.OracleJDBCLock}}. +If you are using Oracle as your database for JDBC locking, the {{karaf.lock.class}} property in the {{$KARAF_HOME/etc/system.properties}} file must point to {{org.apache.karaf.main.OracleJDBCLock}}. Otherwise, configure the system.properties file as normal for your setup, for example: @@ -98,14 +98,14 @@ karaf.lock.delay=10 {noformat} -The {{karaf.log.level}} property tells the Karaf instance how far up the boot process to bring the OSGi container. Bundles assigned the same start level or lower will then also be started in that Karaf instance. +The {{karaf.lock.level}} property tells the Karaf instance how far into the boot process to bring the OSGi container. All bundles with an ID equal or lower to this start level will be started in that Karaf instance. -Bundle start levels are specified in {{$KARAF_HOME/etc/startup.properties}}, in the format {{jar.name=level}}. The core system bundles have levels below 50, where as user bundles have levels greater than 50. +Bundle start levels are specified in {{$KARAF_HOME/etc/startup.properties}}, in the format {{jar.name=level}}. The core system bundles have levels below 50, while user bundles have levels greater than 50. || Level || Behavior || | 1 | A 'cold' standby instance. Core bundles are not loaded into container. Slaves will wait until lock acquired to start server. | | <50 | A 'hot' standby instance. Core bundles are loaded into the container. Slaves will wait until lock acquired to start user level bundles. The console will be accessible for each slave instance at this level. | -| >50 | This setting is not recommended as user bundles will be started. | +| >50 | This setting is not recommended as user bundles will end up being started. | *Note*: When using a 'hot' spare on the same host you need to set the JMX remote port to a unique value to avoid bind conflicts. You can edit the Karaf start script to include the following: Index: manual/src/main/webapp/users-guide/kar.conf =================================================================== --- manual/src/main/webapp/users-guide/kar.conf (revision 1141702) +++ manual/src/main/webapp/users-guide/kar.conf (working copy) @@ -4,7 +4,7 @@ Karaf provides a specific archive format named the KAR (Karaf ARchive). -Basically, the kar format is a jar (so a zip file) which contains a set of features descriptor and bundles jar files. +Basically, the kar format is a jar (so a zip file) which contains a set of feature descriptors and bundle jar files. For instance, a kar looks like: * my-features-1.xml Index: manual/src/main/webapp/users-guide/web-console.conf =================================================================== --- manual/src/main/webapp/users-guide/web-console.conf (revision 1141702) +++ manual/src/main/webapp/users-guide/web-console.conf (working copy) @@ -28,7 +28,7 @@ h2. Changing the web console port number -By default, the console runs on port 8181. You can change the port number by creating the properties file, {{etc/org.ops4j.pax.web.cfg}}, and adding the following property setting (changing the port number to whatever value you want): +By default, the console runs on port 8181. You can change the port number by creating the properties file, {{etc/org.ops4j.pax.web.cfg}}, and adding the following property setting (changing the port number to whatever value desired): {code} org.osgi.service.http.port=8181 Index: manual/src/main/webapp/users-guide/start-stop.conf =================================================================== --- manual/src/main/webapp/users-guide/start-stop.conf (revision 1141702) +++ manual/src/main/webapp/users-guide/start-stop.conf (working copy) @@ -75,7 +75,7 @@ shutdown {code} -The shutdown command ask you to confirm that you really want to shutdown. If you are sure about the shutdown and avoid the confirmation message, you can use the -f or --force option: +The shutdown command asks you to confirm that you really want to shutdown. If you are sure about the shutdown wish to avoid the confirmation message, you can use the -f or --force option: {code} osgi:shutdown -f Index: manual/src/main/webapp/users-guide/wrapper.conf =================================================================== --- manual/src/main/webapp/users-guide/wrapper.conf (revision 1141702) +++ manual/src/main/webapp/users-guide/wrapper.conf (working copy) @@ -16,7 +16,7 @@ * Linux kernels 2.2.x, 2.4.x, 2.6.x. Known to work with Debian, Ubuntu, and Red Hat, but should work with any distribution. Currently supported on both 32-bit and 64-bit x86, Itanium, and PPC systems. * Macintosh OS X * Sun OS, Solaris 9 and 10. Currently supported on both 32-bit and 64-bit sparc, and x86 systems. -* Windows - Windows 2000, XP, 2003, Vista, 2008 and Windows 7. Currently supported on both 32-bit and 64-bit x86 and Itanium systems. Also known to run on Windows 98 and ME, however due the lack of support for services in the OS, the Wrapper can only be run in console mode. +* Windows - Windows 2000, XP, 2003, Vista, 2008 and Windows 7. Currently supported on both 32-bit and 64-bit x86 and Itanium systems. Also known to run on Windows 98 and ME, however due the lack of support for services in the OS, the Wrapper can be run only in console mode. h2. Installation @@ -73,7 +73,7 @@ Creating file: /home/onofreje/apache-karaf-2.1.3/lib/karaf-wrapper.jar Creating file: /home/onofreje/apache-karaf-2.1.3/lib/karaf-wrapper-main.jar -Setup complete. You may want to tweak the JVM properties in the wrapper configuration file: +Setup complete. You may wish to tweak the JVM properties in the wrapper configuration file: /home/onofreje/apache-karaf-2.1.3/etc/KARAF-wrapper.conf before installing and starting the service. Index: manual/src/main/webapp/users-guide/jre-tuning.conf =================================================================== --- manual/src/main/webapp/users-guide/jre-tuning.conf (revision 1141702) +++ manual/src/main/webapp/users-guide/jre-tuning.conf (working copy) @@ -6,14 +6,14 @@ Some examples of package in this case are: * {{javax.xml.stream}} package is provided by the JRE, but also by Apache Geronimo Spec bundles (and the implementation of provided by Woodstox). -* {{com.sun.org.apache.xerces.internal.dom}} package is provided by the JRE, but also by Aapche Xerces. +* {{com.sun.org.apache.xerces.internal.dom}} package is provided by the JRE, but also by Apache Xerces. * {{javax.activation}} package is provided by the JRE, but also by Apache Geronimo Spec bundles. * {{javax.annotation}} package is provided by the JRE, but also by Apache Geronimo Spec bundles. * etc ... -We should define in the Karaf instance which packages should be provided by the JRE or by tiers bundles. +We should define in the Karaf instance which packages should be provided by the JRE or by tier bundles. -Moreover, we should manage of the exported packages of JRE depending of the JRE version: the JRE 1.6 provides more packages +Moreover, we should manage the exported packages of JRE depending of the JRE version: the JRE 1.6 provides more packages than the 1.5 one. To customize this in Karaf, you can tune the {{etc/jre.properties}} file. Index: manual/src/main/webapp/users-guide/provisioning-schema.conf =================================================================== --- manual/src/main/webapp/users-guide/provisioning-schema.conf (revision 1141702) +++ manual/src/main/webapp/users-guide/provisioning-schema.conf (working copy) @@ -2,7 +2,7 @@ h1. XML Schema for provisioning -Following schema can be found in Karaf sources. It is also available public on url http://karaf.apache.org/xmlns/features/v1.0.0. +The following schema can be found in Karaf sources. It is also available publicly at http://karaf.apache.org/xmlns/features/v1.0.0. {snippet:url=../features/core/src/main/resources/org/apache/karaf/features/karaf-features-1.0.0.xsd|lang=xml|pygmentize=true} {snippet} Index: manual/src/main/webapp/users-guide/using-console.conf =================================================================== --- manual/src/main/webapp/users-guide/using-console.conf (revision 1141702) +++ manual/src/main/webapp/users-guide/using-console.conf (working copy) @@ -1,73 +1,73 @@ h1. Using the console -h2. Viewving available commands +h2. Viewing available commands To see a list of the available commands in the console press the {{}} key at the prompt. {code} -root@root> Display all 182 possibilities? (y or n) -*:help addurl admin:change-opts -admin:change-rmi-registry-port admin:change-ssh-port admin:connect -admin:create admin:destroy admin:list -admin:rename admin:start admin:stop -bundle-level cancel cat -change-opts change-rmi-registry-port change-ssh-port -clear commandlist config:cancel -config:edit config:list config:propappend -config:propdel config:proplist config:propset -config:update connect create -create-dump destroy dev:create-dump -dev:dynamic-import dev:framework dev:print-stack-traces -dev:restart dev:show-tree dev:watch -display display-exception dynamic-import -each echo edit -exec exports features:addurl -features:info features:install features:list -features:listrepositories features:listurl features:listversions -features:refreshurl features:removerepository features:removeurl -features:uninstall framework get -grep head headers -help history if -imports info install -jaas:cancel jaas:commandlist jaas:list -jaas:manage jaas:roleadd jaas:roledel -jaas:update jaas:useradd jaas:userdel -jaas:userlist java list -listrepositories listurl listversions -log:clear log:display log:display-exception -log:get log:set log:tail -logout ls manage -more new osgi:bundle-level -osgi:headers osgi:info osgi:install -osgi:list osgi:ls osgi:refresh -osgi:resolve osgi:restart osgi:shutdown -osgi:start osgi:start-level osgi:stop -osgi:uninstall osgi:update packages:exports -packages:imports print-stack-traces printf -propappend propdel proplist -propset refresh refreshurl -removerepository removeurl rename -resolve restart roleadd -roledel set shell:cat -shell:clear shell:each shell:echo -shell:exec shell:grep shell:head -shell:history shell:if shell:info -shell:java shell:logout shell:more -shell:new shell:printf shell:sleep -shell:sort shell:tac shell:tail -show-tree shutdown sleep -sort ssh ssh:ssh -ssh:sshd sshd start -start-level stop tac -tail uninstall update -useradd userdel userlist -watch -root@root> +karaf@root> Display all 186 possibilities? (y or n) +*:help activemq:browse activemq:bstat +activemq:create-broker activemq:destroy-broker activemq:list +activemq:purge activemq:query addurl +admin:change-opts admin:change-rmi-registry-port admin:change-rmi-server-port +admin:change-ssh-port admin:connect admin:create +admin:destroy admin:list admin:rename +admin:start admin:stop browse +bstat bundle-level cancel +cat change-opts change-rmi-registry-port +change-rmi-server-port change-ssh-port clear +commandlist connect create +create-broker create-dump destroy +destroy-broker dev:create-dump dev:dynamic-import +dev:framework dev:print-stack-traces dev:restart +dev:show-tree dev:watch display +display-exception dynamic-import each +echo exec exports +features:addurl features:info features:install +features:list features:listrepositories features:listurl +features:listversions features:refreshurl features:removerepository +features:removeurl features:uninstall framework +get grep head +headers help history +if imports info +install jaas:cancel jaas:commandlist +jaas:list jaas:manage jaas:roleadd +jaas:roledel jaas:update jaas:useradd +jaas:userdel jaas:userlist java +list listrepositories listurl +listversions log:clear log:display +log:display-exception log:get log:set +log:tail logout ls +manage more new +osgi:bundle-level osgi:headers osgi:info +osgi:install osgi:list osgi:ls +osgi:refresh osgi:resolve osgi:restart +osgi:shutdown osgi:start osgi:start-level +osgi:stop osgi:uninstall osgi:update +packages:exports packages:imports print-stack-traces +printf purge query +refresh refreshurl removerepository +removeurl rename resolve +restart roleadd roledel +set shell:cat shell:clear +shell:each shell:echo shell:exec +shell:grep shell:head shell:history +shell:if shell:info shell:java +shell:logout shell:more shell:new +shell:printf shell:sleep shell:sort +shell:source shell:tac shell:tail +show-tree shutdown sleep +sort source ssh +ssh:ssh ssh:sshd sshd +start start-level stop +tac tail uninstall +update useradd userdel +userlist watch web:list {code} -The {{}} key toggles completion anywhere on the line, so if you want to see the commands in the {{osgi}} group, type the first letters and hit {{}}. Depending on the commands, completion may be available on options and arguments too. +The {{}} key toggles autocompletion anywhere on the line, so if you want to see the commands in the {{osgi}} group, type the first letters and hit {{}}. Depending on the command, autocompletion may be available for options and arguments too. -h2. Getting help on a command +h2. Getting help for a command To view help on a particular command, type the command followed by {{--help}} or use the {{help}} command followed by the name of the command: @@ -93,7 +93,7 @@ The list of all available commands and their usage is also available in a [dedicated section|/commands/commands]. -You'll find a more in depth guide to the shell syntax in the [developers guide|/developers-guide/shell-syntax]. +You'll find a more in-depth guide to the shell syntax in the [developers guide|/developers-guide/shell-syntax]. The console can also be easily extended by creating new commands as explained in the [developers guide|/developers-guide/extending-console]. Index: manual/src/main/webapp/users-guide/provisioning.conf =================================================================== --- manual/src/main/webapp/users-guide/provisioning.conf (revision 1141702) +++ manual/src/main/webapp/users-guide/provisioning.conf (working copy) @@ -36,10 +36,10 @@ {code} {warning} -Be carefull when you define them as there is a risk of 'cycling' dependencies. +Be careful when you define them as there is a risk of 'cycling' dependencies. {warning} -Remark : By default, all the features defined in a repository are not installed at the launch of Apache Karaf (see section hereafter 'h2. Service configuration' for more info). +Remark: By default, all the features defined in a repository are not installed at the launch of Apache Karaf (see section hereafter 'h2. Service configuration' for more info). h3. Bundles @@ -49,7 +49,7 @@ {code} Doing this will make sure the above bundle is installed while installing the feature. -However, Karaf provides several URL handlers, in addition to the usual ones (file, http, etc...). One of these is the maven URL handler, which allow reusing maven repositories to point to the bundles. +However, Karaf provides several URL handlers, in addition to the usual ones (file, http, etc...). One of these is the Maven URL handler, which allow reusing Maven repositories to point to the bundles. h4. Maven URL Handler @@ -57,7 +57,7 @@ {code} mvn:org.apache.servicemix.nmr/org.apache.servicemix.nmr.api/1.0.0-m2 {code} -In addition to being less verbose, the maven url handlers can also resolve snapshots and can use a local copy of the jar if one is available in your maven local repository. +In addition to being less verbose, the Maven url handlers can also resolve snapshots and can use a local copy of the jar if one is available in your Maven local repository. The {{org.ops4j.pax.url.mvn}} bundle resolves {{mvn}} URLs. This flexible tool can be configured through the configuration service. For example, to find the current repositories type: @@ -91,13 +91,13 @@ karaf@root:/> config:update {code} -By default, snapshots are disable. To enable an URL for snapshots append @snapshots. For example +By default, snapshots are disabled. To enable an URL for snapshots append @snapshots. For example {code} http://www.example.org/repo@snapshots {code} -Repositories on the local are supported through {{file:/}} URLs +Repositories on the local machine are supported through {{file:/}} URLs h4. Bundle start-level @@ -115,13 +115,13 @@ {code} -The advantage to define the start-level of a bundle is that you can deploy all your bundles including those of the project with the 'infrastructure' bundles required (e.g : camel, activemq) -at the same time and you will have the guaranty when you use Spring Dynamic Module (to register service through OSGI service layer), Blueprint that by example +The advantage in defining the bundle start-level is that you can deploy all your bundles including any required 'infrastructure' bundles (e.g Camel, ActiveMQ) +at the same time and you will have the guarantee when using Spring Dynamic Modules or Blueprint that the Spring context will not be created without all the required services installed. h4. Bundle 'stop/start' -The OSGI specification allows to install a bundle without starting it. To use this functionality, simply add the following attribute in your definition +The OSGI specification allows for installing a bundle without starting it. To use this functionality, simply add the following attribute in your definition {code:xml} @@ -134,7 +134,7 @@ h4. Bundle 'dependency' -A bundle can be flagged as being a dependency. Such information can be used by resolvers to compute the final list of bundles to be installed. +A bundle can be flagged as being a dependency. Such information can be used by resolvers to compute the full list of bundles to be installed. h3. Dependent features @@ -146,7 +146,7 @@ {code} -The effect of such a dependency is to automatically install the required {{nmr}} feature when the {{jbi}} feature will be installed. +The effect of such a dependency is to automatically install the required {{nmr}} feature when the {{jbi}} feature is installed. A version range can be specified on the feature dependency: {code:lang=xml} @@ -155,11 +155,11 @@ ... {code} -In such a case, if no matching feature is already installed, the feature with the highest version available in the range will be installed. If a single version is specified, this version will be choosen. If nothing is specified, the highest available will be instaleld. +In such a case, if no matching feature is already installed, the feature with the highest version available in the range will be installed. If a single version is specified, this version will be chosen. If nothing is specified, the highest available will be installed. h3. Configurations -The configuration section allows to deploy configuration for the OSGi Configuration Admin service along a set of bundles. +The configuration section allows for declaring deployment configuration of the OSGi Configuration Admin service along a set of bundles. Here is an example of such a configuration: {code:lang=xml} @@ -170,7 +170,7 @@ The {{name}} attribute of the {{configuration}} element will be used as the ManagedService PID for the configuration set in the Configuration Admin service. When using a ManagedServiceFactory, the {{name}} attribute is _servicePid_-_aliasId_, where _servicePid_ is the PID of the ManagedServiceFactory and _aliasId_ is a label used to uniquely identify a particular service (an alias to the factory generated service PID). -Deploying such a configuration has the same effect than dropping a file named {{com.foo.bar.cfg}} into the {{etc}} folder. +Deploying such a configuration has the same effect as dropping a file named {{com.foo.bar.cfg}} into the {{etc}} folder. The content of the {{configuration}} element is set of properties parsed using the [standard java property mechanism|http://java.sun.com/j2se/1.5.0/docs/api/java/util/Properties.html#load(java.io.InputStream)]. @@ -206,13 +206,13 @@ In this example, we are using SpringDM with osgi as the primary namespace. Instead of using ctx:context-placeholder we are using the "PropertyPlaceholderConfig" class. Then we are passing in a beans array and inside of that array is where we set our osgix:cm-properties elements. This element "returns" a properties bean. -For more informations about using the Configuration Admin service in Spring-DM, see the [Spring-DM documentation|http://static.springframework.org/osgi/docs/1.2.0-m2/reference/html/compendium.html#compendium:cm:props]. +For more information about using the Configuration Admin service in Spring-DM, see the [Spring-DM documentation|http://static.springframework.org/osgi/docs/1.2.0-m2/reference/html/compendium.html#compendium:cm:props]. h3. Configuration files *Available since Karaf 2.2* -In certain cases it is needed not only to provide configurations for the configuration admin service but to add additional configuration files e.g. a configuration file for jetty (jetty.xml). It even might be help full to deploy a configuration file instead of a configuration for the config admin service since. To achieve this the attribute {{finalname}} shows the final destination of the {{configfile}}, while the value references the maven artifact to deploy. +In certain cases it is needed not only to provide configurations for the configuration admin service but to add additional configuration files e.g. a configuration file for Jetty (jetty.xml). It even might be helpful to deploy a configuration file instead of a configuration for the config admin service. To achieve this the attribute {{finalname}} shows the final destination of the {{configfile}}, while the value references the Maven artifact to deploy. {code} mvn:org.apache.karaf/apache-karaf/${project.version}/xml/jettyconfig @@ -223,7 +223,7 @@ The resolver attribute on a feature can be set to force the use of a given resolver instead of the default resolution process. A resolver will be use to obtain the list of bundles to actually install for a given feature. The default resolver will simply return the list of bundles provided in the feature description. -The obr resolver can be installed and used instead of the standard one. In that case, the resolver will use the OBR service to determine the list of bundles to install (bundles flagged as dependency will only be used as possible candidates to solve various constraints). +The OBR resolver can be installed and used instead of the standard one. In that case, the resolver will use the OBR service to determine the list of bundles to install (bundles flagged as dependency will only be used as possible candidates to solve various constraints). h2. Commands @@ -240,7 +240,7 @@ Karaf maintains a persistent list of these repositories so that if you add one URL and restart Karaf, the features will still be available. -The {{refreshUrl}} command is mostly used when developing features descriptors: when changing the descriptor, it can be handy to reload it in the Kernel without having to restart it or to remove then add again this URL. +The {{refreshUrl}} command is mostly used when developing features descriptors: when changing the descriptor, it can be handy to reload it in the Kernel without having to restart it or to remove then add the URL again. h3. Features management @@ -263,12 +263,12 @@ features:addUrl file:base/features/features.xml {code} -Remark : The path is relative to the Apache Karaf installation directory +Note: The path is relative to the Apache Karaf installation directory -3. Deploy bundles from file system without using maven +3. Deploy bundles from file system without using Maven As we can use file:// as protocol handler to deploy bundles, you can use the following syntax to deploy bundles when they are -located in a directory which is not available using maven +located in a directory which is not available using Maven {code:xml} @@ -278,7 +278,7 @@ {code} -Remark : The path is relative to the Apache Karaf installation directory +Note: The path is relative to the Apache Karaf installation directory h2. Service configuration @@ -287,6 +287,6 @@ * {{featuresBoot}}: a comma separated list of features to install at startup * {{featuresRepositories}}: a comma separated list of feature repositories to load at startup -This configuration file is of interest if you plan to distribute Apache Karaf distribution which includes pre-installed features. Such a process is detailed in the [6.2. Building custom distributions] section. +This configuration file is of interest if you plan to distribute a customized Karaf distribution having pre-installed features. Such a process is detailed in the [6.2. Building custom distributions] section.