You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@karaf.apache.org by jb...@apache.org on 2018/09/03 06:10:49 UTC
svn commit: r1839907 [4/4] - in /karaf/site/production/manual/latest: ./
commands/
Modified: karaf/site/production/manual/latest/instances.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/instances.html?rev=1839907&r1=1839906&r2=1839907&view=diff
==============================================================================
--- karaf/site/production/manual/latest/instances.html (original)
+++ karaf/site/production/manual/latest/instances.html Mon Sep 3 06:10:48 2018
@@ -1067,7 +1067,7 @@ If wait is true, this operation is waiti
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-07-26 16:36:29 +02:00
+Last updated 2018-05-18 16:02:21 +02:00
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/jdbc.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/jdbc.html?rev=1839907&r1=1839906&r2=1839907&view=diff
==============================================================================
--- karaf/site/production/manual/latest/jdbc.html (original)
+++ karaf/site/production/manual/latest/jdbc.html Mon Sep 3 06:10:48 2018
@@ -520,13 +520,13 @@ table.CodeRay td.code>pre{padding:0}
</div>
<div class="listingblock">
<div class="content">
-<pre>karaf@root()> feature:repo-add pax-jdbc
-karaf@root()> feature:install pax-jdbc
-karaf@root()> feature:install pax-jdbc-config
-karaf@root()> feature:install jdbc</pre>
+<pre>karaf@root()> feature:install jdbc</pre>
</div>
</div>
<div class="paragraph">
+<p>NB: <code>jdbc</code> feature automatically installs the <code>pax-jdbc-*</code>Â core features.</p>
+</div>
+<div class="paragraph">
<p>Pax JDBC provides ready to use adapters for different databases:</p>
</div>
<div class="ulist">
@@ -832,7 +832,7 @@ REF_GENERATION | TYPE_NAME | TABLE_NAME
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-11-15 16:55:26 +01:00
+Last updated 2018-07-31 07:02:52 +02:00
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/jms.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/jms.html?rev=1839907&r1=1839906&r2=1839907&view=diff
==============================================================================
--- karaf/site/production/manual/latest/jms.html (original)
+++ karaf/site/production/manual/latest/jms.html Mon Sep 3 06:10:48 2018
@@ -601,14 +601,15 @@ SYNTAX
ARGUMENTS
name
The JMS connection factory name
+ (required)
OPTIONS
-t, --type
- The JMS connection factory type (ActiveMQ or WebsphereMQ)
- (defaults to ActiveMQ)
- -u, --username
- Username to connect to the JMS broker
- (defaults to karaf)
+ The JMS connection factory type (ActiveMQ, Artemis or WebsphereMQ)
+ (defaults to activemq)
+ --pool
+ The pool mechanism to use for this connection factory
+ (defaults to pooledjms)
--help
Display this help message
--url
@@ -616,6 +617,9 @@ OPTIONS
(defaults to tcp://localhost:61616)
-p, --password
Password to connect to the JMS broker
+ (defaults to karaf)
+ -u, --username
+ Username to connect to the JMS broker
(defaults to karaf)</pre>
</div>
</div>
@@ -636,6 +640,9 @@ OPTIONS
<li>
<p>the <code>-p</code> (<code>--password</code>) option is optional (karaf by default). In the case of the broker requires authentication, it’s the password used.</p>
</li>
+<li>
+<p>the <code>--pool</code> option is optional (<code>pooledjms</code> by default). It allows you to define the pooling framework you want to use: pooledjms, narayana, transx.</p>
+</li>
</ul>
</div>
<div class="paragraph">
@@ -643,8 +650,23 @@ OPTIONS
</div>
<div class="listingblock">
<div class="content">
-<pre>karaf@root()> jms:create -t activemq --url tcp://localhost:61616 test</pre>
+<pre>karaf@root()> feature:install pax-jms-activemq
+karaf@root()> jms:create -t activemq --url tcp://localhost:61616 test</pre>
+</div>
</div>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<div class="title">Note</div>
+</td>
+<td class="content">
+<div class="paragraph">
+<p>When you use ActiveMQ, Karaf uses <code>transx</code> as connection factory pooling framework.</p>
+</div>
+</td>
+</tr>
+</table>
</div>
<div class="admonitionblock note">
<table>
@@ -983,7 +1005,7 @@ ID:vostro-59602-1387462183019-3:3:1:1:1
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-07-26 16:36:29 +02:00
+Last updated 2018-08-17 21:42:57 +02:00
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/jndi.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/jndi.html?rev=1839907&r1=1839906&r2=1839907&view=diff
==============================================================================
--- karaf/site/production/manual/latest/jndi.html (original)
+++ karaf/site/production/manual/latest/jndi.html Mon Sep 3 06:10:48 2018
@@ -831,7 +831,7 @@ and the regular JNDI service.</p>
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-07-26 16:36:29 +02:00
+Last updated 2018-05-18 16:02:21 +02:00
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/jpa.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/jpa.html?rev=1839907&r1=1839906&r2=1839907&view=diff
==============================================================================
--- karaf/site/production/manual/latest/jpa.html (original)
+++ karaf/site/production/manual/latest/jpa.html Mon Sep 3 06:10:48 2018
@@ -568,7 +568,7 @@ container managed persistence for applic
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-07-26 16:36:29 +02:00
+Last updated 2018-05-18 16:02:21 +02:00
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/jta.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/jta.html?rev=1839907&r1=1839906&r2=1839907&view=diff
==============================================================================
--- karaf/site/production/manual/latest/jta.html (original)
+++ karaf/site/production/manual/latest/jta.html Mon Sep 3 06:10:48 2018
@@ -658,7 +658,7 @@ aries.transaction.howl.bufferSizeKBytes
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-07-26 16:36:29 +02:00
+Last updated 2018-05-18 16:02:21 +02:00
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/kar.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/kar.html?rev=1839907&r1=1839906&r2=1839907&view=diff
==============================================================================
--- karaf/site/production/manual/latest/kar.html (original)
+++ karaf/site/production/manual/latest/kar.html Mon Sep 3 06:10:48 2018
@@ -902,7 +902,7 @@ list of <code>features</code> to include
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-11-15 16:55:26 +01:00
+Last updated 2018-07-31 07:02:52 +02:00
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/karaf-maven-plugin.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/karaf-maven-plugin.html?rev=1839907&r1=1839906&r2=1839907&view=diff
==============================================================================
--- karaf/site/production/manual/latest/karaf-maven-plugin.html (original)
+++ karaf/site/production/manual/latest/karaf-maven-plugin.html Mon Sep 3 06:10:48 2018
@@ -528,6 +528,9 @@ table.CodeRay td.code>pre{padding:0}
</li>
</ul>
</div>
+<div class="paragraph">
+<p>See [examples/karaf-maven-example] for details.</p>
+</div>
<div class="sect3">
<h4 id="_packaging">Packaging</h4>
<div class="paragraph">
@@ -1216,7 +1219,7 @@ META-INF in the kar, without getting ins
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-11-22 15:12:31 +01:00
+Last updated 2018-08-17 21:42:57 +02:00
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/log.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/log.html?rev=1839907&r1=1839906&r2=1839907&view=diff
==============================================================================
--- karaf/site/production/manual/latest/log.html (original)
+++ karaf/site/production/manual/latest/log.html Mon Sep 3 06:10:48 2018
@@ -1427,7 +1427,7 @@ You can now use your appender directly i
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-11-22 15:12:31 +01:00
+Last updated 2018-08-17 21:42:57 +02:00
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/monitoring.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/monitoring.html?rev=1839907&r1=1839906&r2=1839907&view=diff
==============================================================================
--- karaf/site/production/manual/latest/monitoring.html (original)
+++ karaf/site/production/manual/latest/monitoring.html Mon Sep 3 06:10:48 2018
@@ -913,7 +913,7 @@ Enter host password for user 'karaf':
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-07-26 16:36:29 +02:00
+Last updated 2018-06-14 11:10:16 +02:00
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/obr.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/obr.html?rev=1839907&r1=1839906&r2=1839907&view=diff
==============================================================================
--- karaf/site/production/manual/latest/obr.html (original)
+++ karaf/site/production/manual/latest/obr.html Mon Sep 3 06:10:48 2018
@@ -997,7 +997,7 @@ by the OBR service (meaning installing m
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-07-26 16:36:29 +02:00
+Last updated 2018-05-18 16:02:21 +02:00
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/os-integration.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/os-integration.html?rev=1839907&r1=1839906&r2=1839907&view=diff
==============================================================================
--- karaf/site/production/manual/latest/os-integration.html (original)
+++ karaf/site/production/manual/latest/os-integration.html Mon Sep 3 06:10:48 2018
@@ -923,6 +923,10 @@ wrapper.java.additional.4=-Dkaraf.etc=%K
wrapper.java.additional.5=-Dcom.sun.management.jmxremote
wrapper.java.additional.6=-Dkaraf.startLocalConsole=false
wrapper.java.additional.7=-Dkaraf.startRemoteShell=true
+wrapper.java.additional.8=-Djava.io.tmpdir=%KARAF_DATA%/tmp
+# Uncomment if you need libraries on Java 8
+#wrapper.java.additional.9=-Djava.endorsed.dirs=%JAVA_HOME%/jre/lib/endorsed:%JAVA_HOME%/lib/endorsed:%KARAF_HOME%/lib/endorsed
+#wrapper.java.additional.10=-Djava.ext.dirs=%JAVA_HOME%/jre/lib/ext:%JAVA_HOME%/lib/ext:%KARAF_HOME%/lib/ext
# Uncomment to enable jmx
#wrapper.java.additional.n=-Dcom.sun.management.jmxremote.port=1616
@@ -1284,7 +1288,7 @@ C:\opt\apache-karaf-4\bin\contrib> ka
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-11-22 15:12:31 +01:00
+Last updated 2018-08-17 21:42:57 +02:00
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/overview.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/overview.html?rev=1839907&r1=1839906&r2=1839907&view=diff
==============================================================================
--- karaf/site/production/manual/latest/overview.html (original)
+++ karaf/site/production/manual/latest/overview.html Mon Sep 3 06:10:48 2018
@@ -518,7 +518,7 @@ table.CodeRay td.code>pre{padding:0}
</div>
<div class="paragraph">
<p>Karaf can be used standalone as a container, supporting a wide range of applications and technologies.
-It also supports the "run anywhere" (on any machine with Java, cloud, docker images, …​) using the embedded mode.</p>
+It also supports the "run anywhere" (on any machine with Java, cloud, dockerClient images, …​) using the embedded mode.</p>
</div>
<div class="paragraph">
<p>It’s a lightweight, powerful, and enterprise ready platform.</p>
@@ -590,7 +590,7 @@ Framework, but you can easily switch to
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-07-26 16:36:29 +02:00
+Last updated 2018-08-17 21:42:57 +02:00
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/provisioning.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/provisioning.html?rev=1839907&r1=1839906&r2=1839907&view=diff
==============================================================================
--- karaf/site/production/manual/latest/provisioning.html (original)
+++ karaf/site/production/manual/latest/provisioning.html Mon Sep 3 06:10:48 2018
@@ -1484,7 +1484,7 @@ feature3 won’t be installed:</p>
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-11-22 15:12:31 +01:00
+Last updated 2018-08-17 21:42:57 +02:00
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/quick-start.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/quick-start.html?rev=1839907&r1=1839906&r2=1839907&view=diff
==============================================================================
--- karaf/site/production/manual/latest/quick-start.html (original)
+++ karaf/site/production/manual/latest/quick-start.html Mon Sep 3 06:10:48 2018
@@ -759,7 +759,7 @@ karaf@root()></pre>
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-11-22 15:12:31 +01:00
+Last updated 2018-08-17 21:42:57 +02:00
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/remote.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/remote.html?rev=1839907&r1=1839906&r2=1839907&view=diff
==============================================================================
--- karaf/site/production/manual/latest/remote.html (original)
+++ karaf/site/production/manual/latest/remote.html Mon Sep 3 06:10:48 2018
@@ -593,10 +593,15 @@ hostKey = ${karaf.etc}/host.key
# sshRole = admin
#
+# Defines if the SFTP system is enabled or not in the SSH server
+#
+sftpEnabled=true
+
+#
# Self defined key size in 1024, 2048, 3072, or 4096
-# If not set, this defaults to 4096.
+# If not set, this defaults to 2048.
#
-# keySize = 4096
+# keySize = 2048
#
# Specify host key algorithm, defaults to RSA
@@ -639,6 +644,10 @@ and private key pair of the SSHd server.
defined in <code>etc/system.properties</code>. See the [Security section|security] of this user guide for details.</p>
</li>
<li>
+<p><code>sftpEnabled</code> controls if the SSH server start the SFTP system or not. When enabled, Karaf SSHd supports SFTP, meaning
+that you can remotely access to the Karaf filesystem with any sftp clients.</p>
+</li>
+<li>
<p><code>keySize</code> is the key size used by the SSHd server. The possible values are 1024, 2048, 3072, or 4096. The default
value is 1024.</p>
</li>
@@ -958,11 +967,11 @@ Password:
lftp karaf@localhost:~> ls
-rw-r--r-- 1 jbonofre jbonofre 27754 Oct 26 10:50 LICENSE
-rw-r--r-- 1 jbonofre jbonofre 1919 Dec 3 05:34 NOTICE
--rw-r--r-- 1 jbonofre jbonofre 3933 Aug 18 2012 README
--rw-r--r-- 1 jbonofre jbonofre 101041 Dec 3 05:34 RELEASE-NOTES
+-rw-r--r-- 1 jbonofre jbonofre 3933 Aug 18 2012 README.md
+-rw-r--r-- 1 jbonofre jbonofre 101041 Dec 3 05:34 RELEASE-NOTES.md
drwxr-xr-x 1 jbonofre jbonofre 4096 Dec 3 12:51 bin
drwxr-xr-x 1 jbonofre jbonofre 4096 Dec 3 18:57 data
-drwxr-xr-x 1 jbonofre jbonofre 4096 Dec 3 12:51 demos
+drwxr-xr-x 1 jbonofre jbonofre 4096 Dec 3 12:51 examples
drwxr-xr-x 1 jbonofre jbonofre 4096 Dec 3 13:02 deploy
drwxr-xr-x 1 jbonofre jbonofre 4096 Dec 3 17:59 etc
drwxr-xr-x 1 jbonofre jbonofre 4096 Dec 3 13:02 instances
@@ -1029,7 +1038,7 @@ looks for the artifacts (bundles, featur
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-07-26 16:36:29 +02:00
+Last updated 2018-08-17 21:42:57 +02:00
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/scheduler.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/scheduler.html?rev=1839907&r1=1839906&r2=1839907&view=diff
==============================================================================
--- karaf/site/production/manual/latest/scheduler.html (original)
+++ karaf/site/production/manual/latest/scheduler.html Mon Sep 3 06:10:48 2018
@@ -529,13 +529,14 @@ table.CodeRay td.code>pre{padding:0}
</div>
</div>
<div class="paragraph">
-<p>The <code>scheduler</code> feature automatically installs the <code>scheduler</code> Gogo command group, too:</p>
+<p>The <code>scheduler</code> feature automatically installs the <code>scheduler</code> command group, too:</p>
</div>
<div class="listingblock">
<div class="content">
<pre>scheduler:list
scheduler:schedule
-scheduler:unschedule</pre>
+scheduler:unschedule
+scheduler:reschedule</pre>
</div>
</div>
</div>
@@ -722,11 +723,21 @@ public class Demo {
</div>
</div>
</div>
+<div class="sect3">
+<h4 id="_update_scheduling_of_an_existing_job">Update scheduling of an existing job</h4>
+<div class="paragraph">
+<p>You can change the scheduling of an existing job using <code>scheduler:reschedule</code> command.</p>
+</div>
+<div class="paragraph">
+<p>This command works as the schedule command (using the same <code>at</code>, <code>period</code>, <code>cron</code>, …​ options) but taking the job name
+as argument (as given by the <code>scheduler:list</code> command).</p>
+</div>
+</div>
</div>
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-11-22 15:41:44 +01:00
+Last updated 2018-08-17 21:42:57 +02:00
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/scripting.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/scripting.html?rev=1839907&r1=1839906&r2=1839907&view=diff
==============================================================================
--- karaf/site/production/manual/latest/scripting.html (original)
+++ karaf/site/production/manual/latest/scripting.html Mon Sep 3 06:10:48 2018
@@ -1063,7 +1063,7 @@ wait-for-command = {
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-07-26 16:36:29 +02:00
+Last updated 2018-05-18 16:02:21 +02:00
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/security-framework.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/security-framework.html?rev=1839907&r1=1839906&r2=1839907&view=diff
==============================================================================
--- karaf/site/production/manual/latest/security-framework.html (original)
+++ karaf/site/production/manual/latest/security-framework.html Mon Sep 3 06:10:48 2018
@@ -1834,7 +1834,7 @@ for (Principal p : subject.getPrincipals
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-11-15 16:55:26 +01:00
+Last updated 2018-07-31 07:02:52 +02:00
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/security.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/security.html?rev=1839907&r1=1839906&r2=1839907&view=diff
==============================================================================
--- karaf/site/production/manual/latest/security.html (original)
+++ karaf/site/production/manual/latest/security.html Mon Sep 3 06:10:48 2018
@@ -1344,7 +1344,7 @@ can access those.</p>
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-07-26 16:36:29 +02:00
+Last updated 2018-05-18 16:02:21 +02:00
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/start-stop.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/start-stop.html?rev=1839907&r1=1839906&r2=1839907&view=diff
==============================================================================
--- karaf/site/production/manual/latest/start-stop.html (original)
+++ karaf/site/production/manual/latest/start-stop.html Mon Sep 3 06:10:48 2018
@@ -1115,7 +1115,7 @@ Running ...</pre>
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-07-26 16:36:29 +02:00
+Last updated 2018-05-18 16:02:21 +02:00
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/tuning.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/tuning.html?rev=1839907&r1=1839906&r2=1839907&view=diff
==============================================================================
--- karaf/site/production/manual/latest/tuning.html (original)
+++ karaf/site/production/manual/latest/tuning.html Mon Sep 3 06:10:48 2018
@@ -766,7 +766,7 @@ ones from the bundles.</p>
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-11-15 16:55:26 +01:00
+Last updated 2018-07-31 07:02:52 +02:00
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/update-notes.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/update-notes.html?rev=1839907&r1=1839906&r2=1839907&view=diff
==============================================================================
--- karaf/site/production/manual/latest/update-notes.html (original)
+++ karaf/site/production/manual/latest/update-notes.html Mon Sep 3 06:10:48 2018
@@ -850,7 +850,7 @@ As soon as you use a "new style" feature
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-07-26 16:36:29 +02:00
+Last updated 2018-05-18 16:02:21 +02:00
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/urls.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/urls.html?rev=1839907&r1=1839906&r2=1839907&view=diff
==============================================================================
--- karaf/site/production/manual/latest/urls.html (original)
+++ karaf/site/production/manual/latest/urls.html Mon Sep 3 06:10:48 2018
@@ -974,7 +974,7 @@ accessed bypassing HTTP proxy</p>
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-11-22 15:12:31 +01:00
+Last updated 2018-08-17 21:42:57 +02:00
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/webconsole.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/webconsole.html?rev=1839907&r1=1839906&r2=1839907&view=diff
==============================================================================
--- karaf/site/production/manual/latest/webconsole.html (original)
+++ karaf/site/production/manual/latest/webconsole.html Mon Sep 3 06:10:48 2018
@@ -599,7 +599,7 @@ Right now, the WebConsole doesn’t
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-07-26 16:36:29 +02:00
+Last updated 2018-05-18 16:02:21 +02:00
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/webcontainer.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/webcontainer.html?rev=1839907&r1=1839906&r2=1839907&view=diff
==============================================================================
--- karaf/site/production/manual/latest/webcontainer.html (original)
+++ karaf/site/production/manual/latest/webcontainer.html Mon Sep 3 06:10:48 2018
@@ -813,6 +813,16 @@ reverse domain name convention.</p>
<p>You can note the <code>webbundle</code> prefix, and the <code>Bundle-SymbolicName</code> and <code>Web-ContextPath</code> headers on the URL.</p>
</div>
</div>
+<div class="sect5">
+<h6 id="_http_proxy">HTTP proxy</h6>
+<div class="paragraph">
+<p>Apache Karaf provides a HTTP proxy service. It allows you to proxy any HTTP URLs within Karaf. It allows you to expose
+remote web applications in Karaf.</p>
+</div>
+<div class="paragraph">
+<p>You can use the Karaf <code>ProxyService</code> programmatically, or via the corresponding shell commands and MBeans.</p>
+</div>
+</div>
</div>
<div class="sect4">
<h5 id="_commands">Commands</h5>
@@ -891,6 +901,46 @@ corresponding to the bundle ID (as displ
</div>
</div>
</div>
+<div class="sect5">
+<h6 id="__code_http_proxies_code"><code>http:proxies</code></h6>
+<div class="paragraph">
+<p>The <code>http:proxies</code> command list the configured HTTP proxies:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre>karaf@root()> http:proxies
+karaf@root()> http:proxies
+URL â ProxyTo
+âââââââââââââ¼âââââââââââââââââââââââââââââââââââââ
+/webconsole â http://localhost:8181/system/console</pre>
+</div>
+</div>
+</div>
+</div>
+<div class="sect4">
+<h5 id="__code_http_proxy_add_code"><code>http:proxy-add</code></h5>
+<div class="paragraph">
+<p>The <code>http:proxy-add</code> registers a new HTTP proxy. For instance, you can proxy the Karaf WebConsole on another URL of your choice using:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre>karaf@root()> http:proxy-add /webconsole http://localhost:8181/system/console</pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Karaf HTTP Proxy can proxy any URL, like a backend running on Docker or a remote URL.</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="__code_http_proxy_remove_code"><code>http:proxy-remove</code></h5>
+<div class="paragraph">
+<p>The <code>http:proxy-remove</code> removes an existing HTTP proxy:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre>karaf@root()> http:proxy-remove /webconsole</pre>
+</div>
+</div>
</div>
<div class="sect4">
<h5 id="_jmx_httpmbean">JMX HttpMBean</h5>
@@ -924,6 +974,35 @@ corresponding to the bundle ID (as displ
</li>
</ul>
</div>
+<div class="paragraph">
+<p>The <code>Proxies</code> attribute provides a tabular data providing the list of HTTP proxies including:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p><code>URL</code> is the proxy URL.</p>
+</li>
+<li>
+<p><code>proxyTo</code> is the proxy target.</p>
+</li>
+<li>
+<p><code>prefix</code> is optional proxy prefix.</p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect5">
+<h6 id="_operations">Operations</h6>
+<div class="ulist">
+<ul>
+<li>
+<p><code>addProxy(url, proxyTo, prefix)</code> registers a new HTTP proxy.</p>
+</li>
+<li>
+<p><code>removeProxy(url)</code> removes an existing HTTP proxy.</p>
+</li>
+</ul>
+</div>
</div>
</div>
<div class="sect4">
@@ -963,7 +1042,7 @@ corresponding to the bundle ID (as displ
</div>
</div>
<div class="sect5">
-<h6 id="_operations">Operations</h6>
+<h6 id="_operations_2">Operations</h6>
<div class="ulist">
<ul>
<li>
@@ -986,7 +1065,7 @@ corresponding to the bundle ID (as displ
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-08-09 13:23:59 +02:00
+Last updated 2018-08-17 21:42:57 +02:00
</div>
</div>
</body>
Modified: karaf/site/production/manual/latest/writing-tests.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/writing-tests.html?rev=1839907&r1=1839906&r2=1839907&view=diff
==============================================================================
--- karaf/site/production/manual/latest/writing-tests.html (original)
+++ karaf/site/production/manual/latest/writing-tests.html Mon Sep 3 06:10:48 2018
@@ -513,441 +513,13 @@ table.CodeRay td.code>pre{padding:0}
<div class="sect2">
<h3 id="_writing_integration_tests">Writing integration tests</h3>
<div class="paragraph">
-<p>We recommend using <a href="http://team.ops4j.org/wiki/display/paxexam/Pax+Exam">PAX Exam</a> to write integration tests when developing applications using Karaf.</p>
-</div>
-<div class="paragraph">
-<p>Starting with Karaf 3.0 we’ve also included a component briding between Karaf and Pax Exam making it easier to write integration tests
-for Karaf or Karaf based distributions.</p>
-</div>
-<div class="sect3">
-<h4 id="_introduction">Introduction</h4>
-<div class="paragraph">
-<p>Pax Exam directly supports Karaf as a test container.</p>
-</div>
-<div class="paragraph">
-<p>To make use of this new framework simply add the following dependencies into your integration tests pom.xml:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre><dependency>
- <groupId>org.ops4j.pax.exam</groupId>
- <artifactId>pax-exam-container-karaf</artifactId>
- <version>4.7.0</version>
- <scope>test</scope>
-</dependency>
-<dependency>
- <groupId>org.ops4j.pax.exam</groupId>
- <artifactId>pax-exam-junit4</artifactId>
- <version>4.7.0</version>
- <scope>test</scope>
-</dependency>
-<dependency>
- <groupId>org.apache.geronimo.specs</groupId>
- <artifactId>geronimo-atinject-1.0_spec</artifactId>
- <version>1.0</version>
- <scope>test</scope>
-</dependency></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>As a next step you need to reference the distribution you want to run your tests on.
-For instance, if you want to run your tests on Karaf the following section would be required in the integration tests pom.xml:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre><dependency>
- <groupId>org.apache.karaf</groupId>
- <artifactId>apache-karaf</artifactId>
- <version>4.0.0</version>
- <type>tar.gz</type>
- <scope>test</scope>
-</dependency></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>If you want to make use of Exams "versionAsInProject" feature you also need to add the following section:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre><build>
- <plugins>
- <plugin>
- <groupId>org.apache.servicemix.tooling</groupId>
- <artifactId>depends-maven-plugin</artifactId>
- <version>1.2</version>
- <executions>
- <execution>
- <id>generate-depends-file</id>
- <goals>
- <goal>generate-depends-file</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
- </plugins>
-</build></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>With this done we can start writing our first test case:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre>import static junit.framework.Assert.assertTrue;
-import static org.ops4j.pax.exam.options.KarafDistributionOption.karafDistributionConfiguration;
-import static org.ops4j.pax.exam.CoreOptions.maven;
-
-import org.junit.Test;
-import org.junit.runner.RunWith;
-import org.ops4j.pax.exam.Option;
-import org.ops4j.pax.exam.junit.Configuration;
-import org.ops4j.pax.exam.junit.ExamReactorStrategy;
-import org.ops4j.pax.exam.junit.JUnit4TestRunner;
-import org.ops4j.pax.exam.spi.reactors.AllConfinedStagedReactorFactory;
-
-@RunWith(JUnit4TestRunner.class)
-@ExamReactorStrategy(AllConfinedStagedReactorFactory.class)
-public class VersionAsInProjectKarafTest {
-
- @Configuration
- public Option[] config() {
- return new Option[]{ karafDistributionConfiguration().frameworkUrl(
- maven().groupId("org.apache.karaf").artifactId("apache-karaf").type("tar.gz").versionAsInProject())
- .karafVersion("4.0.0").name("Apache Karaf")};
- }
-
- @Test
- public void test() throws Exception {
- assertTrue(true);
- }
-}</pre>
-</div>
-</div>
-</div>
-<div class="sect3">
-<h4 id="_commands">Commands</h4>
-<div class="sect4">
-<h5 id="_karafdistributionconfigurationoption">KarafDistributionConfigurationOption</h5>
-<div class="paragraph">
-<p>The framework itself is non of the typical runtimes you define normally in Pax-Exam.</p>
-</div>
-<div class="paragraph">
-<p>Instead you define a packed distribution as zip or tar.gz. Those distributions have to follow the Karaf packaging style.
-Therefore instead of Karaf you can also enter Servicemix or Geronimo.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre>new KarafDistributionConfigurationOption(
- "mvn:org.apache.karaf/apache-karaf/4.0.0/zip", // artifact to unpack and use
- "karaf", // name; display only
- "4.0.0") // the karaf version; this one is relevant since the startup script differs between versions</pre>
-</div>
-</div>
-<div class="paragraph">
-<p>or for Servicemix e.g.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre>new KarafDistributionConfigurationOption(
- "mvn:org.apache.servicemix/apache-servicemix/4.4.0/zip", // artifact to unpack and use
- "servicemix", // name; display only
- "2.2.4") // the karaf version; this one is relevant since the startup script differs between versions</pre>
-</div>
-</div>
-<div class="paragraph">
-<p>As an alternative you can also use the maven url resolvers.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre>...
-<dependency>
- <groupId>org.apache.karaf</groupId>
- <artifactId>apache-karaf</artifactId>
- <type>zip</type>
- <classifier>bin</classifier>
- <scope>test</scope>
-</dependency>
-...
-<plugin>
- <groupId>org.apache.servicemix.tooling</groupId>
- <artifactId>depends-maven-plugin</artifactId>
- <executions>
- <execution>
- <id>generate-depends-file</id>
- <goals>
- <goal>generate-depends-file</goal>
- </goals>
- </execution>
- </executions>
-</plugin></pre>
-</div>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre>@Configuration
- public Option[] config() {
- return new Option[]{ karafDistributionConfiguration().frameworkUrl(
- maven().groupId("org.apache.karaf").artifactId("apache-karaf").type("zip")
- .classifier("bin").versionAsInProject()) };
- }</pre>
-</div>
-</div>
-<div class="paragraph">
-<p>In addition to the framework specification options this option also includes various additional configuration options.
-Those options are used to configure the internal properties of the runtime environment.</p>
-</div>
-<div class="sect5">
-<h6 id="_unpack_directory">Unpack Directory</h6>
-<div class="paragraph">
-<p>Pax-Exam Testframework extracts the distribution you specify by default into the paxexam config directory.
-If you would like to unpack them into your target directory simply extend the KarafDistributionConfigurationOption with the unpackDirectoryFile like shown in the next example:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre>@Configuration
-public Option[] config() {
- return new Option[]{ karafDistributionConfiguration("mvn:org.apache.karaf/apache-karaf/4.0.0/zip")
- .unpackDirectory(new File("target/paxexam/unpack/")) };
-}</pre>
-</div>
-</div>
-</div>
-<div class="sect5">
-<h6 id="_use_deploy_folder">Use Deploy Folder</h6>
-<div class="paragraph">
-<p>Karaf distributions come by default with a deploy folder where you can simply drop artifacts to be deployed.
-In some distributions this folder might have been removed. To still be able to deploy your additional artifacts using
-default Pax Exam ProvisionOptions you can configure PaxExam Karaf to use a features.xml (which is directly added to
-your <code>etc/org.apache.karaf.features.cfg</code>) for those deploys. To use it instead of the deploy folder simply do the following:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre>@Configuration
-public Option[] config() {
- return new Option[]{ karafDistributionConfiguration("mvn:org.apache.karaf/apache-karaf/4.0.0/zip")
- .useDeployFolder(false)) };
-}</pre>
-</div>
-</div>
-</div>
-</div>
-<div class="sect4">
-<h5 id="_karafdistributionkitconfigurationoption">KarafDistributionKitConfigurationOption</h5>
-<div class="paragraph">
-<p>The KarafDistributionKitConfigurationOption is almost equal to all variations of the KarafDistributionConfigurationOption
-with the exception that it requires to have set a platform and optionally the executable and the files which should be
-made executable additionally. By default it is bin/karaf for nix platforms and bin\karaf.bat for windows platforms.
-The executable option comes in handy if you like to e.g. embed an own java runtime. You should add a windows AND a
-linux Kit definition. The framework automatically takes the correct one then. The following shows a simple example for Karaf:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre>@Configuration
-public Option[] config() {
- return new Option[]{
- new KarafDistributionKitConfigurationOption("mvn:org.apache.karaf/apache-karaf/4.0.0/zip",
- Platform.WINDOWS).executable("bin\\karaf.bat").filesToMakeExecutable("bin\\admin.bat"),
- new KarafDistributionKitConfigurationOption("mvn:org.apache.karaf/apache-karaf/4.0.0/tar.gz", "karaf",
- Platform.NIX).executable("bin/karaf").filesToMakeExecutable("bin/admin") };
-}</pre>
-</div>
-</div>
-</div>
-<div class="sect4">
-<h5 id="_karafdistributionconfigurationfileputoption">KarafDistributionConfigurationFilePutOption</h5>
-<div class="paragraph">
-<p>The option replaces or adds an option to one of Karaf’s configuration files:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre>new KarafDistributionConfigurationFilePutOption(
- "etc/config.properties", // config file to modify based on karaf.base
- "karaf.framework", // key to add or change
- "equinox") // value to add or change</pre>
-</div>
-</div>
-<div class="paragraph">
-<p>This option could also be used in "batch-mode" via a property file. Therefore use the
-KarafDistributionOption#editConfigurationFilePut(final String configurationFilePath, File source, String…​ keysToUseFromSource) method.
-This option allows you to add all properties found in the file as KarafDistributionConfigurationFilePutOption. If you configure the "keysToUseFromSource" array only the keys specified there will be used. That way you can easily put an entire range of properties.</p>
-</div>
-</div>
-<div class="sect4">
-<h5 id="_karafdistributionconfigurationfileextendoption">KarafDistributionConfigurationFileExtendOption</h5>
-<div class="paragraph">
-<p>This one does the same as the KarafDistributionConfigurationFilePutOption option with the one difference that it either
-adds or appends a specific property. This is especially useful if you do not want to store the entire configuration in the line in your code.</p>
-</div>
-<div class="paragraph">
-<p>This option could also be extended in "batch-mode" via a property file. Therefore use the
-KarafDistributionOption#editConfigurationFileExtend(final String configurationFilePath, File source, String…​ keysToUseFromSource) method. This option allows you to extend all properties found in the file as KarafDistributionConfigurationFileExtendOption. If you configure the "keysToUseFromSource" array only the keys specified there will be used. That way you can easily extend an entire range of properties.</p>
-</div>
-</div>
-<div class="sect4">
-<h5 id="_karafdistributionconfigurationfilereplacementoption">KarafDistributionConfigurationFileReplacementOption</h5>
-<div class="paragraph">
-<p>The file replacement option allows you to simply replace a file in you Karaf distribution with a different file:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre>new KarafDistributionConfigurationFileReplacementOption("etc/tests.cfg", new File(
- "src/test/resources/BaseKarafDefaultFrameworkDuplicatedPropertyEntryTestSecondKey"));</pre>
-</div>
-</div>
-</div>
-<div class="sect4">
-<h5 id="_provisionoption">ProvisionOption</h5>
-<div class="paragraph">
-<p>The new test container fully supports the provision option. Feel free to use any option provided here by paxexam itself (e.g. Maven resolver).
-All those artifacts are copied into the deploy folder of your Karaf distribution before it is started. Therefore they all will be available after startup.</p>
-</div>
-</div>
-<div class="sect4">
-<h5 id="_karafdistributionconfigurationconsoleoption">KarafDistributionConfigurationConsoleOption</h5>
-<div class="paragraph">
-<p>The test container supports options to configure if the localConsole and/or the remote shell should be started. Possible options to do so are shown in the following two examples:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre>@Configuration
-public Option[] config() {
- return new Option[]{ karafDistributionConfiguration("mvn:org.apache.karaf/apache-karaf/4.0.0/zip"),
- configureConsole().ignoreLocalConsole().startRemoteShell() };
-}</pre>
-</div>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre>@Configuration
-public Option[] config() {
- return new Option[]{ karafDistributionConfiguration("mvn:org.apache.karaf/apache-karaf/4.0.0/zip"),
- configureConsole().startLocalConsole(), configureConsole().ignoreRemoteShell() };
-}</pre>
-</div>
-</div>
-</div>
-<div class="sect4">
-<h5 id="_vmoption">VMOption</h5>
-<div class="paragraph">
-<p>The Karaf container passes the vmOptions now through to the Karaf environment. They are directly passed to the startup of the container.
-In addition the KarafDistributionOption helper has two methods (debugConfiguration() and debugConfiguration(String port, boolean hold)) to activate debugging quickly.</p>
-</div>
-</div>
-<div class="sect4">
-<h5 id="_logleveloption">LogLevelOption</h5>
-<div class="paragraph">
-<p>The Paxexam-Karaf specific log-level option allows an easy way to set a specific log-level for the Karaf based distribution. For example simply add the following to your Option[] array to get TRACE logging:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre>import static org.openengsb.labs.paxexam.karaf.options.KarafDistributionOption.logLevel;
-...
-@Configuration
-public Option[] config() {
- return new Option[]{ karafDistributionConfiguration("mvn:org.apache.karaf/apache-karaf/4.0.0/zip"),
- logLevel(LogLevel.TRACE) };
-}</pre>
-</div>
-</div>
-</div>
-<div class="sect4">
-<h5 id="_donotmodifylogoption">DoNotModifyLogOption</h5>
-<div class="paragraph">
-<p>The option to modify the logging behavior requires that the container automatically modifies the logging configuration file.
-If you would like to suppress this behavior simply set the doNotModifyLogConfiguration option as shown in the next example:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre>@Configuration
-public Option[] config() {
- return new Option[]{ karafDistributionConfiguration("mvn:org.apache.karaf/apache-karaf/4.0.0/zip"),
- doNotModifyLogConfiguration() };
-}</pre>
-</div>
-</div>
-</div>
-<div class="sect4">
-<h5 id="_keepruntimefolderoption">KeepRuntimeFolderOption</h5>
-<div class="paragraph">
-<p>Per default the test container removes all test runner folders. If you want to keep them for any reasons (e.g. check why a test fails) set the following option:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre>@Configuration
-public Option[] config() {
- return new Option[]{ karafDistributionConfiguration("mvn:org.apache.karaf/apache-karaf/4.0.0/zip"),
- keepRuntimeFolder() };
-}</pre>
-</div>
-</div>
-</div>
-<div class="sect4">
-<h5 id="_featuresscannerprovisionoption">FeaturesScannerProvisionOption</h5>
-<div class="paragraph">
-<p>The FeaturesScannerProvisionOption (e.g. CoreOption.scanFeature()) are directly supported by the Paxexam Karaf Testframework.</p>
-</div>
-</div>
-<div class="sect4">
-<h5 id="_bootdelegationoption">BootDelegationOption</h5>
-<div class="paragraph">
-<p>The BootDelegationOption as known from PaxExam is also supported added the boot delegation string directly into the correct property files.</p>
-</div>
-</div>
-<div class="sect4">
-<h5 id="_systempackageoption">SystemPackageOption</h5>
-<div class="paragraph">
-<p>The Standard Exam SystemPackageOption is implemented by adding those packages to "org.osgi.framework.system.packages.extra" of the config.properties file.</p>
-</div>
-</div>
-<div class="sect4">
-<h5 id="_bootclasspathlibraryoption">BootClasspathLibraryOption</h5>
-<div class="paragraph">
-<p>The BootClasspathLibraryOption is honored by copying the urls into the lib directory where they are automatically taken and worked on.</p>
-</div>
-</div>
-<div class="sect4">
-<h5 id="_exambundlesstartlevel">ExamBundlesStartLevel</h5>
-<div class="paragraph">
-<p>The ExamBundlesStartLevel can be used to configure the start lvl of the bundles provided by the test-frameworks features.xml. Simply use it as a new option like:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre>@Configuration
-public Option[] config() {
- return new Option[]{ karafDistributionConfiguration("mvn:org.apache.karaf/apache-karaf/4.0.0/zip"),
- useOwnExamBundlesStartLevel(4) };
-}</pre>
-</div>
-</div>
-</div>
-</div>
-<div class="sect3">
-<h4 id="_driver">Driver</h4>
-<div class="paragraph">
-<p>Drivers are the parts of the framework responsible for running the Karaf Based Distribution. By default the already in
-the overview explained KarafDistributionConfigurationOption uses a JavaRunner starting the distribution platform independent
-but not using the scripts in the distribution. If you like to test those scripts too an option is to to use the ScriptRunner via the KarafDistributionKitConfigurationOption instead.</p>
-</div>
-<div class="sect4">
-<h5 id="_javarunner">JavaRunner</h5>
-<div class="paragraph">
-<p>The JavaRunner builds the entire command itself and executes Karaf in a new JVM. This behavior is more or less exactly
-what the default runner does. Simply use the KarafDistributionConfigurationOption as explained in the Commands section to use this.</p>
-</div>
-</div>
-<div class="sect4">
-<h5 id="_scriptrunner">ScriptRunner</h5>
-<div class="paragraph">
-<p>The script runner has the disadvantage over the java runner that it is also platform dependent.
-The advantage though is that you can also test your specific scripts. To use it follow the explanation of the KarafDistributionKitConfigurationOption in the Commands section.</p>
-</div>
-</div>
+<p>See [examples/karaf-itest-example/README.md]</p>
</div>
</div>
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-07-26 16:36:29 +02:00
+Last updated 2018-08-17 21:42:57 +02:00
</div>
</div>
</body>