workbench.im

Class IMConfig

java.lang.Object

workbench.im.IMConfig

All Implemented Interfaces:

Comparable

public class IMConfig
extends Object
implements Comparable

Version:

$Id: IMConfig.java 8020 2012-07-03 01:37:06Z brutzman $

Constructor Summary

Constructors

Constructor and Description
IMConfig() constructor
IMConfig(Object owner, String sHost, int iPort, String sUser, String sPassword, String sResource, String sNickname) constructor

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acceptMsg(String sFrom) determine whether to accept message from a particular user, mainly used to down Jabber server broadcast messages e.g.
int	compareTo(Object aObj) compare 2 objects
void	connectionClose() close jabber connection
boolean	connectionOpen() open jabber connection, close existing session, if any
String	getHost() get host name
AgentConfig	getMonitor() get event monitoring criteria object
String	getNickname() get nickname
int	getNumMsgIgnore() no. of messages to ignore
String	getPassword() get user password
int	getPort() get session port no.
String	getPresence() get user presence
String	getPresenceStatus() get user presence status
String	getResource() get resource name
String	getUserName() get user name
boolean	groupchatJoin(String chatRoomName) join a chatroom e.g. groupchatJoin("savage@conference.savage.nps.edu");
boolean	groupchatLeave(String sRoom) leave a chatroom
ArrayList	groupchatParticipants(String sRoom) get list of participants in chatroom
boolean	groupchatSendMessage(String sRoom, String sBody) send message to a chatroom (no subject title)
boolean	groupchatSendMessage(String sRoom, String sBody, String sXHTML) send message to a chatroom
void	loadFromXML(String sFilename, String sTag) load setting from XML file
boolean	p2pchatOpen(String sJID) open a peer-to-peer chat session with another user
boolean	p2PchatSendFile(String sJID, String sSubject, String sBody, ArrayList lstAP) send message to a chatroom (no subject title)
boolean	p2PchatSendFile(String sJID, String sSubject, String sBody, String filename) send message to a chatroom (no subject title) and no
boolean	p2PchatSendFile(String sJID, String sSubject, String sBody, String filename, String[] arrURL) send message to a chatroom (no subject title) and no
boolean	p2PchatSendMessage(String sJID, String sBody) send message to a chatroom (no subject title)
boolean	p2PchatSendMessage(String sJID, String sSubject, String sBody, String sXHTML, boolean flagXHTML) send message to a chatroom
boolean	processMessageBody(String sJID, String sBody, String sXHTML) process incoming message body check whether message body contains keywords.
boolean	processMessageSubject(String sJID, String sSubject, String sXHTML) process incoming message subject check whether message body contains keywords.
void	setHost(String value) set host
void	setMonitor(AgentConfig obj) set event monitoring criteria
void	setNickname(String value) set nickname
void	setNumMsgIgnore(int num) set no. of messages to ignore
void	setPassword(String value) set password
void	setPort(int value) set session port no.
boolean	setPresence(String value) set presence
void	setPresenceStatus(String value) set presence status e.g.
void	setResource(String value) set resource
void	setUserName(String value) set user name
String	toString() display contents of object
void	writeErr(String aStr) write a error messgae to console
void	writeLn(String aStr) write a line to console

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IMConfig

public IMConfig()

constructor

IMConfig

public IMConfig(Object owner,
        String sHost,
        int iPort,
        String sUser,
        String sPassword,
        String sResource,
        String sNickname)

constructor

Parameters:

owner - parent object

sHost - hostname

iPort - port no.

sUser - user name

sPassword - user password

sResource - resource

sNickname - nickname

Method Detail

getMonitor

public AgentConfig getMonitor()

get event monitoring criteria object

Returns:

AgentConfig object

setMonitor

public void setMonitor(AgentConfig obj)

set event monitoring criteria

Parameters:

obj - AgentConfig object

acceptMsg

public boolean acceptMsg(String sFrom)

determine whether to accept message from a particular user, mainly used to down Jabber server broadcast messages e.g. "User1 has just become available"

Parameters:

sFrom - a JID

Returns:

true is accept, otherwise reject

connectionClose

public void connectionClose()

close jabber connection

connectionOpen

public boolean connectionOpen()

open jabber connection, close existing session, if any

Returns:

true - succcessful, otherwise failed to join chatroom

groupchatJoin

public boolean groupchatJoin(String chatRoomName)

join a chatroom e.g. groupchatJoin("savage@conference.savage.nps.edu");

Parameters:

chatRoomName - chat room name

Returns:

true - succcessful, otherwise failed to join chatroom

groupchatLeave

public boolean groupchatLeave(String sRoom)

leave a chatroom

Parameters:

sRoom - chatroom

Returns:

true - succcessful, otherwise failed to join chatroom

groupchatParticipants

public ArrayList groupchatParticipants(String sRoom)

get list of participants in chatroom

Parameters:

sRoom - chatroom

Returns:

list of chatroom participants

groupchatSendMessage

public boolean groupchatSendMessage(String sRoom,
                           String sBody,
                           String sXHTML)

send message to a chatroom

Parameters:

sRoom - chatroom name

sBody - message to be set out

sXHTML - XHTML string data to be sent out

Returns:

true - succcessful, otherwise failed to join chatroom

groupchatSendMessage

public boolean groupchatSendMessage(String sRoom,
                           String sBody)

send message to a chatroom (no subject title)

Parameters:

sRoom - chatroom name

sBody - body of message to be set out

Returns:

true - succcessful, otherwise failed to join chatroom

p2pchatOpen

public boolean p2pchatOpen(String sJID)

open a peer-to-peer chat session with another user

Parameters:

sJID - a valid JID e.g. auvw@savage.nps.edu

Returns:

true - succcessful, otherwise failed to start chat session

p2PchatSendFile

public boolean p2PchatSendFile(String sJID,
                      String sSubject,
                      String sBody,
                      String filename)

send message to a chatroom (no subject title) and no

Parameters:

sJID - chatroom name

sSubject - message subject

sBody - body of message to be set out

filename - file attachment to be sent

Returns:

true - succcessful, otherwise failed to join chatroom

p2PchatSendFile

public boolean p2PchatSendFile(String sJID,
                      String sSubject,
                      String sBody,
                      String filename,
                      String[] arrURL)

send message to a chatroom (no subject title) and no

Parameters:

sJID - chatroom name

sSubject - message subject

sBody - body of message to be set out

filename - file attachment to be sent

arrURL - list of URLs associated with file

Returns:

true - succcessful, otherwise failed to join chatroom

p2PchatSendFile

public boolean p2PchatSendFile(String sJID,
                      String sSubject,
                      String sBody,
                      ArrayList lstAP)

send message to a chatroom (no subject title)

Parameters:

sJID - chatroom name

sSubject - message subject

sBody - body of message to be set out

lstAP - list of AgentPayload object to send

Returns:

true - succcessful, otherwise failed to join chatroom

p2PchatSendMessage

public boolean p2PchatSendMessage(String sJID,
                         String sBody)

send message to a chatroom (no subject title)

Parameters:

sJID - chatroom name

sBody - body of message to be set out

Returns:

true - succcessful, otherwise failed to join chatroom

p2PchatSendMessage

public boolean p2PchatSendMessage(String sJID,
                         String sSubject,
                         String sBody,
                         String sXHTML,
                         boolean flagXHTML)

send message to a chatroom

Parameters:

sJID - chatroom name

sSubject - subject of message

sBody - body of message to be set out

sXHTML - XHTML string data to be sent out

flagXHTML - is it XHTML message?

Returns:

true - succcessful, otherwise failed to join chatroom

processMessageBody

public boolean processMessageBody(String sJID,
                         String sBody,
                         String sXHTML)

process incoming message body check whether message body contains keywords.

Parameters:

sJID - Jabber user ID (not used)

sBody - message body

sXHTML - determine whether it has XHTML data

Returns:

true if found, otherwsie false

processMessageSubject

public boolean processMessageSubject(String sJID,
                            String sSubject,
                            String sXHTML)

process incoming message subject check whether message body contains keywords.

Parameters:

sJID - Jabber user ID (not used)

sSubject - message subject

sXHTML - determine whether it has XHTML data

Returns:

true if found, otherwsie false

loadFromXML

public void loadFromXML(String sFilename,
               String sTag)

load setting from XML file

Parameters:

sFilename - XML file

sTag - which tag to read from

setPort

public void setPort(int value)

set session port no.

Parameters:

value - numeric value to be set

getPort

public int getPort()

get session port no.

Returns:

port no.

setHost

public void setHost(String value)

set host

Parameters:

value - string to be set

getHost

public String getHost()

get host name

Returns:

host name

setNumMsgIgnore

public void setNumMsgIgnore(int num)

set no. of messages to ignore

Parameters:

num - numeric value

getNumMsgIgnore

public int getNumMsgIgnore()

no. of messages to ignore

Returns:

numeric value

setNickname

public void setNickname(String value)

set nickname

Parameters:

value - string to be set

getNickname

public String getNickname()

get nickname

Returns:

user nickname

setPassword

public void setPassword(String value)

set password

Parameters:

value - string to be set

getPassword

public String getPassword()

get user password

Returns:

user password

setPresence

public boolean setPresence(String value)

set presence

Parameters:

value - string to be set, valid values AVAILABLE, ERROR, SUBSCRIBE, SUBSCRIBED, UNAVAILABLE, UNSUBSCRIBE, UNSUBSCRIBED

Returns:

true - succcessful, otherwise failed to set presence

getPresence

public String getPresence()

get user presence

Returns:

user presence

setPresenceStatus

public void setPresenceStatus(String value)

set presence status e.g. "Went out for lunch"

Parameters:

value - string to be set

getPresenceStatus

public String getPresenceStatus()

get user presence status

Returns:

user presence

setResource

public void setResource(String value)

set resource

Parameters:

value - string to be set

getResource

public String getResource()

get resource name

Returns:

resource name

setUserName

public void setUserName(String value)

set user name

Parameters:

value - string to be set

getUserName

public String getUserName()

get user name

Returns:

user name

compareTo

public int compareTo(Object aObj)

compare 2 objects

Specified by:

compareTo in interface Comparable

Parameters:

aObj - object to be compared with

Returns:

true/false

toString

public String toString()

display contents of object

Overrides:

toString in class Object

Returns:

string value

writeErr

public void writeErr(String aStr)

write a error messgae to console

Parameters:

aStr - line to be written to console

writeLn

public void writeLn(String aStr)

write a line to console

Parameters:

aStr - line to be written to console