org.walluck.oscar.tools
Class ICQTool

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

All Implemented Interfaces:

ICQListener, Listener

public class ICQTool
extends Tool
implements ICQListener

ICQ tool.

Since:

1.0

Version:

1.0

Author:

David Walluck

Field Summary

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

listeners

Constructor Summary

ICQTool()
Creates a new ICQ tool.

Method Summary

void	bosConnectionAvailable() Method called by the LoginTool once the BOS connection is available.
void	shutdown(AIMSession sess) Called when the tool is shutting down.
void	srvMeta10E(AIMSession sess, AIMFrame frame, int unknown) Describe srvMeta10E method here.
void	srvMetaAbout(AIMSession sess, AIMFrame frame, String about) Describe srvMetaAbout method here.
void	srvMetaAboutDone(AIMSession sess, AIMFrame frame) Describe srvMetaAboutDone method here.
void	srvMetaBackground(AIMSession sess, AIMFrame frame, byte pastCount, ArrayList pastAreas, ArrayList pastDescriptions, byte affiliationCount, ArrayList affiliationAreas, ArrayList affiliationDescriptions) Describe srvMetaBackground method here.
void	srvMetaFound(AIMSession sess, AIMFrame frame, ICQMetaFound imf) Describe srvMetaFound method here.
void	srvMetaGeneral(AIMSession sess, AIMFrame frame, ICQMetaGeneral img) Describe srvMetaGeneral method here.
void	srvMetaGeneralDone(AIMSession sess, AIMFrame frame) Describe srvMetaGeneralDone method here.
void	srvMetaInfo(AIMSession sess, AIMFrame frame, ICQMetaGeneral img) Describe srvMetaInfo method here.
void	srvMetaInterest(AIMSession sess, AIMFrame frame, byte interestCount, ArrayList interestAreas, ArrayList interestDescriptions) Describe srvMetaInterest method here.
void	srvMetaLast(AIMSession sess, AIMFrame frame, ICQMetaFound imf, int missed) Describe srvMetaLast method here.
void	srvMetaMore(AIMSession sess, AIMFrame frame, ICQMetaMore imm) Describe srvMetaMore method here.
void	srvMetaMoreDone(AIMSession sess, AIMFrame frame) Describe srvMetaMoreDone method here.
void	srvMetaMoreEmail(AIMSession sess, AIMFrame frame, byte country, byte flags, String email) Describe srvMetaMoreEmail method here.
void	srvMetaPassDone(AIMSession sess, AIMFrame frame) Describe srvMetaPassDone method here.
void	srvMetaRandom(AIMSession sess, AIMFrame frame, int uin, short group, byte[] externalIP, int port, byte[] internalIP, byte tcpFlags, short tcpVersion, byte[] unknown) Describe srvMetaRandom method here.
void	srvMetaRandomDone(AIMSession sess, AIMFrame frame) Describe srvMetaRandomDone method here.
void	srvMetaWork(AIMSession sess, AIMFrame frame, ICQMetaWork imw) Describe srvMetaWork method here.
void	srvOfflineMsg(AIMSession sess, AIMFrame frame, ICQOfflineMsg msg) Describe srvOfflineMsg method here.
void	srvOfflineMsgDone(AIMSession sess, AIMFrame frame) Describe srvOfflineMsgDone 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

ICQTool

public ICQTool()

Creates a new ICQ tool.

Method Detail

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

srvOfflineMsgDone

public void srvOfflineMsgDone(AIMSession sess,
                              AIMFrame frame)

Describe srvOfflineMsgDone method here.

Specified by:

srvOfflineMsgDone in interface ICQListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

srvMetaGeneralDone

public void srvMetaGeneralDone(AIMSession sess,
                               AIMFrame frame)

Describe srvMetaGeneralDone method here.

Specified by:

srvMetaGeneralDone in interface ICQListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

srvMetaMoreDone

public void srvMetaMoreDone(AIMSession sess,
                            AIMFrame frame)

Describe srvMetaMoreDone method here.

Specified by:

srvMetaMoreDone in interface ICQListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

srvMetaAboutDone

public void srvMetaAboutDone(AIMSession sess,
                             AIMFrame frame)

Describe srvMetaAboutDone method here.

Specified by:

srvMetaAboutDone in interface ICQListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

srvMetaPassDone

public void srvMetaPassDone(AIMSession sess,
                            AIMFrame frame)

Describe srvMetaPassDone method here.

Specified by:

srvMetaPassDone in interface ICQListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

srvMetaGeneral

public void srvMetaGeneral(AIMSession sess,
                           AIMFrame frame,
                           ICQMetaGeneral img)

Describe srvMetaGeneral method here.

Specified by:

srvMetaGeneral in interface ICQListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

img - an ICQMetaGeneral value

srvMetaWork

public void srvMetaWork(AIMSession sess,
                        AIMFrame frame,
                        ICQMetaWork imw)

Describe srvMetaWork method here.

Specified by:

srvMetaWork in interface ICQListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

imw - an ICQMetaWork value

srvMetaMore

public void srvMetaMore(AIMSession sess,
                        AIMFrame frame,
                        ICQMetaMore imm)

Describe srvMetaMore method here.

Specified by:

srvMetaMore in interface ICQListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

imm - an ICQMetaMore value

srvMetaAbout

public void srvMetaAbout(AIMSession sess,
                         AIMFrame frame,
                         String about)

Describe srvMetaAbout method here.

Specified by:

srvMetaAbout in interface ICQListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

about - a String value

srvMetaMoreEmail

public void srvMetaMoreEmail(AIMSession sess,
                             AIMFrame frame,
                             byte country,
                             byte flags,
                             String email)

Describe srvMetaMoreEmail method here.

Specified by:

srvMetaMoreEmail in interface ICQListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

country - a byte value

flags - a byte value

email - a String value

srvMetaInterest

public void srvMetaInterest(AIMSession sess,
                            AIMFrame frame,
                            byte interestCount,
                            ArrayList interestAreas,
                            ArrayList interestDescriptions)

Describe srvMetaInterest method here.

Specified by:

srvMetaInterest in interface ICQListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

interestCount - a byte value

interestAreas - a ArrayList value

interestDescriptions - a ArrayList value

srvMetaBackground

public void srvMetaBackground(AIMSession sess,
                              AIMFrame frame,
                              byte pastCount,
                              ArrayList pastAreas,
                              ArrayList pastDescriptions,
                              byte affiliationCount,
                              ArrayList affiliationAreas,
                              ArrayList affiliationDescriptions)

Describe srvMetaBackground method here.

Specified by:

srvMetaBackground in interface ICQListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

pastCount - a byte value

pastAreas - a ArrayList value

pastDescriptions - a ArrayList value

affiliationCount - a byte value

affiliationAreas - a ArrayList value

affiliationDescriptions - a ArrayList value

srvMetaInfo

public void srvMetaInfo(AIMSession sess,
                        AIMFrame frame,
                        ICQMetaGeneral img)

Describe srvMetaInfo method here.

Specified by:

srvMetaInfo in interface ICQListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

img - an ICQMetaGeneral value

srvMeta10E

public void srvMeta10E(AIMSession sess,
                       AIMFrame frame,
                       int unknown)

Describe srvMeta10E method here.

Specified by:

srvMeta10E in interface ICQListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

unknown - an int value

srvMetaFound

public void srvMetaFound(AIMSession sess,
                         AIMFrame frame,
                         ICQMetaFound imf)

Describe srvMetaFound method here.

Specified by:

srvMetaFound in interface ICQListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

imf - an ICQMetaFound value

srvMetaLast

public void srvMetaLast(AIMSession sess,
                        AIMFrame frame,
                        ICQMetaFound imf,
                        int missed)

Describe srvMetaLast method here.

Specified by:

srvMetaLast in interface ICQListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

imf - an ICQMetaFound value

missed - an int value

srvMetaRandom

public void srvMetaRandom(AIMSession sess,
                          AIMFrame frame,
                          int uin,
                          short group,
                          byte[] externalIP,
                          int port,
                          byte[] internalIP,
                          byte tcpFlags,
                          short tcpVersion,
                          byte[] unknown)

Describe srvMetaRandom method here.

Specified by:

srvMetaRandom in interface ICQListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

uin - an int value

group - a short value

externalIP - a byte[] value

port - an int value

internalIP - a byte[] value

tcpFlags - a byte value

tcpVersion - a short value

unknown - a byte[] value

srvMetaRandomDone

public void srvMetaRandomDone(AIMSession sess,
                              AIMFrame frame)

Describe srvMetaRandomDone method here.

Specified by:

srvMetaRandomDone in interface ICQListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

srvOfflineMsg

public void srvOfflineMsg(AIMSession sess,
                          AIMFrame frame,
                          ICQOfflineMsg msg)

Describe srvOfflineMsg method here.

Specified by:

srvOfflineMsg in interface ICQListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

msg - an ICQOfflineMsg value