Public Member Functions | Protected Attributes

alma.acs.component.ComponentImplBase Class Reference

Inheritance diagram for alma.acs.component.ComponentImplBase:
alma.acs.component.ComponentLifecycle alma.acs.component.StatelessComponentImplBase alma.ACS.impl.CharacteristicComponentImpl alma.acs.monitoring.blobber.BlobberImpl alma.acs.monitoring.controller.ControllerImpl alma.ACSCOURSE_MOUNT.Mount1Impl.Mount1Impl alma.acsexmplErrorComponent.ErrorComponentImpl.ErrorComponentImpl alma.alarmsystemdemo.AntennaImpl.AntennaImpl alma.alarmsystemdemo.MFImpl.MFImpl alma.alarmsystemdemo.MountImpl.MountImpl alma.alarmsystemdemo.PSImpl.PSImpl alma.demo.ComponentWithXmlOffshootImpl.ComponentWithXmlOffshootImpl alma.demo.ErrorSystemComp.ErrorSystemImpl alma.demo.EventConsumerImpl.EventConsumerImpl alma.demo.EventConsumerImpl.NCReceiverImpl alma.demo.EventSupplierImpl.EventSupplierImpl alma.demo.LampAccessImpl.LampAccessImpl alma.demo.LampCallbackImpl.LampCallbackImpl alma.demo.XmlComponentImpl.XmlComponentImpl

List of all members.

Public Member Functions

void initialize (ContainerServices containerServices) throws ComponentLifecycleException
void execute () throws ComponentLifecycleException
void cleanUp () throws AcsJComponentCleanUpEx
void aboutToAbort ()
ComponentStates componentState ()
String name ()

Protected Attributes

String m_instanceName
ContainerServices m_containerServices
AcsLogger m_logger

Detailed Description

Convenience base class for components. Provides default implementation of the required interface methods.

Author:
hsommer May 6, 2003 11:50:18 AM

Member Function Documentation

void alma.acs.component.ComponentImplBase.aboutToAbort (  ) 

Calls cleanUp). Override this method if the emergency situation of a container/component abort with unknown remaining lifetime requires a different strategy than the regular clean-up.

See also:
alma.acs.component.ComponentLifecycle.aboutToAbort()

References alma.acs.component.ComponentImplBase.cleanUp(), and alma.acs.component.ComponentImplBase.m_logger.

void alma.acs.component.ComponentImplBase.cleanUp (  )  throws AcsJComponentCleanUpEx
ComponentStates alma.acs.component.ComponentImplBase.componentState (  ) 
void alma.acs.component.ComponentImplBase.execute (  )  throws ComponentLifecycleException
void alma.acs.component.ComponentImplBase.initialize ( ContainerServices  containerServices  )  throws ComponentLifecycleException

Member Data Documentation

API through which the container explicitly provides various services to its components.

Referenced by alma.demo.XmlComponentImpl.XmlComponentImpl.activateOffshoot(), alma.demo.LampCallbackImpl.LampCallbackImpl.cleanUp(), alma.demo.LampAccessImpl.LampAccessImpl.cleanUp(), alma.acs.monitoring.controller.ControllerImpl.cleanUp(), alma.demo.ComponentWithXmlOffshootImpl.ComponentWithXmlOffshootImpl.cleanUp(), alma.acs.component.ComponentImplBase.componentState(), alma.acs.monitoring.blobber.BlobberImpl.createBlobberPlugin(), alma.ACSCOURSE_MOUNT.Mount6Impl.Mount6Impl.createMyXmlConfigData(), alma.demo.XmlComponentImpl.XmlComponentImpl.createObsProposal(), alma.acs.monitoring.blobber.BlobberImpl.createWorker(), alma.demo.XmlComponentImpl.XmlComponentImpl.deactivateOffshoot(), alma.demo.ComponentWithXmlOffshootImpl.ComponentWithXmlOffshootImpl.deactivateOffshoot(), alma.ACS.impl.CharacteristicComponentImpl.execute(), alma.acs.monitoring.blobber.BlobberImpl.execute(), alma.ACS.impl.CharacteristicComponentImpl.get_all_characteristics(), alma.ACS.impl.CharacteristicComponentImpl.get_characteristic_by_name(), alma.acs.monitoring.controller.ControllerImpl.getBlobber(), alma.ACS.impl.CharacteristicComponentImpl.getComponentContainerServices(), alma.demo.LampCallbackImpl.LampCallbackImpl.getLamp(), alma.demo.LampAccessImpl.LampAccessImpl.getLampBrightnessProperty(), alma.demo.XmlComponentImpl.XmlComponentImpl.getOffshoot(), alma.demo.ComponentWithXmlOffshootImpl.ComponentWithXmlOffshootImpl.getOffshoot(), alma.demo.XmlComponentImpl.XmlComponentImpl.initialize(), alma.demo.EventConsumerImpl.NCReceiverImpl.initialize(), alma.ACS.MasterComponentImpl.MasterComponentImplBase.initialize(), alma.demo.EventSupplierImpl.EventSupplierImpl.initialize(), alma.demo.EventConsumerImpl.EventConsumerImpl.initialize(), alma.acs.monitoring.controller.ControllerImpl.initialize(), alma.acs.component.ComponentImplBase.initialize(), alma.ACS.impl.CharacteristicComponentImpl.initialize(), alma.acs.monitoring.blobber.BlobberImpl.initialize(), alma.demo.LampCallbackImpl.LampCallbackImpl.monitorLampBrightness(), alma.acs.monitoring.controller.ControllerImpl.registerKnownCollectors(), alma.demo.XmlComponentImpl.XmlComponentImpl.sayHello(), alma.demo.LampAccessImpl.LampAccessImpl.setLampBrightness(), and alma.demo.LampCallbackImpl.LampCallbackImpl.stopMonitor().

name of the component instance, which is either given statically in the CDB deployment configuration or determined right before the instantiation of a dynamic component. To be used by subclass as a shortcut for m_containerServices.getName().

Referenced by alma.ACS.impl.CharacteristicComponentImpl.descriptor(), alma.acs.component.ComponentImplBase.initialize(), alma.ACS.impl.CharacteristicComponentImpl.initialize(), and alma.acs.component.ComponentImplBase.name().

Logger to be used by subclass for all application code logging.

Referenced by alma.acs.component.ComponentImplBase.aboutToAbort(), alma.acs.monitoring.controller.ControllerImpl.addCollector(), alma.demo.XmlComponentImpl.XmlComponentImpl.addNewSchedBlocks(), alma.ACS.MasterComponentImpl.MasterComponentImplBase.DefaultResourceErrorHandler< T >.badState(), alma.ACS.MasterComponentImpl.MasterComponentImplBase.cleanUp(), alma.demo.LampCallbackImpl.LampCallbackImpl.cleanUp(), alma.demo.LampAccessImpl.LampAccessImpl.cleanUp(), alma.ACS.impl.CharacteristicComponentImpl.cleanUp(), alma.acs.monitoring.blobber.BlobberImpl.cleanUp(), alma.ACSCOURSE_MOUNT.Mount6Impl.Mount6Impl.createMyXmlConfigData(), alma.demo.XmlComponentImpl.XmlComponentImpl.createObsProposal(), alma.acs.monitoring.controller.ControllerImpl.deregisterCollector(), alma.acsexmplErrorComponent.ErrorComponentImpl.ErrorComponentImpl.displayMessage(), alma.ACS.MasterComponentImpl.MasterComponentImplBase.doTransition(), alma.demo.XmlComponentImpl.XmlComponentImpl.exceptionMethod(), alma.acs.monitoring.blobber.BlobberImpl.execute(), alma.demo.LampCallbackImpl.LampCallbackImpl.getLamp(), alma.demo.LampAccessImpl.LampAccessImpl.getLampBrightness(), alma.demo.LampCallbackImpl.LampCallbackImpl.getLampBrightnessObject(), alma.demo.XmlComponentImpl.XmlComponentImpl.initialize(), alma.demo.EventConsumerImpl.NCReceiverImpl.initialize(), alma.ACS.MasterComponentImpl.MasterComponentImplBase.initialize(), alma.demo.LampAccessImpl.LampAccessImpl.initialize(), alma.demo.EventConsumerImpl.EventConsumerImpl.initialize(), alma.acs.monitoring.controller.ControllerImpl.initialize(), alma.acs.component.ComponentImplBase.initialize(), alma.acs.monitoring.blobber.BlobberImpl.initialize(), alma.acs.monitoring.controller.ControllerImpl.isRegistered(), alma.demo.LampCallbackImpl.LampCallbackImpl.monitorLampBrightness(), alma.ACSCOURSE_MOUNT.Mount1Impl.Mount1Impl.objfix(), alma.demo.EventConsumerImpl.NCReceiverImpl.receive(), alma.demo.EventConsumerImpl.EventConsumerImpl.receive(), alma.acs.monitoring.controller.ControllerImpl.registerCollector(), alma.acs.monitoring.controller.ControllerImpl.registerKnownCollectors(), alma.ACS.impl.CharacteristicComponentImpl.registerProperty(), alma.ACS.MasterComponentImpl.MasterComponentImplBase.DefaultResourceErrorHandler< T >.resourceUnreachable(), alma.demo.XmlComponentImpl.XmlComponentImpl.sayHello(), alma.demo.EventSupplierImpl.EventSupplierImpl.sendEvents(), alma.demo.EventSupplierImpl.EventSupplierImpl.sendEventsSpecial(), alma.demo.LampAccessImpl.LampAccessImpl.setLampBrightness(), alma.acsexmplErrorComponent.ErrorComponentImpl.ErrorComponentImpl.sleepingCmd(), alma.ACS.MasterComponentImpl.MasterComponentImplBase.stateChangedNotify(), alma.demo.LampCallbackImpl.LampCallbackImpl.stopMonitor(), alma.ACS.impl.CharacteristicComponentImpl.unregisterProperty(), and alma.ACS.MasterComponentImpl.MasterComponentImplBase.updateStateHierarchy().


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties