com.cosylab.acs.maci.plug

Class ClientImpl

java.lang.Object

com.cosylab.acs.maci.plug.ClientImpl

All Implemented Interfaces:

Client

public class ClientImpl
extends java.lang.Object
implements Client

Author:

Matej Sekoranja (matej.sekoranja@cosylab.com)

Constructor Summary

Constructors

Constructor and Description
ClientImpl(java.lang.String name) Implementation of Client.

Method Summary

Modifier and Type	Method and Description
AuthenticationData	authenticate(long executionId, java.lang.String question) Authentication method.
void	components_available(ComponentInfo[] cobs) Notify client about the change (availability) of the components currently in use by this client.
void	components_unavailable(java.lang.String[] cobs) Notify client that some of the components currently in use by client have become unavailable.
void	disconnect() Disconnect notification.
int	getHandle() Returns the handle.
java.lang.String	getName() Returns the name.
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	setHandle(int handle) Sets the handle.
void	setName(java.lang.String name) Sets the name.
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.
java.lang.String	toString() Returns a single-line rendition of this instance into text.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ClientImpl

public ClientImpl(java.lang.String name)

Implementation of Client.

Parameters:

name - name of the client

Method Detail

authenticate

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

Description copied from interface: Client

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.

Specified by:

authenticate in interface Client

question - The question posed by the Manager.

Returns:

authentication structure (including answer to the question).

Throws:

RemoteException

See Also:

Client.authenticate(long, String)

components_available

public void components_available(ComponentInfo[] cobs)
                          throws RemoteException

Description copied from interface: Client

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.

Specified by:

components_available in interface Client

Throws:

RemoteException

See Also:

Client.components_available(ComponentInfo[])

components_unavailable

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

Description copied from interface: Client

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

Specified by:

components_unavailable in interface Client

Throws:

RemoteException

See Also:

Client.components_unavailable(String[])

disconnect

public void disconnect()
                throws RemoteException

Description copied from interface: Client

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.

Specified by:

disconnect in interface Client

Throws:

RemoteException

See Also:

Client.disconnect()

message

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

Description copied from interface: Client

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

Specified by:

message in interface Client

Parameters:

type - Type of the message, instance of MessageType.

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

Throws:

RemoteException

See Also:

Client.message(MessageType, String)

taggedmessage

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

Description copied from interface: Client

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

Specified by:

taggedmessage in interface 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

See Also:

com.cosylab.acs.maci.Client#message(MessageType, int, String)

name

public java.lang.String name()
                      throws RemoteException

Description copied from interface: Client

Client name.

Specified by:

name in interface Client

Returns:

name

Throws:

RemoteException

See Also:

Client.name()

ping

public boolean ping()
             throws RemoteException

Description copied from interface: Client

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.

Specified by:

ping in interface Client

Throws:

RemoteException

See Also:

Client.ping()

getHandle

public int getHandle()

Returns the handle.

Returns:

int

getName

public java.lang.String getName()

Returns the name.

Returns:

String

setHandle

public void setHandle(int handle)

Sets the handle.

Parameters:

handle - The handle to set

setName

public void setName(java.lang.String name)

Sets the name.

Parameters:

name - The name to set

getRemoteLocation

public java.lang.String getRemoteLocation()
                                   throws RemoteException

Description copied from interface: Client

Get location string (host@port).

Specified by:

getRemoteLocation in interface Client

Throws:

RemoteException

release

public void release()

Description copied from interface: Client

Release remote resources of this object.

Specified by:

release in interface Client

toString

public java.lang.String toString()

Returns a single-line rendition of this instance into text.

Overrides:

toString in class java.lang.Object

Returns:

internal state of this instance