org.walluck.oscar.tools
Class BOSTool

java.lang.Object
  extended by org.walluck.oscar.tools.Tool
      extended by org.walluck.oscar.tools.BOSTool
All Implemented Interfaces:
BOSListener, Listener

public class BOSTool
extends Tool
implements BOSListener

BOS tool.

Since:
1.0
Version:
1.0
Author:
David Walluck

Field Summary
 
Fields inherited from class org.walluck.oscar.tools.Tool
listeners
 
Constructor Summary
BOSTool()
          Creates a new BOS tool.
 
Method Summary
 void bosConnectionAvailable()
          Method called by the LoginTool once the BOS connection is available.
 void bosRights(AIMSession sess, AIMFrame frame, int maxpermits, int maxdenies)
          Describe bosRights 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

BOSTool

public BOSTool()
Creates a new BOS tool. Family 0x0009.

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

bosRights

public void bosRights(AIMSession sess,
                      AIMFrame frame,
                      int maxpermits,
                      int maxdenies)
Describe bosRights method here.

Specified by:
bosRights in interface BOSListener
Parameters:
sess - an AIMSession value
frame - an AIMFrame value
maxpermits - an int value
maxdenies - an int value