io.hawt.example.ircplugin

Interface IRCHandlerMBean

All Known Implementing Classes:

IRCHandler

public interface IRCHandlerMBean

Author:

Stan Lewis

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	disconnect() Disconnects the current user from an IRC server
List<Object>	fetch() Fetch any available messages from the server that the mbean has received
void	getUserHost(String nicknames)
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)

Method Detail

connect

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.

Parameters:

settings -

fetch

List<Object> fetch()

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

Returns:

send

void send(String command)

Send a low-level IRC command to the IRC server

Parameters:

command -

connected

boolean connected()

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

Returns:

disconnect

void disconnect()

Disconnects the current user from an IRC server

back

void back()

Remove away message

away

void away(String message)

Sets the user's status to away

Parameters:

message -

join

void join(String channel)

Join an IRC channel

Parameters:

channel -

join

void join(String channel,
        String key)

Join an IRC channel with a key

Parameters:

channel -

key -

kick

void kick(String channel,
        String nick)

kick

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

list

void list()

list

void list(String channels)

names

void names()

names

void names(String channels)

nick

void nick(String nick)

notice

void notice(String target,
          String message)

part

void part(String channel)

part

void part(String channel,
        String message)

topic

void topic(String channel)

changeTopic

void changeTopic(String channel,
               String topic)

getUserHost

void getUserHost(String nicknames)

who

void who(String nick)

whowas

void whowas(String nick)

whois

void whois(String nick)

message

void message(String target,
           String message)