Interface XmppEndpointBuilderFactory.XmppEndpointBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
,org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
,XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder
,XmppEndpointBuilderFactory.XmppEndpointProducerBuilder
- Enclosing interface:
- XmppEndpointBuilderFactory
public static interface XmppEndpointBuilderFactory.XmppEndpointBuilder extends XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder, XmppEndpointBuilderFactory.XmppEndpointProducerBuilder
Builder for endpoint for the XMPP component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default XmppEndpointBuilderFactory.AdvancedXmppEndpointBuilder
advanced()
default XmppEndpointBuilderFactory.XmppEndpointBuilder
headerFilterStrategy(String headerFilterStrategy)
To use a custom HeaderFilterStrategy to filter header to and from Camel message.default XmppEndpointBuilderFactory.XmppEndpointBuilder
headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
To use a custom HeaderFilterStrategy to filter header to and from Camel message.default XmppEndpointBuilderFactory.XmppEndpointBuilder
login(boolean login)
Whether to login the user.default XmppEndpointBuilderFactory.XmppEndpointBuilder
login(String login)
Whether to login the user.default XmppEndpointBuilderFactory.XmppEndpointBuilder
nickname(String nickname)
Use nickname when joining room.default XmppEndpointBuilderFactory.XmppEndpointBuilder
password(String password)
Password for login.default XmppEndpointBuilderFactory.XmppEndpointBuilder
pubsub(boolean pubsub)
Accept pubsub packets on input, default is false.default XmppEndpointBuilderFactory.XmppEndpointBuilder
pubsub(String pubsub)
Accept pubsub packets on input, default is false.default XmppEndpointBuilderFactory.XmppEndpointBuilder
room(String room)
If this option is specified, the component will connect to MUC (Multi User Chat).default XmppEndpointBuilderFactory.XmppEndpointBuilder
roomPassword(String roomPassword)
Password for room.default XmppEndpointBuilderFactory.XmppEndpointBuilder
serviceName(String serviceName)
The name of the service you are connecting to.default XmppEndpointBuilderFactory.XmppEndpointBuilder
testConnectionOnStartup(boolean testConnectionOnStartup)
Specifies whether to test the connection on startup.default XmppEndpointBuilderFactory.XmppEndpointBuilder
testConnectionOnStartup(String testConnectionOnStartup)
Specifies whether to test the connection on startup.default XmppEndpointBuilderFactory.XmppEndpointBuilder
user(String user)
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.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
-
Methods inherited from interface org.apache.camel.builder.endpoint.dsl.XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder
connectionPollDelay, connectionPollDelay, doc, doc
-
-
-
-
Method Detail
-
advanced
default XmppEndpointBuilderFactory.AdvancedXmppEndpointBuilder advanced()
- Specified by:
advanced
in interfaceXmppEndpointBuilderFactory.XmppEndpointConsumerBuilder
- Specified by:
advanced
in interfaceXmppEndpointBuilderFactory.XmppEndpointProducerBuilder
-
login
default XmppEndpointBuilderFactory.XmppEndpointBuilder login(boolean login)
Whether to login the user. The option is a: <code>boolean</code> type. Default: true Group: common- Specified by:
login
in interfaceXmppEndpointBuilderFactory.XmppEndpointConsumerBuilder
- Specified by:
login
in interfaceXmppEndpointBuilderFactory.XmppEndpointProducerBuilder
- Parameters:
login
- the value to set- Returns:
- the dsl builder
-
login
default XmppEndpointBuilderFactory.XmppEndpointBuilder login(String login)
Whether to login the user. The option will be converted to a <code>boolean</code> type. Default: true Group: common- Specified by:
login
in interfaceXmppEndpointBuilderFactory.XmppEndpointConsumerBuilder
- Specified by:
login
in interfaceXmppEndpointBuilderFactory.XmppEndpointProducerBuilder
- Parameters:
login
- the value to set- Returns:
- the dsl builder
-
nickname
default XmppEndpointBuilderFactory.XmppEndpointBuilder 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: <code>java.lang.String</code> type. Group: common- Specified by:
nickname
in interfaceXmppEndpointBuilderFactory.XmppEndpointConsumerBuilder
- Specified by:
nickname
in interfaceXmppEndpointBuilderFactory.XmppEndpointProducerBuilder
- Parameters:
nickname
- the value to set- Returns:
- the dsl builder
-
pubsub
default XmppEndpointBuilderFactory.XmppEndpointBuilder pubsub(boolean pubsub)
Accept pubsub packets on input, default is false. The option is a: <code>boolean</code> type. Default: false Group: common- Specified by:
pubsub
in interfaceXmppEndpointBuilderFactory.XmppEndpointConsumerBuilder
- Specified by:
pubsub
in interfaceXmppEndpointBuilderFactory.XmppEndpointProducerBuilder
- Parameters:
pubsub
- the value to set- Returns:
- the dsl builder
-
pubsub
default XmppEndpointBuilderFactory.XmppEndpointBuilder pubsub(String pubsub)
Accept pubsub packets on input, default is false. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Specified by:
pubsub
in interfaceXmppEndpointBuilderFactory.XmppEndpointConsumerBuilder
- Specified by:
pubsub
in interfaceXmppEndpointBuilderFactory.XmppEndpointProducerBuilder
- Parameters:
pubsub
- the value to set- Returns:
- the dsl builder
-
room
default XmppEndpointBuilderFactory.XmppEndpointBuilder 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: <code>java.lang.String</code> type. Group: common- Specified by:
room
in interfaceXmppEndpointBuilderFactory.XmppEndpointConsumerBuilder
- Specified by:
room
in interfaceXmppEndpointBuilderFactory.XmppEndpointProducerBuilder
- Parameters:
room
- the value to set- Returns:
- the dsl builder
-
serviceName
default XmppEndpointBuilderFactory.XmppEndpointBuilder serviceName(String 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- Specified by:
serviceName
in interfaceXmppEndpointBuilderFactory.XmppEndpointConsumerBuilder
- Specified by:
serviceName
in interfaceXmppEndpointBuilderFactory.XmppEndpointProducerBuilder
- Parameters:
serviceName
- the value to set- Returns:
- the dsl builder
-
testConnectionOnStartup
default XmppEndpointBuilderFactory.XmppEndpointBuilder 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- Specified by:
testConnectionOnStartup
in interfaceXmppEndpointBuilderFactory.XmppEndpointConsumerBuilder
- Specified by:
testConnectionOnStartup
in interfaceXmppEndpointBuilderFactory.XmppEndpointProducerBuilder
- Parameters:
testConnectionOnStartup
- the value to set- Returns:
- the dsl builder
-
testConnectionOnStartup
default XmppEndpointBuilderFactory.XmppEndpointBuilder 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- Specified by:
testConnectionOnStartup
in interfaceXmppEndpointBuilderFactory.XmppEndpointConsumerBuilder
- Specified by:
testConnectionOnStartup
in interfaceXmppEndpointBuilderFactory.XmppEndpointProducerBuilder
- Parameters:
testConnectionOnStartup
- the value to set- Returns:
- the dsl builder
-
headerFilterStrategy
default XmppEndpointBuilderFactory.XmppEndpointBuilder 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- Specified by:
headerFilterStrategy
in interfaceXmppEndpointBuilderFactory.XmppEndpointConsumerBuilder
- Specified by:
headerFilterStrategy
in interfaceXmppEndpointBuilderFactory.XmppEndpointProducerBuilder
- Parameters:
headerFilterStrategy
- the value to set- Returns:
- the dsl builder
-
headerFilterStrategy
default XmppEndpointBuilderFactory.XmppEndpointBuilder 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- Specified by:
headerFilterStrategy
in interfaceXmppEndpointBuilderFactory.XmppEndpointConsumerBuilder
- Specified by:
headerFilterStrategy
in interfaceXmppEndpointBuilderFactory.XmppEndpointProducerBuilder
- Parameters:
headerFilterStrategy
- the value to set- Returns:
- the dsl builder
-
password
default XmppEndpointBuilderFactory.XmppEndpointBuilder password(String password)
Password for login. The option is a: <code>java.lang.String</code> type. Group: security- Specified by:
password
in interfaceXmppEndpointBuilderFactory.XmppEndpointConsumerBuilder
- Specified by:
password
in interfaceXmppEndpointBuilderFactory.XmppEndpointProducerBuilder
- Parameters:
password
- the value to set- Returns:
- the dsl builder
-
roomPassword
default XmppEndpointBuilderFactory.XmppEndpointBuilder roomPassword(String roomPassword)
Password for room. The option is a: <code>java.lang.String</code> type. Group: security- Specified by:
roomPassword
in interfaceXmppEndpointBuilderFactory.XmppEndpointConsumerBuilder
- Specified by:
roomPassword
in interfaceXmppEndpointBuilderFactory.XmppEndpointProducerBuilder
- Parameters:
roomPassword
- the value to set- Returns:
- the dsl builder
-
user
default XmppEndpointBuilderFactory.XmppEndpointBuilder user(String 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- Specified by:
user
in interfaceXmppEndpointBuilderFactory.XmppEndpointConsumerBuilder
- Specified by:
user
in interfaceXmppEndpointBuilderFactory.XmppEndpointProducerBuilder
- Parameters:
user
- the value to set- Returns:
- the dsl builder
-
-