io.hawt.example.ircplugin

Class IRCHandler

java.lang.Object

io.hawt.example.ircplugin.IRCHandler

All Implemented Interfaces:

IRCHandlerMBean

public class IRCHandler
extends Object
implements IRCHandlerMBean

Author:

Stan Lewis

Constructor Summary

Constructors

Constructor and Description
IRCHandler()

Method Summary

Methods

Modifier and Type	Method and Description
void	away(String message) Sets the user's status to away
void	back() Remove away message
void	changeTopic(String channel, String topic)
void	connect(Map<String,String> settings) Connects the current user to an IRC server, the map should be in a format like: { "host": "my.irc.hostname", "nickname": "myNick", "ports": "6667,6668", "password": "mypass", "username": "myuser", "realname": "my name", "useSSL": false } only "host" and "nickname" are required.
boolean	connected() Checks to see if we have a connection to the IRC server
void	destroy()
void	disconnect() Disconnects the current user from an IRC server
List<Object>	fetch() Fetch any available messages from the server that the mbean has received
protected IRCConnectionHandler	getConnection()
protected ObjectName	getObjectName()
protected Subject	getSubject()
void	getUserHost(String nicknames)
void	init()
void	join(String channel) Join an IRC channel
void	join(String channel, String key) Join an IRC channel with a key
void	kick(String channel, String nick)
void	kick(String channel, String nick, String message)
void	list()
void	list(String channels)
void	message(String target, String message)
void	names()
void	names(String channels)
void	nick(String nick)
void	notice(String target, String message)
void	part(String channel)
void	part(String channel, String message)
void	send(String command) Send a low-level IRC command to the IRC server
void	topic(String channel)
void	who(String nick)
void	whois(String nick)
void	whowas(String nick)

Methods inherited from class java.lang.Object

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

Constructor Detail

IRCHandler

public IRCHandler()

Method Detail

init

public void init()

connect

public void connect(Map<String,String> settings)

Description copied from interface: IRCHandlerMBean

Connects the current user to an IRC server, the map should be in a format like: { "host": "my.irc.hostname", "nickname": "myNick", "ports": "6667,6668", "password": "mypass", "username": "myuser", "realname": "my name", "useSSL": false } only "host" and "nickname" are required.

Specified by:

connect in interface IRCHandlerMBean

fetch

public List<Object> fetch()

Description copied from interface: IRCHandlerMBean

Fetch any available messages from the server that the mbean has received

Specified by:

fetch in interface IRCHandlerMBean

Returns:

send

public void send(String command)

Description copied from interface: IRCHandlerMBean

Send a low-level IRC command to the IRC server

Specified by:

send in interface IRCHandlerMBean

connected

public boolean connected()

Description copied from interface: IRCHandlerMBean

Checks to see if we have a connection to the IRC server

Specified by:

connected in interface IRCHandlerMBean

Returns:

disconnect

public void disconnect()

Description copied from interface: IRCHandlerMBean

Disconnects the current user from an IRC server

Specified by:

disconnect in interface IRCHandlerMBean

getSubject

protected Subject getSubject()

getConnection

protected IRCConnectionHandler getConnection()

getObjectName

protected ObjectName getObjectName()
                            throws Exception

Throws:

Exception

destroy

public void destroy()

back

public void back()

Description copied from interface: IRCHandlerMBean

Remove away message

Specified by:

back in interface IRCHandlerMBean

away

public void away(String message)

Description copied from interface: IRCHandlerMBean

Sets the user's status to away

Specified by:

away in interface IRCHandlerMBean

join

public void join(String channel)

Description copied from interface: IRCHandlerMBean

Join an IRC channel

Specified by:

join in interface IRCHandlerMBean

join

public void join(String channel,
        String key)

Description copied from interface: IRCHandlerMBean

Join an IRC channel with a key

Specified by:

join in interface IRCHandlerMBean

kick

public void kick(String channel,
        String nick)

Specified by:

kick in interface IRCHandlerMBean

kick

public void kick(String channel,
        String nick,
        String message)

Specified by:

kick in interface IRCHandlerMBean

list

public void list()

Specified by:

list in interface IRCHandlerMBean

list

public void list(String channels)

Specified by:

list in interface IRCHandlerMBean

names

public void names()

Specified by:

names in interface IRCHandlerMBean

names

public void names(String channels)

Specified by:

names in interface IRCHandlerMBean

nick

public void nick(String nick)

Specified by:

nick in interface IRCHandlerMBean

notice

public void notice(String target,
          String message)

Specified by:

notice in interface IRCHandlerMBean

part

public void part(String channel)

Specified by:

part in interface IRCHandlerMBean

part

public void part(String channel,
        String message)

Specified by:

part in interface IRCHandlerMBean

topic

public void topic(String channel)

Specified by:

topic in interface IRCHandlerMBean

changeTopic

public void changeTopic(String channel,
               String topic)

Specified by:

changeTopic in interface IRCHandlerMBean

getUserHost

public void getUserHost(String nicknames)

Specified by:

getUserHost in interface IRCHandlerMBean

who

public void who(String nick)

Specified by:

who in interface IRCHandlerMBean

whowas

public void whowas(String nick)

Specified by:

whowas in interface IRCHandlerMBean

whois

public void whois(String nick)

Specified by:

whois in interface IRCHandlerMBean

message

public void message(String target,
           String message)

Specified by:

message in interface IRCHandlerMBean