org.apache.camel.component.irc

Class IrcConfiguration

java.lang.Object

org.apache.camel.component.irc.IrcConfiguration

All Implemented Interfaces:

Cloneable

@UriParams
public class IrcConfiguration
extends Object
implements Cloneable

Constructor Summary

Constructors

Constructor and Description
IrcConfiguration()
IrcConfiguration(String hostname, String nickname, String displayname, String channels)
IrcConfiguration(String hostname, String username, String password, String nickname, String displayname, String channels)

Method Summary

Modifier and Type	Method and Description
void	configure(String uriStr)
IrcConfiguration	copy()
IrcChannel	findChannel(String name)
String	getCacheKey()
List<IrcChannel>	getChannelList()
String	getChannels() Comma separated list of IRC channels.
long	getCommandTimeout()
String	getHostname()
String	getKeys() Comma separated list of keys for channels.
String	getNickname()
String	getNickPassword() Your IRC server nickname password.
String	getPassword()
int	getPort()
int[]	getPorts()
String	getRealname()
String	getSpaceSeparatedChannelNames()
org.apache.camel.support.jsse.SSLContextParameters	getSslContextParameters()
org.schwering.irc.lib.ssl.SSLTrustManager	getTrustManager()
String	getUsername()
boolean	getUsingSSL()
boolean	isAutoRejoin()
boolean	isColors()
boolean	isNamesOnJoin()
boolean	isOnJoin()
boolean	isOnKick()
boolean	isOnMode()
boolean	isOnNick()
boolean	isOnPart()
boolean	isOnPrivmsg()
boolean	isOnQuit()
boolean	isOnReply()
boolean	isOnTopic()
boolean	isPersistent()
static String	sanitize(String uri)
void	setAutoRejoin(boolean autoRejoin) Whether to auto re-join when being kicked
void	setChannels(String channels)
void	setColors(boolean colors) Whether or not the server supports color codes.
void	setCommandTimeout(long timeout) Delay in milliseconds before sending commands after the connection is established.
void	setHostname(String hostname) Hostname for the IRC chat server
void	setKeys(String keys)
void	setNamesOnJoin(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'.
void	setNickname(String nickname) The nickname used in chat.
void	setNickPassword(String nickPassword)
void	setOnJoin(boolean onJoin) Handle user join events.
void	setOnKick(boolean onKick) Handle kick events.
void	setOnMode(boolean onMode) Handle mode change events.
void	setOnNick(boolean onNick) Handle nickname change events.
void	setOnPart(boolean onPart) Handle user part events.
void	setOnPrivmsg(boolean onPrivmsg) Handle private message events.
void	setOnQuit(boolean onQuit) Handle user quit events.
void	setOnReply(boolean onReply) Whether or not to handle general responses to commands or informational messages.
void	setOnTopic(boolean onTopic) Handle topic change events.
void	setPassword(String password) The IRC server password.
void	setPersistent(boolean persistent) Deprecated. not in use
void	setPort(int port) Port number for the IRC chat server.
void	setPorts(int[] ports) Port numbers for the IRC chat server
void	setRealname(String realname) The IRC user's actual name.
void	setSslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters) Used for configuring security using SSL.
void	setTrustManager(org.schwering.irc.lib.ssl.SSLTrustManager trustManager) The trust manager used to verify the SSL server's certificate.
void	setUsername(String username) The IRC server user name.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IrcConfiguration

public IrcConfiguration()

IrcConfiguration

public IrcConfiguration(String hostname,
                        String nickname,
                        String displayname,
                        String channels)

IrcConfiguration

public IrcConfiguration(String hostname,
                        String username,
                        String password,
                        String nickname,
                        String displayname,
                        String channels)

Method Detail

copy

public IrcConfiguration copy()

getCacheKey

public String getCacheKey()

getSpaceSeparatedChannelNames

public String getSpaceSeparatedChannelNames()

configure

public void configure(String uriStr)
               throws URISyntaxException

Throws:

URISyntaxException

getChannelList

public List<IrcChannel> getChannelList()

findChannel

public IrcChannel findChannel(String name)

setTrustManager

public void setTrustManager(org.schwering.irc.lib.ssl.SSLTrustManager trustManager)

The trust manager used to verify the SSL server's certificate.

getTrustManager

public org.schwering.irc.lib.ssl.SSLTrustManager getTrustManager()

getUsingSSL

public boolean getUsingSSL()

getHostname

public String getHostname()

setHostname

public void setHostname(String hostname)

Hostname for the IRC chat server

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

The IRC server password.

getNickname

public String getNickname()

setNickname

public void setNickname(String nickname)

The nickname used in chat.

getRealname

public String getRealname()

setRealname

public void setRealname(String realname)

The IRC user's actual name.

getUsername

public String getUsername()

getChannels

public String getChannels()

Comma separated list of IRC channels.

setChannels

public void setChannels(String channels)

getKeys

public String getKeys()

Comma separated list of keys for channels.

setKeys

public void setKeys(String keys)

setUsername

public void setUsername(String username)

The IRC server user name.

getPorts

public int[] getPorts()

setPorts

public void setPorts(int[] ports)

Port numbers for the IRC chat server

getPort

public int getPort()

setPort

public void setPort(int port)

Port number for the IRC chat server. If no port is configured then a default port of either 6667, 6668 or 6669 is used.

isPersistent

public boolean isPersistent()

setPersistent

@Deprecated
public void setPersistent(boolean persistent)

Deprecated. not in use

Use persistent messages.

isColors

public boolean isColors()

setColors

public void setColors(boolean colors)

Whether or not the server supports color codes.

isOnNick

public boolean isOnNick()

setOnNick

public void setOnNick(boolean onNick)

Handle nickname change events.

isOnQuit

public boolean isOnQuit()

setOnQuit

public void setOnQuit(boolean onQuit)

Handle user quit events.

isOnJoin

public boolean isOnJoin()

setOnJoin

public void setOnJoin(boolean onJoin)

Handle user join events.

isOnKick

public boolean isOnKick()

setOnKick

public void setOnKick(boolean onKick)

Handle kick events.

isOnMode

public boolean isOnMode()

setOnMode

public void setOnMode(boolean onMode)

Handle mode change events.

isOnPart

public boolean isOnPart()

setOnPart

public void setOnPart(boolean onPart)

Handle user part events.

isOnReply

public boolean isOnReply()

setOnReply

public void setOnReply(boolean onReply)

Whether or not to handle general responses to commands or informational messages.

isOnTopic

public boolean isOnTopic()

setOnTopic

public void setOnTopic(boolean onTopic)

Handle topic change events.

isOnPrivmsg

public boolean isOnPrivmsg()

setOnPrivmsg

public void setOnPrivmsg(boolean onPrivmsg)

Handle private message events.

isAutoRejoin

public boolean isAutoRejoin()

setAutoRejoin

public void setAutoRejoin(boolean autoRejoin)

Whether to auto re-join when being kicked

getSslContextParameters

public org.apache.camel.support.jsse.SSLContextParameters getSslContextParameters()

setSslContextParameters

public void setSslContextParameters(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.

getNickPassword

public String getNickPassword()

Your IRC server nickname password.

setNickPassword

public void setNickPassword(String nickPassword)

setCommandTimeout

public void setCommandTimeout(long timeout)

Delay in milliseconds before sending commands after the connection is established.

Parameters:

timeout - timeout value in milliseconds

getCommandTimeout

public long getCommandTimeout()

isNamesOnJoin

public boolean isNamesOnJoin()

setNamesOnJoin

public void setNamesOnJoin(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'.

toString

public String toString()

Overrides:

toString in class Object

sanitize

public static String sanitize(String uri)