org.schwering.irc.lib.impl

Class DefaultIRCConnection

java.lang.Object

org.schwering.irc.lib.impl.DefaultIRCConnection

All Implemented Interfaces:

IRCConnection

public class DefaultIRCConnection
extends Object
implements IRCConnection

The default implementation of IRCConnection. Typically created via IRCConnectionFactory.newConnection(org.schwering.irc.lib.IRCConfig) or IRCConnectionFactory.newConnection(IRCServerConfig, IRCRuntimeConfig) . Creates a new connection to an IRC server. It's the main class of the IRClib, the point everything starts.

Author:

Christoph Schwering <schwering@gmail.com>, Peter Palaga

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	DefaultIRCConnection.Consumer The Runnable used in the Thread for parsing incoming IRC stream.

Field Summary

Fields inherited from interface org.schwering.irc.lib.IRCConnection

INVALID_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
DefaultIRCConnection(IRCServerConfig serverConfig, IRCRuntimeConfig runtimeConfig) Creates a new DefaultIRCConnection out of the given IRCServerConfig and IRCRuntimeConfig.

Method Summary

Modifier and Type	Method and Description
void	addIRCEventListener(IRCEventListener l) Adds a new IRCEventListener which listens for actions coming from the IRC server.
void	addIRCEventListener(IRCEventListener l, int i)
void	close() Close the connection forcefully.
void	connect() Establish a connection to the server.
protected Runnable	createConsumer()
protected Thread	createThread()
void	doAway() Removes away message.
void	doAway(String msg) Sets away message.
void	doInvite(String nick, String chan) Invites a user to a channel.
void	doIson(String nick) Checks if one or more nicks are used on the server.
void	doJoin(String chan) Joins a channel without a key.
void	doJoin(String chan, String key) Joins a channel with a key.
void	doKick(String chan, String nick) Kicks a user from a channel.
void	doKick(String chan, String nick, String msg) Kicks a user from a channel with a comment.
void	doList() Lists all channels with their topic and status.
void	doList(String chan) Lists channel(s) with their topic and status.
void	doMode(String chan) Requests a Reply 324 for the modes of a given channel.
void	doMode(String target, String mode) Sends a mode to the server.
void	doNames() Lists all visible users.
void	doNames(String chan) Lists all visible users of (a) channel(s).
void	doNick(String nick) Changes the nickname.
void	doNotice(String target, String msg) Notices a message to a person or a channel.
void	doPart(String chan) Parts from a given channel.
void	doPart(String chan, String msg) Parts from a given channel with a given parg-msg.
void	doPong(String ping) Quits from the IRC server with a quit-msg.
void	doPrivmsg(String target, String msg) Sends a message to a person or a channel.
void	doQuit() Quits from the IRC server.
void	doQuit(String msg) Quits from the IRC server with a quit-msg.
void	doTopic(String chan) Requests the topic of a chan.
void	doTopic(String chan, String topic) Changes the topic of a chan.
void	doUserhost(String nick) Requires host-information about up to 5 users which must be listed and divided by spaces.
void	doWho(String criteric) Requests information about users matching the given criteric, for example a channel they are on.
void	doWhois(String nick) Requires information about an existing user.
void	doWhowas(String nick) Requires host-information about a user, who is not connected anymore.
InetAddress	getLocalAddress() Returns the local address of the connection socket.
String	getNick() Returns the nickname of this instance.
int	getPort() Returns the port to which the IRCConnection connected, or 0 if the connection failed or wasn't tried yet.
int	getTimeout() Returns the timeout of the socket.
boolean	isConnected() Tells whether there's a connection to the IRC network or not.
boolean	isSSL()
boolean	removeIRCEventListener(IRCEventListener l) Removes the first occurence of the given IRCEventListener from the listener-vector.
void	send(String line) Sends a String to the server.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultIRCConnection

public DefaultIRCConnection(IRCServerConfig serverConfig,
                            IRCRuntimeConfig runtimeConfig)

Creates a new DefaultIRCConnection out of the given IRCServerConfig and IRCRuntimeConfig. DO not forget to call connect() after you have prepared the connection.

Parameters:

serverConfig - the IRCServerConfig

runtimeConfig - the IRCRuntimeConfig

Method Detail

connect

public void connect()
             throws IOException,
                    KeyManagementException,
                    NoSuchAlgorithmException

Description copied from interface: IRCConnection

Establish a connection to the server. This method must be invoked to start a connection as the constructor does not do that.

It tries all ports from IRCServerConfig.getPorts() until the connecting succeeds. If all ports fail an IOException is thrown.

This method can be invokde once only.

Specified by:

connect in interface IRCConnection

Throws:

IOException - If an I/O error occurs.

SocketException - If the connect method was already invoked.

KeyManagementException - rethrown from the SSL layer

NoSuchAlgorithmException - rethrown from the SSL layer

See Also:

IRCConnection.connect()

createThread

protected Thread createThread()

Returns:

the consumer thread

createConsumer

protected Runnable createConsumer()

Returns:

a new DefaultIRCConnection.Consumer.

send

public void send(String line)

Description copied from interface: IRCConnection

Sends a String to the server. You should use this method only, if you must do it. For most purposes, there are do* methods (like doJoin). A carriage return line feed (\r\n) is appended automatically.

Specified by:

send in interface IRCConnection

Parameters:

line - The line which should be send to the server without the trailing carriage return line feed (\r\n).

See Also:

IRCConnection.send(java.lang.String)

close

public void close()

Description copied from interface: IRCConnection

Close the connection forcefully.

This method does not send QUIT IRC command. Consider using IRCConnection.doQuit() or IRCConnection.doQuit(String) to send the proper QUIT command to the server.

This method should be used only when there is a good reason for that, e.g. that the IRC server does not react to QUIT command.

Possibly occuring IOExceptions are handled according to the set exception handling.

Specified by:

close in interface IRCConnection

See Also:

IRCConnection.close()

addIRCEventListener

public void addIRCEventListener(IRCEventListener l)

Description copied from interface: IRCConnection

Adds a new IRCEventListener which listens for actions coming from the IRC server.

Specified by:

addIRCEventListener in interface IRCConnection

Parameters:

l - An instance of the IRCEventListener interface.

See Also:

IRCConnection.addIRCEventListener(org.schwering.irc.lib.IRCEventListener)

addIRCEventListener

public void addIRCEventListener(IRCEventListener l,
                                int i)

removeIRCEventListener

public boolean removeIRCEventListener(IRCEventListener l)

Description copied from interface: IRCConnection

Removes the first occurence of the given IRCEventListener from the listener-vector.

Specified by:

removeIRCEventListener in interface IRCConnection

Parameters:

l - An instance of the IRCEventListener interface.

Returns:

true if the listener was successfully removed; false if it was not found.

See Also:

IRCConnection.removeIRCEventListener(org.schwering.irc.lib.IRCEventListener)

isConnected

public boolean isConnected()

Description copied from interface: IRCConnection

Tells whether there's a connection to the IRC network or not. If connect wasn't called yet, it returns false.

Specified by:

isConnected in interface IRCConnection

Returns:

The status of the connection; true if it's connected.

See Also:

IRCConnection.isConnected()

getNick

public String getNick()

Description copied from interface: IRCConnection

Returns the nickname of this instance.

Specified by:

getNick in interface IRCConnection

Returns:

The nickname.

See Also:

IRCConnection.getNick()

getPort

public int getPort()

Description copied from interface: IRCConnection

Returns the port to which the IRCConnection connected, or 0 if the connection failed or wasn't tried yet.

Specified by:

getPort in interface IRCConnection

Returns:

The port to which the IRCConnection, or 0 if the connection failed or wasn't tried yet.

See Also:

IRCConnection.getPort()

getTimeout

public int getTimeout()

Description copied from interface: IRCConnection

Returns the timeout of the socket. If an error occurs, which is never the case, -1 is returned. The possibly occuring IOException are handled according to the set exception handling.

Specified by:

getTimeout in interface IRCConnection

Returns:

The timeout.

See Also:

IRCConnection.getTimeout()

getLocalAddress

public InetAddress getLocalAddress()

Description copied from interface: IRCConnection

Returns the local address of the connection socket. If the connection is not yet connected, null is returned.

Specified by:

getLocalAddress in interface IRCConnection

Returns:

the local address

See Also:

IRCConnection.getLocalAddress()

toString

public String toString()

Overrides:

toString in class Object

doAway

public void doAway()

Description copied from interface: IRCConnection

Removes away message.

Specified by:

doAway in interface IRCConnection

See Also:

IRCConnection.doAway()

doAway

public void doAway(String msg)

Description copied from interface: IRCConnection

Sets away message.

Specified by:

doAway in interface IRCConnection

Parameters:

msg - The away message.

See Also:

IRCConnection.doAway(java.lang.String)

doInvite

public void doInvite(String nick,
                     String chan)

Description copied from interface: IRCConnection

Invites a user to a channel.

Specified by:

doInvite in interface IRCConnection

Parameters:

nick - The nickname of the user who should be invited.

chan - The channel the user should be invited to.

See Also:

IRCConnection.doInvite(java.lang.String, java.lang.String)

doIson

public void doIson(String nick)

Description copied from interface: IRCConnection

Checks if one or more nicks are used on the server.

Specified by:

doIson in interface IRCConnection

Parameters:

nick - The nickname of the user we search for.

See Also:

IRCConnection.doIson(java.lang.String)

doJoin

public void doJoin(String chan)

Description copied from interface: IRCConnection

Joins a channel without a key.

Specified by:

doJoin in interface IRCConnection

Parameters:

chan - The channel which is to join.

See Also:

IRCConnection.doJoin(java.lang.String)

doJoin

public void doJoin(String chan,
                   String key)

Description copied from interface: IRCConnection

Joins a channel with a key.

Specified by:

doJoin in interface IRCConnection

Parameters:

chan - The channel which is to join.

key - The key of the channel.

See Also:

IRCConnection.doJoin(java.lang.String, java.lang.String)

doKick

public void doKick(String chan,
                   String nick)

Description copied from interface: IRCConnection

Kicks a user from a channel.

Specified by:

doKick in interface IRCConnection

Parameters:

chan - The channel somebody should be kicked from.

nick - The nickname of the user who should be kicked.

See Also:

IRCConnection.doKick(java.lang.String, java.lang.String)

doKick

public void doKick(String chan,
                   String nick,
                   String msg)

Description copied from interface: IRCConnection

Kicks a user from a channel with a comment.

Specified by:

doKick in interface IRCConnection

Parameters:

chan - The channel somebody should be kicked from.

nick - The nickname of the user who should be kicked.

msg - The optional kickmessage.

See Also:

IRCConnection.doKick(java.lang.String, java.lang.String, java.lang.String)

doList

public void doList()

Description copied from interface: IRCConnection

Lists all channels with their topic and status.

Specified by:

doList in interface IRCConnection

See Also:

IRCConnection.doList()

doList

public void doList(String chan)

Description copied from interface: IRCConnection

Lists channel(s) with their topic and status.

Specified by:

doList in interface IRCConnection

Parameters:

chan - The channel the LIST refers to.

See Also:

IRCConnection.doList(java.lang.String)

doNames

public void doNames()

Description copied from interface: IRCConnection

Lists all visible users.

Specified by:

doNames in interface IRCConnection

See Also:

IRCConnection.doNames()

doNames

public void doNames(String chan)

Description copied from interface: IRCConnection

Lists all visible users of (a) channel(s).

Specified by:

doNames in interface IRCConnection

Parameters:

chan - The channel the NAMES command is refering to.

See Also:

IRCConnection.doNames(java.lang.String)

doPrivmsg

public void doPrivmsg(String target,
                      String msg)

Description copied from interface: IRCConnection

Sends a message to a person or a channel.

Specified by:

doPrivmsg in interface IRCConnection

Parameters:

target - The nickname or channel the message should be sent to.

msg - The message which should be transmitted.

See Also:

IRCConnection.doPrivmsg(java.lang.String, java.lang.String)

doMode

public void doMode(String chan)

Description copied from interface: IRCConnection

Requests a Reply 324 for the modes of a given channel.

Specified by:

doMode in interface IRCConnection

Parameters:

chan - The channel the MODE request is refering to.

See Also:

IRCConnection.doMode(java.lang.String)

doMode

public void doMode(String target,
                   String mode)

Description copied from interface: IRCConnection

Sends a mode to the server. The first argument is a nickname (user-mode) or a channel (channel-mode). String mode must contain the operators (+/-), the modes (o/v/i/k/l/p/s/w) and the possibly values (nicks/banmask/limit/key).

Specified by:

doMode in interface IRCConnection

Parameters:

target - The nickname or channel of the user whose modes will be changed.

mode - The new modes.

See Also:

IRCConnection.doMode(java.lang.String, java.lang.String)

doNick

public void doNick(String nick)

Description copied from interface: IRCConnection

Changes the nickname.

Specified by:

doNick in interface IRCConnection

Parameters:

nick - The new nickname.

See Also:

IRCConnection.doNick(java.lang.String)

doNotice

public void doNotice(String target,
                     String msg)

Description copied from interface: IRCConnection

Notices a message to a person or a channel.

Specified by:

doNotice in interface IRCConnection

Parameters:

target - The nickname or channel (group) the message should be sent to.

msg - The message which should be transmitted.

See Also:

IRCConnection.doNotice(java.lang.String, java.lang.String)

doPart

public void doPart(String chan)

Description copied from interface: IRCConnection

Parts from a given channel.

Specified by:

doPart in interface IRCConnection

Parameters:

chan - The channel you want to part from.

See Also:

IRCConnection.doPart(java.lang.String)

doPart

public void doPart(String chan,
                   String msg)

Description copied from interface: IRCConnection

Parts from a given channel with a given parg-msg.

Specified by:

doPart in interface IRCConnection

Parameters:

chan - The channel you want to part from.

msg - The optional partmessage.

See Also:

IRCConnection.doPart(java.lang.String, java.lang.String)

doPong

public void doPong(String ping)

Description copied from interface: IRCConnection

Quits from the IRC server with a quit-msg.

Specified by:

doPong in interface IRCConnection

Parameters:

ping - The ping which was received in onPing. It's a String, because sometimes on some networks the server-hostname (for example splatterworld.quakenet.org) is given as parameter which would throw an Exception if we gave the ping as long.

See Also:

IRCConnection.doPong(java.lang.String)

doQuit

public void doQuit()

Description copied from interface: IRCConnection

Quits from the IRC server. Calls the disconnect-method which does the work actually.

Specified by:

doQuit in interface IRCConnection

See Also:

IRCConnection.doQuit()

doQuit

public void doQuit(String msg)

Description copied from interface: IRCConnection

Quits from the IRC server with a quit-msg. Calls the disconnect-method which does the work actually.

Specified by:

doQuit in interface IRCConnection

Parameters:

msg - The optional quitmessage.

See Also:

IRCConnection.doQuit(java.lang.String)

doTopic

public void doTopic(String chan)

Description copied from interface: IRCConnection

Requests the topic of a chan. The topic is given in a numeric reply.

Specified by:

doTopic in interface IRCConnection

Parameters:

chan - The channel which topic should be requested.

See Also:

IRCConnection.doTopic(java.lang.String)

doTopic

public void doTopic(String chan,
                    String topic)

Description copied from interface: IRCConnection

Changes the topic of a chan.

Specified by:

doTopic in interface IRCConnection

Parameters:

chan - The channel which topic is changed.

topic - The new topic.

See Also:

IRCConnection.doTopic(java.lang.String, java.lang.String)

doWho

public void doWho(String criteric)

Description copied from interface: IRCConnection

Requests information about users matching the given criteric, for example a channel they are on.

Specified by:

doWho in interface IRCConnection

Parameters:

criteric - The criterics of the WHO query.

See Also:

IRCConnection.doWho(java.lang.String)

doWhois

public void doWhois(String nick)

Description copied from interface: IRCConnection

Requires information about an existing user.

Specified by:

doWhois in interface IRCConnection

Parameters:

nick - The nickname of the user the query is refering to.

See Also:

IRCConnection.doWhois(java.lang.String)

doWhowas

public void doWhowas(String nick)

Description copied from interface: IRCConnection

Requires host-information about a user, who is not connected anymore.

Specified by:

doWhowas in interface IRCConnection

Parameters:

nick - The nickname of the user the query is refering to.

See Also:

IRCConnection.doWhowas(java.lang.String)

doUserhost

public void doUserhost(String nick)

Description copied from interface: IRCConnection

Requires host-information about up to 5 users which must be listed and divided by spaces.

Specified by:

doUserhost in interface IRCConnection

Parameters:

nick - The nickname of the user the query is refering to.

See Also:

IRCConnection.doUserhost(java.lang.String)

isSSL

public boolean isSSL()

Specified by:

isSSL in interface IRCConnection

Returns:

true if the connection is using SSL

See Also:

IRCConnection.isSSL()