infosapient.client
Interface InfoSapientClient

All Known Implementing Classes:

InfoSapientClientImpl

public interface InfoSapientClient

extends java.rmi.Remote

InfoSapientClient is the interface used to connect with a InfoSapient service. Creation date: (04/07/01 4:20:52 PM)

Version:

$Revision: 1.1.1.1 $

Method Summary

boolean	connect(java.util.Properties p) Connect to a BlackMesaService - implementation classes dictate properties needed
java.rmi.server.ObjID	getObjID() Return the java.rmi.server.ObjID used as a unique identifier for this client.
boolean	notifyClient(java.lang.String tag, java.lang.Object data, java.rmi.server.ObjID src) Notification from service that a message has been sent from a BlackMesaClient.
boolean	send(java.lang.String tag, java.lang.Object data, java.rmi.server.ObjID dst) Notify the service that I wish to send a message to the specified client.

Method Detail

connect

public boolean connect(java.util.Properties p)
                throws java.rmi.RemoteException

Connect to a BlackMesaService - implementation classes dictate properties needed

Parameters:

Properties - - the properties object containing - the server name, - port (if used), - BlackMesaService name.

Returns:

boolean success - true if successful

Throws:

java.rmi.RemoteException -

getObjID

public java.rmi.server.ObjID getObjID()
                               throws java.rmi.RemoteException

Return the java.rmi.server.ObjID used as a unique identifier for this client.

Returns:

java.rmi.server.ObjID

Throws:

java.rmi.RemoteException -

notifyClient

public boolean notifyClient(java.lang.String tag,
                            java.lang.Object data,
                            java.rmi.server.ObjID src)
                     throws java.io.IOException,
                            java.rmi.RemoteException

Notification from service that a message has been sent from a BlackMesaClient.

Parameters:

tag - - String representing an arbitrary msg type.

Object - - actual message data. Up to implementing class to decide what to do with it.

src - - ObjID - the ObjID identifier of the sending client.

Returns:

boolean - should be true if message recieved ok.

Throws:

java.io.IOException -

java.rmi.RemoteException -

send

public boolean send(java.lang.String tag,
                    java.lang.Object data,
                    java.rmi.server.ObjID dst)
             throws java.io.IOException,
                    java.rmi.RemoteException

Notify the service that I wish to send a message to the specified client.

Parameters:

tag - - String - the arbitrary message type.

data - - Object - the message

dst - - ObjID - the id of the destination client.

Returns:

boolean - true if successful

Throws:

java.io.IOException -

java.rmi.RemoteException -