docs/components/modules/ROOT/pages/xmpp-component.adoc

[[xmpp-component]]
= XMPP Component
:page-source: components/camel-xmpp/src/main/docs/xmpp-component.adoc

*Available as of Camel version 1.0*

The XMPP component implements an XMPP (Jabber) transport.

Maven users will need to add the following dependency to their `pom.xml`
for this component:

[source,xml]
------------------------------------------------------------
<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

[source,text]
------------------------------------------------------
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.

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

== Options


// component options: START
The XMPP component supports 1 options, which are listed below.



[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *basicPropertyBinding* (advanced) | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean
|===
// component options: END



// endpoint options: START
The XMPP endpoint is configured using URI syntax:

----
xmpp:host:port/participant
----

with the following path and query parameters:

=== Path Parameters (3 parameters):


[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *host* | *Required* Hostname for the chat server |  | String
| *port* | *Required* Port number for the chat server |  | int
| *participant* | JID (Jabber ID) of person to receive messages. room parameter has precedence over participant. |  | String
|===


=== Query Parameters (21 parameters):


[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *login* (common) | Whether to login the user. | true | boolean
| *nickname* (common) | Use nickname when joining room. If room is specified and nickname is not, user will be used for the nickname. |  | String
| *pubsub* (common) | Accept pubsub packets on input, default is false | false | boolean
| *room* (common) | 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 supermanjabber.org and want to join the krypton room, then the room URL is kryptonconference.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 |  | String
| *serviceName* (common) | The name of the service you are connecting to. For Google Talk, this would be gmail.com. |  | String
| *testConnectionOnStartup* (common) | 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. | true | boolean
| *createAccount* (common) | If true, an attempt to create an account will be made. Default is false. | false | boolean
| *resource* (common) | XMPP resource. The default is Camel. | Camel | String
| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean
| *connectionPollDelay* (consumer) | The amount of time in seconds between polls (in seconds) 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. | 10 | int
| *doc* (consumer) | 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 | false | boolean
| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. |  | ExceptionHandler
| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. |  | ExchangePattern
| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | boolean
| *basicPropertyBinding* (advanced) | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean
| *connectionConfig* (advanced) | To use an existing connection configuration. Currently org.jivesoftware.smack.tcp.XMPPTCPConnectionConfiguration is only supported (XMPP over TCP). |  | ConnectionConfiguration
| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean
| *headerFilterStrategy* (filter) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. |  | HeaderFilterStrategy
| *password* (security) | Password for login |  | String
| *roomPassword* (security) | Password for room |  | String
| *user* (security) | User name (without server name). If not specified, anonymous login will be attempted. |  | String
|===
// endpoint options: END
// spring-boot-auto-configure options: START
== Spring Boot Auto-Configuration

When using Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

[source,xml]
----
<dependency>
  <groupId>org.apache.camel</groupId>
  <artifactId>camel-xmpp-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>
----


The component supports 2 options, which are listed below.



[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *camel.component.xmpp.basic-property-binding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | Boolean
| *camel.component.xmpp.enabled* | Enable xmpp component | true | Boolean
|===
// spring-boot-auto-configure options: END



== 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`:

[source,text]
------------------------------------------------------------------------------
xmpp://superman@jabber.org/?room=krypton@conference.jabber.org&password=secret
------------------------------------------------------------------------------

User `superman` to send messages to `joker`:

[source,text]
-----------------------------------------------------------
xmpp://superman@jabber.org/joker@jabber.org?password=secret
-----------------------------------------------------------

Routing example in Java:

[source,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`.

[source,java]
--------------------------------------------------------------------
from("xmpp://superman@jabber.org/joker@jabber.org?password=secret").
to("activemq:evil.talk");
--------------------------------------------------------------------

Consumer configuration, which listens to room messages:

[source,java]
---------------------------------------------------------------------------------------
from("xmpp://superman@jabber.org/?password=secret&room=krypton@conference.jabber.org").
to("activemq:krypton.talk");
---------------------------------------------------------------------------------------

Room in short notation (no domain part):

[source,java]
-----------------------------------------------------------------
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:

[source,java]
---------------------------------------------------------------------------------------------------------
from("direct:start").
  to("xmpp://talk.google.com:5222/touser@gmail.com?serviceName=gmail.com&user=fromuser&password=secret").
  to("mock:result");
---------------------------------------------------------------------------------------------------------