jadex.bdi.planlib.messaging

Class AIM

java.lang.Object

jadex.bdi.planlib.messaging.AIM

public class AIM
extends Object

AIM The class provides utilities to connect to the AIM instant messaging network and send messages using TOC version 2.

Field Summary

Fields

Modifier and Type	Field and Description
String	authHost The OSCAR authentication server.
int	authPort The OSCAR authentication server's port.
static int	DATA The ID number for a DATA packet (flap).
String	language What language to use.
String	roastString The string used to "roast" passwords.
static int	SIGNON The ID number for a SIGNON packet(FLAP).
String	tocHost The host address of the TOC server.
int	tocPort The port used to connect to the TOC server.
String	version The version of the client.

Constructor Summary

Constructors

Constructor and Description
AIM(String id, String password) Constructor for AIM.

Method Summary

Methods

Modifier and Type	Method and Description
String	getError() Getter for error
boolean	isLoggedin() Getter for loggedin
boolean	login(String id, String password) Log in to TOC
void	logout() Logout of toc and close the socket
void	send(String to, String msg) Send a IM

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

tocHost

public String tocHost

The host address of the TOC server.

tocPort

public int tocPort

The port used to connect to the TOC server.

authHost

public String authHost

The OSCAR authentication server.

authPort

public int authPort

The OSCAR authentication server's port.

language

public String language

What language to use.

version

public String version

The version of the client.

roastString

public String roastString

The string used to "roast" passwords. See the roastPassword method for more info.

SIGNON

public static final int SIGNON

The ID number for a SIGNON packet(FLAP).

See Also:

Constant Field Values

DATA

public static final int DATA

The ID number for a DATA packet (flap).

See Also:

Constant Field Values

Constructor Detail

AIM

public AIM(String id,
   String password)

Constructor for AIM.

Parameters:

id -

password -

Method Detail

login

public boolean login(String id,
            String password)

Log in to TOC

Parameters:

id - The screen name to login with

password - The screen name's password

Returns:

true on success

logout

public void logout()

Logout of toc and close the socket

send

public void send(String to,
        String msg)

Send a IM

Parameters:

to - Screen name to send an IM to

msg - The instant message

getError

public String getError()

Getter for error

Returns:

Returns error.

isLoggedin

public boolean isLoggedin()

Getter for loggedin

Returns:

Returns loggedin.