MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder (Camel

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver

All Known Subinterfaces:

MinaEndpointBuilderFactory.MinaEndpointBuilder

Enclosing interface:

MinaEndpointBuilderFactory
```
public static interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
```
Builder for endpoint consumers for the Mina component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default MinaEndpointBuilderFactory.AdvancedMinaEndpointConsumerBuilder`	`advanced()`
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`allowDefaultCodec(boolean allowDefaultCodec)` The mina component installs a default codec if both, codec is null and textline is false.
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`allowDefaultCodec(String allowDefaultCodec)` The mina component installs a default codec if both, codec is null and textline is false.
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`autoStartTls(boolean autoStartTls)` Whether to auto start SSL handshake.
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`autoStartTls(String autoStartTls)` Whether to auto start SSL handshake.
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`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 MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`bridgeErrorHandler(String 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 MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`clientMode(boolean clientMode)` If the clientMode is true, mina consumer will connect the address as a TCP client.
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`clientMode(String clientMode)` If the clientMode is true, mina consumer will connect the address as a TCP client.
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`codec(Object codec)` To use a custom minda codec implementation.
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`codec(String codec)` To use a custom minda codec implementation.
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`decoderMaxLineLength(int decoderMaxLineLength)` To set the textline protocol decoder max line length.
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`decoderMaxLineLength(String decoderMaxLineLength)` To set the textline protocol decoder max line length.
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`disconnect(boolean disconnect)` Whether to disconnect(close) from Mina session right after use.
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`disconnect(String disconnect)` Whether to disconnect(close) from Mina session right after use.
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`encoderMaxLineLength(int encoderMaxLineLength)` To set the textline protocol encoder max line length.
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`encoderMaxLineLength(String encoderMaxLineLength)` To set the textline protocol encoder max line length.
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`encoding(String encoding)` You can configure the encoding (a charset name) to use for the TCP textline codec and the UDP protocol.
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`filters(List<Object> filters)` You can set a list of Mina IoFilters to use.
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`filters(String filters)` You can set a list of Mina IoFilters to use.
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`minaLogger(boolean minaLogger)` You can enable the Apache MINA logging filter.
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`minaLogger(String minaLogger)` You can enable the Apache MINA logging filter.
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`sslContextParameters(Object sslContextParameters)` To configure SSL security.
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`sslContextParameters(String sslContextParameters)` To configure SSL security.
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`sync(boolean sync)` Setting to set endpoint as one-way or request-response.
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`sync(String sync)` Setting to set endpoint as one-way or request-response.
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`textline(boolean textline)` Only used for TCP.
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`textline(String textline)` Only used for TCP.
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`textlineDelimiter(MinaEndpointBuilderFactory.MinaTextLineDelimiter textlineDelimiter)` Only used for TCP and if textline=true.
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`textlineDelimiter(String textlineDelimiter)` Only used for TCP and if textline=true.
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`timeout(long timeout)` You can configure the timeout that specifies how long to wait for a response from a remote server.
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`timeout(String timeout)` You can configure the timeout that specifies how long to wait for a response from a remote server.
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`writeTimeout(long writeTimeout)` Maximum amount of time it should take to send data to the MINA session.
`default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder`	`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

- Method Detail
  - advanced
```
default MinaEndpointBuilderFactory.AdvancedMinaEndpointConsumerBuilder advanced()
```
  - disconnect
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder 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
    
    Parameters:
    
    disconnect - the value to set
    
    Returns:
    
    the dsl builder
  - disconnect
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder 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
    
    Parameters:
    
    disconnect - the value to set
    
    Returns:
    
    the dsl builder
  - minaLogger
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder 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
    
    Parameters:
    
    minaLogger - the value to set
    
    Returns:
    
    the dsl builder
  - minaLogger
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder 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
    
    Parameters:
    
    minaLogger - the value to set
    
    Returns:
    
    the dsl builder
  - sync
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder 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
    
    Parameters:
    
    sync - the value to set
    
    Returns:
    
    the dsl builder
  - sync
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder 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
    
    Parameters:
    
    sync - the value to set
    
    Returns:
    
    the dsl builder
  - timeout
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder 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
    
    Parameters:
    
    timeout - the value to set
    
    Returns:
    
    the dsl builder
  - timeout
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder 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
    
    Parameters:
    
    timeout - the value to set
    
    Returns:
    
    the dsl builder
  - writeTimeout
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder 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
    
    Parameters:
    
    writeTimeout - the value to set
    
    Returns:
    
    the dsl builder
  - writeTimeout
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder 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
    
    Parameters:
    
    writeTimeout - the value to set
    
    Returns:
    
    the dsl builder
  - bridgeErrorHandler
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder 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
  - bridgeErrorHandler
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder bridgeErrorHandler(String 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 will be converted to a <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    bridgeErrorHandler - the value to set
    
    Returns:
    
    the dsl builder
  - clientMode
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder clientMode(boolean clientMode)
```
    If the clientMode is true, mina consumer will connect the address as a TCP client. The option is a: <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    clientMode - the value to set
    
    Returns:
    
    the dsl builder
  - clientMode
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder clientMode(String clientMode)
```
    If the clientMode is true, mina consumer will connect the address as a TCP client. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    clientMode - the value to set
    
    Returns:
    
    the dsl builder
  - allowDefaultCodec
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder 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
    
    Parameters:
    
    allowDefaultCodec - the value to set
    
    Returns:
    
    the dsl builder
  - allowDefaultCodec
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder 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
    
    Parameters:
    
    allowDefaultCodec - the value to set
    
    Returns:
    
    the dsl builder
  - codec
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder codec(Object codec)
```
    To use a custom minda codec implementation. The option is a: <code>org.apache.mina.filter.codec.ProtocolCodecFactory</code> type. Group: codec
    
    Parameters:
    
    codec - the value to set
    
    Returns:
    
    the dsl builder
  - codec
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder 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
    
    Parameters:
    
    codec - the value to set
    
    Returns:
    
    the dsl builder
  - decoderMaxLineLength
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder 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
    
    Parameters:
    
    decoderMaxLineLength - the value to set
    
    Returns:
    
    the dsl builder
  - decoderMaxLineLength
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder 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
    
    Parameters:
    
    decoderMaxLineLength - the value to set
    
    Returns:
    
    the dsl builder
  - encoderMaxLineLength
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder 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
    
    Parameters:
    
    encoderMaxLineLength - the value to set
    
    Returns:
    
    the dsl builder
  - encoderMaxLineLength
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder 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
    
    Parameters:
    
    encoderMaxLineLength - the value to set
    
    Returns:
    
    the dsl builder
  - encoding
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder 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
    
    Parameters:
    
    encoding - the value to set
    
    Returns:
    
    the dsl builder
  - filters
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder filters(List<Object> filters)
```
    You can set a list of Mina IoFilters to use. The option is a: <code>java.util.List<org.apache.mina.core.filterchain.IoFilter></code> type. Group: codec
    
    Parameters:
    
    filters - the value to set
    
    Returns:
    
    the dsl builder
  - filters
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder filters(String filters)
```
    You can set a list of Mina IoFilters to use. The option will be converted to a <code>java.util.List<org.apache.mina.core.filterchain.IoFilter></code> type. Group: codec
    
    Parameters:
    
    filters - the value to set
    
    Returns:
    
    the dsl builder
  - textline
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder 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
    
    Parameters:
    
    textline - the value to set
    
    Returns:
    
    the dsl builder
  - textline
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder 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
    
    Parameters:
    
    textline - the value to set
    
    Returns:
    
    the dsl builder
  - textlineDelimiter
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder textlineDelimiter(MinaEndpointBuilderFactory.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
    
    Parameters:
    
    textlineDelimiter - the value to set
    
    Returns:
    
    the dsl builder
  - textlineDelimiter
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder 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
    
    Parameters:
    
    textlineDelimiter - the value to set
    
    Returns:
    
    the dsl builder
  - autoStartTls
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder autoStartTls(boolean autoStartTls)
```
    Whether to auto start SSL handshake. The option is a: <code>boolean</code> type. Default: true Group: security
    
    Parameters:
    
    autoStartTls - the value to set
    
    Returns:
    
    the dsl builder
  - autoStartTls
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder autoStartTls(String autoStartTls)
```
    Whether to auto start SSL handshake. The option will be converted to a <code>boolean</code> type. Default: true Group: security
    
    Parameters:
    
    autoStartTls - the value to set
    
    Returns:
    
    the dsl builder
  - sslContextParameters
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder sslContextParameters(Object sslContextParameters)
```
    To configure SSL security. 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
  - sslContextParameters
```
default MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder 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
    
    Parameters:
    
    sslContextParameters - the value to set
    
    Returns:
    
    the dsl builder

Interface MinaEndpointBuilderFactory.MinaEndpointConsumerBuilder

Method Summary

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

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

Method Detail

advanced

disconnect

disconnect

minaLogger

minaLogger

sync

sync

timeout

timeout

writeTimeout

writeTimeout

bridgeErrorHandler

bridgeErrorHandler

clientMode

clientMode

allowDefaultCodec

allowDefaultCodec

codec

codec

decoderMaxLineLength

decoderMaxLineLength

encoderMaxLineLength

encoderMaxLineLength

encoding

filters

filters

textline

textline

textlineDelimiter

textlineDelimiter

autoStartTls

autoStartTls

sslContextParameters

sslContextParameters