org.walluck.oscar.tools
Class IconTool

java.lang.Object
  org.walluck.oscar.tools.Tool
      org.walluck.oscar.tools.IconTool

All Implemented Interfaces:

IconListener, Listener, ServiceListener

public class IconTool
extends Tool
implements IconListener, ServiceListener

Icon tool.

TODO: Find a better place to store icons!

Since:

1.0

Version:

1.0

Author:

David Walluck

Field Summary

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

listeners

Constructor Summary

IconTool()
Creates a new Icon tool.

Method Summary

void	bosConnectionAvailable() Method called by the LoginTool once the BOS connection is available.
boolean	checkIcon(String sn, byte[] iconcsum)
boolean	checkIcon(String sn, int iconcsum)
void	evilNotify(AIMSession sess, AIMFrame frame, int newEvil, UserInfo userinfo) Describe evilNotify method here.
void	getIcon(String nsn, byte[] data) Add an icon to the request queue.
void	getIcons(AIMSession sess) Get everyone's icon.
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	parseIcon(AIMSession sess, AIMFrame frame, String sn, byte[] iconcsum, byte[] icon) Describe parseIcon 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	uploadAck(AIMSession sess, AIMFrame frame, byte[] cksum) Describe uploadAck method here.
void	writeIcon(String sn, byte[] icon) Write an icon to a file.

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

IconTool

public IconTool()

Creates a new Icon tool.

Method Detail

checkIcon

public boolean checkIcon(String sn,
                         int iconcsum)

Parameters:

sn - the screenname

iconcsum - the icon checksum

Returns:

true if icons are equal, false otherwise

checkIcon

public boolean checkIcon(String sn,
                         byte[] iconcsum)

Parameters:

sn - the screenname

iconcsum - the icon checksum

Returns:

true if icons are equal, false otherwise

writeIcon

public void writeIcon(String sn,
                      byte[] icon)

Write an icon to a file.

Parameters:

sn - the screenname

icon - the icon data

getIcon

public void getIcon(String nsn,
                    byte[] data)

Add an icon to the request queue. This is used by the BuddyListTool when processing buddy info.

Parameters:

nsn - Normalized buddy name.

data - Cookie data needed to get the icon

getIcons

public void getIcons(AIMSession sess)

Get everyone's icon.

Parameters:

sess - the oscar session

parseIcon

public void parseIcon(AIMSession sess,
                      AIMFrame frame,
                      String sn,
                      byte[] iconcsum,
                      byte[] icon)

Describe parseIcon method here.

Specified by:

parseIcon in interface IconListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

sn - a String value

iconcsum - a byte[] value

icon - a byte[] value

uploadAck

public void uploadAck(AIMSession sess,
                      AIMFrame frame,
                      byte[] cksum)

Describe uploadAck method here.

Specified by:

uploadAck in interface IconListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

cksum - a byte[] 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