MinaComponentBuilderFactory.MinaComponentBuilder (Camel

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.mina.MinaComponent>

All Known Implementing Classes:

MinaComponentBuilderFactory.MinaComponentBuilderImpl

Enclosing interface:

MinaComponentBuilderFactory
```
public static interface MinaComponentBuilderFactory.MinaComponentBuilder
extends ComponentBuilder<org.apache.camel.component.mina.MinaComponent>
```
Builder for the Mina component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default MinaComponentBuilderFactory.MinaComponentBuilder`	`allowDefaultCodec(boolean allowDefaultCodec)` The mina component installs a default codec if both, codec is null and textline is false.
`default MinaComponentBuilderFactory.MinaComponentBuilder`	`autoStartTls(boolean autoStartTls)` Whether to auto start SSL handshake.
`default MinaComponentBuilderFactory.MinaComponentBuilder`	`basicPropertyBinding(boolean basicPropertyBinding)` Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities.
`default MinaComponentBuilderFactory.MinaComponentBuilder`	`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 MinaComponentBuilderFactory.MinaComponentBuilder`	`cachedAddress(boolean cachedAddress)` Whether to create the InetAddress once and reuse.
`default MinaComponentBuilderFactory.MinaComponentBuilder`	`clientMode(boolean clientMode)` If the clientMode is true, mina consumer will connect the address as a TCP client.
`default MinaComponentBuilderFactory.MinaComponentBuilder`	`codec(org.apache.mina.filter.codec.ProtocolCodecFactory codec)` To use a custom minda codec implementation.
`default MinaComponentBuilderFactory.MinaComponentBuilder`	`configuration(org.apache.camel.component.mina.MinaConfiguration configuration)` To use the shared mina configuration.
`default MinaComponentBuilderFactory.MinaComponentBuilder`	`decoderMaxLineLength(int decoderMaxLineLength)` To set the textline protocol decoder max line length.
`default MinaComponentBuilderFactory.MinaComponentBuilder`	`disconnect(boolean disconnect)` Whether or not to disconnect(close) from Mina session right after use.
`default MinaComponentBuilderFactory.MinaComponentBuilder`	`disconnectOnNoReply(boolean disconnectOnNoReply)` If sync is enabled then this option dictates MinaConsumer if it should disconnect where there is no reply to send back.
`default MinaComponentBuilderFactory.MinaComponentBuilder`	`encoderMaxLineLength(int encoderMaxLineLength)` To set the textline protocol encoder max line length.
`default MinaComponentBuilderFactory.MinaComponentBuilder`	`encoding(String encoding)` You can configure the encoding (a charset name) to use for the TCP textline codec and the UDP protocol.
`default MinaComponentBuilderFactory.MinaComponentBuilder`	`filters(List<org.apache.mina.core.filterchain.IoFilter> filters)` You can set a list of Mina IoFilters to use.
`default MinaComponentBuilderFactory.MinaComponentBuilder`	`lazySessionCreation(boolean lazySessionCreation)` Sessions can be lazily created to avoid exceptions, if the remote server is not up and running when the Camel producer is started.
`default MinaComponentBuilderFactory.MinaComponentBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default MinaComponentBuilderFactory.MinaComponentBuilder`	`maximumPoolSize(int maximumPoolSize)` Number of worker threads in the worker pool for TCP and UDP.
`default MinaComponentBuilderFactory.MinaComponentBuilder`	`minaLogger(boolean minaLogger)` You can enable the Apache MINA logging filter.
`default MinaComponentBuilderFactory.MinaComponentBuilder`	`noReplyLogLevel(org.apache.camel.LoggingLevel noReplyLogLevel)` If sync is enabled this option dictates MinaConsumer which logging level to use when logging a there is no reply to send back.
`default MinaComponentBuilderFactory.MinaComponentBuilder`	`orderedThreadPoolExecutor(boolean orderedThreadPoolExecutor)` Whether to use ordered thread pool, to ensure events are processed orderly on the same channel.
`default MinaComponentBuilderFactory.MinaComponentBuilder`	`sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)` To configure SSL security.
`default MinaComponentBuilderFactory.MinaComponentBuilder`	`sync(boolean sync)` Setting to set endpoint as one-way or request-response.
`default MinaComponentBuilderFactory.MinaComponentBuilder`	`textline(boolean textline)` Only used for TCP.
`default MinaComponentBuilderFactory.MinaComponentBuilder`	`textlineDelimiter(org.apache.camel.component.mina.MinaTextLineDelimiter textlineDelimiter)` Only used for TCP and if textline=true.
`default MinaComponentBuilderFactory.MinaComponentBuilder`	`timeout(long timeout)` You can configure the timeout that specifies how long to wait for a response from a remote server.
`default MinaComponentBuilderFactory.MinaComponentBuilder`	`transferExchange(boolean transferExchange)` Only used for TCP.
`default MinaComponentBuilderFactory.MinaComponentBuilder`	`useGlobalSslContextParameters(boolean useGlobalSslContextParameters)` Enable usage of global SSL context parameters.
`default MinaComponentBuilderFactory.MinaComponentBuilder`	`writeTimeout(long writeTimeout)` Maximum amount of time it should take to send data to the MINA session.

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register

- Method Detail
  - disconnect
```
default MinaComponentBuilderFactory.MinaComponentBuilder disconnect(boolean disconnect)
```
    Whether or not to disconnect(close) from Mina session right after use. Can be used for both consumer and producer. The option is a: boolean type. Default: false Group: common
  - minaLogger
```
default MinaComponentBuilderFactory.MinaComponentBuilder 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: boolean type. Default: false Group: common
  - sync
```
default MinaComponentBuilderFactory.MinaComponentBuilder sync(boolean sync)
```
    Setting to set endpoint as one-way or request-response. The option is a: boolean type. Default: true Group: common
  - timeout
```
default MinaComponentBuilderFactory.MinaComponentBuilder 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: long type. Default: 30000 Group: common
  - writeTimeout
```
default MinaComponentBuilderFactory.MinaComponentBuilder 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: long type. Default: 10000 Group: common
  - bridgeErrorHandler
```
default MinaComponentBuilderFactory.MinaComponentBuilder 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: boolean type. Default: false Group: consumer
  - clientMode
```
default MinaComponentBuilderFactory.MinaComponentBuilder clientMode(boolean clientMode)
```
    If the clientMode is true, mina consumer will connect the address as a TCP client. The option is a: boolean type. Default: false Group: consumer
  - disconnectOnNoReply
```
default MinaComponentBuilderFactory.MinaComponentBuilder disconnectOnNoReply(boolean disconnectOnNoReply)
```
    If sync is enabled then this option dictates MinaConsumer if it should disconnect where there is no reply to send back. The option is a: boolean type. Default: true Group: consumer (advanced)
  - noReplyLogLevel
```
default MinaComponentBuilderFactory.MinaComponentBuilder noReplyLogLevel(org.apache.camel.LoggingLevel noReplyLogLevel)
```
    If sync is enabled this option dictates MinaConsumer which logging level to use when logging a there is no reply to send back. The option is a: org.apache.camel.LoggingLevel type. Default: WARN Group: consumer (advanced)
  - lazyStartProducer
```
default MinaComponentBuilderFactory.MinaComponentBuilder 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: boolean type. Default: false Group: producer
  - cachedAddress
```
default MinaComponentBuilderFactory.MinaComponentBuilder cachedAddress(boolean cachedAddress)
```
    Whether to create the InetAddress once and reuse. Setting this to false allows to pickup DNS changes in the network. The option is a: boolean type. Default: true Group: producer (advanced)
  - lazySessionCreation
```
default MinaComponentBuilderFactory.MinaComponentBuilder lazySessionCreation(boolean lazySessionCreation)
```
    Sessions can be lazily created to avoid exceptions, if the remote server is not up and running when the Camel producer is started. The option is a: boolean type. Default: true Group: producer (advanced)
  - basicPropertyBinding
```
default MinaComponentBuilderFactory.MinaComponentBuilder basicPropertyBinding(boolean basicPropertyBinding)
```
    Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option is a: boolean type. Default: false Group: advanced
  - configuration
```
default MinaComponentBuilderFactory.MinaComponentBuilder configuration(org.apache.camel.component.mina.MinaConfiguration configuration)
```
    To use the shared mina configuration. The option is a: org.apache.camel.component.mina.MinaConfiguration type. Group: advanced
  - maximumPoolSize
```
default MinaComponentBuilderFactory.MinaComponentBuilder maximumPoolSize(int maximumPoolSize)
```
    Number of worker threads in the worker pool for TCP and UDP. The option is a: int type. Default: 16 Group: advanced
  - orderedThreadPoolExecutor
```
default MinaComponentBuilderFactory.MinaComponentBuilder orderedThreadPoolExecutor(boolean orderedThreadPoolExecutor)
```
    Whether to use ordered thread pool, to ensure events are processed orderly on the same channel. The option is a: boolean type. Default: true Group: advanced
  - transferExchange
```
default MinaComponentBuilderFactory.MinaComponentBuilder transferExchange(boolean transferExchange)
```
    Only used for TCP. You can transfer the exchange over the wire instead of just the body. The following fields are transferred: In body, Out body, fault body, In headers, Out headers, fault headers, exchange properties, exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. The option is a: boolean type. Default: false Group: advanced
  - allowDefaultCodec
```
default MinaComponentBuilderFactory.MinaComponentBuilder 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: boolean type. Default: true Group: codec
  - codec
```
default MinaComponentBuilderFactory.MinaComponentBuilder codec(org.apache.mina.filter.codec.ProtocolCodecFactory codec)
```
    To use a custom minda codec implementation. The option is a: org.apache.mina.filter.codec.ProtocolCodecFactory type. Group: codec
  - decoderMaxLineLength
```
default MinaComponentBuilderFactory.MinaComponentBuilder 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: int type. Default: 1024 Group: codec
  - encoderMaxLineLength
```
default MinaComponentBuilderFactory.MinaComponentBuilder 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: int type. Default: -1 Group: codec
  - encoding
```
default MinaComponentBuilderFactory.MinaComponentBuilder 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: java.lang.String type. Group: codec
  - filters
```
default MinaComponentBuilderFactory.MinaComponentBuilder filters(List<org.apache.mina.core.filterchain.IoFilter> filters)
```
    You can set a list of Mina IoFilters to use. The option is a: java.util.List type. Group: codec
  - textline
```
default MinaComponentBuilderFactory.MinaComponentBuilder 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: boolean type. Default: false Group: codec
  - textlineDelimiter
```
default MinaComponentBuilderFactory.MinaComponentBuilder 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: org.apache.camel.component.mina.MinaTextLineDelimiter type. Group: codec
  - autoStartTls
```
default MinaComponentBuilderFactory.MinaComponentBuilder autoStartTls(boolean autoStartTls)
```
    Whether to auto start SSL handshake. The option is a: boolean type. Default: true Group: security
  - sslContextParameters
```
default MinaComponentBuilderFactory.MinaComponentBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
```
    To configure SSL security. The option is a: org.apache.camel.support.jsse.SSLContextParameters type. Group: security
  - useGlobalSslContextParameters
```
default MinaComponentBuilderFactory.MinaComponentBuilder useGlobalSslContextParameters(boolean useGlobalSslContextParameters)
```
    Enable usage of global SSL context parameters. The option is a: boolean type. Default: false Group: security

Interface MinaComponentBuilderFactory.MinaComponentBuilder

Method Summary

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

Method Detail

disconnect

minaLogger

sync

timeout

writeTimeout

bridgeErrorHandler

clientMode

disconnectOnNoReply

noReplyLogLevel

lazyStartProducer

cachedAddress

lazySessionCreation

basicPropertyBinding

configuration

maximumPoolSize

orderedThreadPoolExecutor

transferExchange

allowDefaultCodec

codec

decoderMaxLineLength

encoderMaxLineLength

encoding

filters

textline

textlineDelimiter

autoStartTls

sslContextParameters

useGlobalSslContextParameters