To send and receive messages from a XMPP (chat) server.
| Name | Kind | Group | Required | Default | Type | Enum | Description |
|---|---|---|---|---|---|---|---|
| host | path | common | true | java.lang.String | Hostname for the chat server | ||
| port | path | common | true | int | Port number for the chat server | ||
| participant | path | common | java.lang.String | JID (Jabber ID) of person to receive messages. room parameter has precedence over participant. | |||
| login | parameter | common | true | boolean | Whether to login the user. | ||
| nickname | parameter | common | java.lang.String | Use nickname when joining room. If room is specified and nickname is not, user will be used for the nickname. | |||
| pubsub | parameter | common | boolean | Accept pubsub packets on input, default is false | |||
| room | parameter | common | java.lang.String | 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 | |||
| serviceName | parameter | common | java.lang.String | The name of the service you are connecting to. For Google Talk, this would be gmail.com. | |||
| testConnectionOnStartup | parameter | common | true | boolean | 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. | ||
| createAccount | parameter | common (advanced) | boolean | If true, an attempt to create an account will be made. Default is false. | |||
| resource | parameter | common (advanced) | Camel | java.lang.String | XMPP resource. The default is Camel. | ||
| bridgeErrorHandler | parameter | consumer | boolean | 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/ERROR level and ignored. | |||
| connectionPollDelay | parameter | consumer | 10 | int | 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. | ||
| doc | parameter | consumer | boolean | 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 | |||
| exceptionHandler | parameter | consumer (advanced) | org.apache.camel.spi.ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions, that will be logged at WARN/ERROR level and ignored. | |||
| exchangePattern | parameter | consumer (advanced) | org.apache.camel.ExchangePattern | InOnly RobustInOnly InOut InOptionalOut OutOnly RobustOutOnly OutIn OutOptionalIn |
Sets the exchange pattern when the consumer creates an exchange. | ||
| connectionConfig | parameter | advanced | org.jivesoftware.smack.ConnectionConfiguration | To use an existing connection configuration | |||
| synchronous | parameter | advanced | false | boolean | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | ||
| headerFilterStrategy | parameter | filter | org.apache.camel.spi.HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | |||
| password | parameter | security | java.lang.String | Password for login | |||
| user | parameter | security | java.lang.String | User name (without server name). If not specified, anonymous login will be attempted. |
A {@link org.apache.camel.Consumer Consumer} which listens to XMPP packets