org.walluck.oscar.tools
Class AdvertTool

java.lang.Object
  extended by org.walluck.oscar.tools.Tool
      extended by org.walluck.oscar.tools.AdvertTool
All Implemented Interfaces:
AdvertListener, Listener, ServiceListener

public class AdvertTool
extends Tool
implements AdvertListener, ServiceListener

Advert tool.

Since:
1.0
Version:
1.0
Author:
David Walluck

Field Summary
 
Fields inherited from class org.walluck.oscar.tools.Tool
listeners
 
Constructor Summary
AdvertTool()
          Creates a new Advert tool.
 
Method Summary
 void adSent(AIMSession sess, AIMFrame frame, Ad ad)
          Describe adSent method here.
 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 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.
 
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

AdvertTool

public AdvertTool()
Creates a new Advert tool. Family 0x0005.

Method Detail

adSent

public void adSent(AIMSession sess,
                   AIMFrame frame,
                   Ad ad)
Describe adSent method here.

Specified by:
adSent in interface AdvertListener
Parameters:
sess - an AIMSession value
frame - an AIMFrame value
ad - an Ad 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

rateChange

public void rateChange(AIMSession sess,
                       AIMFrame frame,
                       int code,
                       RateClass rc)
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)
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)
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)
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)
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)
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)
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)
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

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

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