org.licas.module

Class BehaviourModule

java.lang.Object

java.lang.Thread

org.licas.module.LicasModule

org.licas.module.FrameworkModule

org.licas.module.BehaviourModule

All Implemented Interfaces:

java.lang.Runnable, ServiceDef

Direct Known Subclasses:

BM_InfoClientPS, BM_LinkData, BM_Script

public abstract class BehaviourModule
extends FrameworkModule

Base class for the specific behaviour and evaluation for autonomous behaviours.

Author:

Kieran Greer

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class org.licas.module.FrameworkModule

passwordHandler, service, serviceType

Fields inherited from class org.licas.module.LicasModule

jarFile, syncOn, uuid

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
BehaviourModule(Auto service, PasswordHandler passwordHandler) Create a new instance of BehaviourModule.

Method Summary

Modifier and Type	Method and Description
abstract MessageInfo	behaviourAction(MessageInfo messageInfo, HeuristicModule evaluate, SM_Data sm) Run the behaviour evaluation.
protected boolean	testEnded(org.licas_xml.abs.Element reply) Return true if the test has ended.

Methods inherited from class org.licas.module.FrameworkModule

canAccess, canAccessTemp, getPasswordHandler, getPasswordHandler, getServerPassword, getServicePassword, getServiceType, isAdminKey, setServiceDetails, setServiceType

Methods inherited from class org.licas.module.LicasModule

getJarFile, getUUID, loadObject, setJarFile, setUUID, threadAliveState

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, run, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.licas.def.ServiceDef

getUUID, setJarFile, setUUID

Constructor Detail

BehaviourModule

public BehaviourModule(Auto service,
                       PasswordHandler passwordHandler)
                throws java.lang.Exception

Create a new instance of BehaviourModule.

Parameters:

service - the probably Auto-derived service the behaviour is for.

passwordHandler - the service's password handler.

Throws:

java.lang.Exception - any error.

Method Detail

behaviourAction

public abstract MessageInfo behaviourAction(MessageInfo messageInfo,
                                            HeuristicModule evaluate,
                                            SM_Data sm)
                                     throws java.lang.Exception

Run the behaviour evaluation.

Parameters:

messageInfo - the Input message to evaluate.

evaluate - heuristic to evaluate the behaviour with.

sm - the service module.

Returns:

the evaluation result.

Throws:

java.lang.Exception - any error.

testEnded

protected boolean testEnded(org.licas_xml.abs.Element reply)

Return true if the test has ended.

Parameters:

reply - the evaluation reply.

Returns:

true if not null and indicates the end of the test.