XMPP Component
The xmpp: component implements an XMPP (Jabber) transport.
Maven users will need to add the following dependency to their pom.xml
for this component:
<dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-xmpp</artifactId> <version>x.x.x</version> <!-- use the same version as your Camel core version --> </dependency>
URI format
xmpp://[login@]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.
You can append query options to the URI in the following format, ?option=value&option=value&...
Options
Name |
Description |
---|---|
|
If this option is specified, the component will connect to MUC (Multi User Chat). Usually, the domain name for MUC is different from the login domain. For example, if you are |
|
User name (without server name). If not specified, anonymous login will be attempted. |
|
Password. |
|
XMPP resource. The default is |
|
If |
|
JID (Jabber ID) of person to receive messages. |
|
Use nickname when joining room. If room is specified and nickname is not, |
|
Camel 1.6/2.0 The name of the service you are connecting to. For Google Talk, this would be |
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 are also set if they are provided as IN headers.
Examples
User superman
to join room krypton
at jabber
server with password, secret
:
xmpp://superman@jabber.org/?room=krypton@conference.jabber.org&password=secret
User superman
to send messages to joker
:
xmpp://superman@jabber.org/joker@jabber.org?password=secret
Routing example in Java:
from("timer://kickoff?period=10000"). setBody(constant("I will win!\n Your Superman.")). to("xmpp://superman@jabber.org/joker@jabber.org?password=secret");
Consumer configuration, which writes all messages from joker
into the queue, evil.talk
.
from("xmpp://superman@jabber.org/joker@jabber.org?password=secret"). to("activemq:evil.talk");
Consumer configuration, which listens to room messages (supported from camel-1.5.0):
from("xmpp://superman@jabber.org/?password=secret&room=krypton@conference.jabber.org"). to("activemq:krypton.talk");
Room in short notation (no domain part; for camel-1.5.0+):
from("xmpp://superman@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):