http://git-wip-us.apache.org/repos/asf/karaf/blob/3de05ae9/manual/src/main/webapp/quick-start.conf ---------------------------------------------------------------------- diff --git a/manual/src/main/webapp/quick-start.conf b/manual/src/main/webapp/quick-start.conf deleted file mode 100644 index fa3c462..0000000 --- a/manual/src/main/webapp/quick-start.conf +++ /dev/null @@ -1,162 +0,0 @@ -h1. Quick Start - -These instructions should help you get Apache Karaf up and running in 5 to 15 minutes. - -h2. Prerequisites - -Karaf requires a Java SE 7 or Java SE 8 environment to run. Refer to [http://www.oracle.com/technetwork/java/javase/] for details on how to download and install Java SE 1.7 or greater. - -* Open a Web browser and access the following URL: [http://karaf.apache.org/index/community/download.html] -* Download the binary distribution that matches your system (zip for windows, tar.gz for unixes) -* Extract the archive to a new folder on your hard drive; for example in c:\karaf - from now on this directory will be referenced as <KARAF_HOME>. - -h2. Start the server - -Open a command line console and change the directory to <KARAF_HOME>. - -To start the server, run the following command in Windows: -{code} -bin\karaf.bat -{code} -respectively on Unix: -{code} -bin/karaf -{code} -You should see the following information on the command line console: - -{code} - __ __ ____ - / //_/____ __________ _/ __/ - / ,< / __ `/ ___/ __ `/ /_ - / /| |/ /_/ / / / /_/ / __/ - /_/ |_|\__,_/_/ \__,_/_/ - - Apache Karaf (4.0.0) - -Hit '<tab>' for a list of available commands -and '[cmd] --help' for help on a specific command. -Hit '<ctrl-d>' or type 'system:shutdown' or 'logout' to shutdown Karaf. - -karaf@root()> - -{code} - -h2. Some shell Basics - -You can now run your first command. Simply type the {{<tab>}} key in the console. -{code:borderStyle=solid} -karaf@root()> Display all 294 possibilities? (y or n) -... -shell:logout shell:more shell:new shell:printf shell:sleep shell:sort shell:source -shell:stack-traces-print shell:tac shell:tail shell:threads shell:watch shell:wc shell:while -shutdown sleep sort source ssh ssh ssh-host-change -ssh-port-change ssh:ssh stack-traces-print start start-level status stop -su sudo system system:framework system:name system:property system:shutdown -system:start-level system:version tac tail threads tree-show uninstall -update user-add user-delete user-list version version-list wait -watch wc while -{code} - -You can then grab more specific help for a given command using the {{--help}} option for this command: - -{code:borderStyle=solid} -karaf@root()> bundle:list --help -DESCRIPTION - bundle:list - - Lists all installed bundles. - -SYNTAX - bundle:list [options] [ids] - -ARGUMENTS - ids - The list of bundle (identified by IDs or name or name/version) separated by whitespaces - -OPTIONS - -t - Specifies the bundle threshold; bundles with a start-level less than this value will not get printed out. - --no-format - Disable table rendered output - -s - Shows the symbolic name - -l - Show the locations - --no-ellipsis - - --help - Display this help message - -u - Shows the update locations - --context, -c - Use the given bundle context - (defaults to 0) - -r - Shows the bundle revisions -{code} - -Note that the console supports tab completion so if you start typing a command it will show all possible completions and also auto complete if there is only one completion. - -h2. Deploy a sample application - -While you will learn in the Karaf user's guide how to fully use and leverage Apache Karaf, let's install a sample [Apache Camel|http://camel.apache.org] application for now: - -In the console, run the following commands: -{code} -karaf@root()> feature:repo-add camel 2.15.2 -Adding feature url mvn:org.apache.camel.karaf/apache-camel/2.15.2/xml/features -karaf@root()> feature:install camel-spring -karaf@root()> bundle:install -s mvn:org.apache.camel/camel-example-osgi/2.15.2 -Bundle ID: 82 -{code} - -The example installed is using Camel to start a timer every 2 seconds and output a message in the log. -The previous commands download the Camel features descriptor and install the example feature. - -You can display the log in the shell: - -{code} -karaf@root()> log:display -... -2015-06-30 13:39:44,731 | INFO | timer://myTimer | ExampleRouter | 53 - org.apache.camel.camel-core - 2.15.2 | Exchange[ExchangePattern: InOnly, BodyType: String, Body: SpringDSL set body: Tue Jun 30 13:39:44 CEST 2015] -2015-06-30 13:39:46,730 | INFO | timer://myTimer | MyTransform | 82 - camel-example-osgi - 2.15.2 | >>>> SpringDSL set body: Tue Jun 30 13:39:46 CEST 2015 -2015-06-30 13:39:46,731 | INFO | timer://myTimer | ExampleRouter | 53 - org.apache.camel.camel-core - 2.15.2 | Exchange[ExchangePattern: InOnly, BodyType: String, Body: SpringDSL set body: Tue Jun 30 13:39:46 CEST 2015] -2015-06-30 13:39:48,730 | INFO | timer://myTimer | MyTransform | 82 - camel-example-osgi - 2.15.2 | >>>> SpringDSL set body: Tue Jun 30 13:39:48 CEST 2015 -2015-06-30 13:39:48,730 | INFO | timer://myTimer | ExampleRouter | 53 - org.apache.camel.camel-core - 2.15.2 | Exchange[ExchangePattern: InOnly, BodyType: String, Body: SpringDSL set body: Tue Jun 30 13:39:48 CEST 2015] -{code} - -h3. Stopping and uninstalling the sample application - -To stop and uninstall the demo, run the following command: - -{code} -karaf@root()> bundle:stop camel-example-osgi -karaf@root()> bundle:uninstall camel-example-osgi -{code} - -h2. Stopping Karaf - -To stop Karaf from the console, enter {{^D}} in the console: -{code} -^D -{code} - -Alternatively, you can also run the following command: - -{code} -karaf@root()> system:shutdown -{code} - -halt is also an alias for system:shutdown: - -{code} -karaf@root()> halt -{code} - -h3. Cleaning the Karaf state - -Normally Karaf remembers the features and bundles you installed and started. To reset Karaf into a clean state, just delete the data directory when Karaf is not running. - -h2. Summary - -This document shows how simple it is to get Apache Karaf up and running and install a simple Apache Camel application.
http://git-wip-us.apache.org/repos/asf/karaf/blob/3de05ae9/manual/src/main/webapp/update-notes.conf ---------------------------------------------------------------------- diff --git a/manual/src/main/webapp/update-notes.conf b/manual/src/main/webapp/update-notes.conf deleted file mode 100644 index 9847f2d..0000000 --- a/manual/src/main/webapp/update-notes.conf +++ /dev/null @@ -1,126 +0,0 @@ -h1. Update Notes (from 3.x to 4.x) - -This section is dedicated to users of previous Apache Karaf version. - -NB: for the users upgrading from Karaf 2.x, please see the "Update Notes (from 2.x to 3.x)" in the Karaf 3.x -documentation first. - -NB: Karaf 4.x supports Java8. - -h2. Distributions - -Apache Karaf 4.x is available as tar.gz and zip archives. The content is the same and works on either Unix or Windows -platforms. -The {{bin}} folder contains both sh and bat scripts. - -h2. Commands - -Karaf 4 commands are close to the ones provided in Karaf 3. - -The sub-shell modes are the same (in {{etc/org.apache.karaf.shell.cfg}} or using {{shell:completion}} command). - -However, some minor changes have been introduced and new commands available: - -|| Apache Karaf 4.x || -| feature:requirement-list | -| feature:requirement-add | -| feature:requirement-remove | -| feature:regions | -| feature:start | -| feature:stop | -| jaas:group-create | -| jaas:group-add | -| jaas:group-delete | -| jaas:group-list | -| jaas:group-role-add | -| jaas:group-role-delete | -| jaas:su | -| jaas:sudo | -| shell:edit | -| shell:env | -| shell:less | -| shell:stack-traces-print | -| shell:threads | -| shell:while | -| log:list | -| bundle:capabilities | -| bundle:diag | -| bundle:id | -| bundle:load-test | -| bundle:requirements | -| bundle:resolve | -| system:name | - -We encourage the users to use the {{--help}} option to check the name and type of arguments and options. - -In term of development, you can still use the blueprint definition as you do in Karaf 2.x & 3.x (with the corresponding annotations). - -However, in Karaf 4.x, you can use DS and new annotations and avoid the usage of a blueprint XML. - -The new annotations are available: @Service, @Completion, @Parsing, @Reference. It allows you to complete define the command -in the command class directly. - -To simplify the generation of the code and OSGi headers, Karaf 4.x provides the karaf-services-maven-plugin (in org.apache.karaf.tooling Maven groupId). - -Take a look in the developer guide for the command development "new style" details. - -h2. Features repositories - -Karaf 4.x provides: - -* {{mvn:org.apache.karaf.features/enterprise/4.0.x/xml/features}} -* {{mvn:org.apache.karaf.features/framework/4.0.x/xml/features}} -* {{mvn:org.apache.karaf.features/spring/4.0.x/xml/features}} -* {{mvn:org.apache.karaf.features/standard/4.0.x/xml/features}} -* {{mvn:org.apache.karaf.features/static/4.0.x/xml/features}} - -h2. Features resolver - -Apache Karaf 4.x brings a complete new feature resolver. The purpose is to simplify the features installation and -lifecycle. -The new resolver now checks the feature requirements (defined directly in the features XML), and check which bundles -provides the capabilities to satisfy these requirements. -It allows Karaf to automatically install bundles required by features. - -For "old style" feature (features XML using namespace from Karaf 2.x or 3.x), this feature is not enabled. -As soon as you use a "new style" feature (with namespace 1.3.0 used by Karaf 4.x), this feature is enabled. - -h2. Namespaces - -Apache Karaf 4.x brings updated version of the namespaces: - -* Supported features namespaces: -** {{karaf-features-1.0.0.xsd}} -** {{karaf-features-1.1.0.xsd}} -** {{karaf-features-1.2.0.xsd}} -** {{karaf-features-1.2.1.xsd}} -** {{karaf-features-1.3.0.xsd}} -* Supported jaas namespaces: -** {{karaf-jaas-1.0.0.xsd}} -** {{karaf-jaas-1.1.0.xsd}} -* Supported shell namespaces: -** {{karaf-shell-1.0.0.xsd}} -** {{karaf-shell-1.1.0.xsd}} - -h2. Maven plugin - -A cleanup of the goals provided by {{karaf-maven-plugin}} has been done. - -Now the provided goals are: - -* {{karaf:archive}} to create a tar.gz or zip of a Karaf distribution -* {{karaf:assembly}} to create a custom Karaf distribution assembly -* {{karaf:kar}} to create a kar file -* {{karaf:verify}} to verify and validate Karaf features -* {{karaf:features-add-to-repository}} to recursively copy features XML and content into a folder (repository) -* {{karaf:features-export-meta-data}} to extract the metadata from a features XML -* {{karaf:features-generate-descriptor}} to generate a features XML -* {{karaf:commands-generate-help}} to generate help/documentation on the commands - -h2. Update guide - -We encourage users to start a fresh Apache Karaf 4.x container. - -If you upgrade an existing container, {{lib}} and {{system}} folder have to be updated (just an override copy). - -For the {{etc}} folder, a diff is required as some properties changed and new configurations are available. http://git-wip-us.apache.org/repos/asf/karaf/blob/3de05ae9/manual/src/main/webapp/users-guide/cdi.conf ---------------------------------------------------------------------- diff --git a/manual/src/main/webapp/users-guide/cdi.conf b/manual/src/main/webapp/users-guide/cdi.conf deleted file mode 100644 index be474a4..0000000 --- a/manual/src/main/webapp/users-guide/cdi.conf +++ /dev/null @@ -1,61 +0,0 @@ -h1. CDI - -This section described how to add support of CDI, and embed a CDI container in Apache Karaf. It doesn't describe -how to develop CDI applications. See the developer guide for that. - -h2. Pax CDI - -Apache Karaf supports different CDI containers by using Pax CDI. - -Pax CDI is pre-loaded in Apache Karaf. - -You can see now a set of new CDI features available: - -{code} -karaf@root()> feature:list|grep -i cdi -pax-cdi | 0.12.0 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Provide CDI support -pax-cdi-1.1 | 0.12.0 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Provide CDI 1.1 support -pax-cdi-1.2 | 0.12.0 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Provide CDI 1.2 support -pax-cdi-weld | 0.12.0 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Weld CDI support -pax-cdi-1.1-weld | 0.12.0 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Weld CDI 1.1 support -pax-cdi-1.2-weld | 0.12.0 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Weld CDI 1.2 support -pax-cdi-openwebbeans | 0.12.0 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | OpenWebBeans CDI support -pax-cdi-web | 0.12.0 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Web CDI support -pax-cdi-1.1-web | 0.12.0 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Web CDI 1.1 support -pax-cdi-1.2-web | 0.12.0 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Web CDI 1.2 support -pax-cdi-web-weld | 0.12.0 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Weld Web CDI support -pax-cdi-1.1-web-weld | 0.12.0 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Weld Web CDI 1.1 support -pax-cdi-1.2-web-weld | 0.12.0 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Weld Web CDI 1.2 support -pax-cdi-web-openwebbeans | 0.12.0 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | OpenWebBeans Web CDI support -deltaspike-core | 1.2.1 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Apache Deltaspike core support -deltaspike-jpa | 1.2.1 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Apache Deltaspike jpa support -deltaspike-partial-bean | 1.2.1 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Apache Deltaspike partial bean support -deltaspike-data | 1.2.1 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Apache Deltaspike data support -{code} - -h2. CDI Containers - -Thanks to Pax CDI, Apache Karaf supports multiple CDI implementation versions, and different CDI containers. - -You just have to install the feature corresponding to the CDI container and version that you want to use. - -h3. Apache OpenWebBeans - -Apache Karaf provides a ready to use feature for Apache OpenWebBeans. - -The {{openwebbeans}} feature automatically install the Pax CDI features and the Apache OpenWebBeans bundles: - -{code} -karaf@root()> feature:install http -karaf@root()> feature:install pax-cdi-openwebbeans -{code} - -h3. JBoss Weld CDI container - -Apache Karaf provides a ready to use feature for JBoss Weld. - -The {{weld}} feature automatically install the Pax CDI features and the JBoss Weld bundles: - -{code} -karaf@root()> feature:install pax-cdi-weld -{code} http://git-wip-us.apache.org/repos/asf/karaf/blob/3de05ae9/manual/src/main/webapp/users-guide/configuration.conf ---------------------------------------------------------------------- diff --git a/manual/src/main/webapp/users-guide/configuration.conf b/manual/src/main/webapp/users-guide/configuration.conf deleted file mode 100644 index e5f312e..0000000 --- a/manual/src/main/webapp/users-guide/configuration.conf +++ /dev/null @@ -1,368 +0,0 @@ -h1. Configuration - -h2. Files - -Apache Karaf stores and loads all configuration in files located in the {{etc}} folder. - -By default, the {{etc}} folder is located relatively to the {{KARAF_BASE}} folder. You can define another location -using the {{KARAF_ETC}} variable. - -Each configuration is identified by a ID (the ConfigAdmin PID). The configuration files name follows the {{pid.cfg}} -name convention. - -For instance, {{etc/org.apache.karaf.shell.cfg}} means that this file is the file used by the configuration with -{{org.apache.karaf.shell}} as PID. - -A configuration file is a properties file containing key/value pairs: - -{code} -property=value -{code} - -In Apache Karaf, a configuration is PID with a set of properties attached. - -Apache Karaf automatically loads all {{*.cfg}} files from the {{etc}} folder. - -You can configure the behaviour of the configuration files using some dedicated properties in the -{{etc/config.properties}} configuration file: - -{code} -... -# -# Configuration FileMonitor properties -# -felix.fileinstall.enableConfigSave = true -felix.fileinstall.dir = ${karaf.etc} -felix.fileinstall.filter = .*\\.cfg -felix.fileinstall.poll = 1000 -felix.fileinstall.noInitialDelay = true -felix.fileinstall.log.level = 3 -felix.fileinstall.log.default = jul -... -{code} - -* {{felix.fileinstall.enableConfigSave}} flush back in the configuration file the changes performed directly on the -configuration service (ConfigAdmin). If {{true}}, any change (using {{config:*}} commands, MBeans, OSGi service) is -persisted back in the configuration false. Default is {{true}}. -* {{felix.fileinstall.dir}} is the directory where Apache Karaf is looking for configuration files. Default is {{${karaf.etc}}} -meaning the value of the {{KARAF_ETC}} variable. -* {{felix.fileinstall.filter}} is the file name pattern used to load only some configuration files. Only files matching -the pattern will be loaded. Default value is {{.*\\.cfg}} meaning *.cfg files. -* {{felix.fileinstall.poll}} is the polling interval (in milliseconds). Default value is {{1000}} meaning that Apache -Karaf "re-loads" the configuration files every second. -* {{felix.fileinstall.noInitialDelay}} is a flag indicating if the configuration file polling starts as soon as Apache -Karaf starts or wait for a certain time. If {{true}}, Apache Karaf polls the configuration files as soon as the configuration -service starts. -* {{felix.fileinstall.log.level}} is the log message verbosity level of the configuration polling service. More -this value is high, more verbose the configuration service is. -* {{felix.fileinstall.log.default}} is the logging framework to use, {{jul}} meaning Java Util Logging. - -You can change the configuration at runtime by directly editiing the configuration file. - -You can also do the same using the {{config:*}} commands or the ConfigMBean. - -h2. {{config:*}} commands - -Apache Karaf provides a set of commands to manage the configuration. - -h3. {{config:list}} - -{{config:list}} displays the list of all configurations available, or the properties in a given configuration (PID). - -Without the {{query}} argument, the {{config:list}} command display all configurations, with PID, attached bundle and -properties defined in the configuration: - -{code} -karaf@root()> config:list ----------------------------------------------------------------- -Pid: org.apache.karaf.service.acl.command.system.start-level -BundleLocation: mvn:org.apache.karaf.shell/org.apache.karaf.shell.console/4.0.0 -Properties: - service.guard = (&(osgi.command.scope=system)(osgi.command.function=start-level)) - * = * - start-level = admin # admin can set any start level, including < 100 - start-level[/[^0-9]*/] = viewer # viewer can obtain the current start level - execute[/.*/,/[^0-9]*/] = viewer # viewer can obtain the current start level - execute = admin # admin can set any start level, including < 100 - service.pid = org.apache.karaf.service.acl.command.system.start-level - start-level[/.*[0-9][0-9][0-9]+.*/] = manager # manager can set startlevels above 100 - execute[/.*/,/.*[0-9][0-9][0-9]+.*/] = manager # manager can set startlevels above 100 ----------------------------------------------------------------- -Pid: org.apache.karaf.log -BundleLocation: mvn:org.apache.karaf.log/org.apache.karaf.log.core/4.0.0 -Properties: - service.pid = org.apache.karaf.log - size = 500 - pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n - felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg -... -{code} - -The {{query}} argument accepts a query using a LDAP syntax. - -For instance, you can display details on one specific configuration using the following filter: - -{code} -karaf@root()> config:list "(service.pid=org.apache.karaf.log)" ----------------------------------------------------------------- -Pid: org.apache.karaf.log -BundleLocation: mvn:org.apache.karaf.log/org.apache.karaf.log.core/4.0.0 -Properties: - felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg - pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n - service.pid = org.apache.karaf.log - size = 500 -{code} - -h3. {{config:edit}} - -{{config:edit}} is the first command to do when you want to change a configuration. {{config:edit}} command put you -in edition mode for a given configuration. - -For instance, you can edit the {{org.apache.karaf.log}} configuration: - -{code} -karaf@root()> config:edit org.apache.karaf.log -{code} - -The {{config:edit}} command doesn't display anything, it just puts you in configuration edit mode. You are now ready -to use other config commands (like {{config:property-append}}, {{config:property-delete}}, {{config:property-set}}, ...). - -If you provide a configuration PID that doesn't exist yet, Apache Karaf will create a new configuration (and so a new -configuration file) automatically. - -All changes that you do in configuration edit mode are store in your console session: the changes are not directly -applied in the configuration. It allows you to "commit" the changes (see {{config:update}} command) or "rollback" and -cancel your changes (see {{config:cancel}} command). - -h3. {{config:property-list}} - -The {{config:property-list}} lists the properties for the currently edited configuration. - -Assuming that you edited the {{org.apache.karaf.log}} configuration, you can do: - -{code} -karaf@root()> config:property-list - felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg - pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n - service.pid = org.apache.karaf.log - size = 500 -{code} - -h3. {{config:property-set}} - -The {{config:property-set}} command update the value of a given property in the currently edited configuration. - -For instance, to change the value of the {{size}} property of previously edited {{org.apache.karaf.log}} configuration, -you can do: - -{code} -karaf@root()> config:property-set size 1000 -karaf@root()> config:property-list - felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg - pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n - service.pid = org.apache.karaf.log - size = 1000 -{code} - -If the property doesn't exist, the {{config:property-set}} command creates the property. - -You can use {{config:property-set}} command outside the configuration edit mode, by specifying the {{-p}} (for configuration pid) option: - -{code} -karaf@root()> config:property-set -p org.apache.karaf.log size 1000 -karaf@root()> config:list "(service.pid=org.apache.karaf.log)" ----------------------------------------------------------------- -Pid: org.apache.karaf.log -BundleLocation: mvn:org.apache.karaf.log/org.apache.karaf.log.core/4.0.0 -Properties: - service.pid = org.apache.karaf.log - size = 1000 - pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n - felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg -{code} - -{warning} -Using the {{pid}} option, you bypass the configuration commit and rollback mechanism. -{warning} - -h3. {{config:property-append}} - -The {{config:property-append}} is similar to {{config:property-set}} command, but instead of completely replacing the -property value, it appends a string at the end of the property value. - -For instance, to add 1 at the end of the value of the {{size}} property in {{org.apache.karaf.log}} configuration -(and so have 5001 for the value instead of 500), you can do: - -{code} -karaf@root()> config:property-append size 1 -karaf@root()> config:property-list - service.pid = org.apache.karaf.log - size = 5001 - pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n - felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg -{code} - -Like the {{config:property-set}} command, if the property doesn't exist, the {{config:property-set}} command creates -the property. - -You can use the {{config:property-append}} command outside the configuration edit mode, by specifying the {{-p}} (for configuration pid) option: - -{code} -karaf@root()> config:property-append -p org.apache.karaf.log size 1 -karaf@root()> config:list "(service.pid=org.apache.karaf.log)" ----------------------------------------------------------------- -Pid: org.apache.karaf.log -BundleLocation: mvn:org.apache.karaf.log/org.apache.karaf.log.core/4.0.0 -Properties: - service.pid = org.apache.karaf.log - size = 5001 - pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n - felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg -{code} - -{warning} -Using the {{pid}} option, you bypass the configuration commit and rollback mechanism. -{warning} - -h3. {{config:property-delete}} - -The {{config:property-delete}} command delete a property in the currently edited configuration. - -For instance, you previously added a {{test}} property in {{org.apache.karaf.log}} configuration. To delete this {{test}} -property, you do: - -{code} -karaf@root()> config:property-set test test -karaf@root()> config:property-list - service.pid = org.apache.karaf.log - size = 500 - pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n - felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg - test = test -karaf@root()> config:property-delete test -karaf@root()> config:property-list - service.pid = org.apache.karaf.log - size = 500 - pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n - felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg -{code} - -You can use the {{config:property-delete}} command outside the configuration edit mode, by specifying the {{-p}} (for configuration pid) option: - -{code} -karaf@root()> config:property-delete -p org.apache.karaf.log test -{code} - -h3. {{config:update}} and {{config:cancel}} - -When you are in the configuration edit mode, all changes that you do using {{config:property*}} commands are stored in "memory" -(actually in the console session). - -Thanks to that, you can "commit" your changes using the {{config:update}} command. The {{config:update}} command will -commit your changes, update the configuration, and (if possible) update the configuration files. - -For instance, after changing {{org.apache.karaf.log}} configuration with some {{config:property*}} commands, you have -to commit your change like this: - -{code} -karaf@root()> config:edit org.apache.karaf.log -karaf@root()> config:property-set test test -karaf@root()> config:update -karaf@root()> config:list "(service.pid=org.apache.karaf.log)" ----------------------------------------------------------------- -Pid: org.apache.karaf.log -BundleLocation: mvn:org.apache.karaf.log/org.apache.karaf.log.core/4.0.0 -Properties: - service.pid = org.apache.karaf.log - size = 500 - pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n - felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg - test = test -{code} - -On the other hand, if you want to "rollback" your changes, you can use the {{config:cancel}} command. It will cancel all -changes that you did, and return of the configuration state just before the {{config:edit}} command. The {{config:cancel}} -exits from the edit mode. - -For instance, you added the test property in the {{org.apache.karaf.log}} configuration, but it was a mistake: - -{code} -karaf@root()> config:edit org.apache.karaf.log -karaf@root()> config:property-set test test -karaf@root()> config:cancel -karaf@root()> config:list "(service.pid=org.apache.karaf.log)" ----------------------------------------------------------------- -Pid: org.apache.karaf.log -BundleLocation: mvn:org.apache.karaf.log/org.apache.karaf.log.core/4.0.0 -Properties: - service.pid = org.apache.karaf.log - size = 500 - pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n - felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg -{code} - -h3. {{config:delete}} - -The {{config:delete}} command completely delete an existing configuration. You don't have to be in edit mode to delete -a configuration. - -For instance, you added {{my.config}} configuration: - -{code} -karaf@root()> config:edit my.config -karaf@root()> config:property-set test test -karaf@root()> config:update -karaf@root()> config:list "(service.pid=my.config)" ----------------------------------------------------------------- -Pid: my.config -BundleLocation: null -Properties: - service.pid = my.config - test = test -{code} - -You can delete the {{my.config}} configuration (including all properties in the configuration) using the {{config:delete}} -command: - -{code} -karaf@root()> config:delete my.config -karaf@root()> config:list "(service.pid=my.config)" -karaf@root()> -{code} - -h3. {{config:meta}} - -The {{config:meta}} command lists the meta type information related to a given configuration. - -It allows you to get details about the configuration properties: key, name, type, default value, and description: - -{code} -karaf@root()> config:meta -p org.apache.karaf.log -Meta type informations for pid: org.apache.karaf.log -key | name | type | default | description ---------------------------------------------------------------------------------------------------------------------------------------- -size | Size | int | 500 | size of the log to keep in memory -pattern | Pattern | String | %d{ABSOLUTE} | %-5.5p | %-16.16t | %-32.32c{1} | %-32.32C %4L | %m%n | Pattern used to display log entries -{code} - -h2. JMX ConfigMBean - -On the JMX layer, you have a MBean dedicated to the management of the configurations: the ConfigMBean. - -The ConfigMBean object name is: {{org.apache.karaf:type=config,name=*}}. - -h3. Attributes - -The {{Configs}} attribute is a list of all configuration PIDs. - -h3. Operations - -* {{listProperties(pid)}} returns the list of properties (property=value formatted) for the configuration {{pid}}. -* {{deleteProperty(pid, property)}} deletes the {{property}} from the configuration {{pid}}. -* {{appendProperty(pid, property, value)}} appends {{value}} at the end of the value of the {{property}} of the configuration {{pid}}. -* {{setProperty(pid, property, value)}} sets {{value}} for the value of the {{property}} of the configuration {{pid}}. -* {{delete(pid)}} deletes the configuration identified by the {{pid}}. -* {{create(pid)}} creates an empty (without any property) configuration with {{pid}}. -* {{update(pid, properties)}} updates a configuration identified with {{pid}} with the provided {{properties}} map. - http://git-wip-us.apache.org/repos/asf/karaf/blob/3de05ae9/manual/src/main/webapp/users-guide/console.conf ---------------------------------------------------------------------- diff --git a/manual/src/main/webapp/users-guide/console.conf b/manual/src/main/webapp/users-guide/console.conf deleted file mode 100644 index e508793..0000000 --- a/manual/src/main/webapp/users-guide/console.conf +++ /dev/null @@ -1,443 +0,0 @@ -h1. Using the console - -h2. Available commands - -To see a list of the available commands in the console, you can use the {{help}}: - -{code} -karaf@root()> help -bundle Enter the subshell -bundle:capabilities Displays OSGi capabilities of a given bundles. -bundle:classes Displays a list of classes/resources contained in the bundle -bundle:diag Displays diagnostic information why a bundle is not Active -bundle:dynamic-import Enables/disables dynamic-import for a given bundle. -bundle:find-class Locates a specified class in any deployed bundle -bundle:headers Displays OSGi headers of a given bundles. -bundle:id Gets the bundle ID. -... -{code} - -You have the list of all commands with a short description. - -You can use the tab key to get a quick list of all commands: - -{code} -karaf@root()> Display all 294 possibilities? (y or n) -... -{code} - -h2. Subshell and completion mode - -The commands have a scope and a name. For instance, the command {{feature:list}} has {{feature}} as scope, and {{list}} as name. - -Karaf "groups" the commands by scope. Each scope form a subshell. - -You can directly execute a command with its full qualified name (scope:name): - -{code} -karaf@root()> feature:list -... -{code} - -or enter in a subshell and type the command contextual to the subshell: - -{code} -karaf@root()> feature -karaf@root(feature)> list -{code} - -You can note that you enter in a subshell directly by typing the subshell name (here {{feature}}). You can "switch" directly from a subshell to another: - -{code} -karaf@root()> feature -karaf@root(feature)> bundle -karaf@root(bundle)> -{code} - -The prompt displays the current subshell between (). - -The {{exit}} command goes to the parent subshell: - -{code} -karaf@root()> feature -karaf@root(feature)> exit -karaf@root()> -{code} - -The completion mode defines the behaviour of the tab key and the help command. - -You have three different modes available: - -* GLOBAL -* FIRST -* SUBSHELL - -You can define your default completion mode using the completionMode property in {{etc/org.apache.karaf.shell.cfg}} file. By default, you have: - -{code} -completionMode = GLOBAL -{code} - -You can also change the completion mode âon the flyâ (while using the Karaf shell console) using the {{shell:completion}} command: - -{code} -karaf@root()> shell:completion -GLOBAL -karaf@root()> shell:completion FIRST -karaf@root()> shell:completion -FIRST -{code} - -{{shell:completion}} can inform you about the current completion mode used. You can also provide the new completion mode that you want. - -GLOBAL completion mode is the default one in Karaf 4.0.0 (mostly for transition purpose). - -GLOBAL mode doesnât really use subshell: itâs the same behavior as in previous Karaf versions. - -When you type the tab key, whatever in which subshell you are, the completion will display all commands and all aliases: - -{code} -karaf@root()> <TAB> -karaf@root()> Display all 273 possibilities? (y or n) -... -karaf@root()> feature -karaf@root(feature)> <TAB> -karaf@root(feature)> Display all 273 possibilities? (y or n) -{code} - -FIRST completion mode is an alternative to the GLOBAL completion mode. - -If you type the tab key on the root level subshell, the completion will display the commands and the aliases from all subshells (as in GLOBAL mode). -However, if you type the tab key when you are in a subshell, the completion will display only the commands of the current subshell: - -{code} -karaf@root()> shell:completion FIRST -karaf@root()> <TAB> -karaf@root()> Display all 273 possibilities? (y or n) -... -karaf@root()> feature -karaf@root(feature)> <TAB> -karaf@root(feature)> -info install list repo-add repo-list repo-remove uninstall version-list -karaf@root(feature)> exit -karaf@root()> log -karaf@root(log)> <TAB> -karaf@root(log)> -clear display exception-display get log set tail -{code} - -SUBSHELL completion mode is the real subshell mode. - -If you type the tab key on the root level, the completion displays the subshell commands (to go into a subshell), and the global aliases. -Once you are in a subshell, if you type the TAB key, the completion displays the commands of the current subshell: - -{code} -karaf@root()> shell:completion SUBSHELL -karaf@root()> <TAB> -karaf@root()> -* bundle cl config dev feature help instance jaas kar la ld lde log log:list man package region service shell ssh system -karaf@root()> bundle -karaf@root(bundle)> <TAB> -karaf@root(bundle)> -capabilities classes diag dynamic-import find-class headers info install list refresh requirements resolve restart services start start-level stop -uninstall update watch -karaf@root(bundle)> exit -karaf@root()> camel -karaf@root(camel)> <TAB> -karaf@root(camel)> -backlog-tracer-dump backlog-tracer-info backlog-tracer-start backlog-tracer-stop context-info context-list context-start context-stop endpoint-list route-info route-list route-profile route-reset-stats -route-resume route-show route-start route-stop route-suspend -{code} - -h2. Unix like environment - -Karaf console provides a full Unix like environment. - -h3. Help or man - -We already saw the usage of the {{help}} command to display all commands available. - -But you can also use the {{help}} command to get details about a command or -the {{man}} command which is an alias to the {{help}} command. -You can also use another form to get the command help, by using the {{--help}} option to the command. - -So these commands - -{code} -karaf@root()> help feature:list -karaf@root()> man feature:list -karaf@root()> feature:list --help -{code} - -All produce the same help output: -{code} -DESCRIPTION - feature:list - - Lists all existing features available from the defined repositories. - -SYNTAX - feature:list [options] - -OPTIONS - --help - Display this help message - -o, --ordered - Display a list using alphabetical order - -i, --installed - Display a list of all installed features only - --no-format - Disable table rendered output - -{code} - -h3. Completion - -When you type the tab key, Karaf tries to complete: - -* subshell -* commands -* aliases -* command arguments -* command options - -h3. Alias - -An alias is another name associated to a given command. - -The {{shell:alias}} command creates a new alias. For instance, to create the {{list-installed-features}} alias to the actual -{{feature:list -i}} command, you can do: - -{code} -karaf@root()> alias "list-features-installed = { feature:list -i }" -karaf@root()> list-features-installed -Name | Version | Required | State | Repository | Description ------------------------------------------------------------------------------------------------------------------------------- -feature | 4.0.0 | x | Started | standard-4.0.0 | Features Support -shell | 4.0.0 | x | Started | standard-4.0.0 | Karaf Shell -deployer | 4.0.0 | x | Started | standard-4.0.0 | Karaf Deployer -bundle | 4.0.0 | x | Started | standard-4.0.0 | Provide Bundle support -config | 4.0.0 | x | Started | standard-4.0.0 | Provide OSGi ConfigAdmin support -diagnostic | 4.0.0 | x | Started | standard-4.0.0 | Provide Diagnostic support -instance | 4.0.0 | x | Started | standard-4.0.0 | Provide Instance support -jaas | 4.0.0 | x | Started | standard-4.0.0 | Provide JAAS support -log | 4.0.0 | x | Started | standard-4.0.0 | Provide Log support -package | 4.0.0 | x | Started | standard-4.0.0 | Package commands and mbeans -service | 4.0.0 | x | Started | standard-4.0.0 | Provide Service support -system | 4.0.0 | x | Started | standard-4.0.0 | Provide System support -kar | 4.0.0 | x | Started | standard-4.0.0 | Provide KAR (KARaf archive) support -ssh | 4.0.0 | x | Started | standard-4.0.0 | Provide a SSHd server on Karaf -management | 4.0.0 | x | Started | standard-4.0.0 | Provide a JMX MBeanServer and a set of MBeans in -{code} - -At login, the Apache Karaf console reads the {{etc/shell.init.script}} file where you can create your aliases. -It's similar to a bashrc or profile file on Unix. - -{code} -ld = { log:display $args } ; -lde = { log:exception-display $args } ; -la = { bundle:list -t 0 $args } ; -ls = { service:list $args } ; -cl = { config:list "(service.pid=$args)" } ; -halt = { system:shutdown -h -f $args } ; -help = { *:help $args | more } ; -man = { help $args } ; -log:list = { log:get ALL } ; -{code} - -You can see here the aliases available by default: - -* {{ld}} is a short form to display log (alias to {{log:display}} command) -* {{lde}} is a short form to display exceptions (alias to {{log:exception-display}} command) -* {{la}} is a short form to list all bundles (alias to {{bundle:list -t 0}} command) -* {{ls}} is a short form to list all services (alias to {{service:list}} command) -* {{cl}} is a short form to list all configurations (alias to {{config:list}} command) -* {{halt}} is a short form to shutdown Apache Karaf (alias to {{system:shutdown -h -f}} command) -* {{help}} is a short form to display help (alias to {{*:help}} command) -* {{man}} is the same as help (alias to {{help}} command) -* {{log:list}} displays all loggers and level (alias to {{log:get ALL}} command) - -You can create your own aliases in the {{etc/shell.init.script}} file. - -h3. Key binding - -Like on most Unix environment, Karaf console support some key bindings: - -* the arrows key to navigate in the commands history -* CTRL-D to logout/shutdown Karaf -* CTRL-R to search previously executed command -* CTRL-U to remove the current line - -h3. Pipe - -You can pipe the output of one command as input to another one. It's a pipe, using the | character: - -{code} -karaf@root()> feature:list |grep -i war -pax-war | 4.1.4 | | Uninstalled | org.ops4j.pax.web-4.1.4 | Provide support of a full WebContainer -pax-war-tomcat | 4.1.4 | | Uninstalled | org.ops4j.pax.web-4.1.4 | -war | 4.0.0 | | Uninstalled | standard-4.0.0 | Turn Karaf as a full WebContainer -blueprint-web | 4.0.0 | | Uninstalled | standard-4.0.0 | Provides an OSGI-aware Servlet ContextListener fo -{code} - -h3. Grep, more, find, ... - -Karaf console provides some core commands similar to Unix environment: - -* {{shell:alias}} creates an alias to an existing command -* {{shell:cat}} displays the content of a file or URL -* {{shell:clear}} clears the current console display -* {{shell:completion}} displays or change the current completion mode -* {{shell:date}} displays the current date (optionally using a format) -* {{shell:each}} executes a closure on a list of arguments -* {{shell:echo}} echoes and prints arguments to stdout -* {{shell:edit}} calls a text editor on the current file or URL -* {{shell:env}} displays or sets the value of a shell session variable -* {{shell:exec}} executes a system command -* {{shell:grep}} prints lines matching the given pattern -* {{shell:head}} displays the first line of the input -* {{shell:history}} prints the commands history -* {{shell:if}} allows you to use conditions (if, then, else blocks) in script -* {{shell:info}} prints various information about the current Karaf instance -* {{shell:java}} executes a Java application -* {{shell:less}} file pager -* {{shell:logout}} disconnects shell from current session -* {{shell:more}} is a file pager -* {{shell:new}} creates a new Java object -* {{shell:printf}} formats and prints arguments -* {{shell:sleep}} sleeps for a bit then wakes up -* {{shell:sort}} writes sorted concatenation of all files to stdout -* {{shell:source}} executes commands contained in a script -* {{shell:stack-traces-print}} prints the full stack trace in the console when the execution of a command throws an exception -* {{shell:tac}} captures the STDIN and returns it as a string -* {{shell:tail}} displays the last lines of the input -* {{shell:threads}} prints the current thread -* {{shell:watch}} periodically executes a command and refresh the output -* {{shell:wc}} prints newline, words, and byte counts for each file -* {{shell:while}} loop while the condition is true - -You don't have to use the fully qualified name of the command, you can directly use the command name as long as it is unique. -So you can use 'head' instead of 'shell:head' - -Again, you can find details and all options of these commands using {{help}} command or {{--help}} option. - -h3. Scripting - -The Apache Karaf Console supports a complete scripting language, similar to bash or csh on Unix. - -The {{each}} ({{shell:each}}) command can iterate in a list: - -{code} -karaf@root()> list = [1 2 3]; each ($list) { echo $it } -1 -2 -3 -{code} - -{tip} -The same loop could be written with the {{shell:while}} command: - -{code} -karaf@root()> a = 0 ; while { %((a+=1) <= 3) } { echo $a } -1 -2 -3 -{code} -{tip} - -You can create the list yourself (as in the previous example), or some commands can return a list too. - -We can note that the console created a "session" variable with the name {{list}} that you can access with {{$list}}. - -The {{$it}} variable is an implicit one corresponding to the current object (here the current iterated value from the -list). - -When you create a list with {{[]}}, Apache Karaf console creates a Java ArrayList. It means that you can use methods -available in the ArrayList objects (like get or size for instance): - -{code} -karaf@root()> list = ["Hello" world]; echo ($list get 0) ($list get 1) -Hello world -{code} - -We can note here that calling a method on an object is directly using {{(object method argument)}}. -Here {{($list get 0)}} means {{$list.get(0)}} where {{$list}} is the ArrayList. - -The {{class}} notation will display details about the object: - -{code} -karaf@root()> $list class -... -ProtectionDomain ProtectionDomain null - null - <no principals> - java.security.Permissions@6521c24e ( - ("java.security.AllPermission" "<all permissions>" "<all actions>") -) - - -Signers null -SimpleName ArrayList -TypeParameters [E] -{code} - -You can "cast" a variable to a given type. - -{code} -karaf@root()> ("hello world" toCharArray) -[h, e, l, l, o, , w, o, r, l, d] -{code} - -If it fails, you will see the casting exception: - -{code} -karaf@root()> ("hello world" toCharArray)[0] -Error executing command: [C cannot be cast to [Ljava.lang.Object; -{code} - -You can "call" a script using the {{shell:source}} command: - -{code} -karaf@root> shell:source script.txt -True! -{code} - -where {{script.txt}} contains: - -{code} -foo = "foo" -if { $foo equals "foo" } { - echo "True!" -} -{code} - -{warning} -The spaces are important when writing script. -For instance, the following script is not correct: - -{code} -if{ $foo equals "foo" } ... -{code} - -and will fail with: - -{code} -karaf@root> shell:source script.txt -Error executing command: Cannot coerce echo "true!"() to any of [] -{code} - -because a space is missing after the {{if}} statement. -{warning} - -As for the aliases, you can create init scripts in the {{etc/shell.init.script}} file. -You can also named you script with an alias. Actually, the aliases are just scripts. - -See the Scripting section of the developers guide for details. - -h2. Security - -The Apache Karaf console supports a Role Based Access Control (RBAC) security mechanism. It means that depending of -the user connected to the console, you can define, depending of the user's groups and roles, the permission to execute -some commands, or limit the values allowed for the arguments. - -Console security is detailed in the [Security section|security] of this user guide. http://git-wip-us.apache.org/repos/asf/karaf/blob/3de05ae9/manual/src/main/webapp/users-guide/deployers.conf ---------------------------------------------------------------------- diff --git a/manual/src/main/webapp/users-guide/deployers.conf b/manual/src/main/webapp/users-guide/deployers.conf deleted file mode 100644 index f8972f3..0000000 --- a/manual/src/main/webapp/users-guide/deployers.conf +++ /dev/null @@ -1,223 +0,0 @@ -h1. Deployers - -The following picture describes the architecture of the deployers. - -!/images/deployer.png! - -Apache Karaf polls the {{deploy}} folder for new files. - -You can configure the location of the {{deploy}} folder, and the polling behaviour in the {{etc/org.apache.felix.fileinstall-deploy.cfg}} -configuration file: - -{code} -################################################################################ -# -# Licensed to the Apache Software Foundation (ASF) under one or more -# contributor license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright ownership. -# The ASF licenses this file to You under the Apache License, Version 2.0 -# (the "License"); you may not use this file except in compliance with -# the License. You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -################################################################################ - -felix.fileinstall.dir = ${karaf.base}/deploy -felix.fileinstall.tmpdir = ${karaf.data}/generated-bundles -felix.fileinstall.poll = 1000 -felix.fileinstall.start.level = 80 -felix.fileinstall.active.level = 80 -felix.fileinstall.log.level = 3 -{code} - -* {{felix.fileinstall.dir}} defines the location of the {{deploy}} folder. Default value is {{KARAF_BASE/deploy}}. -* {{felix.fileinstall.tmpdir}} defines a temporary folder where the deployers store their files. Default value is {{KARAF_DATA/generated-bundles}}. -* {{felix.fileinstall.poll}} defines the polling interval (in milliseconds). Default value is 1 second. - -When Apache Karaf polls a file from the {{deploy}} folder, it "delegates" the file handling to a deployer. - -By default, Apache Karaf provides a set of deployers: - -* Blueprint deployer is able to handle Blueprint XML files. -* Spring deployer is able to handle Spring XML files. -* Features deployer is able to handle Apache Karaf features XML files (see [Provisioning section|provisioning] for details). -* KAR deployer is able to handle KAR files (see [KAR section|kar] for details). -* Wrap deployer is able to handle non-OSGi jar files and turns it as OSGi bundles "on the fly". -* Optionally, WAR deployer (if you install the war feature) is able to handle WAR files. - -h2. Blueprint deployer - -The Blueprint deployer is able to handle plain Blueprint XML configuration files. - -The Blueprint deployer is able to transform "on the fly" any Blueprint XML file into valid OSGi bundle. - -The generated OSGi MANIFEST will contain the following headers: - -{code} -Manifest-Version: 2 -Bundle-SymbolicName: [name of the file] -Bundle-Version: [version of the file] -Import-Package: [required packages] -DynamicImport-Package: * -{code} - -The {{name}} and {{version}} of the file are extracted using a heuristic that will match common patterns. - -For example {{my-config-1.0.1.xml}} will lead to {{name = my-config}} and {{version = 1.0.1}}. - -The default imported packages are extracted from the spring file definition and includes all classes referenced directly. - -If you need to customize the generated manifest, you can do so by including an xml element in your blueprint configuration: - -{code:lang=xml} -<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0";> - <manifest xmlns="http://karaf.apache.org/xmlns/deployer/blueprint/v1.0.0";> - Require-Bundle= my-bundle - </manifest> -{code} - -h2. Spring deployer - -The Spring deployer is similar to the Blueprint deployer. - -The Spring deployer is able to deploy Spring XML files. - -Like the Blueprint deployer, the generated OSGi MANIFEST will contain the following headers: - -{code} -Manifest-Version: 2 -Bundle-SymbolicName: [name of the file] -Bundle-Version: [version of the file] -Spring-Context: *;publish-context:=false;create-asynchronously:=true -Import-Package: [required packages] -DynamicImport-Package: * -{code} - -If you need to customize the generated manifest, you can do so by including a XML element in your Spring configuration: - -{code:lang=xml} -<spring:beans ...> - <manifest xmlns="http://karaf.apache.org/xmlns/deployer/spring/v1.0.0";> - Require-Bundle= my-bundle - </manifest> -{code} - -h2. Features deployer - -See the [Provisioning section|provisioning] for details. - -h2. KAR deployer - -See the [KAR section|kar] for details. - -h2. War deployer - -The installation of the WAR feature enables a WAR deployer. - -It means that with the war feature installed, Apache Karaf is a complete OSGi WebContainer (like Tomcat) where -you can deploy WAB (WebApplication Bundle) or pure WAR (WebApplication aRchive). - -You can install the war feature with: - -{code} -karaf@root()> feature:install war -{code} - -The WAR deployer supports: - -* WAB files -* WAR files -* exploded WAR (as a directory named {{*.war}}). - -The only requirement of the WAR deployer is that the archive contains the {{WEB-INF/web.xml}} file. - -h2. Wrap deployer - -The wrap deployer allows you to "hot deploy" non-OSGi jar files ("classical" jar files) from the deploy folder. - -The wrap deployer creates "on the fly" an OSGi bundle with a non-OSGi jar file. - -The wrap deployer looks for jar files in the deploy folder. A jar file is considered as non-OSGi if the MANIFEST doesn't -contain the {{Bundle-SymbolicName}} and {{Bundle-Version}} attributes, or if there is no MANIFEST at all. - -The wrap deployer "transforms" non-OSGi jar file into an OSGi bundle. - -The wrap deployer tries to populate the Bundle-SymbolicName and Bundle-Version extracted from the jar file path. - -For example, if you simply copy commons-lang-2.3.jar (which is not an OSGi bundle) into the deploy folder, you -will see: - -{code} -karaf@root()> la|grep -i commons-lang -80 | Active | 80 | 2.3 | commons-lang -{code} - -If you take a look on the commons-lang headers, you can see that the bundle exports all packages with optional resolution -and that {{Bundle-SymbolicName}} and {{Bundle-Version}} have been populated: - -{code} -karaf@root()> bundle:headers 80 - -commons-lang (80) ------------------ -Specification-Title = Commons Lang -Tool = Bnd-2.1.0.20130426-122213 -Specification-Version = 2.3 -Specification-Vendor = Apache Software Foundation -Implementation-Version = 2.3 -Generated-By-Ops4j-Pax-From = wrap:file:/opt/apache-karaf-4.0.0/deploy/commons-lang-2.3.jar$Bundle-SymbolicName=commons-lang&Bundle-Version=2.3 -Implementation-Vendor-Id = org.apache -Created-By = 1.7.0_21 (Oracle Corporation) -Implementation-Title = Commons Lang -Manifest-Version = 1.0 -Bnd-LastModified = 1386339925753 -X-Compile-Target-JDK = 1.1 -Originally-Created-By = 1.3.1_09-85 ("Apple Computer, Inc.") -Ant-Version = Apache Ant 1.6.5 -Package = org.apache.commons.lang -X-Compile-Source-JDK = 1.3 -Extension-Name = commons-lang -Implementation-Vendor = Apache Software Foundation - -Bundle-Name = commons-lang -Bundle-SymbolicName = commons-lang -Bundle-Version = 2.3 -Bundle-ManifestVersion = 2 - -Export-Package = - org.apache.commons.lang;uses:=org.apache.commons.lang.exception, - org.apache.commons.lang.builder, - org.apache.commons.lang.enum, - org.apache.commons.lang.enums, - org.apache.commons.lang.exception, - org.apache.commons.lang.math, - org.apache.commons.lang.mutable, - org.apache.commons.lang.text, - org.apache.commons.lang.time, - org, - org.apache, - org.apache.commons - -{code} - -You can specify some MANIFEST headers by specifying the headers as URL parameters. - -In the URL parameters, you can specify the headers using the '$' character and '&' to separate the different headers. -For instance: - -{code} -karaf@root()> bundle:install -s 'wrap:mvn:jboss/jbossall-client/4.2.3.GA/$Bundle-SymbolicName=jbossall-client&Bundle-Version=4.2.3.GA&Export-Package=org.jboss.remoting;version="4.2.3.GA",\!*' -{code} - -When defined in a features.xml file, it's necessary to escape any ampersands and quotes, or use a CDATA tag: - -{code:lang=xml} -<bundle>wrap:mvn:jboss/jbossall-client/4.3.2.GA/$Bundle-SymbolicName=jbossall-client&Bundle-Version=4.3.2.GA&Export-Package=org.jboss.remoting;version="4.3.2.GA",!*</bundle> -{code} http://git-wip-us.apache.org/repos/asf/karaf/blob/3de05ae9/manual/src/main/webapp/users-guide/directory-structure.conf ---------------------------------------------------------------------- diff --git a/manual/src/main/webapp/users-guide/directory-structure.conf b/manual/src/main/webapp/users-guide/directory-structure.conf deleted file mode 100644 index 3e624dc..0000000 --- a/manual/src/main/webapp/users-guide/directory-structure.conf +++ /dev/null @@ -1,25 +0,0 @@ -h1. Directory structure - -The directory layout of a Karaf installation is as follows: -* {{/bin}}: control scripts to start, stop, login, ... -* {{/demos}}: contains some simple Karaf samples -* {{/etc}}: configuration files -* {{/data}}: working directory -** {{/cache}}: OSGi framework bundle cache -** {{/generated-bundles}}: temporary folder used by the deployers -** {{/log}}: log files -* {{/deploy}}: hot deploy directory -* {{/instances}}: directory containing [instances|instances] -* {{/lib}}: contains libraries -** {{/lib/boot}}: contains the systeù libraries used at Karaf bootstrap -** {{/lib/endorsed}}: directory for endorsed libraries -** {{/lib/ext}}: directory for JRE extensions -* {{/system}}: OSGi bundles repository, laid out as a Maven 2 repository - -{tip} -The {{data}} folder contains all the working and temporary files for Karaf. -If you want to restart from a clean state, you can wipe out this directory, which has the same effect as -[using the clean option|start-stop#Starting Karaf from clean]. -{tip} - - http://git-wip-us.apache.org/repos/asf/karaf/blob/3de05ae9/manual/src/main/webapp/users-guide/ejb.conf ---------------------------------------------------------------------- diff --git a/manual/src/main/webapp/users-guide/ejb.conf b/manual/src/main/webapp/users-guide/ejb.conf deleted file mode 100644 index 2b8f24a..0000000 --- a/manual/src/main/webapp/users-guide/ejb.conf +++ /dev/null @@ -1,80 +0,0 @@ -h1. EJB - -This section describes how to add support of EJB in Apache Karaf. It doesn't describe how to develop EJB applications. -See the developer guide for that. - -h2. Apache OpenEJB - -Apache Karaf doesn't provide "native" support of EJB (Enterprise Java Beans). - -Apache OpenEJB provides EJB support for Apache Karaf by providing a set of features. - -You have to update some Karaf configuration to have full OpenEJB support. - -First, in the {{etc/system.properties}}, you have to append the following properties: - -{code} -... -# -# OpenEJB scanner -# -openejb.deployments.classpath.exclude=bundle:* -openejb.deployments.classpath.filter.descriptors=true -{code} - -Due to some OpenEJB version constraint, you also have to update the {{etc/jre.properties}} by changing the version of -the {{javax.xml.namespace}} package, and remove the version of the {{javax.annotation}} package (provided by Geronimo -Annotation API spec bundle, used by OpenEJB): - -{code} -... -javax.annotation, \ -javax.annotation.processing, \ -... -javax.xml.namespace;version="1.0.0", \ -... -{code} - -It enables the OpenEJB bundles scanning, looking for EJBs. - -After starting/restart Karaf to take these changes, we can install the OpenEJB feature: - -{code} -karaf@root()> feature:repo-add openejb -{code} - -By default, the {{feature:repo-add openejb}} command will install the latest OpenEJB version available. - -You can specify a target version using the {{version}} argument: - -{code} -karaf@root()> feature:repo-add openejb 4.5.2 -{code} - -Now, you have a set of new OpenEJB features available in your Apache Karaf container: - -{code} -karaf@root()> la -... -openejb-core | 4.5.2 | | openejb-features | -openejb-server | 4.5.2 | | openejb-features | -openejb-cxf | 4.5.2 | | openejb-features | -openejb-rest | 4.5.2 | | openejb-features | -openejb-soap | 4.5.2 | | openejb-features | -{code} - -You can add EJB support installing the {{openejb-core}} feature: - -{code} -karaf@root()> feature:install openejb-core -{code} - -h2. Apache KarafEE - -A custom distribution of Apache Karaf embedding OpenEJB is available in the Apache TomEE project. - -The name of this custom distribution is KarafEE: - -[https://svn.apache.org/repos/asf/tomee/karafee/] - -However, this project is now "deprecated", and all resources from KarafEE will move directly in Apache Karaf soon. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/karaf/blob/3de05ae9/manual/src/main/webapp/users-guide/enterprise.conf ---------------------------------------------------------------------- diff --git a/manual/src/main/webapp/users-guide/enterprise.conf b/manual/src/main/webapp/users-guide/enterprise.conf deleted file mode 100644 index 87518fe..0000000 --- a/manual/src/main/webapp/users-guide/enterprise.conf +++ /dev/null @@ -1,21 +0,0 @@ -h1. Enterprise - -Apache Karaf provides a set of enterprise class features. - -These features are not installed by default, you have to install yourself depending of your needs. - -The enterprise features available are: - -* [Http Service|http] provide basic OSGi HttpServices -* [WebContainer (JSP/Servlet)|webcontainer] providing a complete JSP/Servlet support. These feature turns Apache Karaf as a complete - web container where you can deploy web application (as you can do in Apache Tomcat, or other JEE application servers). -* [Naming (JNDI)|jndi] providing a complete Java Naming and Directory Interface support. Apache Karaf provides a complete - JNDI "server" (context) where you can create name to identify Objects (especially OSGi services). -* [Transaction (JTA)|jta] providing a complete transaction manager as an OSGi service. -* [DataSources (JDBC)|jdbc] providing useful OSGi service, console commands, and MBean to manipulate JDBC datasources and perform database operations. -* [MOM (JMS)|jms] providing useful OSGi service, console commands, and MBean to manipulate JMS connection factories and perform messaging operations. -* [Persistence (JPA)|jpa] providing ready to use JPA engines and entity manager as an OSGi service. -* [EJB|ejb] adding EJB support in Apache Karaf. -* [CDI|cdi] providing ready to use CDI containers in Apache Karaf. -* [HA/failover and cluster|failover] providing active/passive or active/active topologies with multiple Apache Karaf instances. - http://git-wip-us.apache.org/repos/asf/karaf/blob/3de05ae9/manual/src/main/webapp/users-guide/failover.conf ---------------------------------------------------------------------- diff --git a/manual/src/main/webapp/users-guide/failover.conf b/manual/src/main/webapp/users-guide/failover.conf deleted file mode 100644 index 1cd06f0..0000000 --- a/manual/src/main/webapp/users-guide/failover.conf +++ /dev/null @@ -1,230 +0,0 @@ -h1. HA/failover and cluster - -Apache Karaf natively provides a failover mechanism. It uses a kind of master/slave topology where one instance is active -and the others are in standby. - -If you are looking for cluster of Apache Karaf instances (active/active), [Apache Karaf Cellar|http://karaf.apache.org/index/subprojects/cellar.html] is a solution. - -Karaf provides failover capability using either a simple lock file or a JDBC locking mechanism. -In both cases, a container-level lock system allows bundles to be preloaded into the slave Karaf instance in order to provide faster failover performance. - -h2. HA/failover (active/passive) - -The Apache Karaf failover capability uses a lock system. - -This container-level lock system allows bundles installed on the master to be preloaded on the slave, in order to provide faster failover performance. - -Two types of lock are supported: - -* filesystem lock -* database lock - -When a first instance starts, if the lock is available, it takes the lock and become the master. -If a second instance starts, it tries to acquire the lock. As the lock is already hold by the master, the instance becomes -a slave, in standby mode (not active). A slave periodically check if the lock has been released or not. - -h3. Filesystem lock - -The Apache Karaf instances share a lock on the filesystem. It means that the filesystem storing the lock has to be accessible -to the different instances (using SAN, NFS, ...). - -The configuration of the lock system has to be defined in the {{etc/system.properties}} file, on each instance (master/slave): - -{code} -karaf.lock=true -karaf.lock.class=org.apache.karaf.main.SimpleFileLock -karaf.lock.dir=<PathToLockFileDirectory> -karaf.lock.delay=10000 -{code} - -* {{karaf.lock}} property enables the the HA/failover mechanism -* {{karaf.lock.class}} property contains the class name providing the lock implementation. Here, we use the filesystem lock. -* {{karaf.lock.dir}} property contains the location where the lock will be written. All instances have to share the same lock. -* {{karaf.lock.delay}} property is the interval period (in milliseconds) to check if the lock has been released or not. - -h3. Database lock - -It's not always possible and easy to have a shared filesystem between multiple Apache Karaf instances. - -Instead of sharing a filesystem, Apache Karaf supports sharing a database. - -The master instance holds the lock by locking a table in the database. If the master loses the lock, a waiting slave -gains access to the locking table, acquire the lock on the table and starts. - -The database lock uses JDBC (Java DataBase Connectivity). To use database locking, you have to: - -* copy the JDBC driver in the {{lib/ext}} folder on each instance. The JDBC driver to use is the one corresponding to the - database used for the locking system. -* update {{etc/system.properties}} file on each instance: - -{code} -karaf.lock=true -karaf.lock.class=org.apache.karaf.main.DefaultJDBCLock -karaf.lock.level=50 -karaf.lock.delay=10000 -karaf.lock.jdbc.url=jdbc:derby://dbserver:1527/sample -karaf.lock.jdbc.driver=org.apache.derby.jdbc.ClientDriver -karaf.lock.jdbc.user=user -karaf.lock.jdbc.password=password -karaf.lock.jdbc.table=KARAF_LOCK -karaf.lock.jdbc.clustername=karaf -karaf.lock.jdbc.timeout=30 -{code} - -* {{karaf.lock}} property enabled the HA/failover mechanism -* {{karaf.lock.class}} property contains the class name providing the lock implementation. The {{org.apache.karaf.main.DefaultJDBCLock}} - is the most generic database lock system implementation. Apache Karaf supports lock system for specific databases (see later for details). -* {{karaf.lock.level}} property is the container-level locking (see later for details). -* {{karaf.lock.delay}} property is the interval period (in milliseconds) to check if the lock has been released or not. -* {{karaf.lock.jdbc.url}} property contains the JDBC URL to the database (derby in this example). -* {{karaf.lock.jdbc.driver}} property contains the class name of the JDBC driver to use (derby in this example). -* {{karaf.lock.jdbc.user}} property contains the username to use to connect to the database. -* {{karaf.lock.jdbc.password}} property contains the password to use to connet to the database. -* {{karaf.lock.jdbc.table}} property contains the database table to use for the lock. Karaf will first try to find the table as specified in this property, - and if not found, it will try the table name in lower and upper case. - -{warning} -Apache Karaf won't start if the JDBC driver is not present in the {{lib/ext}} folder. -{warning} - -{warning} -The {{sample}} database will be created automatically if it does not exist. -{warning} - -{warning} -If the connection to the database is lost, the master instance tries to gracefully shutdown, allowing a slave instance to -become the master when the database is back. The former master instance will required a manual restart. -{warning} - -h4. Lock on Oracle - -Apache Karaf supports Oracle database for locking. The lock implementation class name to use is {{org.apache.karaf.main.lock.OracleJDBCLock}}: - -{code} -karaf.lock=true -karaf.lock.class=org.apache.karaf.main.lock.OracleJDBCLock -karaf.lock.jdbc.url=jdbc:oracle:thin:@hostname:1521:XE -karaf.lock.jdbc.driver=oracle.jdbc.OracleDriver -karaf.lock.jdbc.user=user -karaf.lock.jdbc.password=password -karaf.lock.jdbc.table=KARAF_LOCK -karaf.lock.jdbc.clustername=karaf -karaf.lock.jdbc.timeout=30 -{code} - -The Oracle JDBC driver file ({{ojdbc*.jar}}) has to be copied in the {{lib/ext}} folder. - -{warning} -The {{karaf.lock.jdbc.url}} property contains a JDBC URL which requires an active SID. It means that you must manually create the Oracle -database instance first before using the lock mechanism. -{warning} - -h4. Lock on Derby - -Apache Karaf supports Apache Derby database for locking. The lock implementation class name to use is {{org.apache.karaf.main.lock.DerbyJDBCLock}}: - -{code} -karaf.lock=true -karaf.lock.class=org.apache.karaf.main.lock.DerbyJDBCLock -karaf.lock.jdbc.url=jdbc:derby://127.0.0.1:1527/dbname -karaf.lock.jdbc.driver=org.apache.derby.jdbc.ClientDriver -karaf.lock.jdbc.user=user -karaf.lock.jdbc.password=password -karaf.lock.jdbc.table=KARAF_LOCK -karaf.lock.jdbc.clustername=karaf -karaf.lock.jdbc.timeout=30 -{code} - -The Derby JDBC driver file name has to be copied in the {{lib/ext}} folder. - -h4.Lock on MySQL - -Apache Karaf supports MySQL database for locking. The lock implementation class name to use is {{org.apache.karaf.main.lock.MySQLJDBCLock}}: - -{code} -karaf.lock=true -karaf.lock.class=org.apache.karaf.main.lock.MySQLJDBCLock -karaf.lock.jdbc.url=jdbc:mysql://127.0.0.1:3306/dbname -karaf.lock.jdbc.driver=com.mysql.jdbc.Driver -karaf.lock.jdbc.user=user -karaf.lock.jdbc.password=password -karaf.lock.jdbc.table=KARAF_LOCK -karaf.lock.jdbc.clustername=karaf -karaf.lock.jdbc.timeout=30 -{code} - -The MySQL JDBC driver file name has to be copied in {{lib/ext}} folder. - -h4. Lock on PostgreSQL - -Apache Karaf supports PostgreSQL database for locking. The lock implementation class name to use is {{org.apache.karaf.main.lock.PostgreSQLJDBCLock}}: - -{code} -karaf.lock=true -karaf.lock.class=org.apache.karaf.main.lock.PostgreSQLJDBCLock -karaf.lock.jdbc.url=jdbc:postgresql://127.0.0.1:1527/dbname -karaf.lock.jdbc.driver=org.postgresql.Driver -karaf.lock.jdbc.user=user -karaf.lock.jdbc.password=password -karaf.lock.jdbc.table=KARAF_LOCK -karaf.lock.jdbc.clustername=karaf -karaf.lock.jdbc.timeout=0 -{code} - -The PostgreSQL JDBC driver file has to be copied in the {{lib/ext}} folder. - -h4. Lock on Microsoft SQLServer - -Apache Karaf supports Microsoft SQLServer database for locking. The lock implementation class name to use is {{org.apache.karaf.main.lock.SQLServerJDBCLock}}: - -{code} -karaf.lock=true -karaf.lock.class=org.apache.karaf.main.lock.SQLServerJDBCLock -karaf.lock.level=50 -karaf.lock.delay=10000 -karaf.lock.jdbc.url=jdbc:jtds:sqlserver://127.0.0.1;databaseName=sample -karaf.lock.jdbc.driver=net.sourceforge.jtds.jdbc.Driver -karaf.lock.jdbc.user=user -karaf.lock.jdbc.password=password -karaf.lock.jdbc.table=KARAF_LOCK -karaf.lock.jdbc.clustername=karaf -karaf.lock.jdbc.timeout=30 -{code} - -The JTDS JDBC driver file has to be copied in the {{lib/ext}} folder. - -h3. Container-level locking - -Apache Karaf supports container-level locking. It allows bundles to be preloaded into the slave instance. -Thanks to that, switching to a slave instance is very fast as the slave instance already contains all required bundles. - -The container-level locking is supported in both filesystem and database lock mechanisms. - -The container-level locking uses the {{karaf.lock.level}} property: - -{code} -karaf.lock.level=50 -{code} - -The {{karaf.lock.level}} property tells the Karaf instance how far up the boot process to bring the OSGi container. -All bundles with an ID equals or lower to this start level will be started in that Karaf instance. - -As reminder, the bundles start levels are specified in {{etc/startup.properties}}, in the {{url=level}} format. - -|| 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 end up being started. | - -{warning} -Using 'hot' standby means that the slave instances are running and bind some ports. So, if you use master and slave instances on the same machine, you have -to update the slave configuration to bind the services (ssh, JMX, etc) on different port numbers. -{warning} - -h2. Cluster (active/active) - -Apache Karaf doesn't natively support cluster. By cluster, we mean several active instances, synchronized with each other. - -However, [Apache Karaf Cellar|http://karaf.apache.org/index/subprojects/cellar.html] can be installed to provide cluster support. - -See the [Apache Karaf Cellar website|http://karaf.apache.org/index/subprojects/cellar.html] for details. http://git-wip-us.apache.org/repos/asf/karaf/blob/3de05ae9/manual/src/main/webapp/users-guide/features.conf ---------------------------------------------------------------------- diff --git a/manual/src/main/webapp/users-guide/features.conf b/manual/src/main/webapp/users-guide/features.conf deleted file mode 100644 index 6dc83de..0000000 --- a/manual/src/main/webapp/users-guide/features.conf +++ /dev/null @@ -1,52 +0,0 @@ -h1. Features - -h2. Standard Features - -* *Hot deployment*: simply drop a file in the {{deploy}} directory, Apache Karaf will detect the type of the file and - try to deploy it. -* *Complete Console*: Apache Karaf provides a complete Unix-like console where you can completely manage the container. -* *Dynamic Configuration*: Apache Karaf provides a set of command dedicated for the management of the configuration files. - All configuration files are centralized in the {{etc}} folder. Any change in a configuration file is taken on the fly. -* *Advanced Logging System*: Apache Karaf supports a large set of Logging framework (slf4j, log4j, etc). Whatever the - logging framework you use, Apache Karaf centralizes the configuration in one file. -* *Provisioning*: Apache Karaf supports a large set of URL where you can install your application (Maven repository, HTTP, - file, etc). It also provides the concept of "Karaf Feature" which is a way to describe your application. -* *Management*: Apache Karaf is an enterprise-ready container, providing a lot of management indicators and operations - via JMX. -* *Remote*: Apache Karaf embeds an SSHd server allowing you to use the console remotely. The management layer is also - accessible remotely. -* *Security*: Apache Karaf provides a complete security framework (based on JAAS), and providing RBAC (Role-Based Access - Control) mechanism for console and JMX. -* *Instances*: multiple instances of Apache Karaf can be managed directly from a main instance (root). -* *OSGi frameworks*: Apache Karaf is not tight to one OSGi framework. By default, Apache Karaf runs with Apache Felix - Framework, but you can easily switch to Equinox (just change on property in a configuration file). - -!/images/karaf.png! - -h2. Enterprise features - -* WebContainer (JSP/Servlet support, including WAR archive deployment support) -* Naming (JNDI) -* Transaction (JTA) -* DataSources (JDBC) -* MOM (JMS) -* Persistence (JPA) -* EJB -* CDI -* HA/failover and cluster (Apache Karaf Cellar) -* Monitoring (Apache Karaf Decanter) -* Artifacts repository and OSGi bundle repository (Apache Karaf Cave) - -h2. External Features - -As a very extend-able container, OpenSource and commercial projects provide "native" support of Apache Karaf. - -We can mention (this list is not exhaustive): - -* [Apache ActiveMQ|http://activemq.apache.org/osgi-integration.html] -* [Apache Camel|http://camel.apache.org/karaf.html] -* [Apache CXF|http://cxf.apache.org] -* [JClouds|http://www.jclouds.org/documentation/userguide/karaf/] -* [Apache Wicket|http://team.ops4j.org/wiki/display/paxwicket/Install+Pax+Wicket] -* ... - http://git-wip-us.apache.org/repos/asf/karaf/blob/3de05ae9/manual/src/main/webapp/users-guide/http.conf ---------------------------------------------------------------------- diff --git a/manual/src/main/webapp/users-guide/http.conf b/manual/src/main/webapp/users-guide/http.conf deleted file mode 100644 index fa45219..0000000 --- a/manual/src/main/webapp/users-guide/http.conf +++ /dev/null @@ -1,60 +0,0 @@ -h1. Http Service - -The Karaf http feature enables the Pax Web implementation of the OSGi HTTPService. - -h2. Installing the HTTP feature - -{code} -root@karaf()> feature:install http -{code} - -Test the HTTP service is up by pointing your browser to [http://localhost:8181/]. - -h2. Configuring the HTTPService - -By default the HTTPService listens on port 8181 you can change the port by creating a file {{etc/org.ops4j.pax.web.cfg}} with the following content: - -{code} -org.osgi.service.http.port=8181 -{code} - -or by typing: -{code} -root@karaf> config:property-set -p org.ops4j.pax.web org.osgi.service.http.port 8181 -{code} - -If the http feature is already installed the change will take effect immediately. - -h2. Registering a servlet with the HttpService manually - -See [Apache Felix HTTP Service|http://felix.apache.org/site/apache-felix-http-service.html]. - -h2. Using the Pax Web whiteboard extender - -The Pax Web whiteboard extender is an enhancement of the http feature. So use the following command to install: - -{code} -root@karaf> feature:install http-whiteboard -{code} - -The [Pax Web whiteboard|http://team.ops4j.org/wiki/display/ops4j/Pax+Web+Extender+-+Whiteboard] extender listens to services -of interface type HttpServlet and Filter. -It will register each of these interfaces with the HttpService and remove them as soon as the service goes down. -So it is much more convenient than registering with the HttpService directly. - -{code} -<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0";> - <service interface="javax.servlet.http.HttpServlet"> - <service-properties> - <entry key="alias" value="/myservlet"/> - </service-properties> - <bean id="myServlet" class="com.example.MyServlet"/> - </service> -</blueprint> -{code} - -The above snippet publishes the Servlet MyServlet on http://localhost:8181/myServlet. - -Please keep in mind that the Whiteboard pattern for Servlets is not standardized and only works with Pax Web. - -For commands take a look at the command section in the [webcontainer|webcontainer] chapter. http://git-wip-us.apache.org/repos/asf/karaf/blob/3de05ae9/manual/src/main/webapp/users-guide/index.conf ---------------------------------------------------------------------- diff --git a/manual/src/main/webapp/users-guide/index.conf b/manual/src/main/webapp/users-guide/index.conf deleted file mode 100644 index d140ec0..0000000 --- a/manual/src/main/webapp/users-guide/index.conf +++ /dev/null @@ -1,30 +0,0 @@ -h1. Users Guide - -* [Installation|installation] -* [Directory structure|directory-structure] -* [Start, stop, restart, connect|start-stop] -* [Integration in the operating system: the Service Wrapper|wrapper] -* [Console|/users-guide/console] -* [Remote|remote] -* [Log|log] -* [Configuration|configuration] -* [Artifacts repositories and URLs|urls] -* [Provisioning and features|provisioning] -* [Deployers|deployers] -* [KAR|kar] -* [Instances|instances] -* [Security|security] -* [OBR|obr] -* [Enterprise|enterprise] -** [WebContainer (JSP/Servlet)|webcontainer] -** [Naming (JNDI)|jndi] -** [Transaction (JTA)|jta] -** [DataSource (JDBC)|jdbc] -** [MOM (JMS)|jms] -** [Persistence (JPA)|jpa] -** [EJB|ejb] -** [CDI|cdi] -** [HA/failover and cluster|failover] -* [Monitoring and Management using JMX|monitoring] -* [WebConsole|webconsole] -* [Tuning|tuning]
