com.cosylab.acs.maci.plug

Class ClientProxy

java.lang.Object

com.cosylab.acs.maci.plug.CORBAReferenceSerializator

com.cosylab.acs.maci.plug.ClientProxy

All Implemented Interfaces:

Client, java.io.Serializable

Direct Known Subclasses:

AdministratorProxy, ContainerProxy

public class ClientProxy
extends CORBAReferenceSerializator
implements Client, java.io.Serializable

CORBA Client Proxy.

Author:

Matej Sekoranja (matej.sekoranja@cosylab.com)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected si.ijs.maci.Client	client CORBA reference.
protected java.lang.String	ior Cached serialized reference.

Constructor Summary

Constructors

Constructor and Description
ClientProxy(si.ijs.maci.Client client) Constructor for ClientProxy.

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.
boolean	equals(org.omg.CORBA.Object obj)
si.ijs.maci.Client	getClient() Returns the client.
java.lang.String	getRemoteLocation() Get CORBA host/port string.
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() We explicitly release the client reference, so that the ClientGIOPConnection can be closed, where otherwise it will occupy one of the connector threads until it gets garbage collected, possibly leading to the manager lock up described in http://jira.alma.cl/browse/COMP-979
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.
static ClientType	toClientType(si.ijs.maci.ClientType type) Convert CORBA ClienType to manager type.
static ImplLang	toImplLang(si.ijs.maci.ImplLangType type) Convert CORBA ImplLang to manager type.
java.lang.String	toString() Returns a single-line rendition of this instance into text.
si.ijs.maci.Client	wrapForRoundtripTimeout(si.ijs.maci.Client corbaRef, double timeoutSeconds) Impl note: The corba spec (v 2.4, 4.3.8.1) describes the difference between SetOverrideType.SET_OVERRIDE and SetOverrideType.ADD_OVERRIDE.

Methods inherited from class com.cosylab.acs.maci.plug.CORBAReferenceSerializator

deserialize, getOrb, serialize, setOrb

Methods inherited from class java.lang.Object

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

Field Detail

client

protected si.ijs.maci.Client client

CORBA reference.

ior

protected java.lang.String ior

Cached serialized reference.

Constructor Detail

ClientProxy

public ClientProxy(si.ijs.maci.Client client)

Constructor for ClientProxy.

Parameters:

client - CORBA reference, non-null.

Method Detail

toClientType

public static ClientType toClientType(si.ijs.maci.ClientType type)

Convert CORBA ClienType to manager type.

Parameters:

type -

Returns:

toImplLang

public static ImplLang toImplLang(si.ijs.maci.ImplLangType type)

Convert CORBA ImplLang to manager type.

Parameters:

type -

Returns:

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:

Client.message(MessageType, 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()

wrapForRoundtripTimeout

public si.ijs.maci.Client wrapForRoundtripTimeout(si.ijs.maci.Client corbaRef,
                                                  double timeoutSeconds)
                                           throws AcsJCORBAProblemEx

Impl note: The corba spec (v 2.4, 4.3.8.1) describes the difference between SetOverrideType.SET_OVERRIDE and SetOverrideType.ADD_OVERRIDE. It is not clear to me (HSO) which one should be used, or if there is no practical difference.

Parameters:

corbaRef -

timeoutSeconds -

Returns:

Throws:

AcsJCORBAProblemEx

getClient

public si.ijs.maci.Client getClient()

Returns the client.

Returns:

si.ijs.maci.Client

getRemoteLocation

public java.lang.String getRemoteLocation()
                                   throws RemoteException

Get CORBA host/port string.

Specified by:

getRemoteLocation in interface Client

Throws:

RemoteException

See Also:

Client.getRemoteLocation()

release

public void release()

We explicitly release the client reference, so that the ClientGIOPConnection can be closed, where otherwise it will occupy one of the connector threads until it gets garbage collected, possibly leading to the manager lock up described in http://jira.alma.cl/browse/COMP-979

Specified by:

release in interface Client

See Also:

Client.release()

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

equals

public boolean equals(org.omg.CORBA.Object obj)

See Also:

Object.equals(Object)