Acspy.Clients.BaseClient
index
/diska/alma_tmp/ACS/LGPL/CommonSoftware/acspy/src/Acspy/Clients/BaseClient.py

BaseClient - An implementation of the MACI simple client interface
 
This module includes a bare-bones implementation of the Client IDL interface
designed to be used in all Python servant implementations derived from Client.
BaseClient is more of a helper class than anything else.

 
Modules
       
maci

 
Classes
       
maci__POA.Client(omniORB.PortableServer.Servant)
BaseClient

 
class BaseClient(maci__POA.Client)
    BaseClient class is an implementation of the MACI Client IDL interface in
Python.
 
 
Method resolution order:
BaseClient
maci__POA.Client
omniORB.PortableServer.Servant

Methods defined here:
__init__(self, name='Python Client')
Initialize the client.
 
Parameters:
- name is what manager will refer to this client instance as
 
Returns: Nothing
 
Raises: CORBAProblemExImpl
authenticate(self, execution_id, question)
Authentication method. Method authenticate is the challenge issued to
the client after it tries to login. The login will be successful if the
clients authenticate() produces the expected result. Only in this case
will the Managers login method return a valid handle, which the client
will later use as the id parameter with all calls to the Manager.
 
Parameters: question this string does not currently matter
 
Return Answer - first character of the answer identifies the type of
the client, and can be one of:
- C = a regular client (implements just the Client interface).
- A = a container (implements the Container interface).
- AR = a container with recovery capability (implements the Container interface).
- S = Supervisor (implements the Administrator interface).
 
Raises: Nothing
 
string authenticate (in string question);
components_available(self, components)
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:
- components is a sequence of ComponentInfo structures
 
Returns: None
 
Raises: Nothing
 
oneway void components_available(in ComponentInfoSeq components)
components_unavailable(self, component_names)
Notify client that some of the Components currently in use by client
have become unavailable.
 
Parameters:
- component_names names of various unavailable components
 
Returns: None
 
Raises: Nothing
 
oneway void Compoents_unavailable (in stringSeq component_names)
disconnect(self)
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.
 
Also, the client developer is required to disconnect all connected clients
before exiting the Python interpreter.
 
Parameters: None
 
Returns: None
 
Raises: Nothing
 
oneway void disconnect ();
getCode(self)
Returns the code to be used when manager tries to authenticate this
object
 
Parameters: None
 
Returns: the code to be returned to manager.
 
Raises: Nothing
getMyCorbaRef(self)
Helper method which returns this Python objects underlying CORBA servant
reference.
 
This implementation implicityly activates the client using the default
POA if it has not been activated before.
 
Parameters: None
 
Returns: a CORBA reference to this object
 
Raises: CORBAProblemExImpl
message(self, message_type, message)
The Manager and administrators use this method for sending textual messages
to the client.
 
This implementation first attempts to use the ACS logging mechanism to
display the message and if that fails for any reason, it is only sent
to standard out.
 
Parameters:
- message_type is an integer defined as a constant in the Client interface
- message is a string
 
Returns: Nothing
 
Raises: Nothing
 
oneway void message (in short message_type, in string message)
ping(self)
Manager pings its clients to verify they still exist.
 
Parameters: None
 
Returns: CORBA.TRUE (i.e., 1)
 
Raises: Nothing
 
boolean ping ();

 
Data
        TRUE = 1
__revision__ = '$Id: BaseClient.py,v 1.14 2007/12/03 17:53:02 agrimstrup Exp $'