Author: veithen
Date: Thu Apr 9 19:10:40 2009
New Revision: 763771
URL: http://svn.apache.org/viewvc?rev=763771&view=rev
Log:
Some formatting changes in the docs.
Modified:
webservices/commons/trunk/modules/transport/src/site/apt/jms.apt
Modified: webservices/commons/trunk/modules/transport/src/site/apt/jms.apt
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/transport/src/site/apt/jms.apt?rev=763771&r1=763770&r2=763771&view=diff
==============================================================================
--- webservices/commons/trunk/modules/transport/src/site/apt/jms.apt (original)
+++ webservices/commons/trunk/modules/transport/src/site/apt/jms.apt Thu Apr 9
19:10:40 2009
@@ -27,59 +27,59 @@
<<<axis2.xml>>>. The syntax is the same for the transport listener and
sender. For example,
the following configuration sets up the JMS listener with three connection
factories:
++----------------------------+
+<transportReceiver name="jms"
class="org.apache.axis2.transport.jms.JMSListener">
+ <parameter name="myTopicConnectionFactory" locked="false">
+ <parameter name="java.naming.factory.initial"
locked="false">org.apache.activemq.jndi.ActiveMQInitialContextFactory</parameter>
+ <parameter name="java.naming.provider.url"
locked="false">tcp://localhost:61616</parameter>
+ <parameter name="transport.jms.ConnectionFactoryJNDIName"
locked="false">TopicConnectionFactory</parameter>
+ </parameter>
+ <parameter name="myQueueConnectionFactory" locked="false">
+ <parameter name="java.naming.factory.initial"
locked="false">org.apache.activemq.jndi.ActiveMQInitialContextFactory</parameter>
+ <parameter name="java.naming.provider.url"
locked="false">tcp://localhost:61616</parameter>
+ <parameter name="transport.jms.ConnectionFactoryJNDIName"
locked="false">QueueConnectionFactory</parameter>
+ </parameter>
+ <parameter name="default" locked="false">
+ <parameter name="java.naming.factory.initial"
locked="false">org.apache.activemq.jndi.ActiveMQInitialContextFactory</parameter>
+ <parameter name="java.naming.provider.url"
locked="false">tcp://localhost:61616</parameter>
+ <parameter name="transport.jms.ConnectionFactoryJNDIName"
locked="false">QueueConnectionFactory</parameter>
+ </parameter>
+</transportReceiver>
++----------------------------+
+
+ If a connection factory named <<<default>>> (as shown above) is defined,
this would be used for services which does
+ not explicitly specify the connection factory that should be used. The
<<<services.xml>>> of a service should indicate
+ the connection factory and the destination name to be associated with. If a
destination is not specified, the
+ implementation would create a JMS Queue with the service name. The JMS
destination should ideally be created
+ and administered through the JMS provider utilities.
+
+ For the JMS sender, only the outer element is different:
+
+----------------------------+
- <transportReceiver name="jms"
class="org.apache.axis2.transport.jms.JMSListener">
- <parameter name="myTopicConnectionFactory" locked="false">
- <parameter name="java.naming.factory.initial"
locked="false">org.apache.activemq.jndi.ActiveMQInitialContextFactory</parameter>
- <parameter name="java.naming.provider.url"
locked="false">tcp://localhost:61616</parameter>
- <parameter name="transport.jms.ConnectionFactoryJNDIName"
locked="false">TopicConnectionFactory</parameter>
- </parameter>
- <parameter name="myQueueConnectionFactory" locked="false">
- <parameter name="java.naming.factory.initial"
locked="false">org.apache.activemq.jndi.ActiveMQInitialContextFactory</parameter>
- <parameter name="java.naming.provider.url"
locked="false">tcp://localhost:61616</parameter>
- <parameter name="transport.jms.ConnectionFactoryJNDIName"
locked="false">QueueConnectionFactory</parameter>
- </parameter>
- <parameter name="default" locked="false">
- <parameter name="java.naming.factory.initial"
locked="false">org.apache.activemq.jndi.ActiveMQInitialContextFactory</parameter>
- <parameter name="java.naming.provider.url"
locked="false">tcp://localhost:61616</parameter>
- <parameter name="transport.jms.ConnectionFactoryJNDIName"
locked="false">QueueConnectionFactory</parameter>
- </parameter>
- </transportReceiver>
+<transportSender name="jms" class="org.apache.axis2.transport.jms.JMSSender">
+ ...
+</transportSender>
+----------------------------+
- If a connection factory named "default" (as shown above) is defined, this
would be used for services which does
- not explicitly specify the connection factory that should be used. The
services.xml of a service should indicate
- the connection factory and the destination name to be associated with. If
a destination is not specified, the
- implementation would create a JMS Queue with the service name. The JMS
destination should ideally be created
- and administered through the JMS provider utilities.
+ As explained below, for the JMS sender configuration it is not mandatory
(but recommended) to specify
+ connection factories.
+
+ The parameters that may appear in a connection factory configuration are
defined as follows:
+
+ [<<<java.naming.factory.initial>>>]
+ TODO
- For the JMS sender, only the outer element is different:
+ [<<<java.naming.provider.url>>>]
+ TODO
-+----------------------------+
- <transportSender name="jms"
class="org.apache.axis2.transport.jms.JMSSender">
- ...
- </transportSender>
-+----------------------------+
-
- As explained below, for the JMS sender configuration it is not mandatory
(but recommended) to specify
- connection factories.
+ [<<<transport.jms.ConnectionFactoryJNDIName>>>]
+ TODO
- The parameters that may appear in a connection factory configuration are
defined as follows:
+ [<<<transport.jms.JMSSpecVersion>>>]
+ TODO
- [java.naming.factory.initial]
- TODO
-
- [java.naming.provider.url]
- TODO
-
- [transport.jms.ConnectionFactoryJNDIName]
- TODO
-
- [transport.jms.JMSSpecVersion]
- TODO
-
- [transport.jms.CacheLevel]
- TODO
+ [<<<transport.jms.CacheLevel>>>]
+ TODO
* {JMS connections and message dispatching}
@@ -115,20 +115,20 @@
* {Service configuration}
- [transport.jms.ConnectionFactory (Optional)]
- The JMS connection factory definition (from axis2.xml) to be used to
+ [<<<transport.jms.ConnectionFactory>>> (Optional)]
+ The JMS connection factory definition (from <<<axis2.xml>>>) to be used to
listen for messages for this service.
- [transport.jms.Destination (Optional)]
+ [<<<transport.jms.Destination>>> (Optional)]
The JMS destination name (Defaults to a Queue with the service name).
- [transport.jms.DestinationType (Optional)]
+ [<<<transport.jms.DestinationType>>> (Optional)]
The JMS destination type. Accept values 'queue' or 'topic' (default: queue).
- [transport.jms.ReplyDestination (Optional)]
+ [<<<transport.jms.ReplyDestination>>> (Optional)]
The destination where a reply will be posted.
- [transport.jms.ContentType (Optional)]
+ [<<<transport.jms.ContentType>>> (Optional)]
Specifies how the transport listener should determine the content type of
received messages.
This can either be a simple string value, in which case the transport
listener assumes that
the received messages always have the specified content type, or a set of
rules as in the following example:
@@ -145,15 +145,15 @@
The rules are evaluated in turn until the first matches. The following rule
types are defined:
- [jmsProperty]
+ [<<<jmsProperty>>>]
Extract the content type from the specified message property.
- [bytesMessage\
- textMessage]
+ [<<<bytesMessage>>>\
+ <<<textMessage>>>]
Match the corresponding message type. The content type is specified as the
value of
the rule, e.g. <<<\<bytesMessage\>binary/octet-stream\</bytesMessage\>>>>
- [default]
+ [<<<default>>>]
Defines the default content type. This rule always matches and should
therefore
be the last rule in the rule set.
@@ -171,17 +171,17 @@
+--------------------------------------------+
This choice preserves compatibility with previous versions of the JMS
transport. Note however
- that "Content-Type" is not a valid JMS property name and will not work with
some JMS providers.
+ that <<<Content-Type>>> is not a valid JMS property name and will not work
with some JMS providers.
- [Wrapper (Optional)]
+ [<<<Wrapper>>> (Optional)]
The wrapper element for pure text or binary messages. Note that this
parameter is
- actually not JMS specific but recognized by the message builders for
text/plain and
- application/octet-stream (which are the respective default content types for
JMS text
+ actually not JMS specific but recognized by the message builders for
<<<text/plain>>> and
+ <<<application/octet-stream>>> (which are the respective default content
types for JMS text
and binary messages).
[]
- Sample services.xml:
+ Sample <<<services.xml>>>:
+--------------------------------------------+
<service name="echo">
@@ -207,34 +207,32 @@
<<<jms-dest>>> is the JNDI name of the destination to send the message to.
The parameters are
defined as follows:
- [transport.jms.ConnectionFactoryJNDIName]
- TODO
+ [<<<transport.jms.ConnectionFactoryJNDIName>>>]
+ TODO
- [transport.jms.DestinationType]
- TODO
+ [<<<transport.jms.DestinationType>>>]
+ TODO
- [transport.jms.ReplyDestination]
- TODO
+ [<<<transport.jms.ReplyDestination>>>]
+ TODO
- [transport.jms.ReplyDestinationType]
- TODO
+ [<<<transport.jms.ReplyDestinationType>>>]
+ TODO
- [transport.jms.ContentTypeProperty]
- The name of the message property to store the content type of messages sent
to the endpoint.
+ [<<<transport.jms.ContentTypeProperty>>>]
+ The name of the message property to store the content type of messages
sent to the endpoint.
- [java.naming.factory.initial]
- TODO
+ [<<<java.naming.factory.initial>>>]
+ TODO
- [java.naming.provider.url]
- TODO
+ [<<<java.naming.provider.url>>>]
+ TODO
- [java.naming.security.principal]
- TODO
+ [<<<java.naming.security.principal>>>]
+ TODO
- [java.naming.security.credentials]
- TODO
-
- []
+ [java.naming.security.credentials]
+ TODO
The JMS sender will check if the transport configuration contains a
connection factory compatible
with the settings specified in the endpoint URL. If a matching configuration
is found, the
