org.apache.camel.builder.component.dsl

Interface StompComponentBuilderFactory.StompComponentBuilder

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.stomp.StompComponent>

All Known Implementing Classes:

StompComponentBuilderFactory.StompComponentBuilderImpl

Enclosing interface:

StompComponentBuilderFactory

public static interface StompComponentBuilderFactory.StompComponentBuilder
extends ComponentBuilder<org.apache.camel.component.stomp.StompComponent>

Builder for the Stomp component.

Method Summary

Modifier and Type	Method and Description
default StompComponentBuilderFactory.StompComponentBuilder	autowiredEnabled(boolean autowiredEnabled) Whether autowiring is enabled.
default StompComponentBuilderFactory.StompComponentBuilder	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 StompComponentBuilderFactory.StompComponentBuilder	brokerURL(String brokerURL) The URI of the Stomp broker to connect to.
default StompComponentBuilderFactory.StompComponentBuilder	configuration(org.apache.camel.component.stomp.StompConfiguration configuration) Component configuration.
default StompComponentBuilderFactory.StompComponentBuilder	customHeaders(Properties customHeaders) To set custom headers.
default StompComponentBuilderFactory.StompComponentBuilder	headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy) To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
default StompComponentBuilderFactory.StompComponentBuilder	host(String host) The virtual host name.
default StompComponentBuilderFactory.StompComponentBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default StompComponentBuilderFactory.StompComponentBuilder	login(String login) The username.
default StompComponentBuilderFactory.StompComponentBuilder	passcode(String passcode) The password.
default StompComponentBuilderFactory.StompComponentBuilder	sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters) To configure security using SSLContextParameters.
default StompComponentBuilderFactory.StompComponentBuilder	useGlobalSslContextParameters(boolean useGlobalSslContextParameters) Enable usage of global SSL context parameters.
default StompComponentBuilderFactory.StompComponentBuilder	version(String version) The stomp version (1.1, or 1.2).

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

build, build, doSetProperty, register

Method Detail

brokerURL

default StompComponentBuilderFactory.StompComponentBuilder brokerURL(String brokerURL)

The URI of the Stomp broker to connect to. The option is a: <code>java.lang.String</code> type. Default: tcp://localhost:61613 Group: common

Parameters:

brokerURL - the value to set

Returns:

the dsl builder

customHeaders

default StompComponentBuilderFactory.StompComponentBuilder customHeaders(Properties customHeaders)

To set custom headers. The option is a: <code>java.util.Properties</code> type. Group: common

Parameters:

customHeaders - the value to set

Returns:

the dsl builder

host

default StompComponentBuilderFactory.StompComponentBuilder host(String host)

The virtual host name. The option is a: <code>java.lang.String</code> type. Group: common

Parameters:

host - the value to set

Returns:

the dsl builder

version

default StompComponentBuilderFactory.StompComponentBuilder version(String version)

The stomp version (1.1, or 1.2). The option is a: <code>java.lang.String</code> type. Group: common

Parameters:

version - the value to set

Returns:

the dsl builder

bridgeErrorHandler

default StompComponentBuilderFactory.StompComponentBuilder 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: <code>boolean</code> type. Default: false Group: consumer

Parameters:

bridgeErrorHandler - the value to set

Returns:

the dsl builder

lazyStartProducer

default StompComponentBuilderFactory.StompComponentBuilder 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: <code>boolean</code> type. Default: false Group: producer

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder

autowiredEnabled

default StompComponentBuilderFactory.StompComponentBuilder autowiredEnabled(boolean autowiredEnabled)

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced

Parameters:

autowiredEnabled - the value to set

Returns:

the dsl builder

configuration

default StompComponentBuilderFactory.StompComponentBuilder configuration(org.apache.camel.component.stomp.StompConfiguration configuration)

Component configuration. The option is a: <code>org.apache.camel.component.stomp.StompConfiguration</code> type. Group: advanced

Parameters:

configuration - the value to set

Returns:

the dsl builder

headerFilterStrategy

default StompComponentBuilderFactory.StompComponentBuilder headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)

To use a custom org.apache.camel.spi.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

login

default StompComponentBuilderFactory.StompComponentBuilder login(String login)

The username. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

login - the value to set

Returns:

the dsl builder

passcode

default StompComponentBuilderFactory.StompComponentBuilder passcode(String passcode)

The password. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

passcode - the value to set

Returns:

the dsl builder

sslContextParameters

default StompComponentBuilderFactory.StompComponentBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)

To configure security using SSLContextParameters. The option is a: <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security

Parameters:

sslContextParameters - the value to set

Returns:

the dsl builder

useGlobalSslContextParameters

default StompComponentBuilderFactory.StompComponentBuilder useGlobalSslContextParameters(boolean useGlobalSslContextParameters)

Enable usage of global SSL context parameters. The option is a: <code>boolean</code> type. Default: false Group: security

Parameters:

useGlobalSslContextParameters - the value to set

Returns:

the dsl builder