infosapient.server
Interface InfoSapientService

All Known Implementing Classes:

InfoSapientServiceImpl

public interface InfoSapientService

extends java.rmi.Remote

BlackMesaService is the interface used to perform knowledgebase sessions on behalf of BlackMesaClients. Creation date: (04/06/01 1:17:22 PM)

Version:

$Revision: 1.1.1.1 $

Method Summary

boolean	broadcast(java.rmi.server.ObjID from, java.lang.String mtag, java.lang.Object data) Broadcast a message to all known clients.
java.rmi.server.ObjID	execute(InfoSapientClient interestedClient, java.util.Properties goalProperties) Used by a InfoSapientClient to initiate a knowledgebase session by starting a new thread.
boolean	register(java.rmi.server.ObjID i, InfoSapientClient c) Register this client with the service.
boolean	remove(InfoSapientClient c) Remove this client from the registry.
boolean	send(java.rmi.server.ObjID to, java.rmi.server.ObjID from, java.lang.String mtag, java.lang.Object data) Send a message from a client, to another client.

Method Detail

broadcast

public boolean broadcast(java.rmi.server.ObjID from,
                         java.lang.String mtag,
                         java.lang.Object data)
                  throws java.io.IOException,
                         java.rmi.RemoteException

Broadcast a message to all known clients.

Parameters:

from - - ObjID - unique identifier from whom the message is from

mtag - - String - arbitrary message identifier (implementation dependent)

data - - Object - message object.

Returns:

- boolean - true if broadcast successful.

Throws:

- - IOException

- - RemoteException

execute

public java.rmi.server.ObjID execute(InfoSapientClient interestedClient,
                                     java.util.Properties goalProperties)
                              throws java.rmi.RemoteException

Used by a InfoSapientClient to initiate a knowledgebase session by starting a new thread. Register the client with the BlackMesaService. Return the ObjID of the BlackMesaKnowledgeWorker actually performing the work.

Parameters:

InfoSapientClient - - the client that wishes to start a kb session

Properties - - the properties object that contains the Knowledgebase, the goal, and supporting attribute values.

Returns:

ObjID - the unique idenifier of the thread actually doing the work.

Throws:

java.rmi.RemoteException -

register

public boolean register(java.rmi.server.ObjID i,
                        InfoSapientClient c)
                 throws java.rmi.RemoteException

Register this client with the service.

Parameters:

java.rmi.server.ObjID - - the identifier of the interested client.

InfoSapientClient - - the interested client

Returns:

boolean - true if successfully registered.

Throws:

java.rmi.RemoteException -

remove

public boolean remove(InfoSapientClient c)
               throws java.rmi.RemoteException

Remove this client from the registry.

Parameters:

InfoSapientClient - - the client to be removed.

Returns:

boolean - true if successfully removed.

Throws:

java.rmi.RemoteException -

send

public boolean send(java.rmi.server.ObjID to,
                    java.rmi.server.ObjID from,
                    java.lang.String mtag,
                    java.lang.Object data)
             throws java.io.IOException,
                    java.rmi.RemoteException

Send a message from a client, to another client.

Parameters:

java.rmi.server.ObjID - to - the recipient client

java.rmi.server.ObjID - from - the sending client

String - - mtag - the arbitrary message tag.

Object - - data - the message object. (Implementations decide what that object is.)

Returns:

boolean - true if successful.

Throws:

java.io.IOException -

java.rmi.RemoteException -