org.apache.camel.builder.endpoint.dsl

Interface StreamEndpointBuilderFactory.StreamEndpointProducerBuilder

All Superinterfaces:

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

All Known Subinterfaces:

StreamEndpointBuilderFactory.StreamEndpointBuilder

Enclosing interface:

StreamEndpointBuilderFactory

public static interface StreamEndpointBuilderFactory.StreamEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint producers for the Stream component.

Method Summary

Modifier and Type	Method and Description
default StreamEndpointBuilderFactory.AdvancedStreamEndpointProducerBuilder	advanced()
default StreamEndpointBuilderFactory.StreamEndpointProducerBuilder	autoCloseCount(int autoCloseCount) Number of messages to process before closing stream on Producer side.
default StreamEndpointBuilderFactory.StreamEndpointProducerBuilder	autoCloseCount(String autoCloseCount) Number of messages to process before closing stream on Producer side.
default StreamEndpointBuilderFactory.StreamEndpointProducerBuilder	closeOnDone(boolean closeOnDone) This option is used in combination with Splitter and streaming to the same file.
default StreamEndpointBuilderFactory.StreamEndpointProducerBuilder	closeOnDone(String closeOnDone) This option is used in combination with Splitter and streaming to the same file.
default StreamEndpointBuilderFactory.StreamEndpointProducerBuilder	delay(long delay) Initial delay in milliseconds before producing the stream.
default StreamEndpointBuilderFactory.StreamEndpointProducerBuilder	delay(String delay) Initial delay in milliseconds before producing the stream.
default StreamEndpointBuilderFactory.StreamEndpointProducerBuilder	encoding(String encoding) You can configure the encoding (is a charset name) to use text-based streams (for example, message body is a String object).
default StreamEndpointBuilderFactory.StreamEndpointProducerBuilder	fileName(String fileName) When using the stream:file URI format, this option specifies the filename to stream to/from.
default StreamEndpointBuilderFactory.StreamEndpointProducerBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default StreamEndpointBuilderFactory.StreamEndpointProducerBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default StreamEndpointBuilderFactory.AdvancedStreamEndpointProducerBuilder advanced()

encoding

default StreamEndpointBuilderFactory.StreamEndpointProducerBuilder encoding(String encoding)

You can configure the encoding (is a charset name) to use text-based streams (for example, message body is a String object). If not provided, Camel uses the JVM default Charset. The option is a: <code>java.lang.String</code> type. Group: common

Parameters:

encoding - the value to set

Returns:

the dsl builder

fileName

default StreamEndpointBuilderFactory.StreamEndpointProducerBuilder fileName(String fileName)

When using the stream:file URI format, this option specifies the filename to stream to/from. The option is a: <code>java.lang.String</code> type. Group: common

Parameters:

fileName - the value to set

Returns:

the dsl builder

autoCloseCount

default StreamEndpointBuilderFactory.StreamEndpointProducerBuilder autoCloseCount(int autoCloseCount)

Number of messages to process before closing stream on Producer side. Never close stream by default (only when Producer is stopped). If more messages are sent, the stream is reopened for another autoCloseCount batch. The option is a: <code>int</code> type. Group: producer

Parameters:

autoCloseCount - the value to set

Returns:

the dsl builder

autoCloseCount

default StreamEndpointBuilderFactory.StreamEndpointProducerBuilder autoCloseCount(String autoCloseCount)

Number of messages to process before closing stream on Producer side. Never close stream by default (only when Producer is stopped). If more messages are sent, the stream is reopened for another autoCloseCount batch. The option will be converted to a <code>int</code> type. Group: producer

Parameters:

autoCloseCount - the value to set

Returns:

the dsl builder

closeOnDone

default StreamEndpointBuilderFactory.StreamEndpointProducerBuilder closeOnDone(boolean closeOnDone)

This option is used in combination with Splitter and streaming to the same file. The idea is to keep the stream open and only close when the Splitter is done, to improve performance. Mind this requires that you only stream to the same file, and not 2 or more files. The option is a: <code>boolean</code> type. Default: false Group: producer

Parameters:

closeOnDone - the value to set

Returns:

the dsl builder

closeOnDone

default StreamEndpointBuilderFactory.StreamEndpointProducerBuilder closeOnDone(String closeOnDone)

This option is used in combination with Splitter and streaming to the same file. The idea is to keep the stream open and only close when the Splitter is done, to improve performance. Mind this requires that you only stream to the same file, and not 2 or more files. The option will be converted to a <code>boolean</code> type. Default: false Group: producer

Parameters:

closeOnDone - the value to set

Returns:

the dsl builder

delay

default StreamEndpointBuilderFactory.StreamEndpointProducerBuilder delay(long delay)

Initial delay in milliseconds before producing the stream. The option is a: <code>long</code> type. Group: producer

Parameters:

delay - the value to set

Returns:

the dsl builder

delay

default StreamEndpointBuilderFactory.StreamEndpointProducerBuilder delay(String delay)

Initial delay in milliseconds before producing the stream. The option will be converted to a <code>long</code> type. Group: producer

Parameters:

delay - the value to set

Returns:

the dsl builder

lazyStartProducer

default StreamEndpointBuilderFactory.StreamEndpointProducerBuilder 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

lazyStartProducer

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

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder