IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder (Camel

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

All Methods Instance Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default IrcEndpointBuilderFactory.AdvancedIrcEndpointConsumerBuilder`	`advanced()`
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`autoRejoin(boolean autoRejoin)` Whether to auto re-join when being kicked.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`autoRejoin(String autoRejoin)` Whether to auto re-join when being kicked.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`bridgeErrorHandler(boolean bridgeErrorHandler)` 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.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`bridgeErrorHandler(String bridgeErrorHandler)` 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.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`channels(String channels)` Comma separated list of IRC channels.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`commandTimeout(long commandTimeout)` Delay in milliseconds before sending commands after the connection is established.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`commandTimeout(String commandTimeout)` Delay in milliseconds before sending commands after the connection is established.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`keys(String keys)` Comma separated list of keys for channels.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`namesOnJoin(boolean namesOnJoin)` Sends NAMES command to channel after joining it.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`namesOnJoin(String namesOnJoin)` Sends NAMES command to channel after joining it.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`nickname(String nickname)` The nickname used in chat.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`nickPassword(String nickPassword)` Your IRC server nickname password.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`onJoin(boolean onJoin)` Handle user join events.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`onJoin(String onJoin)` Handle user join events.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`onKick(boolean onKick)` Handle kick events.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`onKick(String onKick)` Handle kick events.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`onMode(boolean onMode)` Handle mode change events.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`onMode(String onMode)` Handle mode change events.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`onNick(boolean onNick)` Handle nickname change events.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`onNick(String onNick)` Handle nickname change events.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`onPart(boolean onPart)` Handle user part events.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`onPart(String onPart)` Handle user part events.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`onPrivmsg(boolean onPrivmsg)` Handle private message events.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`onPrivmsg(String onPrivmsg)` Handle private message events.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`onQuit(boolean onQuit)` Handle user quit events.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`onQuit(String onQuit)` Handle user quit events.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`onReply(boolean onReply)` Whether or not to handle general responses to commands or informational messages.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`onReply(String onReply)` Whether or not to handle general responses to commands or informational messages.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`onTopic(boolean onTopic)` Handle topic change events.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`onTopic(String onTopic)` Handle topic change events.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`password(String password)` The IRC server password.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`persistent(boolean persistent)` Deprecated.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`persistent(String persistent)` Deprecated.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`realname(String realname)` The IRC user's actual name.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`sslContextParameters(Object sslContextParameters)` Used for configuring security using SSL.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`sslContextParameters(String sslContextParameters)` Used for configuring security using SSL.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`trustManager(Object trustManager)` The trust manager used to verify the SSL server's certificate.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`trustManager(String trustManager)` The trust manager used to verify the SSL server's certificate.
`default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder`	`username(String username)` The IRC server user name.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve

- 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: boolean type. Default: true Group: common
  - autoRejoin
```
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder autoRejoin(String autoRejoin)
```
    Whether to auto re-join when being kicked. The option will be converted to a boolean type. Default: true Group: common
  - channels
```
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder channels(String channels)
```
    Comma separated list of IRC channels. The option is a: java.lang.String type. Group: common
  - commandTimeout
```
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder commandTimeout(long commandTimeout)
```
    Delay in milliseconds before sending commands after the connection is established. The option is a: long type. Default: 5000 Group: common
  - 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 long type. Default: 5000 Group: common
  - keys
```
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder keys(String keys)
```
    Comma separated list of keys for channels. The option is a: java.lang.String type. Group: common
  - 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: boolean type. Default: false Group: common
  - 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 boolean type. Default: false Group: common
  - nickname
```
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder nickname(String nickname)
```
    The nickname used in chat. The option is a: java.lang.String type. Group: common
  - persistent
```
@Deprecated
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder persistent(boolean persistent)
```
    Deprecated.
    
    Use persistent messages. The option is a: boolean type. Default: true Group: common
  - persistent
```
@Deprecated
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder persistent(String persistent)
```
    Deprecated.
    
    Use persistent messages. The option will be converted to a boolean type. Default: true Group: common
  - realname
```
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder realname(String realname)
```
    The IRC user's actual name. The option is a: java.lang.String type. Group: common
  - bridgeErrorHandler
```
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
```
    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. The option is a: boolean type. Default: false Group: consumer
  - bridgeErrorHandler
```
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder bridgeErrorHandler(String bridgeErrorHandler)
```
    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. The option will be converted to a boolean type. Default: false Group: consumer
  - onJoin
```
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onJoin(boolean onJoin)
```
    Handle user join events. The option is a: boolean type. Default: true Group: filter
  - onJoin
```
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onJoin(String onJoin)
```
    Handle user join events. The option will be converted to a boolean type. Default: true Group: filter
  - onKick
```
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onKick(boolean onKick)
```
    Handle kick events. The option is a: boolean type. Default: true Group: filter
  - onKick
```
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onKick(String onKick)
```
    Handle kick events. The option will be converted to a boolean type. Default: true Group: filter
  - onMode
```
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onMode(boolean onMode)
```
    Handle mode change events. The option is a: boolean type. Default: true Group: filter
  - onMode
```
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onMode(String onMode)
```
    Handle mode change events. The option will be converted to a boolean type. Default: true Group: filter
  - onNick
```
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onNick(boolean onNick)
```
    Handle nickname change events. The option is a: boolean type. Default: true Group: filter
  - onNick
```
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onNick(String onNick)
```
    Handle nickname change events. The option will be converted to a boolean type. Default: true Group: filter
  - onPart
```
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onPart(boolean onPart)
```
    Handle user part events. The option is a: boolean type. Default: true Group: filter
  - onPart
```
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onPart(String onPart)
```
    Handle user part events. The option will be converted to a boolean type. Default: true Group: filter
  - onPrivmsg
```
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onPrivmsg(boolean onPrivmsg)
```
    Handle private message events. The option is a: boolean type. Default: true Group: filter
  - onPrivmsg
```
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onPrivmsg(String onPrivmsg)
```
    Handle private message events. The option will be converted to a boolean type. Default: true Group: filter
  - onQuit
```
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onQuit(boolean onQuit)
```
    Handle user quit events. The option is a: boolean type. Default: true Group: filter
  - onQuit
```
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onQuit(String onQuit)
```
    Handle user quit events. The option will be converted to a boolean type. Default: true Group: filter
  - onReply
```
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onReply(boolean onReply)
```
    Whether or not to handle general responses to commands or informational messages. The option is a: boolean type. Default: false Group: filter
  - 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 boolean type. Default: false Group: filter
  - onTopic
```
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onTopic(boolean onTopic)
```
    Handle topic change events. The option is a: boolean type. Default: true Group: filter
  - onTopic
```
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder onTopic(String onTopic)
```
    Handle topic change events. The option will be converted to a boolean type. Default: true Group: filter
  - nickPassword
```
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder nickPassword(String nickPassword)
```
    Your IRC server nickname password. The option is a: java.lang.String type. Group: security
  - password
```
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder password(String password)
```
    The IRC server password. The option is a: java.lang.String type. Group: security
  - sslContextParameters
```
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder sslContextParameters(Object 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: org.apache.camel.support.jsse.SSLContextParameters type. Group: security
  - 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 org.apache.camel.support.jsse.SSLContextParameters type. Group: security
  - trustManager
```
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder trustManager(Object trustManager)
```
    The trust manager used to verify the SSL server's certificate. The option is a: org.schwering.irc.lib.ssl.SSLTrustManager type. Group: security
  - 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 org.schwering.irc.lib.ssl.SSLTrustManager type. Group: security
  - username
```
default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder username(String username)
```
    The IRC server user name. The option is a: java.lang.String type. Group: security

Interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

Method Detail

advanced

autoRejoin

autoRejoin

channels

commandTimeout

commandTimeout

keys

namesOnJoin

namesOnJoin

nickname

persistent

persistent

realname

bridgeErrorHandler

bridgeErrorHandler

onJoin

onJoin

onKick

onKick

onMode

onMode

onNick

onNick

onPart

onPart

onPrivmsg

onPrivmsg

onQuit

onQuit

onReply

onReply

onTopic

onTopic

nickPassword

password

sslContextParameters

sslContextParameters

trustManager

trustManager

username