| // kafka-connector options: START |
| [[camel-irc-kafka-connector-sink]] |
| = camel-irc-kafka-connector sink configuration |
| |
| When using camel-irc-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector: |
| |
| [source,xml] |
| ---- |
| <dependency> |
| <groupId>org.apache.camel.kafkaconnector</groupId> |
| <artifactId>camel-irc-kafka-connector</artifactId> |
| <version>x.x.x</version> |
| <!-- use the same version as your Camel Kafka connector version --> |
| </dependency> |
| ---- |
| |
| |
| The camel-irc sink connector supports 31 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Priority |
| | *camel.sink.path.hostname* | Hostname for the IRC chat server | null | HIGH |
| | *camel.sink.path.port* | Port number for the IRC chat server. If no port is configured then a default port of either 6667, 6668 or 6669 is used. | null | MEDIUM |
| | *camel.sink.endpoint.autoRejoin* | Whether to auto re-join when being kicked | true | MEDIUM |
| | *camel.sink.endpoint.channels* | Comma separated list of IRC channels. | null | MEDIUM |
| | *camel.sink.endpoint.commandTimeout* | Delay in milliseconds before sending commands after the connection is established. | 5000L | MEDIUM |
| | *camel.sink.endpoint.keys* | Comma separated list of keys for channels. | null | MEDIUM |
| | *camel.sink.endpoint.namesOnJoin* | Sends NAMES command to channel after joining it. onReply has to be true in order to process the result which will have the header value irc.num = '353'. | false | MEDIUM |
| | *camel.sink.endpoint.nickname* | The nickname used in chat. | null | MEDIUM |
| | *camel.sink.endpoint.persistent* | Use persistent messages. | true | LOW |
| | *camel.sink.endpoint.realname* | The IRC user's actual name. | null | MEDIUM |
| | *camel.sink.endpoint.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. | false | MEDIUM |
| | *camel.sink.endpoint.basicPropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM |
| | *camel.sink.endpoint.colors* | Whether or not the server supports color codes. | true | MEDIUM |
| | *camel.sink.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | MEDIUM |
| | *camel.sink.endpoint.onJoin* | Handle user join events. | true | MEDIUM |
| | *camel.sink.endpoint.onKick* | Handle kick events. | true | MEDIUM |
| | *camel.sink.endpoint.onMode* | Handle mode change events. | true | MEDIUM |
| | *camel.sink.endpoint.onNick* | Handle nickname change events. | true | MEDIUM |
| | *camel.sink.endpoint.onPart* | Handle user part events. | true | MEDIUM |
| | *camel.sink.endpoint.onPrivmsg* | Handle private message events. | true | MEDIUM |
| | *camel.sink.endpoint.onQuit* | Handle user quit events. | true | MEDIUM |
| | *camel.sink.endpoint.onReply* | Whether or not to handle general responses to commands or informational messages. | false | MEDIUM |
| | *camel.sink.endpoint.onTopic* | Handle topic change events. | true | MEDIUM |
| | *camel.sink.endpoint.nickPassword* | Your IRC server nickname password. | null | MEDIUM |
| | *camel.sink.endpoint.password* | The IRC server password. | null | MEDIUM |
| | *camel.sink.endpoint.sslContextParameters* | Used for configuring security using SSL. Reference to a org.apache.camel.support.jsse.SSLContextParameters in the Registry. This reference overrides any configured SSLContextParameters at the component level. Note that this setting overrides the trustManager option. | null | MEDIUM |
| | *camel.sink.endpoint.trustManager* | The trust manager used to verify the SSL server's certificate. | null | MEDIUM |
| | *camel.sink.endpoint.username* | The IRC server user name. | null | MEDIUM |
| | *camel.component.irc.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. | false | MEDIUM |
| | *camel.component.irc.basicPropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM |
| | *camel.component.irc.useGlobalSslContextParameters* | Enable usage of global SSL context parameters. | false | MEDIUM |
| |=== |
| // kafka-connector options: END |
