org.walluck.oscar.tools

Class ChatTool

java.lang.Object

org.walluck.oscar.tools.Tool

org.walluck.oscar.tools.ChatTool

All Implemented Interfaces:

ChatListener, Listener, ServiceListener

public class ChatTool
extends Tool
implements ChatListener, ServiceListener

Chat tool.

Since:

1.0

Version:

1.0

Author:

David Walluck

Field Summary

Fields inherited from class org.walluck.oscar.tools.Tool

listeners

Constructor Summary

Constructors

Constructor and Description
ChatTool() Creates a new Chat tool.

Method Summary

Methods

Modifier and Type	Method and Description
void	bosConnectionAvailable() Method called by the LoginTool once the BOS connection is available.
void	evilNotify(AIMSession sess, AIMFrame frame, int newEvil, UserInfo userinfo) Describe evilNotify method here.
void	incomingChatMsg(AIMSession sess, AIMFrame frame, UserInfo userinfo, String msg) Describe incomingChatMsg method here.
void	infoUpdate(AIMSession sess, AIMFrame frame, Chat roominfo, String roomName, int userCount, ArrayList occupants, String roomdesc, int flags, int creationTime, int maxmsglen, int maxOccupancy, int creationPerms, int maxvisiblemsglen) Describe infoUpdate method here.
void	joinRoom(JoinRoomRequest jrr) If someone invited the user to join a chat room, the client needs to call this method with the provided JoinRoomRequest instance to make the join happen.
void	memRequest(AIMSession sess, AIMFrame frame, int offset, int len, String modname) Describe memRequest method here.
void	migrate(AIMSession sess, AIMFrame frame, String ip, byte[] cookie) Describe migrate method here.
void	motd(AIMSession sess, AIMFrame frame, int id, String msg) Describe motd method here.
void	rateChange(AIMSession sess, AIMFrame frame, int code, RateClass rc) Describe rateChange method here.
void	rateResp(AIMSession sess, AIMFrame frame) Describe rateResp method here.
void	redirect(AIMSession sess, AIMFrame frame, Redir redir) Describe redirect method here.
void	selfInfo(AIMSession sess, AIMFrame frame, UserInfo userinfo) Describe selfInfo method here.
void	serverPause(AIMSession sess, AIMFrame frame) Describe serverPause method here.
void	serverResume(AIMSession sess, AIMFrame frame) Describe serverResume method here.
void	shutdown(AIMSession sess) Called when the tool is shutting down.
void	userlistChange(AIMSession sess, AIMFrame frame, int curcount, ArrayList userinfo) Describe userlistChange method here.

Methods inherited from class org.walluck.oscar.tools.Tool

getFamily, getId, getSession, getToolData, getVersion, setFamily, setId, setSession, setToolData, setVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

ChatTool

public ChatTool()

Creates a new Chat tool. Family 0x000e.

Method Detail

joinRoom

public void joinRoom(JoinRoomRequest jrr)

If someone invited the user to join a chat room, the client needs to call this method with the provided JoinRoomRequest instance to make the join happen.

Parameters:

jrr -

infoUpdate

public void infoUpdate(AIMSession sess,
              AIMFrame frame,
              Chat roominfo,
              String roomName,
              int userCount,
              ArrayList occupants,
              String roomdesc,
              int flags,
              int creationTime,
              int maxmsglen,
              int maxOccupancy,
              int creationPerms,
              int maxvisiblemsglen)

Describe infoUpdate method here.

Specified by:

infoUpdate in interface ChatListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

roominfo - a Chat value

roomName - a String value

userCount - an int value

occupants - a ArrayList value

roomdesc - a String value

flags - an int value

creationTime - an int value

maxmsglen - an int value

maxOccupancy - an int value

creationPerms - an int value

maxvisiblemsglen - an int value

userlistChange

public void userlistChange(AIMSession sess,
                  AIMFrame frame,
                  int curcount,
                  ArrayList userinfo)

Describe userlistChange method here.

Specified by:

userlistChange in interface ChatListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

curcount - an int value

userinfo - a ArrayList value

incomingChatMsg

public void incomingChatMsg(AIMSession sess,
                   AIMFrame frame,
                   UserInfo userinfo,
                   String msg)

Describe incomingChatMsg method here.

Specified by:

incomingChatMsg in interface ChatListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

userinfo - an UserInfo value

msg - a String value

rateResp

public void rateResp(AIMSession sess,
            AIMFrame frame)

Describe rateResp method here.

Specified by:

rateResp in interface ServiceListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

redirect

public void redirect(AIMSession sess,
            AIMFrame frame,
            Redir redir)

Describe redirect method here.

Specified by:

redirect in interface ServiceListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

redir - a Redir value

rateChange

public void rateChange(AIMSession sess,
              AIMFrame frame,
              int code,
              RateClass rc)

Description copied from interface: ServiceListener

Describe rateChange method here.

Specified by:

rateChange in interface ServiceListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

code - an int value

rc - a RateClass value

serverPause

public void serverPause(AIMSession sess,
               AIMFrame frame)

Description copied from interface: ServiceListener

Describe serverPause method here.

Specified by:

serverPause in interface ServiceListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

serverResume

public void serverResume(AIMSession sess,
                AIMFrame frame)

Description copied from interface: ServiceListener

Describe serverResume method here.

Specified by:

serverResume in interface ServiceListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

selfInfo

public void selfInfo(AIMSession sess,
            AIMFrame frame,
            UserInfo userinfo)

Description copied from interface: ServiceListener

Describe selfInfo method here.

Specified by:

selfInfo in interface ServiceListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

userinfo - an UserInfo value

evilNotify

public void evilNotify(AIMSession sess,
              AIMFrame frame,
              int newEvil,
              UserInfo userinfo)

Description copied from interface: ServiceListener

Describe evilNotify method here.

Specified by:

evilNotify in interface ServiceListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

newEvil - an int value

userinfo - an UserInfo value

migrate

public void migrate(AIMSession sess,
           AIMFrame frame,
           String ip,
           byte[] cookie)

Description copied from interface: ServiceListener

Describe migrate method here.

Specified by:

migrate in interface ServiceListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

ip - a String value

cookie - a byte[] value

motd

public void motd(AIMSession sess,
        AIMFrame frame,
        int id,
        String msg)

Description copied from interface: ServiceListener

Describe motd method here.

Specified by:

motd in interface ServiceListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

id - an int value

msg - a String value

memRequest

public void memRequest(AIMSession sess,
              AIMFrame frame,
              int offset,
              int len,
              String modname)

Description copied from interface: ServiceListener

Describe memRequest method here.

Specified by:

memRequest in interface ServiceListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

offset - an int value

len - an int value

modname - a String value

shutdown

public void shutdown(AIMSession sess)

Called when the tool is shutting down.

Specified by:

shutdown in class Tool

Parameters:

sess - the oscar session

bosConnectionAvailable

public void bosConnectionAvailable()

Method called by the LoginTool once the BOS connection is available. This allows the other tools to get registered and get involved in the process.

Specified by:

bosConnectionAvailable in class Tool