org.apache.camel.builder.endpoint.dsl

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

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

bridgeErrorHandler, bridgeErrorHandler

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

lazyStartProducer, lazyStartProducer

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default IrcEndpointBuilderFactory.AdvancedIrcEndpointBuilder advanced()

Specified by:

advanced in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

advanced in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

autoRejoin

default IrcEndpointBuilderFactory.IrcEndpointBuilder autoRejoin(boolean autoRejoin)

Whether to auto re-join when being kicked. The option is a: boolean type. Default: true Group: common

Specified by:

autoRejoin in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

autoRejoin in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

autoRejoin

default IrcEndpointBuilderFactory.IrcEndpointBuilder autoRejoin(String autoRejoin)

Whether to auto re-join when being kicked. The option will be converted to a boolean type. Default: true Group: common

Specified by:

autoRejoin in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

autoRejoin in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

channels

default IrcEndpointBuilderFactory.IrcEndpointBuilder channels(String channels)

Comma separated list of IRC channels. The option is a: java.lang.String type. Group: common

Specified by:

channels in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

channels in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

commandTimeout

default IrcEndpointBuilderFactory.IrcEndpointBuilder commandTimeout(long commandTimeout)

Delay in milliseconds before sending commands after the connection is established. The option is a: long type. Default: 5000 Group: common

Specified by:

commandTimeout in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

commandTimeout in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

commandTimeout

default IrcEndpointBuilderFactory.IrcEndpointBuilder 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

Specified by:

commandTimeout in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

commandTimeout in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

keys

default IrcEndpointBuilderFactory.IrcEndpointBuilder keys(String keys)

Comma separated list of keys for channels. The option is a: java.lang.String type. Group: common

Specified by:

keys in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

keys in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

namesOnJoin

default IrcEndpointBuilderFactory.IrcEndpointBuilder 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

Specified by:

namesOnJoin in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

namesOnJoin in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

namesOnJoin

default IrcEndpointBuilderFactory.IrcEndpointBuilder 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

Specified by:

namesOnJoin in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

namesOnJoin in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

nickname

default IrcEndpointBuilderFactory.IrcEndpointBuilder nickname(String nickname)

The nickname used in chat. The option is a: java.lang.String type. Group: common

Specified by:

nickname in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

nickname in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

persistent

@Deprecated
default IrcEndpointBuilderFactory.IrcEndpointBuilder persistent(boolean persistent)

Deprecated.

Use persistent messages. The option is a: boolean type. Default: true Group: common

Specified by:

persistent in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

persistent in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

persistent

@Deprecated
default IrcEndpointBuilderFactory.IrcEndpointBuilder persistent(String persistent)

Deprecated.

Use persistent messages. The option will be converted to a boolean type. Default: true Group: common

Specified by:

persistent in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

persistent in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

realname

default IrcEndpointBuilderFactory.IrcEndpointBuilder realname(String realname)

The IRC user's actual name. The option is a: java.lang.String type. Group: common

Specified by:

realname in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

realname in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

onJoin

default IrcEndpointBuilderFactory.IrcEndpointBuilder onJoin(boolean onJoin)

Handle user join events. The option is a: boolean type. Default: true Group: filter

Specified by:

onJoin in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

onJoin in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

onJoin

default IrcEndpointBuilderFactory.IrcEndpointBuilder onJoin(String onJoin)

Handle user join events. The option will be converted to a boolean type. Default: true Group: filter

Specified by:

onJoin in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

onJoin in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

onKick

default IrcEndpointBuilderFactory.IrcEndpointBuilder onKick(boolean onKick)

Handle kick events. The option is a: boolean type. Default: true Group: filter

Specified by:

onKick in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

onKick in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

onKick

default IrcEndpointBuilderFactory.IrcEndpointBuilder onKick(String onKick)

Handle kick events. The option will be converted to a boolean type. Default: true Group: filter

Specified by:

onKick in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

onKick in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

onMode

default IrcEndpointBuilderFactory.IrcEndpointBuilder onMode(boolean onMode)

Handle mode change events. The option is a: boolean type. Default: true Group: filter

Specified by:

onMode in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

onMode in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

onMode

default IrcEndpointBuilderFactory.IrcEndpointBuilder onMode(String onMode)

Handle mode change events. The option will be converted to a boolean type. Default: true Group: filter

Specified by:

onMode in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

onMode in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

onNick

default IrcEndpointBuilderFactory.IrcEndpointBuilder onNick(boolean onNick)

Handle nickname change events. The option is a: boolean type. Default: true Group: filter

Specified by:

onNick in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

onNick in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

onNick

default IrcEndpointBuilderFactory.IrcEndpointBuilder onNick(String onNick)

Handle nickname change events. The option will be converted to a boolean type. Default: true Group: filter

Specified by:

onNick in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

onNick in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

onPart

default IrcEndpointBuilderFactory.IrcEndpointBuilder onPart(boolean onPart)

Handle user part events. The option is a: boolean type. Default: true Group: filter

Specified by:

onPart in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

onPart in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

onPart

default IrcEndpointBuilderFactory.IrcEndpointBuilder onPart(String onPart)

Handle user part events. The option will be converted to a boolean type. Default: true Group: filter

Specified by:

onPart in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

onPart in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

onPrivmsg

default IrcEndpointBuilderFactory.IrcEndpointBuilder onPrivmsg(boolean onPrivmsg)

Handle private message events. The option is a: boolean type. Default: true Group: filter

Specified by:

onPrivmsg in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

onPrivmsg in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

onPrivmsg

default IrcEndpointBuilderFactory.IrcEndpointBuilder onPrivmsg(String onPrivmsg)

Handle private message events. The option will be converted to a boolean type. Default: true Group: filter

Specified by:

onPrivmsg in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

onPrivmsg in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

onQuit

default IrcEndpointBuilderFactory.IrcEndpointBuilder onQuit(boolean onQuit)

Handle user quit events. The option is a: boolean type. Default: true Group: filter

Specified by:

onQuit in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

onQuit in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

onQuit

default IrcEndpointBuilderFactory.IrcEndpointBuilder onQuit(String onQuit)

Handle user quit events. The option will be converted to a boolean type. Default: true Group: filter

Specified by:

onQuit in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

onQuit in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

onReply

default IrcEndpointBuilderFactory.IrcEndpointBuilder 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

Specified by:

onReply in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

onReply in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

onReply

default IrcEndpointBuilderFactory.IrcEndpointBuilder 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

Specified by:

onReply in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

onReply in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

onTopic

default IrcEndpointBuilderFactory.IrcEndpointBuilder onTopic(boolean onTopic)

Handle topic change events. The option is a: boolean type. Default: true Group: filter

Specified by:

onTopic in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

onTopic in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

onTopic

default IrcEndpointBuilderFactory.IrcEndpointBuilder onTopic(String onTopic)

Handle topic change events. The option will be converted to a boolean type. Default: true Group: filter

Specified by:

onTopic in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

onTopic in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

nickPassword

default IrcEndpointBuilderFactory.IrcEndpointBuilder nickPassword(String nickPassword)

Your IRC server nickname password. The option is a: java.lang.String type. Group: security

Specified by:

nickPassword in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

nickPassword in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

password

default IrcEndpointBuilderFactory.IrcEndpointBuilder password(String password)

The IRC server password. The option is a: java.lang.String type. Group: security

Specified by:

password in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

password in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

sslContextParameters

default IrcEndpointBuilderFactory.IrcEndpointBuilder 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

Specified by:

sslContextParameters in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

sslContextParameters in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

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 org.apache.camel.support.jsse.SSLContextParameters type. Group: security

Specified by:

sslContextParameters in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

sslContextParameters in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

trustManager

default IrcEndpointBuilderFactory.IrcEndpointBuilder 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

Specified by:

trustManager in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

trustManager in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

trustManager

default IrcEndpointBuilderFactory.IrcEndpointBuilder 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

Specified by:

trustManager in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

trustManager in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

username

default IrcEndpointBuilderFactory.IrcEndpointBuilder username(String username)

The IRC server user name. The option is a: java.lang.String type. Group: security

Specified by:

username in interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

Specified by:

username in interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder