| {"component":{"kind":"component","name":"mina","title":"Mina","description":"Socket level networking using TCP or UDP with Apache Mina 2.x.","deprecated":false,"firstVersion":"2.10.0","label":"networking,tcp,udp","javaType":"org.apache.camel.component.mina.MinaComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mina","version":"3.18.1","scheme":"mina","extendsScheme":"","syntax":"mina:protocol:host:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false},"headers":{"CamelMinaCloseSessionWhenComplete":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Indicates whether the session should be closed after complete","constantName":"org.apache.camel.component.mina.MinaConstants#MINA_CLOSE_SESSION_WHEN_COMPLETE"},"CamelMinaIoSession":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.apache.mina.core.session.IoSession","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key of the IoSession which is stored in the message header","constantName":"org.apache.camel.component.mina.MinaConstants#MINA_IOSESSION"},"CamelMinaLocalAddress":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"java.net.SocketAddress","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The socket address of local machine that received the message.","constantName":"org.apache.camel.component.mina.MinaConstants#MINA_LOCAL_ADDRESS"},"CamelMinaRemoteAddress":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"java.net.SocketAddress","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The socket address of the remote machine that send the message.","constantName":"org.apache.camel.component.mina.MinaConstants#MINA_REMOTE_ADDRESS"}},"properties":{"protocol":{"kind":"path","displayName":"Protocol","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Protocol to use"},"host":{"kind":"path","displayName":"Host","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Hostname to use. Use localhost or 0.0.0.0 for local server as consumer. For producer use the hostname or ip address of the remote server."},"port":{"kind":"path","displayName":"Port","group":"common","label":"","required":true,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Port number"},"disconnect":{"kind":"parameter","displayName":"Disconnect","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Whether to disconnect(close) from Mina session right after use. Can be used for both consumer and producer."},"minaLogger":{"kind":"parameter","displayName":"Mina Logger","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"You can enable the Apache MINA logging filter. Apache MINA uses slf4j logging at INFO level to log all input and output."},"sync":{"kind":"parameter","displayName":"Sync","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Setting to set endpoint as one-way or request-response."},"timeout":{"kind":"parameter","displayName":"Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"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."},"writeTimeout":{"kind":"parameter","displayName":"Write Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Maximum amount of time it should take to send data to the MINA session. Default is 10000 milliseconds."},"clientMode":{"kind":"parameter","displayName":"Client Mode","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"If the clientMode is true, mina consumer will connect the address as a TCP client."},"bridgeErrorHandler":{"kind":"parameter","displayName":"Bridge Error Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"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."},"exceptionHandler":{"kind":"parameter","displayName":"Exception Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.ExceptionHandler","optionalPrefix":"consumer.","deprecated":false,"autowired":false,"secret":false,"description":"To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored."},"exchangePattern":{"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut","InOptionalOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"noReplyLogLevel":{"kind":"parameter","displayName":"No Reply Log Level","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"WARN","configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"If sync is enabled this option dictates MinaConsumer which logging level to use when logging a there is no reply to send back."},"cachedAddress":{"kind":"parameter","displayName":"Cached Address","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Whether to create the InetAddress once and reuse. Setting this to false allows to pickup DNS changes in the network."},"lazySessionCreation":{"kind":"parameter","displayName":"Lazy Session Creation","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Sessions can be lazily created to avoid exceptions, if the remote server is not up and running when the Camel producer is started."},"lazyStartProducer":{"kind":"parameter","displayName":"Lazy Start Producer","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"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."},"disconnectOnNoReply":{"kind":"parameter","displayName":"Disconnect On No Reply","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"If sync is enabled then this option dictates MinaConsumer if it should disconnect where there is no reply to send back."},"maximumPoolSize":{"kind":"parameter","displayName":"Maximum Pool Size","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":16,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Number of worker threads in the worker pool for TCP and UDP"},"orderedThreadPoolExecutor":{"kind":"parameter","displayName":"Ordered Thread Pool Executor","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Whether to use ordered thread pool, to ensure events are processed orderly on the same channel."},"transferExchange":{"kind":"parameter","displayName":"Transfer Exchange","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"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."},"allowDefaultCodec":{"kind":"parameter","displayName":"Allow Default Codec","group":"codec","label":"codec","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"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."},"codec":{"kind":"parameter","displayName":"Codec","group":"codec","label":"codec","required":false,"type":"object","javaType":"org.apache.mina.filter.codec.ProtocolCodecFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"To use a custom minda codec implementation."},"decoderMaxLineLength":{"kind":"parameter","displayName":"Decoder Max Line Length","group":"codec","label":"codec","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1024,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"To set the textline protocol decoder max line length. By default the default value of Mina itself is used which are 1024."},"encoderMaxLineLength":{"kind":"parameter","displayName":"Encoder Max Line Length","group":"codec","label":"codec","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"To set the textline protocol encoder max line length. By default the default value of Mina itself is used which are Integer.MAX_VALUE."},"encoding":{"kind":"parameter","displayName":"Encoding","group":"codec","label":"codec","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"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"},"filters":{"kind":"parameter","displayName":"Filters","group":"codec","label":"codec","required":false,"type":"array","javaType":"java.util.List<org.apache.mina.core.filterchain.IoFilter>","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"You can set a list of Mina IoFilters to use."},"textline":{"kind":"parameter","displayName":"Textline","group":"codec","label":"codec","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"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."},"textlineDelimiter":{"kind":"parameter","displayName":"Textline Delimiter","group":"codec","label":"codec","required":false,"type":"object","javaType":"org.apache.camel.component.mina.MinaTextLineDelimiter","enum":["DEFAULT","AUTO","UNIX","WINDOWS","MAC"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"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."},"autoStartTls":{"kind":"parameter","displayName":"Auto Start Tls","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"Whether to auto start SSL handshake."},"sslContextParameters":{"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.mina.MinaConfiguration","configurationField":"configuration","description":"To configure SSL security."}}} |