alma.acs.component.client

Class AdvancedComponentClient

java.lang.Object

alma.acs.component.client.ComponentClient

alma.acs.component.client.AdvancedComponentClient

Direct Known Subclasses:

AlarmDumperBase, ComponentClientSingleton

public class AdvancedComponentClient
extends ComponentClient

Special version of ComponentClient, which gives more power to specialized applications such as the OMC Gui ("Exec"). Using some of these methods can be dangerous to the stability of the entire system.

If you find that your application needs to use AdvancedComponentClient instead of ComponentClient, better check with the ACS team if there really is no other way.

Author:

hsommer

Field Summary

Fields inherited from class alma.acs.component.client.ComponentClient

m_logger, m_shutdownHook

Constructor Summary

Constructors

Constructor and Description
AdvancedComponentClient(java.util.logging.Logger logger, java.lang.String managerLoc, java.lang.String clientName)
AdvancedComponentClient(java.util.logging.Logger logger, java.lang.String managerLoc, java.lang.String clientName, AcsCorba externalAcsCorba) This ctor's implementation comes already from the base class for practical reasons, but there it is not public.

Method Summary

Modifier and Type	Method and Description
ContainerServices	createContainerServices(java.lang.String clientName, java.util.logging.Logger csLogger) Factory method for additional container service instances.
void	destroyContainerServices(ContainerServices cs) "un-factory" method which inverts createContainerServices(String, Logger).
AcsCorba	getAcsCorba() Gives direct access to the CORBA ORB, POAs etc, encapsulated by the AcsCorba object.
AcsManagerProxy	getAcsManagerProxy() Gives direct access to the ACS manager, encapsulated by the AcsManagerProxy object.

Methods inherited from class alma.acs.component.client.ComponentClient

getContainerServices, initAlarmSystem, initRemoteLogging, registerShutdownHook, tearDown, tearDownAlarmSystem

Methods inherited from class java.lang.Object

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

Constructor Detail

AdvancedComponentClient

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

Throws:

java.lang.Exception

AdvancedComponentClient

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

This ctor's implementation comes already from the base class for practical reasons, but there it is not public. Only here it becomes available to client applications.

Throws:

java.lang.Exception

Method Detail

createContainerServices

public ContainerServices createContainerServices(java.lang.String clientName,
                                                 java.util.logging.Logger csLogger)
                                          throws AcsJContainerServicesEx

Factory method for additional container service instances. This method should only be used by specialized clients such as the OMC GUI which needs independent ContainerServices instances for the plug-ins it runs.

Make sure to call destroyContainerServices(ContainerServices) when done with the new CS.

Parameters:

clientName - name for ContainerServicesBase.getName()

csLogger - logger to be used internally by the new ContainerServices instance (which is different from the Logger returned in ContainerServicesBase.getLogger()). Since ACS 8.0 it is recommended to supply an AcsLogger instead of a plain JDK Logger because a plain Logger will have to be wrapped inside this method.

Throws:

AcsJContainerServicesEx

destroyContainerServices

public void destroyContainerServices(ContainerServices cs)
                              throws AcsJContainerServicesEx

"un-factory" method which inverts createContainerServices(String, Logger).

Parameters:

cs - ContainerServices instance created by createContainerServices(String, Logger).

Throws:

AcsJContainerServicesEx

getAcsCorba

public AcsCorba getAcsCorba()

Gives direct access to the CORBA ORB, POAs etc, encapsulated by the AcsCorba object. Caution: interfering with the ComponentClient's usage of CORBA can have nasty side effects!

getAcsManagerProxy

public AcsManagerProxy getAcsManagerProxy()

Gives direct access to the ACS manager, encapsulated by the AcsManagerProxy object. Caution: interfering with ACS's usage of the manager can have nasty side effects in the entire system!