Interface IggyComponentBuilderFactory.IggyComponentBuilder
- All Superinterfaces:
ComponentBuilder<org.apache.camel.component.iggy.IggyComponent>
- All Known Implementing Classes:
IggyComponentBuilderFactory.IggyComponentBuilderImpl
- Enclosing interface:
IggyComponentBuilderFactory
public static interface IggyComponentBuilderFactory.IggyComponentBuilder
extends ComponentBuilder<org.apache.camel.component.iggy.IggyComponent>
Builder for the Iggy component.
-
Method Summary
Modifier and TypeMethodDescriptionautoCommit(boolean autoCommit) Controls message acknowledgment behavior.autoCreateStream(boolean autoCreateStream) Whether to automatically create stream if it does not exist.autoCreateTopic(boolean autoCreateTopic) Whether to automatically create topic if it does not exist.autowiredEnabled(boolean autowiredEnabled) Whether autowiring is enabled.bridgeErrorHandler(boolean bridgeErrorHandler) Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.clientTransport(String clientTransport) Polling strategy.compressionAlgorithm(org.apache.iggy.topic.CompressionAlgorithm compressionAlgorithm) Compression algorithm for message payload.configuration(org.apache.camel.component.iggy.IggyConfiguration configuration) Allows to pre-configure the Iggy component with common options that the endpoints will reuse.consumerGroupName(String consumerGroupName) The name of the consumer group.consumersCount(int consumersCount) Camel Iggy consumers count.Iggy server hostname or IP address.lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).maxTopicSize(Long maxTopicSize) Maximum topic size in bytes (0 means unlimited).messageExpiry(Long messageExpiry) Message expiry time in seconds (0 means no expiry).partitionId(Long partitionId) The consumer partition id.partitioning(org.apache.iggy.message.Partitioning partitioning) Partitioning strategy for message distribution.partitionsCount(Long partitionsCount) Number of partitions for the topic.Iggy password.pollBatchSize(Long pollBatchSize) The consumer poll batch size.pollingStrategy(String pollingStrategy) Polling strategy.port(int port) Iggy server port number.replicationFactor(Short replicationFactor) Replication factor for the topic.shutdownTimeout(int shutdownTimeout) Camel Iggy shutdown timeout.startingOffset(Long startingOffset) Defines the initial message offset position when autoCommit is disabled.Stream identifier.streamName(String streamName) Stream name.Iggy username.Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register
-
Method Details
-
autoCreateStream
Whether to automatically create stream if it does not exist. The option is a: <code>boolean</code> type. Default: true Group: common- Parameters:
autoCreateStream- the value to set- Returns:
- the dsl builder
-
autoCreateTopic
Whether to automatically create topic if it does not exist. The option is a: <code>boolean</code> type. Default: true Group: common- Parameters:
autoCreateTopic- the value to set- Returns:
- the dsl builder
-
clientTransport
Polling strategy. The option is a: <code>java.lang.String</code> type. Default: TCP Group: common- Parameters:
clientTransport- the value to set- Returns:
- the dsl builder
-
compressionAlgorithm
default IggyComponentBuilderFactory.IggyComponentBuilder compressionAlgorithm(org.apache.iggy.topic.CompressionAlgorithm compressionAlgorithm) Compression algorithm for message payload. The option is a: <code>org.apache.iggy.topic.CompressionAlgorithm</code> type. Default: None Group: common- Parameters:
compressionAlgorithm- the value to set- Returns:
- the dsl builder
-
configuration
default IggyComponentBuilderFactory.IggyComponentBuilder configuration(org.apache.camel.component.iggy.IggyConfiguration configuration) Allows to pre-configure the Iggy component with common options that the endpoints will reuse. The option is a: <code>org.apache.camel.component.iggy.IggyConfiguration</code> type. Group: common- Parameters:
configuration- the value to set- Returns:
- the dsl builder
-
host
Iggy server hostname or IP address. The option is a: <code>java.lang.String</code> type. Default: localhost Group: common- Parameters:
host- the value to set- Returns:
- the dsl builder
-
maxTopicSize
Maximum topic size in bytes (0 means unlimited). The option is a: <code>java.lang.Long</code> type. Group: common- Parameters:
maxTopicSize- the value to set- Returns:
- the dsl builder
-
messageExpiry
Message expiry time in seconds (0 means no expiry). The option is a: <code>java.lang.Long</code> type. Group: common- Parameters:
messageExpiry- the value to set- Returns:
- the dsl builder
-
partitionsCount
Number of partitions for the topic. The option is a: <code>java.lang.Long</code> type. Default: 1 Group: common- Parameters:
partitionsCount- the value to set- Returns:
- the dsl builder
-
password
Iggy password. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
password- the value to set- Returns:
- the dsl builder
-
port
Iggy server port number. The option is a: <code>int</code> type. Default: 8090 Group: common- Parameters:
port- the value to set- Returns:
- the dsl builder
-
replicationFactor
Replication factor for the topic. The option is a: <code>java.lang.Short</code> type. Group: common- Parameters:
replicationFactor- the value to set- Returns:
- the dsl builder
-
streamId
Stream identifier. The option is a: <code>java.lang.Long</code> type. Group: common- Parameters:
streamId- the value to set- Returns:
- the dsl builder
-
streamName
Stream name. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
streamName- the value to set- Returns:
- the dsl builder
-
autoCommit
Controls message acknowledgment behavior. When true, messages are automatically marked as processed after consumption. When false, enables manual offset management and allows setting a custom starting offset position. The option is a: <code>boolean</code> type. Default: true Group: consumer- Parameters:
autoCommit- the value to set- Returns:
- the dsl builder
-
bridgeErrorHandler
default IggyComponentBuilderFactory.IggyComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler) Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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
-
consumerGroupName
default IggyComponentBuilderFactory.IggyComponentBuilder consumerGroupName(String consumerGroupName) The name of the consumer group. The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
consumerGroupName- the value to set- Returns:
- the dsl builder
-
consumersCount
Camel Iggy consumers count. The option is a: <code>int</code> type. Default: 1 Group: consumer- Parameters:
consumersCount- the value to set- Returns:
- the dsl builder
-
partitionId
The consumer partition id. The option is a: <code>java.lang.Long</code> type. Group: consumer- Parameters:
partitionId- the value to set- Returns:
- the dsl builder
-
pollBatchSize
The consumer poll batch size. The option is a: <code>java.lang.Long</code> type. Default: 10 Group: consumer- Parameters:
pollBatchSize- the value to set- Returns:
- the dsl builder
-
pollingStrategy
Polling strategy. The option is a: <code>java.lang.String</code> type. Default: next Group: consumer- Parameters:
pollingStrategy- the value to set- Returns:
- the dsl builder
-
shutdownTimeout
Camel Iggy shutdown timeout. The option is a: <code>int</code> type. Default: 30000 Group: consumer- Parameters:
shutdownTimeout- the value to set- Returns:
- the dsl builder
-
startingOffset
Defines the initial message offset position when autoCommit is disabled. Use 0 to start from the beginning of the stream, or specify a custom offset to resume from a particular point. The option is a: <code>java.lang.Long</code> type. Group: consumer- Parameters:
startingOffset- the value to set- Returns:
- the dsl builder
-
lazyStartProducer
default IggyComponentBuilderFactory.IggyComponentBuilder 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
-
partitioning
default IggyComponentBuilderFactory.IggyComponentBuilder partitioning(org.apache.iggy.message.Partitioning partitioning) Partitioning strategy for message distribution. The option is a: <code>org.apache.iggy.message.Partitioning</code> type. Default: balanced Group: producer- Parameters:
partitioning- the value to set- Returns:
- the dsl builder
-
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
-
username
Iggy username. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
username- the value to set- Returns:
- the dsl builder
-