workbench.im

Class AgentConfig

java.lang.Object

java.util.Observable

workbench.im.AgentConfig

public class AgentConfig
extends Observable

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_DATETIMEEND
static String	ATTR_DATETIMESTART
static String	ATTR_DESC
static String	ATTR_ENABLED
static String	ATTR_EXPR
static String	ATTR_JID
static String	ATTR_KEYWORD_BODY
static String	ATTR_KEYWORD_SUBJECT
static String	ATTR_NAME
static String	ATTR_SRC
static String	ATTR_TYPE
static String	TAG_ALERT
static String[]	TAG_ALERT_CHILD
static String	TAG_MONITOR
static String[]	TAG_MONITOR_CHILD
static String	TAG_MONITORDEFAULT
static String[]	TAG_MONITORDEFAULT_CHILD
static String[]	TAG_REGEXP_CHILD
static String	TAG_WATCHEVENT
static String	TAG_XTCMONITOR XML tags and attributes

Constructor Summary

Constructors

Constructor and Description
AgentConfig(String sXMLFile) constructor

Method Summary

Methods

Modifier and Type	Method and Description
Monitor	createMonitor(Node aNode, String[] sArr) create a Monitor object e.g.
boolean	eventNotify(String sBody, String sXHTML) notify observers, e.g.
ArrayList<String>	getJIDList() get list of JIDs
ArrayList	getKeywordBody(String sJID) get list of keywords in message body based on JID
ArrayList	getKeywordBodyDefault() string value of default list of Message Body keyword for display in edit boxes
ArrayList	getKeywordSubject(String sJID) get list of keywords in message subject based on JID
ArrayList	getKeywordSubjectDefault() string value of default list of Message Subject keyword for display in edit boxes
boolean	inKeywordBody(String sLine) check whether Message Body keyword matches keyword list No JID is provided
boolean	inKeywordBody(String sJID, String sLine) check whether Message Body keyword matches keyword list for a particular JID, if provided
boolean	inKeywordSubject(String sLine) check whether Message Subject keyword matches keyword list No JID is provided
boolean	inKeywordSubject(String sJID, String sLine) check whether Message Subject keyword matches keyword list for a particular JID, if provided
boolean	inKeywordSubjectBody(String sWord) check whether Message Body keyword is in Default Monitor's list
boolean	inKeywordSubjectDefault(String sWord) check whether Message Subject keyword is in Default Monitor's list
WatchEvent	inRegExp(String sLine) check whether the line matches a regular expression in all Monitors (include default)
void	loadXML(String filename) load mission script from a XML file
void	sampleRegExp() sample regular expression
boolean	testNotify(String sBody, String sXHTML) testNotify() notify observers, e.g.
void	testNotifyZZZ(String sLine)
String	toString() get String contents of object
static void	writeErr(String aStr) write a error messgae to console
static void	writeLn() write a line to console
static void	writeLn(boolean bStr) write boolean value to console
static void	writeLn(int iStr) write numeric value to console
static void	writeLn(String aStr) write a line to console

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Field Detail

TAG_XTCMONITOR

public static final String TAG_XTCMONITOR

XML tags and attributes

See Also:

Constant Field Values

TAG_MONITORDEFAULT

public static final String TAG_MONITORDEFAULT

See Also:

Constant Field Values

TAG_MONITOR

public static final String TAG_MONITOR

See Also:

Constant Field Values

TAG_WATCHEVENT

public static final String TAG_WATCHEVENT

See Also:

Constant Field Values

ATTR_NAME

public static final String ATTR_NAME

See Also:

Constant Field Values

ATTR_EXPR

public static final String ATTR_EXPR

See Also:

Constant Field Values

TAG_MONITORDEFAULT_CHILD

public static final String[] TAG_MONITORDEFAULT_CHILD

TAG_MONITOR_CHILD

public static final String[] TAG_MONITOR_CHILD

TAG_ALERT

public static final String TAG_ALERT

See Also:

Constant Field Values

TAG_REGEXP_CHILD

public static final String[] TAG_REGEXP_CHILD

ATTR_TYPE

public static final String ATTR_TYPE

See Also:

Constant Field Values

ATTR_SRC

public static final String ATTR_SRC

See Also:

Constant Field Values

ATTR_ENABLED

public static final String ATTR_ENABLED

See Also:

Constant Field Values

TAG_ALERT_CHILD

public static final String[] TAG_ALERT_CHILD

ATTR_JID

public static final String ATTR_JID

See Also:

Constant Field Values

ATTR_DESC

public static final String ATTR_DESC

See Also:

Constant Field Values

ATTR_DATETIMESTART

public static final String ATTR_DATETIMESTART

See Also:

Constant Field Values

ATTR_DATETIMEEND

public static final String ATTR_DATETIMEEND

See Also:

Constant Field Values

ATTR_KEYWORD_SUBJECT

public static final String ATTR_KEYWORD_SUBJECT

See Also:

Constant Field Values

ATTR_KEYWORD_BODY

public static final String ATTR_KEYWORD_BODY

See Also:

Constant Field Values

Constructor Detail

AgentConfig

public AgentConfig(String sXMLFile)

constructor

Parameters:

sXMLFile - default XML file

Method Detail

createMonitor

public Monitor createMonitor(Node aNode,
                    String[] sArr)

create a Monitor object e.g.

Parameters:

aNode - Monitor node

sArr - list of attributes to retrieve

Returns:

created Monitor object

eventNotify

public boolean eventNotify(String sBody,
                  String sXHTML)

notify observers, e.g. Mission Planner to draw module upon detection of an "Mine" in incoming message

Parameters:

sBody - incoming message body

sXHTML - XHTML data

Returns:

true if triggered event

getJIDList

public ArrayList<String> getJIDList()

get list of JIDs

Returns:

array list

getKeywordBody

public ArrayList getKeywordBody(String sJID)

get list of keywords in message body based on JID

Parameters:

sJID - Jabber user ID, set to "default" for default values

Returns:

array list

getKeywordBodyDefault

public ArrayList getKeywordBodyDefault()

string value of default list of Message Body keyword for display in edit boxes

Returns:

list of keywords

getKeywordSubject

public ArrayList getKeywordSubject(String sJID)

get list of keywords in message subject based on JID

Parameters:

sJID - Jabber user ID, set to "default" for default values

Returns:

array list

getKeywordSubjectDefault

public ArrayList getKeywordSubjectDefault()

string value of default list of Message Subject keyword for display in edit boxes

Returns:

list of keywords

inKeywordBody

public boolean inKeywordBody(String sJID,
                    String sLine)

check whether Message Body keyword matches keyword list for a particular JID, if provided

Parameters:

sJID - Jabber user ID

sLine - sentence to be checked

Returns:

true if found, otherwise false

inKeywordBody

public boolean inKeywordBody(String sLine)

check whether Message Body keyword matches keyword list No JID is provided

Parameters:

sLine - sentence to be checked

Returns:

true if found, otherwise false

inKeywordSubjectBody

public boolean inKeywordSubjectBody(String sWord)

check whether Message Body keyword is in Default Monitor's list

Parameters:

sWord - message subject

Returns:

true if found, otherwise false

inKeywordSubject

public boolean inKeywordSubject(String sJID,
                       String sLine)

check whether Message Subject keyword matches keyword list for a particular JID, if provided

Parameters:

sJID - Jabber user ID

sLine - message subject

Returns:

true if found, otherwise false

inKeywordSubject

public boolean inKeywordSubject(String sLine)

check whether Message Subject keyword matches keyword list No JID is provided

Parameters:

sLine - message subject

Returns:

true if found, otherwise false

inKeywordSubjectDefault

public boolean inKeywordSubjectDefault(String sWord)

check whether Message Subject keyword is in Default Monitor's list

Parameters:

sWord - message subject

Returns:

true if found, otherwise false

inRegExp

public WatchEvent inRegExp(String sLine)

check whether the line matches a regular expression in all Monitors (include default)

Parameters:

sLine - source string to be matched

Returns:

Matcher

loadXML

public void loadXML(String filename)

load mission script from a XML file

Parameters:

filename - file to be loaded from

sampleRegExp

public void sampleRegExp()

sample regular expression

testNotify

public boolean testNotify(String sBody,
                 String sXHTML)

testNotify() notify observers, e.g. Mission Planner to draw module upon detection of an "Mine" in incoming message

Parameters:

sBody - incoming message body

sXHTML - XHTML data

Returns:

true if triggered event

testNotifyZZZ

public void testNotifyZZZ(String sLine)

toString

public String toString()

get String contents of object

Overrides:

toString in class Object

Returns:

string value

writeErr

public static void writeErr(String aStr)

write a error messgae to console

Parameters:

aStr - line to be written to console

writeLn

public static void writeLn(String aStr)

write a line to console

Parameters:

aStr - line to be written to console

writeLn

public static void writeLn(boolean bStr)

write boolean value to console

Parameters:

bStr - boolean value to be written to console

writeLn

public static void writeLn(int iStr)

write numeric value to console

Parameters:

iStr - numeric value to be written to console

writeLn

public static void writeLn()

write a line to console