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 TypeMethodDescriptionadvanced()
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.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.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.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.headerFilterStrategy
(String headerFilterStrategy) To use a custom HeaderFilterStrategy to filter header to and from Camel message.headerFilterStrategy
(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy) To use a custom HeaderFilterStrategy to filter header to and from Camel message.login
(boolean login) Whether to login the user.Whether to login the user.Use nickname when joining room.Password for login.pubsub
(boolean pubsub) Accept pubsub packets on input, default is false.Accept pubsub packets on input, default is false.If this option is specified, the component will connect to MUC (Multi User Chat).roomPassword
(String roomPassword) Password for room.serviceName
(String serviceName) The name of the service you are connecting to.testConnectionOnStartup
(boolean testConnectionOnStartup) Specifies whether to test the connection on startup.testConnectionOnStartup
(String testConnectionOnStartup) Specifies whether to test the connection on startup.User name (without server name).Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve
-
Method Details
-
advanced
-
login
Whether to login the user. The option is a: <code>boolean</code> type. Default: true Group: common- Parameters:
login
- the value to set- Returns:
- the dsl builder
-
login
Whether to login the user. The option will be converted to a <code>boolean</code> type. Default: true Group: common- Parameters:
login
- the value to set- Returns:
- the dsl builder
-
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: <code>java.lang.String</code> type. Group: common- Parameters:
nickname
- the value to set- Returns:
- the dsl builder
-
pubsub
Accept pubsub packets on input, default is false. The option is a: <code>boolean</code> type. Default: false Group: common- Parameters:
pubsub
- the value to set- Returns:
- the dsl builder
-
pubsub
Accept pubsub packets on input, default is false. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Parameters:
pubsub
- the value to set- Returns:
- the dsl builder
-
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: <code>java.lang.String</code> type. Group: common- Parameters:
room
- the value to set- Returns:
- the dsl builder
-
serviceName
The name of the service you are connecting to. For Google Talk, this would be gmail.com. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
serviceName
- the value to set- Returns:
- the dsl builder
-
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: <code>boolean</code> type. Default: true Group: common- Parameters:
testConnectionOnStartup
- the value to set- Returns:
- the dsl builder
-
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 <code>boolean</code> type. Default: true Group: common- Parameters:
testConnectionOnStartup
- the value to set- Returns:
- the dsl builder
-
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: <code>int</code> type. Default: 10 Group: consumer- Parameters:
connectionPollDelay
- the value to set- Returns:
- the dsl builder
-
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 <code>int</code> type. Default: 10 Group: consumer- Parameters:
connectionPollDelay
- the value to set- Returns:
- the dsl builder
-
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: <code>boolean</code> type. Default: false Group: consumer- Parameters:
doc
- the value to set- Returns:
- the dsl builder
-
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 <code>boolean</code> type. Default: false Group: consumer- Parameters:
doc
- the value to set- Returns:
- the dsl builder
-
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: <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: filter- Parameters:
headerFilterStrategy
- the value to set- Returns:
- the dsl builder
-
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 <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: filter- Parameters:
headerFilterStrategy
- the value to set- Returns:
- the dsl builder
-
password
Password for login. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
password
- the value to set- Returns:
- the dsl builder
-
roomPassword
Password for room. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
roomPassword
- the value to set- Returns:
- the dsl builder
-
user
User name (without server name). If not specified, anonymous login will be attempted. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
user
- the value to set- Returns:
- the dsl builder
-