org.apache.camel.builder.endpoint.dsl

Interface XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver

All Known Subinterfaces:

XmppEndpointBuilderFactory.XmppEndpointBuilder

Enclosing interface:

XmppEndpointBuilderFactory

public static interface XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Builder for endpoint consumers for the XMPP component.

Method Summary

Modifier and Type	Method and Description
default XmppEndpointBuilderFactory.AdvancedXmppEndpointConsumerBuilder	advanced()
default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder	bridgeErrorHandler(boolean bridgeErrorHandler) 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.
default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder	bridgeErrorHandler(String bridgeErrorHandler) 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.
default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder	connectionPollDelay(int connectionPollDelay) 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.
default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder	connectionPollDelay(String connectionPollDelay) 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.
default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder	doc(boolean doc) 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.
default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder	doc(String doc) 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.
default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder	headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy) To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder	headerFilterStrategy(String headerFilterStrategy) To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder	login(boolean login) Whether to login the user.
default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder	login(String login) Whether to login the user.
default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder	nickname(String nickname) Use nickname when joining room.
default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder	password(String password) Password for login.
default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder	pubsub(boolean pubsub) Accept pubsub packets on input, default is false.
default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder	pubsub(String pubsub) Accept pubsub packets on input, default is false.
default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder	room(String room) If this option is specified, the component will connect to MUC (Multi User Chat).
default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder	roomPassword(String roomPassword) Password for room.
default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder	serviceName(String serviceName) The name of the service you are connecting to.
default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder	testConnectionOnStartup(boolean testConnectionOnStartup) Specifies whether to test the connection on startup.
default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder	testConnectionOnStartup(String testConnectionOnStartup) Specifies whether to test the connection on startup.
default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder	user(String user) User name (without server name).

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Method Detail

advanced

default XmppEndpointBuilderFactory.AdvancedXmppEndpointConsumerBuilder advanced()

login

default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder login(boolean login)

Whether to login the user. The option is a: boolean type. Default: true Group: common

login

default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder login(String login)

Whether to login the user. The option will be converted to a boolean type. Default: true Group: common

nickname

default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder nickname(String nickname)

Use nickname when joining room. If room is specified and nickname is not, user will be used for the nickname. The option is a: java.lang.String type. Group: common

pubsub

default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder pubsub(boolean pubsub)

Accept pubsub packets on input, default is false. The option is a: boolean type. Default: false Group: common

pubsub

default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder pubsub(String pubsub)

Accept pubsub packets on input, default is false. The option will be converted to a boolean type. Default: false Group: common

room

default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder room(String 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 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. The option is a: java.lang.String type. Group: common

serviceName

default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder serviceName(String serviceName)

The name of the service you are connecting to. For Google Talk, this would be gmail.com. The option is a: java.lang.String type. Group: common

testConnectionOnStartup

default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder testConnectionOnStartup(boolean testConnectionOnStartup)

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. The option is a: boolean type. Default: true Group: common

testConnectionOnStartup

default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder testConnectionOnStartup(String testConnectionOnStartup)

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. The option will be converted to a boolean type. Default: true Group: common

bridgeErrorHandler

default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder bridgeErrorHandler(boolean bridgeErrorHandler)

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. The option is a: boolean type. Default: false Group: consumer

bridgeErrorHandler

default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder bridgeErrorHandler(String bridgeErrorHandler)

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. The option will be converted to a boolean type. Default: false Group: consumer

connectionPollDelay

default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder connectionPollDelay(int connectionPollDelay)

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. The option is a: int type. Default: 10 Group: consumer

connectionPollDelay

default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder connectionPollDelay(String connectionPollDelay)

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. The option will be converted to a int type. Default: 10 Group: consumer

doc

default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder doc(boolean doc)

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. The option is a: boolean type. Default: false Group: consumer

doc

default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder doc(String doc)

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. The option will be converted to a boolean type. Default: false Group: consumer

headerFilterStrategy

default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)

To use a custom HeaderFilterStrategy to filter header to and from Camel message. The option is a: org.apache.camel.spi.HeaderFilterStrategy type. Group: filter

headerFilterStrategy

default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder headerFilterStrategy(String headerFilterStrategy)

To use a custom HeaderFilterStrategy to filter header to and from Camel message. The option will be converted to a org.apache.camel.spi.HeaderFilterStrategy type. Group: filter

password

default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder password(String password)

Password for login. The option is a: java.lang.String type. Group: security

roomPassword

default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder roomPassword(String roomPassword)

Password for room. The option is a: java.lang.String type. Group: security

user

default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder user(String user)

User name (without server name). If not specified, anonymous login will be attempted. The option is a: java.lang.String type. Group: security