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:

URI format

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.

You can append query options to the URI in the following format, ?option=value&option=value&...

Options

Name

Description

room

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 superman@jabber.org and want to join the krypton room, then the room URL is krypton@conference.jabber.org. Note the conference part.
It is not a requirement to provide the full room JID. If the room parameter does not contain the @ symbol, the domain part will be discovered and added by Camel

user

User name (without server name). If not specified, anonymous login will be attempted.

password

Password.

resource

XMPP resource. The default is Camel.

createAccount

If true, 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 nickname when joining room. If room is specified and nickname is not, user will be used for the nickname.

serviceName

The name of the service you are connecting to. For Google Talk, this would be gmail.com.

testConnectionOnStartup

Camel 2.11 Specifies whether to test the connection on startup. This is used to ensure that the XMPP client has a valid connection to the XMPP server when the route starts. Camel throws an exception on startup if a connection cannot be established. When this option is set to false, Camel will attempt to establish a "lazy" connection when needed by a producer, and will poll for a consumer connection until the connection is established. Default is true.

connectionPollDelay

Camel 2.11 The amount of time in seconds between polls to verify the health of the XMPP connection, or between attempts to establish an initial consumer connection. Camel will try to re-establish a connection if it has become inactive. Default is 10 seconds.

pubsubCamel 2.15 Accept pubsub packets on input, default is false
docCamel 2.15 Set a doc header on the IN message containing a Document form of the incoming packet; default is true if presence or pubsub are true, otherwise false

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.
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:

User superman to send messages to joker:

Routing example in Java:

Consumer configuration, which writes all messages from joker into the queue, evil.talk.

Consumer configuration, which listens to room messages:

Room in short notation (no domain part):

When connecting to the Google Chat service, you'll need to specify the serviceName as well as your credentials:

 

See Also

© 2004-2014 The Apache Software Foundation.
Apache Camel, Camel, Apache, the Apache feather logo, and the Apache Camel project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.
Graphic Design By Hiram