XMPP

XMPP

Scheme: xmpp

A XMPP Endpoint

Name Kind Type Required Deprecated Default Value Enum Values Description
host path java.lang.String true false Hostname for the chat server
port path int true false Port number for the chat server
participant path java.lang.String false JID (Jabber ID) of person to receive messages. room parameter has precedence over participant.
user parameter java.lang.String false User name (without server name). If not specified, anonymous login will be attempted.
password parameter java.lang.String false Password for login
resource parameter java.lang.String false Camel XMPP resource. The default is Camel.
login parameter boolean false true Whether to login the user.
createAccount parameter boolean false If true, an attempt to create an account will be made. Default is false.
room parameter java.lang.String false 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
nickname parameter java.lang.String false Use nickname when joining room. If room is specified and nickname is not, user will be used for the nickname.
serviceName parameter java.lang.String false The name of the service you are connecting to. For Google Talk, this would be gmail.com.
pubsub parameter boolean false Accept pubsub packets on input, default is false
doc parameter boolean false 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
testConnectionOnStartup parameter boolean false true 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 parameter int false 10 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.
headerFilterStrategy parameter org.apache.camel.spi.HeaderFilterStrategy false To use a custom HeaderFilterStrategy to filter header to and from Camel message.
exchangePattern parameter org.apache.camel.ExchangePattern false InOnly InOnly
RobustInOnly
InOut
InOptionalOut
OutOnly
RobustOutOnly
OutIn
OutOptionalIn
Sets the default exchange pattern when creating an exchange
synchronous parameter boolean false false Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

xmpp consumer

A {@link org.apache.camel.Consumer Consumer} which listens to XMPP packets