IRC Component
The irc component implements an IRC (Internet Relay Chat) transport.
URI format
irc:nick@host[:port]/#room[?options]
In Camel 2.0, you can also use the following format:
irc:nick@host[:port]?channels=#channel1,#channel2,#channel3[?options]
You can append query options to the URI in the following format, ?option=value&option=value&...
Options
| Name |
Description |
Example |
Default Value |
| channels |
New in 2.0, comma separated list of IRC channels to join. |
channels=#channel1,#channel2 |
null |
| nickname |
The nickname used in chat. |
irc:MyNick@irc.server.org#channel or irc:irc.server.org#channel?nickname=MyUser |
null |
| username |
The IRC server user name. |
irc:MyUser@irc.server.org#channel or irc:irc.server.org#channel?username=MyUser |
Same as nickname. |
| password |
The IRC server password. |
password=somepass |
None |
| realname |
The IRC user's actual name. |
realname=MyName |
None |
| colors |
Whether or not the server supports color codes. |
true, false |
true |
| onReply |
Whether or not to handle general responses to commands or informational messages. |
true, false |
false |
| onNick |
Handle nickname change events. |
true, false |
true |
| onQuit |
Handle user quit events. |
true, false |
true |
| onJoin |
Handle user join events. |
true, false |
true |
| onKick |
Handle kick events. |
true, false |
true |
| onMode |
Handle mode change events. |
true, false |
true |
| onPart |
Handle user part events. |
true, false |
true |
| onTopic |
Handle topic change events. |
true, false |
true |
| onPrivmsg |
Handle message events. |
true, false |
true |
| trustManager |
New in 2.0, the trust manager used to verify the SSL server's certificate. |
trustManager=#referenceToTrustManagerBean |
The default trust manager, which accepts all certificates, will be used. |
SSL Support
As of Camel 2.0, you can also connect to an SSL enabled IRC server, as follows:
ircs:host[:port]/#room?username=user&password=pass
By default, the IRC transport uses SSLDefaultTrustManager. If you need to provide your own custom trust manager, use the trustManager parameter as follows:
ircs:host[:port]/#room?username=user&password=pass&trustManager=#referenceToMyTrustManagerBean
See Also