org.apache.camel.builder.endpoint.dsl

Interface XmppEndpointBuilderFactory.XmppEndpointProducerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

All Known Subinterfaces:

XmppEndpointBuilderFactory.XmppEndpointBuilder

Enclosing interface:

XmppEndpointBuilderFactory

public static interface XmppEndpointBuilderFactory.XmppEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint producers for the XMPP component.

Method Summary

Modifier and Type	Method and Description
default XmppEndpointBuilderFactory.AdvancedXmppEndpointProducerBuilder	advanced()
default XmppEndpointBuilderFactory.XmppEndpointProducerBuilder	headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy) To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default XmppEndpointBuilderFactory.XmppEndpointProducerBuilder	headerFilterStrategy(String headerFilterStrategy) To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default XmppEndpointBuilderFactory.XmppEndpointProducerBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default XmppEndpointBuilderFactory.XmppEndpointProducerBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default XmppEndpointBuilderFactory.XmppEndpointProducerBuilder	login(boolean login) Whether to login the user.
default XmppEndpointBuilderFactory.XmppEndpointProducerBuilder	login(String login) Whether to login the user.
default XmppEndpointBuilderFactory.XmppEndpointProducerBuilder	nickname(String nickname) Use nickname when joining room.
default XmppEndpointBuilderFactory.XmppEndpointProducerBuilder	password(String password) Password for login.
default XmppEndpointBuilderFactory.XmppEndpointProducerBuilder	pubsub(boolean pubsub) Accept pubsub packets on input, default is false.
default XmppEndpointBuilderFactory.XmppEndpointProducerBuilder	pubsub(String pubsub) Accept pubsub packets on input, default is false.
default XmppEndpointBuilderFactory.XmppEndpointProducerBuilder	room(String room) If this option is specified, the component will connect to MUC (Multi User Chat).
default XmppEndpointBuilderFactory.XmppEndpointProducerBuilder	roomPassword(String roomPassword) Password for room.
default XmppEndpointBuilderFactory.XmppEndpointProducerBuilder	serviceName(String serviceName) The name of the service you are connecting to.
default XmppEndpointBuilderFactory.XmppEndpointProducerBuilder	testConnectionOnStartup(boolean testConnectionOnStartup) Specifies whether to test the connection on startup.
default XmppEndpointBuilderFactory.XmppEndpointProducerBuilder	testConnectionOnStartup(String testConnectionOnStartup) Specifies whether to test the connection on startup.
default XmppEndpointBuilderFactory.XmppEndpointProducerBuilder	user(String user) User name (without server name).

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default XmppEndpointBuilderFactory.AdvancedXmppEndpointProducerBuilder advanced()

login

default XmppEndpointBuilderFactory.XmppEndpointProducerBuilder login(boolean login)

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

login

default XmppEndpointBuilderFactory.XmppEndpointProducerBuilder login(String login)

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

nickname

default XmppEndpointBuilderFactory.XmppEndpointProducerBuilder 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.XmppEndpointProducerBuilder pubsub(boolean pubsub)

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

pubsub

default XmppEndpointBuilderFactory.XmppEndpointProducerBuilder 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.XmppEndpointProducerBuilder 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.XmppEndpointProducerBuilder 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.XmppEndpointProducerBuilder 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.XmppEndpointProducerBuilder 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

lazyStartProducer

default XmppEndpointBuilderFactory.XmppEndpointProducerBuilder lazyStartProducer(boolean lazyStartProducer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: boolean type. Default: false Group: producer

lazyStartProducer

default XmppEndpointBuilderFactory.XmppEndpointProducerBuilder lazyStartProducer(String lazyStartProducer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option will be converted to a boolean type. Default: false Group: producer

headerFilterStrategy

default XmppEndpointBuilderFactory.XmppEndpointProducerBuilder 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.XmppEndpointProducerBuilder 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.XmppEndpointProducerBuilder password(String password)

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

roomPassword

default XmppEndpointBuilderFactory.XmppEndpointProducerBuilder roomPassword(String roomPassword)

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

user

default XmppEndpointBuilderFactory.XmppEndpointProducerBuilder 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