org.licas.ai_solver.mediator

Class ProblemSolverMediator

java.lang.Object

java.lang.Thread

org.licas.module.LicasModule

org.licas.module.FrameworkModule

org.licas.module.ServiceModule

org.licas.Service

org.licas.service.ServiceMediator

org.licas.service.InformationMediator

org.licas.ai_solver.mediator.ProblemSolverMediator

All Implemented Interfaces:

java.lang.AutoCloseable, java.lang.Runnable, org.licas.def.ServiceDef

public class ProblemSolverMediator
extends org.licas.service.InformationMediator

This class can be used to mediate between the information services that are created, the information sources and any related centralised problem solver. A service can be created with data added later, or initialised with an information source. The service then runs on the server and communicates with the problem solver classes through the licas framework.

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 java.lang.String	infoServiceType The main type of service being run
protected java.util.ArrayList<java.lang.String>	serviceNames List of service names

Fields inherited from class org.licas.service.InformationMediator

sourceData, sourceURLs

Fields inherited from class org.licas.service.ServiceMediator

serverIP, serverUri, serviceSpec, syncOn

Fields inherited from class org.licas.Service

canAccessMeta, canAccessNested, dm, finalised, isRemoteCall, messageStore, serviceAdmin, serviceGrade, serviceInitialise, serviceLinks, serviceState, sm, toLoadScript

Fields inherited from class org.licas.module.ServiceModule

shutDown

Fields inherited from class org.licas.module.FrameworkModule

passwordHandler, service, serviceType

Fields inherited from class org.licas.module.LicasModule

jarFile, uuid

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
ProblemSolverMediator(org.licas.PasswordHandler thePasswordHandler) Create a new instance of ProblemSolverMediator.
ProblemSolverMediator(java.lang.String thisPassword, java.lang.String thisAdminKey, org.licas.PasswordHandler thePasswordHandler) Creates a new instance of ProblemSolverMediator.

Method Summary

Modifier and Type	Method and Description
org.licas_xml.abs.Element	createAdminScript(java.lang.String serviceUuid, int index) Create the admin script to initialise the service with.
void	createService(java.lang.String serviceUuid, java.lang.String dataOrUrl, int index) Create an information service for each of the listed sources and initiate each one with the source information.
void	createServices() Create an information service for each of the listed sources and initiate each one with the source information.
java.util.ArrayList<java.lang.String>	getServiceNames() Get a list of retrieved service names.
java.util.LinkedHashMap<java.lang.String,java.lang.Object>	getServicesData(TestSpec testSpec) Get the dataset elements from all running services.
java.util.ArrayList<org.ai_heuristic.eval.metric.MetricDataset>	getServicesInfo(TestSpec testSpec, ProblemMediator probMediator) Retrieve the information from each information source in XML format and create a data object by parsing it and adding it to a MetricValue object.
boolean	initialiseServerInfo(ProblemScript theServiceSpec) Initialise the solver mediator with the server details.
void	replyToServices(TestSpec testSpec, org.licas_xml.abs.Element replyXml) Send the solution reply to any services on the serviceNames list.

Methods inherited from class org.licas.service.InformationMediator

createServices, initialiseServerInfo, initialiseServices, sortGroupsForEach, updateQueryInfo

Methods inherited from class org.licas.service.ServiceMediator

createAssociationLinks, createPermanentLinks, dynamicLinksToXml, getLinkedServiceUuids, initialiseInfo, startServices, updateDynamicLinks

Methods inherited from class org.licas.Service

addCommunicationID, addDefaultService, addDefaultService, addDefaultService, addDefaultService, addLinkFromService, addLinkToService, addMessageMetrics, addService, addService, addService, addService, addServiceAssociation, addServicePassword, addTempPassword, allowAddService, canAccess, canAccess, canAccess, canAccess, canAccessMeta, canAccessNested, canAccessTemp, canRun, classNameOK, clearServiceLinks, clearServices, clearServices, close, createMetaForRepos, createMetaFull, createPermanentLinkTo, createServiceWrapper, defaultAdminToRemove, dynamicLinkQuery, dynamicLinksToPermanent, dynamicLinksToXml, execute, finaliseInitialisation, finaliseInitialisation, finaliseModule, finaliseThisConfig, GET, getAllLinkToService, getAllowAddService, getAutonomicManagerConfig, getCommunicationClientURI, getData, getData, getDescription, getFullPath, getInstanceValue, getIsRemoteCall, getLinkFromService, getLinkToService, getLocalRemoteID, getParent, getParent, getPassword, getPassword, getPassword, getPasswordHandler, getPrivateMethods, getPublicMethods, getPublicServiceClassname, getServerPassword, getService, getService, getServiceAdmin, getServiceClasses, getServiceGrade, getServiceLinks, getServiceNames, getServiceNames, getServiceOrWrapper, getServiceState, getServiceType, getServiceTypes, handshake, hasCommunicationID, hasLinkTo, hasServerPassword, hasService, hasServiceType, interrupt, isAdminKey, isCorrectPassword, isPrivateMethod, isPublicMethod, isStarted, linksToXml, passwordsStateToXml, permanentLinksToXml, removeAllLinksTo, removeAllServices, removeAllServices, removeCommunicationID, removeLinkFromService, removeLinkToService, removePermanentLinkTo, removeServiceAssociation, removeServiceID, removeServicePath, removeServicePath, removeTempPassword, serviceNegotiate, serviceToXml, serviceToXml, setAdminInfo, setCanAccessMeta, setCanAccessNested, setData, setDataModule, setDataModule, setDescription, setInstanceValues, setIsRemoteCall, setOtherMeta, setParent, setParent, setSerializeValues, setServerPassword, setServiceGrade, setServiceModule, setServiceState, startAllThreads, startThread, stopAllThreads, syncToAsync, syncToAsyncReply, syncToAsyncTransit, xmlToDynamicLinks, xmlToService

Methods inherited from class org.licas.module.ServiceModule

getShutDown, setShutDown, setShutDown

Methods inherited from class org.licas.module.FrameworkModule

canAccess, getServicePassword, getServiceType, 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

infoServiceType

protected java.lang.String infoServiceType

The main type of service being run

serviceNames

protected java.util.ArrayList<java.lang.String> serviceNames

List of service names

Constructor Detail

ProblemSolverMediator

public ProblemSolverMediator(org.licas.PasswordHandler thePasswordHandler)
                      throws java.lang.Exception

Create a new instance of ProblemSolverMediator.

Parameters:

thePasswordHandler - the password handler.

Throws:

java.lang.Exception - any error.

ProblemSolverMediator

public ProblemSolverMediator(java.lang.String thisPassword,
                             java.lang.String thisAdminKey,
                             org.licas.PasswordHandler thePasswordHandler)
                      throws java.lang.Exception

Creates a new instance of ProblemSolverMediator.

Parameters:

thisPassword - the component password.

thisAdminKey - the unique service key.

thePasswordHandler - the password handler.

Throws:

java.lang.Exception - any error.

Method Detail

initialiseServerInfo

public boolean initialiseServerInfo(ProblemScript theServiceSpec)
                             throws java.lang.Exception

Initialise the solver mediator with the server details. Also clear the network of any existing services and the password handler for this service.

Parameters:

theServiceSpec - the test script with all of the test config. Of type ProblemScript.

Returns:

true if initialised OK, false otherwise. Most likely, it would be missing service initialisation information.

Throws:

java.lang.Exception - any error.

createServices

public void createServices()
                    throws java.lang.Exception

Create an information service for each of the listed sources and initiate each one with the source information. This can include a more detailed admin script and a data generator for random data.

Throws:

java.lang.Exception - any error.

createService

public void createService(java.lang.String serviceUuid,
                          java.lang.String dataOrUrl,
                          int index)
                   throws java.lang.Exception

Create an information service for each of the listed sources and initiate each one with the source information. This can include a more detailed admin script and a data generator for random data.

Parameters:

serviceUuid - uuid for the service to create.

dataOrUrl - address of a resource to load, or string data itself.

index - for unique ids.

Throws:

java.lang.Exception - any error.

createAdminScript

public org.licas_xml.abs.Element createAdminScript(java.lang.String serviceUuid,
                                                   int index)
                                            throws java.lang.Exception

Create the admin script to initialise the service with.

Parameters:

serviceUuid - uuid for the service to create.

index - for unique ids.

Returns:

the service admin script.

Throws:

java.lang.Exception - any error.

replyToServices

public void replyToServices(TestSpec testSpec,
                            org.licas_xml.abs.Element replyXml)
                     throws java.lang.Exception

Send the solution reply to any services on the serviceNames list. Use the messageReply method to return the result, passing a MessageInfo object with an AiConst.NOACTION message state..

Parameters:

testSpec - the model of the tests to perform.

replyXml - the result from the problem solver.

Throws:

java.lang.Exception - any error.

getServicesInfo

public java.util.ArrayList<org.ai_heuristic.eval.metric.MetricDataset> getServicesInfo(TestSpec testSpec,
                                                                                       ProblemMediator probMediator)
                                                                                throws java.lang.Exception

Retrieve the information from each information source in XML format and create a data object by parsing it and adding it to a MetricValue object. This is to seed the problem-solving solutions with and so is probably scientific information in nature.

Parameters:

testSpec - the model of the tests to perform.

probMediator - the problem mediator.

Returns:

the list of created metric objects.

Throws:

java.lang.Exception - any error.

getServicesData

public java.util.LinkedHashMap<java.lang.String,java.lang.Object> getServicesData(TestSpec testSpec)
                                                                           throws java.lang.Exception

Get the dataset elements from all running services.

Parameters:

testSpec - the model of the tests to perform.

Returns:

the dataset elements indexed by the service uuids.

Throws:

java.lang.Exception - any error.

getServiceNames

public java.util.ArrayList<java.lang.String> getServiceNames()

Get a list of retrieved service names.

Overrides:

getServiceNames in class org.licas.Service

Returns:

the value of serviceNames.