From 332f85a2ef7e27d9841ea23fd888b7cfb56a220e Mon Sep 17 00:00:00 2001
From: Josh Long <jolong@vmware.com>
Date: Mon, 12 Jul 2010 08:19:49 +0000
Subject: [PATCH]  updating docs for xmpp adapters.

---
 .../integration/xmpp/XmppHeaders.java         |  4 +-
 .../InboundXmppEndpointTests-context.xml      | 58 ++++++------
 src/docbkx/xmpp.xml                           | 90 ++++++++++++++++++-
 3 files changed, 116 insertions(+), 36 deletions(-)

diff --git a/spring-integration-xmpp/src/main/java/org/springframework/integration/xmpp/XmppHeaders.java b/spring-integration-xmpp/src/main/java/org/springframework/integration/xmpp/XmppHeaders.java
index a7444c528a..de144a8ea5 100644
--- a/spring-integration-xmpp/src/main/java/org/springframework/integration/xmpp/XmppHeaders.java
+++ b/spring-integration-xmpp/src/main/java/org/springframework/integration/xmpp/XmppHeaders.java
@@ -33,9 +33,9 @@ public class XmppHeaders {
     public static final String CHAT_TO_USER = PREFIX + "chat_to_user";
     public static final String CHAT_THREAD_ID = PREFIX + "thread_id";
     public static final String TYPE = PREFIX + "type";
-    public static final String ROSTER_CHANGE_TYPE = PREFIX + "roster_change_type";
+//    public static final String ROSTER_CHANGE_TYPE = PREFIX + "roster_change_type";
     public static final String PRESENCE = PREFIX + "presence";
-    public static final String ROSTER = PREFIX + "roster";
+//    public static final String ROSTER = PREFIX + "roster";
 
     public static final String PRESENCE_LANGUAGE = PRESENCE + "language" ;
     public static final String PRESENCE_PRIORITY = PRESENCE + "priority" ;
diff --git a/spring-integration-xmpp/src/test/resources/org/springframework/integration/xmpp/messages/InboundXmppEndpointTests-context.xml b/spring-integration-xmpp/src/test/resources/org/springframework/integration/xmpp/messages/InboundXmppEndpointTests-context.xml
index d7aa3cdc82..489c766656 100644
--- a/spring-integration-xmpp/src/test/resources/org/springframework/integration/xmpp/messages/InboundXmppEndpointTests-context.xml
+++ b/spring-integration-xmpp/src/test/resources/org/springframework/integration/xmpp/messages/InboundXmppEndpointTests-context.xml
@@ -15,16 +15,16 @@
   ~     limitations under the License.
   -->
 <beans:beans
-        xmlns="http://www.springframework.org/schema/integration"
-        xmlns:beans="http://www.springframework.org/schema/beans"
-        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-        xmlns:p="http://www.springframework.org/schema/p"
-        xmlns:context="http://www.springframework.org/schema/context"
-        xmlns:util="http://www.springframework.org/schema/util"
-        xmlns:xmpp="http://www.springframework.org/schema/integration/xmpp"
-        xmlns:tool="http://www.springframework.org/schema/tool"
-        xmlns:lang="http://www.springframework.org/schema/lang"
-        xsi:schemaLocation="http://www.springframework.org/schema/integration/xmpp
+    xmlns="http://www.springframework.org/schema/integration"
+    xmlns:beans="http://www.springframework.org/schema/beans"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns:p="http://www.springframework.org/schema/p"
+    xmlns:context="http://www.springframework.org/schema/context"
+    xmlns:util="http://www.springframework.org/schema/util"
+    xmlns:xmpp="http://www.springframework.org/schema/integration/xmpp"
+    xmlns:tool="http://www.springframework.org/schema/tool"
+    xmlns:lang="http://www.springframework.org/schema/lang"
+    xsi:schemaLocation="http://www.springframework.org/schema/integration/xmpp
         http://www.springframework.org/schema/integration/xmpp/spring-integration-xmpp.xsd
                         http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
 						http://www.springframework.org/schema/integration http://www.springframework.org/schema/integration/spring-integration.xsd
@@ -33,32 +33,26 @@
 						http://www.springframework.org/schema/tool http://www.springframework.org/schema/tool/spring-tool-3.0.xsd
 						http://www.springframework.org/schema/lang http://www.springframework.org/schema/lang/spring-lang-3.0.xsd">
 
-    <context:component-scan base-package="org.springframework.integration.xmpp"/>
+  <context:component-scan base-package="org.springframework.integration.xmpp"/>
 
-    <beans:bean class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer" p:ignoreUnresolvablePlaceholders="false">
-        <beans:property name="location">
-            <beans:bean class="org.springframework.core.io.FileSystemResource">
-                <beans:constructor-arg value="#{ systemProperties['user.home'] }/Desktop/test.properties"/>
-            </beans:bean>
-        </beans:property>
-    </beans:bean>
+  <context:property-placeholder location="#{ systemProperties['user.home'] }/Desktop/test.properties"/>
 
-    <channel id="xmppInbound"/>
+  <channel id="xmppInbound"/>
 
-    <xmpp:xmpp-connection
-            id="testConnection"
-            user="${user.2.login}"
-            password="${user.2.password}"
-            host="${user.2.host}"
-            port="${user.2.port}"
-            resource="${user.2.resource}"
-            sasl-mechanism-supported="${user.2.sasl.mechanism}"
-            sasl-mechanism-supported-index="${user.2.sasl.index}"
-            service-name="${user.2.service}"
-            />
+  <xmpp:xmpp-connection
+      id="testConnection"
+      user="${user.2.login}"
+      password="${user.2.password}"
+      host="${user.2.host}"
+      port="${user.2.port}"
+      resource="${user.2.resource}"
+      sasl-mechanism-supported="${user.2.sasl.mechanism}"
+      sasl-mechanism-supported-index="${user.2.sasl.index}"
+      service-name="${user.2.service}"
+      />
 
-    <xmpp:message-inbound-channel-adapter channel="xmppInbound" xmpp-connection="testConnection"/>
+  <xmpp:message-inbound-channel-adapter channel="xmppInbound" xmpp-connection="testConnection"/>
 
-    <service-activator input-channel="xmppInbound" ref="xmppMessageConsumer"/>
+  <service-activator input-channel="xmppInbound" ref="xmppMessageConsumer"/>
 
 </beans:beans>
diff --git a/src/docbkx/xmpp.xml b/src/docbkx/xmpp.xml
index a8753e0c47..796f0b7667 100644
--- a/src/docbkx/xmpp.xml
+++ b/src/docbkx/xmpp.xml
@@ -58,7 +58,7 @@
     <title>XMPP Connection</title>
     <para>
       To participate in the network, an actor must connect to an XMPP server. Typically this requires - at a minimum - a
-      <code>user</code>, a<code>password</code>, a<code>host</code>, and a<code>port</code>.
+      <code>user</code>, a <code>password</code>, a <code>host</code>, and a <code>port</code>.
 
       To create an XMPP connection, you may use the XML namespace.
 
@@ -78,7 +78,93 @@
     <title>XMPP Messages</title>
     <section id="xmpp-message-inbound-channel-adapter">
       <title>Inbound Message Adapter</title>
-      <para>TBD</para>
+      <para>The Spring Integration adapters support receiving messages from other users in the system.  To do this, the adapter "logs in" as a user
+        on your behalf and receives the messages sent to that user. Those messages are then forwarded to  your Spring Integration
+        client.
+        The payload of the inbound Spring Integration message may be of the raw type
+        <code>org.jivesoftware.smack.packet.Message</code>, or of the type <code>java.lang.String</code> - which is the type of the raw <code>
+        Message</code>'s <code>
+        body</code> property  -
+        depending on whether you specify <code>extract-payload</code> on the adapter's configuration or not.
+     Inbound  Messages  are typically small and are text-oriented. Messages received using the adapter have
+        a pretty standard layout, with known headers (all headers have keys defined on <code>org.springframework.integration.xmpp.XmppHeaders</code>):
+            </para>
+
+       <table>
+         <tr> <th>   Header Name</th> <th> What it Describes</th></tr>
+           <tr><td>XmppHeaders.CHAT</td>
+            <td> A reference to the <code>org.jivesoftware.smack.Chat</code> class which represents the
+              threaded conversation containing the message.
+            </td>
+           </tr>
+         <tr> <td>XmppHeaders.TYPE</td> <td>The value of the
+          the <code>
+            org.jivesoftware.smack.packet.Message.Type </code> enum that describes the inbound message. Possible values are:
+           <code>normal</code>,
+           <code>chat</code>,
+           <code>groupchat</code>,
+           <code>headline</code>,
+           <code>error</code>.
+        </td>
+         </tr>
+       </table>
+
+
+
+      <para>
+       This adapter requires a reference to an XMPP Connection. You may
+        use the   <link linkend="xmpp-connection">xmpp-connection</link>
+         element to define one.
+
+        An example  might look as follows: 
+
+      <programlisting lang="xml"><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
+
+<beans:beans
+    xmlns="http://www.springframework.org/schema/integration"
+    xmlns:beans="http://www.springframework.org/schema/beans"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns:p="http://www.springframework.org/schema/p"
+    xmlns:context="http://www.springframework.org/schema/context"
+    xmlns:util="http://www.springframework.org/schema/util"
+    xmlns:xmpp="http://www.springframework.org/schema/integration/xmpp"
+    xmlns:tool="http://www.springframework.org/schema/tool"
+    xmlns:lang="http://www.springframework.org/schema/lang"
+    xsi:schemaLocation="http://www.springframework.org/schema/integration/xmpp
+        http://www.springframework.org/schema/integration/xmpp/spring-integration-xmpp.xsd
+        http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
+				http://www.springframework.org/schema/integration http://www.springframework.org/schema/integration/spring-integration.xsd
+				http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd
+        http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-3.0.xsd
+				http://www.springframework.org/schema/tool http://www.springframework.org/schema/tool/spring-tool-3.0.xsd
+				http://www.springframework.org/schema/lang http://www.springframework.org/schema/lang/spring-lang-3.0.xsd">
+
+  <context:component-scan
+            base-package="com.myxmppclient.inbound"/>
+
+  <context:property-placeholder
+            location="#{ systemProperties['user.home'] }/xmpp/xmppclient.properties"/>
+
+  <channel id="xmppInbound"/>
+
+  <xmpp:xmpp-connection
+    id="testConnection"
+      ...
+  />
+
+  <xmpp:message-inbound-channel-adapter
+        channel="xmppInbound"
+        xmpp-connection="testConnection"/>
+
+  <service-activator input-channel="xmppInbound"
+        ref="xmppMessageConsumer"/>
+
+</beans:beans>]]></programlisting>
+
+
+
+
+      </para>
     </section>
     <section id="xmpp-message-outbound-channel-adapter">
       <title>Outbound Message Adapter</title>