Package org.apache.camel.builder.endpoint.dsl

Interface MinaEndpointBuilderFactory.MinaEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder, MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Enclosing interface:

MinaEndpointBuilderFactory

public static interface MinaEndpointBuilderFactory.MinaEndpointBuilder
extends MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder, MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Builder for endpoint for the Mina component.

Method Summary

Modifier and Type	Method	Description
default MinaEndpointBuilderFactory.AdvancedMinaEndpointBuilder	advanced()
default MinaEndpointBuilderFactory.MinaEndpointBuilder	allowDefaultCodec(boolean allowDefaultCodec)	The mina component installs a default codec if both, codec is null and textline is false.
default MinaEndpointBuilderFactory.MinaEndpointBuilder	allowDefaultCodec(String allowDefaultCodec)	The mina component installs a default codec if both, codec is null and textline is false.
default MinaEndpointBuilderFactory.MinaEndpointBuilder	autoStartTls(boolean autoStartTls)	Whether to auto start SSL handshake.
default MinaEndpointBuilderFactory.MinaEndpointBuilder	autoStartTls(String autoStartTls)	Whether to auto start SSL handshake.
default MinaEndpointBuilderFactory.MinaEndpointBuilder	codec(String codec)	To use a custom minda codec implementation.
default MinaEndpointBuilderFactory.MinaEndpointBuilder	codec(org.apache.mina.filter.codec.ProtocolCodecFactory codec)	To use a custom minda codec implementation.
default MinaEndpointBuilderFactory.MinaEndpointBuilder	decoderMaxLineLength(int decoderMaxLineLength)	To set the textline protocol decoder max line length.
default MinaEndpointBuilderFactory.MinaEndpointBuilder	decoderMaxLineLength(String decoderMaxLineLength)	To set the textline protocol decoder max line length.
default MinaEndpointBuilderFactory.MinaEndpointBuilder	disconnect(boolean disconnect)	Whether to disconnect(close) from Mina session right after use.
default MinaEndpointBuilderFactory.MinaEndpointBuilder	disconnect(String disconnect)	Whether to disconnect(close) from Mina session right after use.
default MinaEndpointBuilderFactory.MinaEndpointBuilder	encoderMaxLineLength(int encoderMaxLineLength)	To set the textline protocol encoder max line length.
default MinaEndpointBuilderFactory.MinaEndpointBuilder	encoderMaxLineLength(String encoderMaxLineLength)	To set the textline protocol encoder max line length.
default MinaEndpointBuilderFactory.MinaEndpointBuilder	encoding(String encoding)	You can configure the encoding (a charset name) to use for the TCP textline codec and the UDP protocol.
default MinaEndpointBuilderFactory.MinaEndpointBuilder	filters(String filters)	You can set a list of Mina IoFilters to use.
default MinaEndpointBuilderFactory.MinaEndpointBuilder	filters(List<org.apache.mina.core.filterchain.IoFilter> filters)	You can set a list of Mina IoFilters to use.
default MinaEndpointBuilderFactory.MinaEndpointBuilder	minaLogger(boolean minaLogger)	You can enable the Apache MINA logging filter.
default MinaEndpointBuilderFactory.MinaEndpointBuilder	minaLogger(String minaLogger)	You can enable the Apache MINA logging filter.
default MinaEndpointBuilderFactory.MinaEndpointBuilder	sslContextParameters(String sslContextParameters)	To configure SSL security.
default MinaEndpointBuilderFactory.MinaEndpointBuilder	sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)	To configure SSL security.
default MinaEndpointBuilderFactory.MinaEndpointBuilder	sync(boolean sync)	Setting to set endpoint as one-way or request-response.
default MinaEndpointBuilderFactory.MinaEndpointBuilder	sync(String sync)	Setting to set endpoint as one-way or request-response.
default MinaEndpointBuilderFactory.MinaEndpointBuilder	textline(boolean textline)	Only used for TCP.
default MinaEndpointBuilderFactory.MinaEndpointBuilder	textline(String textline)	Only used for TCP.
default MinaEndpointBuilderFactory.MinaEndpointBuilder	textlineDelimiter(String textlineDelimiter)	Only used for TCP and if textline=true.
default MinaEndpointBuilderFactory.MinaEndpointBuilder	textlineDelimiter(org.apache.camel.component.mina.MinaTextLineDelimiter textlineDelimiter)	Only used for TCP and if textline=true.
default MinaEndpointBuilderFactory.MinaEndpointBuilder	timeout(long timeout)	You can configure the timeout that specifies how long to wait for a response from a remote server.
default MinaEndpointBuilderFactory.MinaEndpointBuilder	timeout(String timeout)	You can configure the timeout that specifies how long to wait for a response from a remote server.
default MinaEndpointBuilderFactory.MinaEndpointBuilder	writeTimeout(long writeTimeout)	Maximum amount of time it should take to send data to the MINA session.
default MinaEndpointBuilderFactory.MinaEndpointBuilder	writeTimeout(String writeTimeout)	Maximum amount of time it should take to send data to the MINA session.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

bridgeErrorHandler, bridgeErrorHandler, clientMode, clientMode

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

lazyStartProducer, lazyStartProducer

Method Detail

advanced

default MinaEndpointBuilderFactory.AdvancedMinaEndpointBuilder advanced()

Specified by:

advanced in interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Specified by:

advanced in interface MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

disconnect

default MinaEndpointBuilderFactory.MinaEndpointBuilder disconnect(boolean disconnect)

Whether to disconnect(close) from Mina session right after use. Can be used for both consumer and producer. The option is a: <code>boolean</code> type. Default: false Group: common

Specified by:

disconnect in interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Specified by:

disconnect in interface MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Parameters:

disconnect - the value to set

Returns:

the dsl builder

disconnect

default MinaEndpointBuilderFactory.MinaEndpointBuilder disconnect(String disconnect)

Whether to disconnect(close) from Mina session right after use. Can be used for both consumer and producer. The option will be converted to a <code>boolean</code> type. Default: false Group: common

Specified by:

disconnect in interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Specified by:

disconnect in interface MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Parameters:

disconnect - the value to set

Returns:

the dsl builder

minaLogger

default MinaEndpointBuilderFactory.MinaEndpointBuilder minaLogger(boolean minaLogger)

You can enable the Apache MINA logging filter. Apache MINA uses slf4j logging at INFO level to log all input and output. The option is a: <code>boolean</code> type. Default: false Group: common

Specified by:

minaLogger in interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Specified by:

minaLogger in interface MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Parameters:

minaLogger - the value to set

Returns:

the dsl builder

minaLogger

default MinaEndpointBuilderFactory.MinaEndpointBuilder minaLogger(String minaLogger)

You can enable the Apache MINA logging filter. Apache MINA uses slf4j logging at INFO level to log all input and output. The option will be converted to a <code>boolean</code> type. Default: false Group: common

Specified by:

minaLogger in interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Specified by:

minaLogger in interface MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Parameters:

minaLogger - the value to set

Returns:

the dsl builder

sync

default MinaEndpointBuilderFactory.MinaEndpointBuilder sync(boolean sync)

Setting to set endpoint as one-way or request-response. The option is a: <code>boolean</code> type. Default: true Group: common

Specified by:

sync in interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Specified by:

sync in interface MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Parameters:

sync - the value to set

Returns:

the dsl builder

sync

default MinaEndpointBuilderFactory.MinaEndpointBuilder sync(String sync)

Setting to set endpoint as one-way or request-response. The option will be converted to a <code>boolean</code> type. Default: true Group: common

Specified by:

sync in interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Specified by:

sync in interface MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Parameters:

sync - the value to set

Returns:

the dsl builder

timeout

default MinaEndpointBuilderFactory.MinaEndpointBuilder timeout(long timeout)

You can configure the timeout that specifies how long to wait for a response from a remote server. The timeout unit is in milliseconds, so 60000 is 60 seconds. The option is a: <code>long</code> type. Default: 30000 Group: common

Specified by:

timeout in interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Specified by:

timeout in interface MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Parameters:

timeout - the value to set

Returns:

the dsl builder

timeout

default MinaEndpointBuilderFactory.MinaEndpointBuilder timeout(String timeout)

You can configure the timeout that specifies how long to wait for a response from a remote server. The timeout unit is in milliseconds, so 60000 is 60 seconds. The option will be converted to a <code>long</code> type. Default: 30000 Group: common

Specified by:

timeout in interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Specified by:

timeout in interface MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Parameters:

timeout - the value to set

Returns:

the dsl builder

writeTimeout

default MinaEndpointBuilderFactory.MinaEndpointBuilder writeTimeout(long writeTimeout)

Maximum amount of time it should take to send data to the MINA session. Default is 10000 milliseconds. The option is a: <code>long</code> type. Default: 10000 Group: common

Specified by:

writeTimeout in interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Specified by:

writeTimeout in interface MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Parameters:

writeTimeout - the value to set

Returns:

the dsl builder

writeTimeout

default MinaEndpointBuilderFactory.MinaEndpointBuilder writeTimeout(String writeTimeout)

Maximum amount of time it should take to send data to the MINA session. Default is 10000 milliseconds. The option will be converted to a <code>long</code> type. Default: 10000 Group: common

Specified by:

writeTimeout in interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Specified by:

writeTimeout in interface MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Parameters:

writeTimeout - the value to set

Returns:

the dsl builder

allowDefaultCodec

default MinaEndpointBuilderFactory.MinaEndpointBuilder allowDefaultCodec(boolean allowDefaultCodec)

The mina component installs a default codec if both, codec is null and textline is false. Setting allowDefaultCodec to false prevents the mina component from installing a default codec as the first element in the filter chain. This is useful in scenarios where another filter must be the first in the filter chain, like the SSL filter. The option is a: <code>boolean</code> type. Default: true Group: codec

Specified by:

allowDefaultCodec in interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Specified by:

allowDefaultCodec in interface MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Parameters:

allowDefaultCodec - the value to set

Returns:

the dsl builder

allowDefaultCodec

default MinaEndpointBuilderFactory.MinaEndpointBuilder allowDefaultCodec(String allowDefaultCodec)

The mina component installs a default codec if both, codec is null and textline is false. Setting allowDefaultCodec to false prevents the mina component from installing a default codec as the first element in the filter chain. This is useful in scenarios where another filter must be the first in the filter chain, like the SSL filter. The option will be converted to a <code>boolean</code> type. Default: true Group: codec

Specified by:

allowDefaultCodec in interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Specified by:

allowDefaultCodec in interface MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Parameters:

allowDefaultCodec - the value to set

Returns:

the dsl builder

codec

default MinaEndpointBuilderFactory.MinaEndpointBuilder codec(org.apache.mina.filter.codec.ProtocolCodecFactory codec)

To use a custom minda codec implementation. The option is a: <code>org.apache.mina.filter.codec.ProtocolCodecFactory</code> type. Group: codec

Specified by:

codec in interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Specified by:

codec in interface MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Parameters:

codec - the value to set

Returns:

the dsl builder

codec

default MinaEndpointBuilderFactory.MinaEndpointBuilder codec(String codec)

To use a custom minda codec implementation. The option will be converted to a <code>org.apache.mina.filter.codec.ProtocolCodecFactory</code> type. Group: codec

Specified by:

codec in interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Specified by:

codec in interface MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Parameters:

codec - the value to set

Returns:

the dsl builder

decoderMaxLineLength

default MinaEndpointBuilderFactory.MinaEndpointBuilder decoderMaxLineLength(int decoderMaxLineLength)

To set the textline protocol decoder max line length. By default the default value of Mina itself is used which are 1024. The option is a: <code>int</code> type. Default: 1024 Group: codec

Specified by:

decoderMaxLineLength in interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Specified by:

decoderMaxLineLength in interface MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Parameters:

decoderMaxLineLength - the value to set

Returns:

the dsl builder

decoderMaxLineLength

default MinaEndpointBuilderFactory.MinaEndpointBuilder decoderMaxLineLength(String decoderMaxLineLength)

To set the textline protocol decoder max line length. By default the default value of Mina itself is used which are 1024. The option will be converted to a <code>int</code> type. Default: 1024 Group: codec

Specified by:

decoderMaxLineLength in interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Specified by:

decoderMaxLineLength in interface MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Parameters:

decoderMaxLineLength - the value to set

Returns:

the dsl builder

encoderMaxLineLength

default MinaEndpointBuilderFactory.MinaEndpointBuilder encoderMaxLineLength(int encoderMaxLineLength)

To set the textline protocol encoder max line length. By default the default value of Mina itself is used which are Integer.MAX_VALUE. The option is a: <code>int</code> type. Default: -1 Group: codec

Specified by:

encoderMaxLineLength in interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Specified by:

encoderMaxLineLength in interface MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Parameters:

encoderMaxLineLength - the value to set

Returns:

the dsl builder

encoderMaxLineLength

default MinaEndpointBuilderFactory.MinaEndpointBuilder encoderMaxLineLength(String encoderMaxLineLength)

To set the textline protocol encoder max line length. By default the default value of Mina itself is used which are Integer.MAX_VALUE. The option will be converted to a <code>int</code> type. Default: -1 Group: codec

Specified by:

encoderMaxLineLength in interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Specified by:

encoderMaxLineLength in interface MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Parameters:

encoderMaxLineLength - the value to set

Returns:

the dsl builder

encoding

default MinaEndpointBuilderFactory.MinaEndpointBuilder encoding(String encoding)

You can configure the encoding (a charset name) to use for the TCP textline codec and the UDP protocol. If not provided, Camel will use the JVM default Charset. The option is a: <code>java.lang.String</code> type. Group: codec

Specified by:

encoding in interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Specified by:

encoding in interface MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Parameters:

encoding - the value to set

Returns:

the dsl builder

filters

default MinaEndpointBuilderFactory.MinaEndpointBuilder filters(List<org.apache.mina.core.filterchain.IoFilter> filters)

You can set a list of Mina IoFilters to use. The option is a: <code>java.util.List&lt;org.apache.mina.core.filterchain.IoFilter&gt;</code> type. Group: codec

Specified by:

filters in interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Specified by:

filters in interface MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Parameters:

filters - the value to set

Returns:

the dsl builder

filters

default MinaEndpointBuilderFactory.MinaEndpointBuilder filters(String filters)

You can set a list of Mina IoFilters to use. The option will be converted to a <code>java.util.List&lt;org.apache.mina.core.filterchain.IoFilter&gt;</code> type. Group: codec

Specified by:

filters in interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Specified by:

filters in interface MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Parameters:

filters - the value to set

Returns:

the dsl builder

textline

default MinaEndpointBuilderFactory.MinaEndpointBuilder textline(boolean textline)

Only used for TCP. If no codec is specified, you can use this flag to indicate a text line based codec; if not specified or the value is false, then Object Serialization is assumed over TCP. The option is a: <code>boolean</code> type. Default: false Group: codec

Specified by:

textline in interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Specified by:

textline in interface MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Parameters:

textline - the value to set

Returns:

the dsl builder

textline

default MinaEndpointBuilderFactory.MinaEndpointBuilder textline(String textline)

Only used for TCP. If no codec is specified, you can use this flag to indicate a text line based codec; if not specified or the value is false, then Object Serialization is assumed over TCP. The option will be converted to a <code>boolean</code> type. Default: false Group: codec

Specified by:

textline in interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Specified by:

textline in interface MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Parameters:

textline - the value to set

Returns:

the dsl builder

textlineDelimiter

default MinaEndpointBuilderFactory.MinaEndpointBuilder textlineDelimiter(org.apache.camel.component.mina.MinaTextLineDelimiter textlineDelimiter)

Only used for TCP and if textline=true. Sets the text line delimiter to use. If none provided, Camel will use DEFAULT. This delimiter is used to mark the end of text. The option is a: <code>org.apache.camel.component.mina.MinaTextLineDelimiter</code> type. Group: codec

Specified by:

textlineDelimiter in interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Specified by:

textlineDelimiter in interface MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Parameters:

textlineDelimiter - the value to set

Returns:

the dsl builder

textlineDelimiter

default MinaEndpointBuilderFactory.MinaEndpointBuilder textlineDelimiter(String textlineDelimiter)

Only used for TCP and if textline=true. Sets the text line delimiter to use. If none provided, Camel will use DEFAULT. This delimiter is used to mark the end of text. The option will be converted to a <code>org.apache.camel.component.mina.MinaTextLineDelimiter</code> type. Group: codec

Specified by:

textlineDelimiter in interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Specified by:

textlineDelimiter in interface MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Parameters:

textlineDelimiter - the value to set

Returns:

the dsl builder

autoStartTls

default MinaEndpointBuilderFactory.MinaEndpointBuilder autoStartTls(boolean autoStartTls)

Whether to auto start SSL handshake. The option is a: <code>boolean</code> type. Default: true Group: security

Specified by:

autoStartTls in interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Specified by:

autoStartTls in interface MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Parameters:

autoStartTls - the value to set

Returns:

the dsl builder

autoStartTls

default MinaEndpointBuilderFactory.MinaEndpointBuilder autoStartTls(String autoStartTls)

Whether to auto start SSL handshake. The option will be converted to a <code>boolean</code> type. Default: true Group: security

Specified by:

autoStartTls in interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Specified by:

autoStartTls in interface MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Parameters:

autoStartTls - the value to set

Returns:

the dsl builder

sslContextParameters

default MinaEndpointBuilderFactory.MinaEndpointBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)

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

Specified by:

sslContextParameters in interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Specified by:

sslContextParameters in interface MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Parameters:

sslContextParameters - the value to set

Returns:

the dsl builder

sslContextParameters

default MinaEndpointBuilderFactory.MinaEndpointBuilder sslContextParameters(String sslContextParameters)

To configure SSL security. The option will be converted to a <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security

Specified by:

sslContextParameters in interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Specified by:

sslContextParameters in interface MinaEndpointBuilderFactory.MinaEndpointProducerBuilder

Parameters:

sslContextParameters - the value to set

Returns:

the dsl builder