Interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
IrcEndpointBuilderFactory.IrcEndpointBuilder
- Enclosing interface:
- IrcEndpointBuilderFactory
public static interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the IRC component.
-
-
Method Summary
-
-
-
Method Detail
-
advanced
default IrcEndpointBuilderFactory.AdvancedIrcEndpointConsumerBuilder advanced()
-
autoRejoin
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder autoRejoin(boolean autoRejoin)
Whether to auto re-join when being kicked. The option is a: <code>boolean</code> type. Default: true Group: common- Parameters:
autoRejoin
- the value to set- Returns:
- the dsl builder
-
autoRejoin
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder autoRejoin(String autoRejoin)
Whether to auto re-join when being kicked. The option will be converted to a <code>boolean</code> type. Default: true Group: common- Parameters:
autoRejoin
- the value to set- Returns:
- the dsl builder
-
channels
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder channels(String channels)
Comma separated list of IRC channels. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
channels
- the value to set- Returns:
- the dsl builder
-
commandTimeout
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder commandTimeout(long commandTimeout)
Delay in milliseconds before sending commands after the connection is established. The option is a: <code>long</code> type. Default: 5000 Group: common- Parameters:
commandTimeout
- the value to set- Returns:
- the dsl builder
-
commandTimeout
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder commandTimeout(String 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- Parameters:
commandTimeout
- the value to set- Returns:
- the dsl builder
-
keys
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder keys(String keys)
Comma separated list of keys for channels. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
keys
- the value to set- Returns:
- the dsl builder
-
namesOnJoin
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder namesOnJoin(boolean 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- Parameters:
namesOnJoin
- the value to set- Returns:
- the dsl builder
-
namesOnJoin
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder namesOnJoin(String 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- Parameters:
namesOnJoin
- the value to set- Returns:
- the dsl builder
-
nickname
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder nickname(String nickname)
The nickname used in chat. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
nickname
- the value to set- Returns:
- the dsl builder
-
persistent
@Deprecated default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder persistent(boolean persistent)
Deprecated.Use persistent messages. The option is a: <code>boolean</code> type. Default: true Group: common- Parameters:
persistent
- the value to set- Returns:
- the dsl builder
-
persistent
@Deprecated default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder persistent(String persistent)
Deprecated.Use persistent messages. The option will be converted to a <code>boolean</code> type. Default: true Group: common- Parameters:
persistent
- the value to set- Returns:
- the dsl builder
-
realname
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder realname(String realname)
The IRC user's actual name. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
realname
- the value to set- Returns:
- the dsl builder
-
onJoin
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onJoin(boolean onJoin)
Handle user join events. The option is a: <code>boolean</code> type. Default: true Group: filter- Parameters:
onJoin
- the value to set- Returns:
- the dsl builder
-
onJoin
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onJoin(String onJoin)
Handle user join events. The option will be converted to a <code>boolean</code> type. Default: true Group: filter- Parameters:
onJoin
- the value to set- Returns:
- the dsl builder
-
onKick
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onKick(boolean onKick)
Handle kick events. The option is a: <code>boolean</code> type. Default: true Group: filter- Parameters:
onKick
- the value to set- Returns:
- the dsl builder
-
onKick
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onKick(String onKick)
Handle kick events. The option will be converted to a <code>boolean</code> type. Default: true Group: filter- Parameters:
onKick
- the value to set- Returns:
- the dsl builder
-
onMode
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onMode(boolean onMode)
Handle mode change events. The option is a: <code>boolean</code> type. Default: true Group: filter- Parameters:
onMode
- the value to set- Returns:
- the dsl builder
-
onMode
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onMode(String onMode)
Handle mode change events. The option will be converted to a <code>boolean</code> type. Default: true Group: filter- Parameters:
onMode
- the value to set- Returns:
- the dsl builder
-
onNick
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onNick(boolean onNick)
Handle nickname change events. The option is a: <code>boolean</code> type. Default: true Group: filter- Parameters:
onNick
- the value to set- Returns:
- the dsl builder
-
onNick
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onNick(String onNick)
Handle nickname change events. The option will be converted to a <code>boolean</code> type. Default: true Group: filter- Parameters:
onNick
- the value to set- Returns:
- the dsl builder
-
onPart
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onPart(boolean onPart)
Handle user part events. The option is a: <code>boolean</code> type. Default: true Group: filter- Parameters:
onPart
- the value to set- Returns:
- the dsl builder
-
onPart
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onPart(String onPart)
Handle user part events. The option will be converted to a <code>boolean</code> type. Default: true Group: filter- Parameters:
onPart
- the value to set- Returns:
- the dsl builder
-
onPrivmsg
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onPrivmsg(boolean onPrivmsg)
Handle private message events. The option is a: <code>boolean</code> type. Default: true Group: filter- Parameters:
onPrivmsg
- the value to set- Returns:
- the dsl builder
-
onPrivmsg
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onPrivmsg(String onPrivmsg)
Handle private message events. The option will be converted to a <code>boolean</code> type. Default: true Group: filter- Parameters:
onPrivmsg
- the value to set- Returns:
- the dsl builder
-
onQuit
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onQuit(boolean onQuit)
Handle user quit events. The option is a: <code>boolean</code> type. Default: true Group: filter- Parameters:
onQuit
- the value to set- Returns:
- the dsl builder
-
onQuit
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onQuit(String onQuit)
Handle user quit events. The option will be converted to a <code>boolean</code> type. Default: true Group: filter- Parameters:
onQuit
- the value to set- Returns:
- the dsl builder
-
onReply
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onReply(boolean 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- Parameters:
onReply
- the value to set- Returns:
- the dsl builder
-
onReply
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onReply(String 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- Parameters:
onReply
- the value to set- Returns:
- the dsl builder
-
onTopic
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onTopic(boolean onTopic)
Handle topic change events. The option is a: <code>boolean</code> type. Default: true Group: filter- Parameters:
onTopic
- the value to set- Returns:
- the dsl builder
-
onTopic
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onTopic(String onTopic)
Handle topic change events. The option will be converted to a <code>boolean</code> type. Default: true Group: filter- Parameters:
onTopic
- the value to set- Returns:
- the dsl builder
-
nickPassword
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder nickPassword(String nickPassword)
Your IRC server nickname password. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
nickPassword
- the value to set- Returns:
- the dsl builder
-
password
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder password(String password)
The IRC server password. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
password
- the value to set- Returns:
- the dsl builder
-
sslContextParameters
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder 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- Parameters:
sslContextParameters
- the value to set- Returns:
- the dsl builder
-
sslContextParameters
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder 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- Parameters:
sslContextParameters
- the value to set- Returns:
- the dsl builder
-
trustManager
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder 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- Parameters:
trustManager
- the value to set- Returns:
- the dsl builder
-
trustManager
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder trustManager(String 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- Parameters:
trustManager
- the value to set- Returns:
- the dsl builder
-
username
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder username(String username)
The IRC server user name. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
username
- the value to set- Returns:
- the dsl builder
-
-