com.cosylab.acs.maci

Interface Client

All Known Subinterfaces:

Administrator, Container, SynchronousAdministrator

All Known Implementing Classes:

AdministratorProxy, ClientImpl, ClientProxy, ContainerProxy, SynchronousAdministratorProxy

public interface Client

Every client of a Component service that is not itself a Component must implement an interface called Client. The interface allows the client to act as a secure party in the communication with the components, to receive general-purpose string messages from the MACI components and to be notified when any change happens to the components that the client utilizes. Each client logs in to the MACI system before any other requests are made, and in turn it obtains an handle, which it must use in every subsequent request to the MACI.

Author:

Matej Sekoranja (matej.sekoranja@cosylab.com)

Method Summary

Modifier and Type	Method and Description
AuthenticationData	authenticate(long executionId, java.lang.String question) Authentication method.
void	components_available(ComponentInfo[] components) Notify client about the change (availability) of the components currently in use by this client.
void	components_unavailable(java.lang.String[] components) Notify client that some of the components currently in use by client have become unavailable.
void	disconnect() Disconnect notification.
java.lang.String	getRemoteLocation() Get location string (host@port).
void	message(MessageType type, java.lang.String message) The Manager and administrators use this method for sending textual messages to the client.
java.lang.String	name() Client name.
boolean	ping() Manager pings its clients (both GUI clients, as well as Containers) repeatedly to verify that they still exist.
void	release() Release remote resources of this object.
void	taggedmessage(MessageType type, short id, java.lang.String message) The Manager and administrators use this method for sending tagged textual messages to the client.

Method Detail

authenticate

AuthenticationData authenticate(long executionId,
                                java.lang.String question)
                         throws RemoteException

Authentication method. Method authenticate is the challenge issued to the client after it tries to login. The login will be successful if the client's authenticate() produces the expected result. Only in this case will the Manager's login method return a valid handle, which the client will later use as the id parameter with all calls to the Manager.

Parameters:

question - The question posed by the Manager.

Returns:

authentication structure (including answer to the question).

Throws:

RemoteException

components_available

void components_available(ComponentInfo[] components)
                   throws RemoteException

Notify client about the change (availability) of the components currently in use by this client. For administrative clients, notification is issued for the change of availability of any component in the domain.

Parameters:

cobs - A sequence of ComponentInfo structures identifying the affected components. Regular clients receive the name, the type, the handle and the reference of the newly activated component. Administrative clients also receive the handle of the container where the component was activated.

Throws:

RemoteException

components_unavailable

void components_unavailable(java.lang.String[] components)
                     throws RemoteException

Notify client that some of the components currently in use by client have become unavailable.

Parameters:

cobs - CURLs of the unavailable components.

Throws:

RemoteException

disconnect

void disconnect()
         throws RemoteException

Disconnect notification. The disconnect method is called by the Manager to notify the client that it will be unavailable and that the client should log off.

Throws:

RemoteException

message

void message(MessageType type,
             java.lang.String message)
      throws RemoteException

The Manager and administrators use this method for sending textual messages to the client.

Parameters:

type - Type of the message, instance of MessageType.

message - Contents of the message. The contents are human readable.

Throws:

RemoteException

taggedmessage

void taggedmessage(MessageType type,
                   short id,
                   java.lang.String message)
            throws RemoteException

The Manager and administrators use this method for sending tagged textual messages to the client.

Parameters:

type - Type of the message, instance of MessageType.

id - Tag of the message, integer

message - Contents of the message. The contents are human readable.

Throws:

RemoteException

name

java.lang.String name()
               throws RemoteException

Client name.

Returns:

name

Throws:

RemoteException

ping

boolean ping()
      throws RemoteException

Manager pings its clients (both GUI clients, as well as Containers) repeatedly to verify that they still exist. The return value can be either "true", indicating that everything is OK with the client, or "false", indicating that client is malfunctioning. If RemoteTransientException exception is thrown, the Manager should retry the ping several times, and only then shall the client be assumed to be malfunctioning. If another exception is thrown, the client may be immediately assumed to be malfunctioning. Once the client is found to be malfunctioning, the Manager makes an implicit logout of the client.

Throws:

RemoteException

getRemoteLocation

java.lang.String getRemoteLocation()
                            throws RemoteException

Get location string (host@port).

Throws:

RemoteException

release

void release()

Release remote resources of this object.

Throws:

RemoteException