alma.acs.component.client

Class ComponentClient

java.lang.Object

alma.acs.component.client.ComponentClient

Direct Known Subclasses:

AdvancedComponentClient, Client, ComponentRefTracker, HelloDemoClient, LampCallbackClient, LampComponentClient1, MasterComponentEventLogger, PubSubExecutor, TestLogLevelsCompClient, TimeoutHandlerClient

public class ComponentClient
extends java.lang.Object

Class that facilitates writing client application that access ACS components. Takes care of the communication with the ACS manager. Provides the ContainerServices. Can be used either as a base class or as a delegate object.

Note that this class is only meant to be used within a stand-alone application that needs to communicate with ACS-based components. It is definitely not meant to be used by a component running inside an ACS container.

Author:

hsommer Nov 21, 2002 5:53:05 PM

Field Summary

Fields

Modifier and Type	Field and Description
protected AcsLogger	m_logger
protected ShutdownHookBase	m_shutdownHook

Constructor Summary

Constructors

Modifier	Constructor and Description
	ComponentClient(java.util.logging.Logger logger, java.lang.String managerLoc, java.lang.String clientName) Normal constructor.
protected	ComponentClient(java.util.logging.Logger logger, java.lang.String managerLoc, java.lang.String clientName, AcsCorba externalAcsCorba) Special c'tor that provides an already initialized instance of AcsCorba which encapsulates the ORB.

Method Summary

Modifier and Type	Method and Description
ContainerServices	getContainerServices() Gives access to the ContainerServices interface.
protected void	initAlarmSystem() Initializes the alarm system, using ACSAlarmSystemInterfaceFactory.init(alma.acs.container.ContainerServicesBase).
void	initRemoteLogging() Sets up the client logger(s) to send log records to the remote log service.
protected void	registerShutdownHook() Default shutdown hook is used to complain if the application forgot to call tearDown().
void	tearDown() Must be called by the application that uses this class, when it is done using ACS components.
protected void	tearDownAlarmSystem() Stops and cleans up the alarm system, using ACSAlarmSystemInterfaceFactory.done().

Methods inherited from class java.lang.Object

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

Field Detail

m_logger

protected final AcsLogger m_logger

m_shutdownHook

protected ShutdownHookBase m_shutdownHook

Constructor Detail

ComponentClient

public ComponentClient(java.util.logging.Logger logger,
                       java.lang.String managerLoc,
                       java.lang.String clientName)
                throws java.lang.Exception

Normal constructor. The component client will take care of creating ORB and POAs, and of setting up remote logging.

Parameters:

logger -

managerLoc -

clientName -

Throws:

java.lang.Exception

See Also:

initRemoteLogging()

ComponentClient

protected ComponentClient(java.util.logging.Logger logger,
                          java.lang.String managerLoc,
                          java.lang.String clientName,
                          AcsCorba externalAcsCorba)
                   throws java.lang.Exception

Special c'tor that provides an already initialized instance of AcsCorba which encapsulates the ORB. This may be useful for an application such as the ALMA executive, which works with different ORBs, tries out available ports, and so on.

With this constructor, also initialization and termination of remote ACS logging is left to the caller.

Parameters:

logger - the logger to be used. If null, one will be created. Since ACS 8.0 it is recommended to supply null or an AcsLogger instead of a plain JDK Logger because a plain Logger will have to be wrapped inside this method.

managerLoc - the corbaloc for the ACS manager, e.g. "corbaloc::myhost:xxxx/Manager"

clientName - name to be used toward the ACS Manager

externalAcsCorba - encapsulates initialized ORB and POAs.

Throws:

java.lang.Exception - at the slightest provocation...

See Also:

initRemoteLogging()

Method Detail

registerShutdownHook

protected void registerShutdownHook()

Default shutdown hook is used to complain if the application forgot to call tearDown(). Can overwrite this, e.g. for cmd line tools.

initAlarmSystem

protected void initAlarmSystem()
                        throws java.lang.Exception

Initializes the alarm system, using ACSAlarmSystemInterfaceFactory.init(alma.acs.container.ContainerServicesBase). Override this method only in special cases such as the eventGUI, when a client does not need to access the alarm system and has special classpath problems with the CERN alarm system jar files.

Throws:

java.lang.Exception

See Also:

tearDownAlarmSystem()

tearDownAlarmSystem

protected void tearDownAlarmSystem()

Stops and cleans up the alarm system, using ACSAlarmSystemInterfaceFactory.done(). Override this method only in special cases such as the eventGUI, when a client does not need to access the alarm system and has special classpath problems with the CERN alarm system jar files.

See Also:

initAlarmSystem()

initRemoteLogging

public void initRemoteLogging()

Sets up the client logger(s) to send log records to the remote log service. This method starts a separate thread and returns immediately.

Makes repeated attempts to connect to the remote logger. If they fail unexpectedly, remote logging will be disabled.

If the ComponentClient has been constructed without an external AcsCorba object (the normal case), then this method is called automatically.
Otherwise (with an external AcsCorba object provided) it is assumed that also remote logging is controlled from outside of this class. If nonetheless you want to initialize remote logging, you may explicitly call this method for convenience.

Override this method to prevent remote logging (useful only if AcsCorba is is not provided externally).

getContainerServices

public ContainerServices getContainerServices()

Gives access to the ContainerServices interface. This class plays the part of the role of the Java container that has to do with providing explicit services to the component, or test case respectively.

Returns:

ContainerServices

tearDown

public void tearDown()
              throws java.lang.Exception

Must be called by the application that uses this class, when it is done using ACS components. At the latest it should be called when the application itself terminates.

Releases all previously obtained components (using manager), and logs out from the manager. It also stops remote logging and terminates the CORBA ORB unless an AcsCorba instance was provided in the c'tor; otherwise the application remains responsible to clean up logging and the ORB.

Throws:

java.lang.Exception