[CONF] Apache Camel: XMPP (page edited)

confluence Mon, 18 May 2009 23:49:31 -0700

Page Edited : CAMEL : XMPP

XMPP has been edited by Claus Ibsen (May 18, 2009).

Content:

XMPP Component

The xmpp: component implements an XMPP (Jabber) transport.

URI format

xmpp://[lo...@]hostname[:port][/participant][?Options]

The component supports both room based and private person-person conversations.
The component supports both producer and consumer (you can get messages from xmpp or send messages to xmpp). Consumer mode supports rooms starting from camel-1.5.0.

Options

Name	Description
room	If room is specified then component will connect to MUC (Multi User Chat). Usually domain name for MUC is different from login domain. For example if you are super...@jabber.org and want to join "krypton" room then room url is kryp...@conference.jabber.org. Note "conference" part. Starting from camel-1.5.0 it is not required to provide full room JID. If room parameter does not contain "@" symbol then domain part will be discovered and added by Camel
user	User name (without server name). If not specified then anonymous login attempt will be performed.
password	Password
resource	XMPP resource. The default is "Camel"
createAccount	If "true" then an attempt to create an account will be made. Default is false
participant	JID (Jabber ID) of person to receive messages. "room" parameter has precedence over "participant".
nickname	Use nick when joining room. If room is specified and nickname is not then "user" will be used for nick
serviceName	Camel 1.6/2.0 The name of the service you are connecting to. For Google Talk, this would be gmail.com

Headers and setting Subject or Language

Camel sets the message IN headers as properties on the XMPP message. You can configure a HeaderFilterStategy if you need custom filtering of headers.
In Camel 1.6.2/2.0 the Subject and Language of the XMPP message is also set if they are provided as IN headers.

Examples

User "superman" to join room krypton at jabber server with password "secret".

xmpp://super...@jabber.org/?room=kryp...@conference.jabber.org&password=secret

User "superman" to send messages to joker

xmpp://super...@jabber.org/jo...@jabber.org?password=secret

Routing example in Java

from("timer://kickoff?period=10000").
setBody(constant("I will win!\n Your Superman.")).
to("xmpp://super...@jabber.org/jo...@jabber.org?password=secret");

Consumer configuration. Will write all messages from Joker into a queue "evil.talk".

from("xmpp://super...@jabber.org/jo...@jabber.org?password=secret").
to("activemq:evil.talk");

Consumer configuration listening to a room messages (supported from camel-1.5.0)

from("xmpp://super...@jabber.org/?password=secret&room=kryp...@conference.jabber.org").
to("activemq:krypton.talk");

Room in short notation (no domain part; for camel-1.5.0+)

from("xmpp://super...@jabber.org/?password=secret&room=krypton").
to("activemq:krypton.talk");

When connecting to the Google Chat service, you'll need to specify the serviceName as well as your credentials (as of Camel 1.6/2.0)

// send a message from fromu...@gmail.com to tou...@gmail.com
from("direct:start").
    to("xmpp://talk.google.com:5222/tou...@gmail.com?servicename=gmail.com&user=fromuser&password=secret").
    to("mock:result");