Author: veithen
Date: Sun Sep 28 10:58:31 2008
New Revision: 699870
URL: http://svn.apache.org/viewvc?rev=699870&view=rev
Log:
Added skeleton site structure and filled in some documentation (basically copy
& paste from Synapse).
Added:
webservices/commons/trunk/modules/transport/src/
webservices/commons/trunk/modules/transport/src/site/
webservices/commons/trunk/modules/transport/src/site/site.xml
webservices/commons/trunk/modules/transport/src/site/xdoc/
webservices/commons/trunk/modules/transport/src/site/xdoc/http.xml
webservices/commons/trunk/modules/transport/src/site/xdoc/jms.xml
webservices/commons/trunk/modules/transport/src/site/xdoc/local.xml
webservices/commons/trunk/modules/transport/src/site/xdoc/mail.xml
webservices/commons/trunk/modules/transport/src/site/xdoc/tcp.xml
webservices/commons/trunk/modules/transport/src/site/xdoc/xmpp.xml
Removed:
webservices/commons/trunk/modules/transport/modules/jms/src/main/java/org/apache/axis2/transport/jms/README.txt
Added: webservices/commons/trunk/modules/transport/src/site/site.xml
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/transport/src/site/site.xml?rev=699870&view=auto
==============================================================================
--- webservices/commons/trunk/modules/transport/src/site/site.xml (added)
+++ webservices/commons/trunk/modules/transport/src/site/site.xml Sun Sep 28
10:58:31 2008
@@ -0,0 +1,44 @@
+<!--
+ ~ 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.
+ -->
+<project name="Transport">
+ <bannerLeft>
+ <name>Axis2 Transport</name>
+ <src>http://ws.apache.org/images/project-logo.jpg</src>
+ <href>http://ws.apache.org/</href>
+ </bannerLeft>
+ <body>
+ <links>
+ <item name="Apache" href="http://www.apache.org/"/>
+ <item name="WebServices" href="http://ws.apache.org/"/>
+ <item name="Commons" href="http://ws.apache.org/commons/"/>
+ <item name="Axis2" href="http://ws.apache.org/axis2/"/>
+ </links>
+ <menu name="Transport">
+ <item name="About" href="index.html"/>
+ <item name="Documentation">
+ <item name="HTTP" href="http.html"/>
+ <item name="JMS" href="jms.html"/>
+ <item name="Mail" href="mail.html"/>
+ <item name="Local" href="local.html"/>
+ <item name="TCP" href="tcp.html"/>
+ <item name="XMPP" href="xmpp.html"/>
+ </item>
+ </menu>
+ </body>
+</project>
Added: webservices/commons/trunk/modules/transport/src/site/xdoc/http.xml
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/transport/src/site/xdoc/http.xml?rev=699870&view=auto
==============================================================================
--- webservices/commons/trunk/modules/transport/src/site/xdoc/http.xml (added)
+++ webservices/commons/trunk/modules/transport/src/site/xdoc/http.xml Sun Sep
28 10:58:31 2008
@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+ ~ 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.
+ -->
+<document>
+ <properties>
+ <title>HTTP transport</title>
+ </properties>
+ <body>
+ </body>
+</document>
\ No newline at end of file
Added: webservices/commons/trunk/modules/transport/src/site/xdoc/jms.xml
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/transport/src/site/xdoc/jms.xml?rev=699870&view=auto
==============================================================================
--- webservices/commons/trunk/modules/transport/src/site/xdoc/jms.xml (added)
+++ webservices/commons/trunk/modules/transport/src/site/xdoc/jms.xml Sun Sep
28 10:58:31 2008
@@ -0,0 +1,182 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+ ~ 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.
+ -->
+<document>
+ <properties>
+ <title>JMS transport</title>
+ </properties>
+ <body>
+ <section name="Transport configuration">
+ <p>Sample axis2.xml:</p>
+<pre><![CDATA[
+ <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>
+]]></pre>
+ <p>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.</p>
+ </section>
+ <section name="Service configuration">
+ <table class="bodyTable">
+ <tr>
+ <th>
+ Parameter
+ </th>
+ <th>
+ Require
+ </th>
+ <th>
+ Description
+ </th>
+ </tr>
+ <tr>
+ <td>
+ transport.jms.ConnectionFactory
+ </td>
+ <td>
+ Optional
+ </td>
+ <td>
+ The JMS connection factory definition (from axis2.xml) to
be used to
+ listen for messages for this service
+ </td>
+ </tr>
+ <tr>
+ <td>
+ transport.jms.Destination
+ </td>
+ <td>
+ Optional
+ </td>
+ <td>
+ The JMS destination name (Defaults to a Queue with the
service name)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ transport.jms.DestinationType
+ </td>
+ <td>
+ Optional
+ </td>
+ <td>
+ The JMS destination type. Accept values 'queue' or 'topic'
(default:
+ queue)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ transport.jms.ReplyDestination
+ </td>
+ <td>
+ Optional
+ </td>
+ <td>
+ The destination where a reply will be posted
+ </td>
+ </tr>
+ <tr>
+ <td>
+ transport.jms.Wrapper
+ </td>
+ <td>
+ Optional
+ </td>
+ <td>
+ The wrapper element for the JMS message
+ </td>
+ </tr>
+ </table>
+ <p>Sample services.xml:</p>
+<pre><![CDATA[
+<service name="echo">
+ <transports>
+ ....
+ <transport>jms</transport>
+ </transports>
+ ...
+ <parameter name="transport.jms.ConnectionFactory"
locked="true">myTopicConnectionFactory</parameter>
+ <parameter name="transport.jms.Destination"
locked="true">dynamicTopics/something.TestTopic</parameter>
+</service>
+]]></pre>
+ </section>
+ <section name="Endpoint references">
+<pre>
+jms-epr = "jms:/" jms-dest [ "?" param *( [ "&" param ] ) ]
+param = param-name "=" param-value
+</pre>
+
+ <table class="bodyTable">
+ <tr>
+ <th>Parameter</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>transport.jms.ConnectionFactoryJNDIName</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td>transport.jms.DestinationType</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td>transport.jms.ReplyDestination</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td>transport.jms.ReplyDestinationType</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td>java.naming.factory.initial</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td>java.naming.provider.url</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td>java.naming.security.principal</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td>java.naming.security.credentials</td>
+ <td></td>
+ </tr>
+ </table>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Added: webservices/commons/trunk/modules/transport/src/site/xdoc/local.xml
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/transport/src/site/xdoc/local.xml?rev=699870&view=auto
==============================================================================
--- webservices/commons/trunk/modules/transport/src/site/xdoc/local.xml (added)
+++ webservices/commons/trunk/modules/transport/src/site/xdoc/local.xml Sun Sep
28 10:58:31 2008
@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+ ~ 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.
+ -->
+<document>
+ <properties>
+ <title>Local transport</title>
+ </properties>
+ <body>
+ </body>
+</document>
\ No newline at end of file
Added: webservices/commons/trunk/modules/transport/src/site/xdoc/mail.xml
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/transport/src/site/xdoc/mail.xml?rev=699870&view=auto
==============================================================================
--- webservices/commons/trunk/modules/transport/src/site/xdoc/mail.xml (added)
+++ webservices/commons/trunk/modules/transport/src/site/xdoc/mail.xml Sun Sep
28 10:58:31 2008
@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+ ~ 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.
+ -->
+<document>
+ <properties>
+ <title>Mail transport</title>
+ </properties>
+ <body>
+ <section name="Transport configuration">
+ <pre xml:space="preserve"> <transportSender name="mailto"
class="org.apache.synapse.transport.mail.MailTransportSender">
+ <parameter name="mail.smtp.host">smtp.gmail.com</parameter>
+ <parameter name="mail.smtp.port">587</parameter>
+ <parameter
name="mail.smtp.starttls.enable">true</parameter>
+ <parameter name="mail.smtp.auth">true</parameter>
+ <parameter name="mail.smtp.user">synapse.demo.0</parameter>
+ <parameter
name="mail.smtp.password">mailpassword</parameter>
+ <parameter name="mail.smtp.from">[EMAIL
PROTECTED]</parameter>
+ </transportSender></pre>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Added: webservices/commons/trunk/modules/transport/src/site/xdoc/tcp.xml
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/transport/src/site/xdoc/tcp.xml?rev=699870&view=auto
==============================================================================
--- webservices/commons/trunk/modules/transport/src/site/xdoc/tcp.xml (added)
+++ webservices/commons/trunk/modules/transport/src/site/xdoc/tcp.xml Sun Sep
28 10:58:31 2008
@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+ ~ 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.
+ -->
+<document>
+ <properties>
+ <title>TCP transport</title>
+ </properties>
+ <body>
+ </body>
+</document>
\ No newline at end of file
Added: webservices/commons/trunk/modules/transport/src/site/xdoc/xmpp.xml
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/transport/src/site/xdoc/xmpp.xml?rev=699870&view=auto
==============================================================================
--- webservices/commons/trunk/modules/transport/src/site/xdoc/xmpp.xml (added)
+++ webservices/commons/trunk/modules/transport/src/site/xdoc/xmpp.xml Sun Sep
28 10:58:31 2008
@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+ ~ 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.
+ -->
+<document>
+ <properties>
+ <title>XMPP transport</title>
+ </properties>
+ <body>
+ </body>
+</document>
\ No newline at end of file
