org.licas.module.s_module

Class SM_Service

java.lang.Object

java.lang.Thread

org.licas.module.LicasModule

org.licas.module.FrameworkModule

org.licas.module.s_module.SM_Service

All Implemented Interfaces:

java.lang.Runnable, ServiceDef

Direct Known Subclasses:

SM_Data

public class SM_Service
extends FrameworkModule

This class stores the minimal set of service operations for behaviours and module plug-ins. The methods are in a separate FrameworkModule class in the same package as the Service class, so that it can access the required Service fields. This is an interface class for a modular setup.

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

Modifier and Type	Field and Description
protected ControlModule	cm This is the control module
protected java.lang.String	commID This stores the value of the last read communication id, so that it can be identified by any method that is subsequently invoked.

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
SM_Service(Service service, PasswordHandler pHandler) Creates a new instance of SM_Service.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCommID() Get the last read communication ID.
java.lang.String	getServerPassword() Get the local server password if it is stored.
void	setCommID(java.lang.String thisCommID) Set the last read communication ID.
protected void	setControlModule() Set the control module.
void	setDataModule(DataModule theDm) Set the data module in the behaviour to access the data Resource.

Methods inherited from class org.licas.module.FrameworkModule

canAccess, canAccessTemp, getPasswordHandler, getPasswordHandler, 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

Field Detail

commID

protected java.lang.String commID

This stores the value of the last read communication id, so that it can be identified by any method that is subsequently invoked.

cm

protected ControlModule cm

This is the control module

Constructor Detail

SM_Service

public SM_Service(Service service,
                  PasswordHandler pHandler)
           throws java.lang.Exception

Creates a new instance of SM_Service.

Parameters:

service - the parent service.

pHandler - the parent password handler.

Throws:

java.lang.Exception - any error.

Method Detail

setControlModule

protected void setControlModule()
                         throws java.lang.Exception

Set the control module.

Throws:

java.lang.Exception - any error.

getServerPassword

public java.lang.String getServerPassword()
                                   throws java.lang.Exception

Get the local server password if it is stored.

Overrides:

getServerPassword in class FrameworkModule

Returns:

the local server password.

Throws:

java.lang.Exception - any error.

setCommID

public void setCommID(java.lang.String thisCommID)

Set the last read communication ID.

Parameters:

thisCommID - the communication ID.

getCommID

public java.lang.String getCommID()

Get the last read communication ID.

Returns:

the value of commID.

setDataModule

public void setDataModule(DataModule theDm)

Set the data module in the behaviour to access the data Resource.

Parameters:

theDm - the data module.