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 2015/02/10 16:15:28 UTC
karaf git commit: [KARAF-3516] Update jms documentation
Repository: karaf
Updated Branches:
refs/heads/karaf-3.0.x 215feb40c -> 0d06db1d9
[KARAF-3516] Update jms documentation
Project: http://git-wip-us.apache.org/repos/asf/karaf/repo
Commit: http://git-wip-us.apache.org/repos/asf/karaf/commit/0d06db1d
Tree: http://git-wip-us.apache.org/repos/asf/karaf/tree/0d06db1d
Diff: http://git-wip-us.apache.org/repos/asf/karaf/diff/0d06db1d
Branch: refs/heads/karaf-3.0.x
Commit: 0d06db1d9473b0e4514276879682dd1ea763e476
Parents: 215feb4
Author: Jean-Baptiste Onofré <jb...@apache.org>
Authored: Tue Feb 10 16:14:32 2015 +0100
Committer: Jean-Baptiste Onofré <jb...@apache.org>
Committed: Tue Feb 10 16:14:32 2015 +0100
----------------------------------------------------------------------
manual/src/main/webapp/users-guide/jms.conf | 24 +++++++++++++++++-------
1 file changed, 17 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/karaf/blob/0d06db1d/manual/src/main/webapp/users-guide/jms.conf
----------------------------------------------------------------------
diff --git a/manual/src/main/webapp/users-guide/jms.conf b/manual/src/main/webapp/users-guide/jms.conf
index c9d6896..e1fd626 100644
--- a/manual/src/main/webapp/users-guide/jms.conf
+++ b/manual/src/main/webapp/users-guide/jms.conf
@@ -56,30 +56,40 @@ DESCRIPTION
Create a JMS connection factory.
SYNTAX
- jms:create [options] name
+ jms:create [options] name
ARGUMENTS
name
The JMS connection factory name
OPTIONS
- -u, --url
- The JMS URL. NB: for WebsphereMQ type, the URL is hostname/port/queuemanager/channel
- --help
- Display this help message
-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)
+ --help
+ Display this help message
+ --url
+ URL of the JMS broker. For WebsphereMQ type, the URL is hostname/port/queuemanager/channel
+ (defaults to tcp://localhost:61616)
+ -p, --password
+ Password to connect to the JMS broker
+ (defaults to karaf)
{code}
* the {{name}} argument is required. It's the name of the JMS connection factory. The name is used to identify the connection factory, and to create the connection factory definition file ({{deploy/connectionfactory-[name].xml}}).
* the {{-t}} ({{--type}}) option is required. It's the type of the JMS connection factory. Currently on {{activemq}} and {{webspheremq}} type are supported. If you want to use another type of JMS connection factory, you can create the {{deploy/connectionfactory-[name].xml}} file by hand (using one as template).
-* the {{-u}} ({{--url}}) option is required. It's the URL used by the JMS connection factory to connect to the broker. If the type is {{activemq}}, the URL looks like {{tcp://localhost:61616}}. If the type is {{webspheremq}}, the URL looks like {{host/port/queuemanager/channel}}.
+* the {{--url}} option is required. It's the URL used by the JMS connection factory to connect to the broker. If the type is {{activemq}}, the URL looks like {{tcp://localhost:61616}}. If the type is {{webspheremq}}, the URL looks like {{host/port/queuemanager/channel}}.
+* the {{-u}} ({{--username}}) option is optional (karaf by default). In the case of the broker requires authentication, it's the username used.
+* the {{-p}} ({{--password}}) option is optional (karaf by default). In the case of the broker requires authentication, it's the password used.
For instance, to create a JMS connection factory for a Apache ActiveMQ broker, you can do:
{code}
-karaf@root()> jms:create -t activemq -u tcp://localhost:61616 test
+karaf@root()> jms:create -t activemq --url tcp://localhost:61616 test
{code}
{warning}