From 956ec17356d4ec181e34c52cce41c5e78650d923 Mon Sep 17 00:00:00 2001 From: Mark Fisher Date: Sat, 13 Nov 2010 12:23:41 -0500 Subject: [PATCH] updated XMPP docs for name changes --- docs/src/reference/docbook/xmpp.xml | 63 ++++++++++++++--------------- 1 file changed, 31 insertions(+), 32 deletions(-) diff --git a/docs/src/reference/docbook/xmpp.xml b/docs/src/reference/docbook/xmpp.xml index 691df3c57b..60255f29c7 100644 --- a/docs/src/reference/docbook/xmpp.xml +++ b/docs/src/reference/docbook/xmpp.xml @@ -9,10 +9,10 @@ Introduction XMPP describes a way for multiple agents to communicate with each other in a distributed system. - The canonical use case is to send and receive instant messages, though XMPP can be, and is, used for far more + The canonical use case is to send and receive chat messages, though XMPP can be, and is, used for far more applications. XMPP is used to describe a network of actors. Within that network, actors may address each other directly, as well - as broadcast status changes. + as broadcast status changes (e.g. "presence"). XMPP provides the messaging fabric that underlies some of the biggest Instant Messaging networks in the world, @@ -27,8 +27,8 @@ - Spring integration provides support for XMPP via XMPP adapters which support sending and receiving both XMPP messages and - status changes from other entries in your roster. As many other adapters, XMPP adapters come with a convenient namespace-based + Spring integration provides support for XMPP via XMPP adapters which support sending and receiving both XMPP chat messages and + presence changes from other entries in your roster. As many other adapters, XMPP adapters come with a convenient namespace-based configuration. To configure XMPP namespace include the following elements into the headers of your XML configuration file: @@ -64,16 +64,16 @@ xsi:schemaLocation="http://www.springframework.org/schema/integration/xmpp XMPP Messages
Inbound Message Channel Adapter - The Spring Integration adapters support receiving messages from other users in the system. To do this, the + The Spring Integration adapters support receiving chat messages from other users in the system. To do this, the Inbound Message Channel 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 org.jivesoftware.smack.packet.Message, or of the type java.lang.String if you set extract-payload value attribute to 'true' when configuring an adapter. - Configuration support for XMPP Inbound Message Channel Adapter is provided via message-inbound-channel-adapter element. + Configuration support for the XMPP Inbound Message Channel Adapter is provided via the inbound-channel-adapter element. - It is also important to mention that XMPP inbound adapter is an event driven adapter and a LifeCycle object. - When started it will register a PacketListener which will listen for the incoming XMPP Messages forwarding them to the underlying - adapter which will convert them to Spring Integration Messages and send them to the output-channel. It will - unregister PacketListener when it is stopped. + When started it will register a PacketListener that will listen for the incoming XMPP Messages. It forwards those messages + to the underlying adapter which will convert them to Spring Integration Messages and send them to the channel. It will + unregister the PacketListener when it is stopped.
- +
Outbound Message Channel Adapter - You may also send messages to other users on XMPP using the Outbound Message Channel Adapter. - Configuration support for XMPP Outbound Message Channel Adapter is provided via message-outbound-channel-adapter element. + You may also send chat messages to other users on XMPP using the Outbound Message Channel Adapter. + Configuration support for the XMPP Outbound Message Channel Adapter is provided via the outbound-channel-adapter element. - ]]> @@ -135,19 +135,18 @@ xsi:schemaLocation="http://www.springframework.org/schema/integration/xmpp
- Inbound Roster Message Channel Adapter + Inbound Presence Message Channel Adapter - Spring Integration provides Inbound Roster Message Channel Adapter which supports receiving Presence (Roster) - events from other users in the system. To do this, the Inbound Roster Message Channel Adapter "logs in" as a user - on your behalf, registers RosterListener and forwards received roster events as Messages to the channel - identified by the channel attribute. The payload of the Message could either be org.jivesoftware.smack.packet.Presence - object (see http://www.igniterealtime.org/builds/smack/docs/3.1.0/javadoc/org/jivesoftware/smack/packet/Presence.html) or - java.util.Collection<String> representing roster entries. + Spring Integration provides an Inbound Presence Message Channel Adapter which supports receiving Presence (Roster) + events from other users in the system. To do this, the adapter "logs in" as a user + on your behalf, registers a RosterListener and forwards received Presence update events as Messages to the channel + identified by the channel attribute. The payload of the Message will be a org.jivesoftware.smack.packet.Presence + object (see http://www.igniterealtime.org/builds/smack/docs/3.1.0/javadoc/org/jivesoftware/smack/packet/Presence.html). - Configuration support for XMPP Inbound Roster Message Channel Adapter is provided via - roster-event-inbound-channel-adapter element. - Inbound Presence Message Channel Adapter is provided via + the presence-inbound-channel-adapter element. + ]]> As you can see amongst the usual attributes this adapter also requires a reference to an XMPP Connection. @@ -158,30 +157,30 @@ xsi:schemaLocation="http://www.springframework.org/schema/integration/xmpp
- Outbound Roster Message Channel Adapter + Outbound Presence Message Channel Adapter Spring Integration also supports sending Presence (Roster) events to be seen by other users in the network. When you send a Message - to the Outbound Roster Message Channel Adapter it extracts the payload which is expected to be of + to the Outbound Presence Message Channel Adapter it extracts the payload which is expected to be of type org.jivesoftware.smack.packet.Presence (see http://www.igniterealtime.org/builds/smack/docs/3.1.0/javadoc/org/jivesoftware/smack/packet/Presence.html) and sends it to the XMPP Connection, thus advertising your presence events to the rest of the network. - Configuration support for XMPP Outbound Roster Message Channel Adapter is provided via - roster-event-outbound-channel-adapter element. + Configuration support for the XMPP Outbound Presence Message Channel Adapter is provided via + the presence-outbound-channel-adapter element. - ]]> It can also be a polling consumer (if it receives Messages from the Polling Channel) in which case you would need to register a Poller. - -]]> +]]> Similar to its Inbound counterpart it requires a reference to an XMPP Connection. @@ -213,7 +212,7 @@ xsi:schemaLocation="http://www.springframework.org/schema/integration/xmpp -]]>