Interface IrcEndpointBuilderFactory.IrcEndpointBuilder
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder,org.apache.camel.EndpointConsumerResolver,org.apache.camel.builder.EndpointProducerBuilder,org.apache.camel.EndpointProducerResolver,IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder,IrcEndpointBuilderFactory.IrcEndpointProducerBuilder
- Enclosing interface:
- IrcEndpointBuilderFactory
public static interface IrcEndpointBuilderFactory.IrcEndpointBuilder
extends IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder, IrcEndpointBuilderFactory.IrcEndpointProducerBuilder
Builder for endpoint for the IRC component.
-
Method Summary
Modifier and TypeMethodDescriptionadvanced()autoRejoin(boolean autoRejoin) Whether to auto re-join when being kicked.autoRejoin(String autoRejoin) Whether to auto re-join when being kicked.Comma separated list of IRC channels.commandTimeout(long commandTimeout) Delay in milliseconds before sending commands after the connection is established.commandTimeout(String commandTimeout) Delay in milliseconds before sending commands after the connection is established.Comma separated list of keys for channels.namesOnJoin(boolean namesOnJoin) Sends NAMES command to channel after joining it.namesOnJoin(String namesOnJoin) Sends NAMES command to channel after joining it.The nickname used in chat.nickPassword(String nickPassword) Your IRC server nickname password.onJoin(boolean onJoin) Handle user join events.Handle user join events.onKick(boolean onKick) Handle kick events.Handle kick events.onMode(boolean onMode) Handle mode change events.Handle mode change events.onNick(boolean onNick) Handle nickname change events.Handle nickname change events.onPart(boolean onPart) Handle user part events.Handle user part events.onPrivmsg(boolean onPrivmsg) Handle private message events.Handle private message events.onQuit(boolean onQuit) Handle user quit events.Handle user quit events.onReply(boolean onReply) Whether or not to handle general responses to commands or informational messages.Whether or not to handle general responses to commands or informational messages.onTopic(boolean onTopic) Handle topic change events.Handle topic change events.The IRC server password.persistent(boolean persistent) Deprecated.persistent(String persistent) Deprecated.The IRC user's actual name.sslContextParameters(String sslContextParameters) Used for configuring security using SSL.sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters) Used for configuring security using SSL.trustManager(String trustManager) The trust manager used to verify the SSL server's certificate.trustManager(org.schwering.irc.lib.ssl.SSLTrustManager trustManager) The trust manager used to verify the SSL server's certificate.The IRC server user name.Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUriMethods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolveMethods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUriMethods inherited from interface org.apache.camel.EndpointProducerResolver
resolve, resolve
-
Method Details
-
advanced
- Specified by:
advancedin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
advancedin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder
-
autoRejoin
Whether to auto re-join when being kicked. The option is a: <code>boolean</code> type. Default: true Group: common- Specified by:
autoRejoinin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
autoRejoinin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
autoRejoin- the value to set- Returns:
- the dsl builder
-
autoRejoin
Whether to auto re-join when being kicked. The option will be converted to a <code>boolean</code> type. Default: true Group: common- Specified by:
autoRejoinin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
autoRejoinin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
autoRejoin- the value to set- Returns:
- the dsl builder
-
channels
Comma separated list of IRC channels. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
channelsin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
channelsin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
channels- the value to set- Returns:
- the dsl builder
-
commandTimeout
Delay in milliseconds before sending commands after the connection is established. The option is a: <code>long</code> type. Default: 5000 Group: common- Specified by:
commandTimeoutin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
commandTimeoutin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
commandTimeout- the value to set- Returns:
- the dsl builder
-
commandTimeout
Delay in milliseconds before sending commands after the connection is established. The option will be converted to a <code>long</code> type. Default: 5000 Group: common- Specified by:
commandTimeoutin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
commandTimeoutin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
commandTimeout- the value to set- Returns:
- the dsl builder
-
keys
Comma separated list of keys for channels. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
keysin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
keysin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
keys- the value to set- Returns:
- the dsl builder
-
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'. The option is a: <code>boolean</code> type. Default: false Group: common- Specified by:
namesOnJoinin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
namesOnJoinin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
namesOnJoin- the value to set- Returns:
- the dsl builder
-
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'. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Specified by:
namesOnJoinin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
namesOnJoinin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
namesOnJoin- the value to set- Returns:
- the dsl builder
-
nickname
The nickname used in chat. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
nicknamein interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
nicknamein interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
nickname- the value to set- Returns:
- the dsl builder
-
persistent
Deprecated.Use persistent messages. The option is a: <code>boolean</code> type. Default: true Group: common- Specified by:
persistentin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
persistentin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
persistent- the value to set- Returns:
- the dsl builder
-
persistent
Deprecated.Use persistent messages. The option will be converted to a <code>boolean</code> type. Default: true Group: common- Specified by:
persistentin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
persistentin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
persistent- the value to set- Returns:
- the dsl builder
-
realname
The IRC user's actual name. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
realnamein interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
realnamein interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
realname- the value to set- Returns:
- the dsl builder
-
onJoin
Handle user join events. The option is a: <code>boolean</code> type. Default: true Group: filter- Specified by:
onJoinin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
onJoinin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
onJoin- the value to set- Returns:
- the dsl builder
-
onJoin
Handle user join events. The option will be converted to a <code>boolean</code> type. Default: true Group: filter- Specified by:
onJoinin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
onJoinin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
onJoin- the value to set- Returns:
- the dsl builder
-
onKick
Handle kick events. The option is a: <code>boolean</code> type. Default: true Group: filter- Specified by:
onKickin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
onKickin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
onKick- the value to set- Returns:
- the dsl builder
-
onKick
Handle kick events. The option will be converted to a <code>boolean</code> type. Default: true Group: filter- Specified by:
onKickin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
onKickin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
onKick- the value to set- Returns:
- the dsl builder
-
onMode
Handle mode change events. The option is a: <code>boolean</code> type. Default: true Group: filter- Specified by:
onModein interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
onModein interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
onMode- the value to set- Returns:
- the dsl builder
-
onMode
Handle mode change events. The option will be converted to a <code>boolean</code> type. Default: true Group: filter- Specified by:
onModein interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
onModein interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
onMode- the value to set- Returns:
- the dsl builder
-
onNick
Handle nickname change events. The option is a: <code>boolean</code> type. Default: true Group: filter- Specified by:
onNickin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
onNickin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
onNick- the value to set- Returns:
- the dsl builder
-
onNick
Handle nickname change events. The option will be converted to a <code>boolean</code> type. Default: true Group: filter- Specified by:
onNickin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
onNickin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
onNick- the value to set- Returns:
- the dsl builder
-
onPart
Handle user part events. The option is a: <code>boolean</code> type. Default: true Group: filter- Specified by:
onPartin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
onPartin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
onPart- the value to set- Returns:
- the dsl builder
-
onPart
Handle user part events. The option will be converted to a <code>boolean</code> type. Default: true Group: filter- Specified by:
onPartin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
onPartin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
onPart- the value to set- Returns:
- the dsl builder
-
onPrivmsg
Handle private message events. The option is a: <code>boolean</code> type. Default: true Group: filter- Specified by:
onPrivmsgin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
onPrivmsgin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
onPrivmsg- the value to set- Returns:
- the dsl builder
-
onPrivmsg
Handle private message events. The option will be converted to a <code>boolean</code> type. Default: true Group: filter- Specified by:
onPrivmsgin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
onPrivmsgin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
onPrivmsg- the value to set- Returns:
- the dsl builder
-
onQuit
Handle user quit events. The option is a: <code>boolean</code> type. Default: true Group: filter- Specified by:
onQuitin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
onQuitin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
onQuit- the value to set- Returns:
- the dsl builder
-
onQuit
Handle user quit events. The option will be converted to a <code>boolean</code> type. Default: true Group: filter- Specified by:
onQuitin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
onQuitin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
onQuit- the value to set- Returns:
- the dsl builder
-
onReply
Whether or not to handle general responses to commands or informational messages. The option is a: <code>boolean</code> type. Default: false Group: filter- Specified by:
onReplyin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
onReplyin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
onReply- the value to set- Returns:
- the dsl builder
-
onReply
Whether or not to handle general responses to commands or informational messages. The option will be converted to a <code>boolean</code> type. Default: false Group: filter- Specified by:
onReplyin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
onReplyin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
onReply- the value to set- Returns:
- the dsl builder
-
onTopic
Handle topic change events. The option is a: <code>boolean</code> type. Default: true Group: filter- Specified by:
onTopicin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
onTopicin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
onTopic- the value to set- Returns:
- the dsl builder
-
onTopic
Handle topic change events. The option will be converted to a <code>boolean</code> type. Default: true Group: filter- Specified by:
onTopicin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
onTopicin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
onTopic- the value to set- Returns:
- the dsl builder
-
nickPassword
Your IRC server nickname password. The option is a: <code>java.lang.String</code> type. Group: security- Specified by:
nickPasswordin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
nickPasswordin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
nickPassword- the value to set- Returns:
- the dsl builder
-
password
The IRC server password. The option is a: <code>java.lang.String</code> type. Group: security- Specified by:
passwordin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
passwordin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
password- the value to set- Returns:
- the dsl builder
-
sslContextParameters
default IrcEndpointBuilderFactory.IrcEndpointBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters 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. The option is a: <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security- Specified by:
sslContextParametersin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
sslContextParametersin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
sslContextParameters- the value to set- Returns:
- the dsl builder
-
sslContextParameters
default IrcEndpointBuilderFactory.IrcEndpointBuilder sslContextParameters(String 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. The option will be converted to a <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security- Specified by:
sslContextParametersin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
sslContextParametersin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
sslContextParameters- the value to set- Returns:
- the dsl builder
-
trustManager
default IrcEndpointBuilderFactory.IrcEndpointBuilder trustManager(org.schwering.irc.lib.ssl.SSLTrustManager trustManager) The trust manager used to verify the SSL server's certificate. The option is a: <code>org.schwering.irc.lib.ssl.SSLTrustManager</code> type. Group: security- Specified by:
trustManagerin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
trustManagerin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
trustManager- the value to set- Returns:
- the dsl builder
-
trustManager
The trust manager used to verify the SSL server's certificate. The option will be converted to a <code>org.schwering.irc.lib.ssl.SSLTrustManager</code> type. Group: security- Specified by:
trustManagerin interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
trustManagerin interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
trustManager- the value to set- Returns:
- the dsl builder
-
username
The IRC server user name. The option is a: <code>java.lang.String</code> type. Group: security- Specified by:
usernamein interfaceIrcEndpointBuilderFactory.IrcEndpointConsumerBuilder- Specified by:
usernamein interfaceIrcEndpointBuilderFactory.IrcEndpointProducerBuilder- Parameters:
username- the value to set- Returns:
- the dsl builder
-