org.walluck.oscar.tools
Class SSITool

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

All Implemented Interfaces:

Listener, SSIListener

public class SSITool
extends Tool
implements SSIListener

SSI tool.

Since:

1.0

Version:

1.0

Author:

David Walluck

Field Summary

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

listeners

Constructor Summary

SSITool()
Creates a new SSI tool.

Method Summary

void	addDeny(AIMSession sess, String who) Describe addDeny method here.
void	addPermit(AIMSession sess, String who) Describe addPermit method here.
void	bosConnectionAvailable() Method called by the LoginTool once the BOS connection is available.
void	parseAck(AIMSession sess, AIMFrame frame) Describe parseAck method here.
void	parseAdd(AIMSession sess, AIMFrame frame) Describe parseAdd method here.
void	parseAuthReq(AIMSession sess, AIMFrame frame, String sn, String reason) Describe parseAuthReq method here.
void	parseData(AIMSession sess, AIMFrame frame, int fmtVer, int numitems, List list, int timestamp) Describe parseData method here.
void	parseDataUnchanged(AIMSession sess, AIMFrame frame) Describe parseDataUnchanged method here.
void	parseDel(AIMSession sess, AIMFrame frame) Describe parseDel method here.
void	parseMod(AIMSession sess, AIMFrame frame) Describe parseMod method here.
void	parseRights(AIMSession sess, AIMFrame frame, short[] maxitems) Describe parseRights method here.
void	receiveAdded(AIMSession sess, AIMFrame frame, String sn) Describe receiveAdded method here.
void	receiveAuthGrant(AIMSession sess, AIMFrame frame, String sn, String msg) Describe receiveAuthGrant method here.
void	receiveAuthGranted(AIMSession sess, AIMFrame frame, String sn, byte reply, String msg) Describe receiveAuthGranted method here.
void	receiveAuthReply(AIMSession sess, AIMFrame frame, String sn, byte reply, String msg) Describe receiveAuthReply method here.
void	receiveAuthRequest(AIMSession sess, AIMFrame frame, String sn, String msg) Describe receiveAuthRequest method here.
void	remDeny(AIMSession sess, String who) Describe remDeny method here.
void	remPermit(AIMSession sess, String who) Describe remPermit 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

SSITool

public SSITool()

Creates a new SSI tool. Family 0x0013.

Method Detail

addPermit

public void addPermit(AIMSession sess,
                      String who)
               throws IOException

Describe addPermit method here.

Parameters:

sess - an AIMSession value

who - a String value

Throws:

IOException - if an error occurs

addDeny

public void addDeny(AIMSession sess,
                    String who)
             throws IOException

Describe addDeny method here.

Parameters:

sess - an AIMSession value

who - a String value

Throws:

IOException - if an error occurs

remPermit

public void remPermit(AIMSession sess,
                      String who)
               throws IOException

Describe remPermit method here.

Parameters:

sess - an AIMSession value

who - a String value

Throws:

IOException - if an error occurs

remDeny

public void remDeny(AIMSession sess,
                    String who)
             throws IOException

Describe remDeny method here.

Parameters:

sess - an AIMSession value

who - a String value

Throws:

IOException - if an error occurs

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

parseAdd

public void parseAdd(AIMSession sess,
                     AIMFrame frame)

Describe parseAdd method here.

Specified by:

parseAdd in interface SSIListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

parseMod

public void parseMod(AIMSession sess,
                     AIMFrame frame)

Describe parseMod method here.

Specified by:

parseMod in interface SSIListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

parseDel

public void parseDel(AIMSession sess,
                     AIMFrame frame)

Describe parseDel method here.

Specified by:

parseDel in interface SSIListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

receiveAuthGrant

public void receiveAuthGrant(AIMSession sess,
                             AIMFrame frame,
                             String sn,
                             String msg)

Describe receiveAuthGrant method here.

Specified by:

receiveAuthGrant in interface SSIListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

sn - a String value

msg - a String value

receiveAuthRequest

public void receiveAuthRequest(AIMSession sess,
                               AIMFrame frame,
                               String sn,
                               String msg)

Describe receiveAuthRequest method here.

Specified by:

receiveAuthRequest in interface SSIListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

sn - a String value

msg - a String value

receiveAuthReply

public void receiveAuthReply(AIMSession sess,
                             AIMFrame frame,
                             String sn,
                             byte reply,
                             String msg)

Describe receiveAuthReply method here.

Specified by:

receiveAuthReply in interface SSIListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

sn - a String value

reply - a byte value

msg - a String value

parseRights

public void parseRights(AIMSession sess,
                        AIMFrame frame,
                        short[] maxitems)

Describe parseRights method here.

Specified by:

parseRights in interface SSIListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

maxitems - a short[] value

parseData

public void parseData(AIMSession sess,
                      AIMFrame frame,
                      int fmtVer,
                      int numitems,
                      List list,
                      int timestamp)

Describe parseData method here.

Specified by:

parseData in interface SSIListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

fmtVer - an int value

numitems - an int value

list - a List value

timestamp - an int value

parseAck

public void parseAck(AIMSession sess,
                     AIMFrame frame)

Describe parseAck method here.

Specified by:

parseAck in interface SSIListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

parseDataUnchanged

public void parseDataUnchanged(AIMSession sess,
                               AIMFrame frame)

Describe parseDataUnchanged method here.

Specified by:

parseDataUnchanged in interface SSIListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

parseAuthReq

public void parseAuthReq(AIMSession sess,
                         AIMFrame frame,
                         String sn,
                         String reason)

Describe parseAuthReq method here.

Specified by:

parseAuthReq in interface SSIListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

sn - a String value

reason - a String value

receiveAuthGranted

public void receiveAuthGranted(AIMSession sess,
                               AIMFrame frame,
                               String sn,
                               byte reply,
                               String msg)

Describe receiveAuthGranted method here.

Specified by:

receiveAuthGranted in interface SSIListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

sn - a String value

reply - a byte value

msg - a String value

receiveAdded

public void receiveAdded(AIMSession sess,
                         AIMFrame frame,
                         String sn)

Describe receiveAdded method here.

Specified by:

receiveAdded in interface SSIListener

Parameters:

sess - an AIMSession value

frame - an AIMFrame value

sn - a String value