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 |
Convenience base class for components. Provides default implementation of the required interface methods.
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.
References alma.acs.component.ComponentImplBase.cleanUp(), and alma.acs.component.ComponentImplBase.m_logger.
void alma.acs.component.ComponentImplBase.cleanUp | ( | ) | throws AcsJComponentCleanUpEx |
Referenced by alma.acs.component.ComponentImplBase.aboutToAbort().
ComponentStates alma.acs.component.ComponentImplBase.componentState | ( | ) |
References alma.acs.container.ContainerServices.getComponentStateManager(), alma.acs.component.ComponentStateManager.getCurrentState(), and alma.acs.component.ComponentImplBase.m_containerServices.
void alma.acs.component.ComponentImplBase.execute | ( | ) | throws ComponentLifecycleException |
void alma.acs.component.ComponentImplBase.initialize | ( | ContainerServices | containerServices | ) | throws ComponentLifecycleException |
Subclass must call super.initialize(containerServices)
unless it overrides as well all other methods which access the member vars of this class.
References alma.acs.container.ContainerServicesBase.getLogger(), alma.acs.component.ComponentImplBase.m_containerServices, alma.acs.component.ComponentImplBase.m_instanceName, and alma.acs.component.ComponentImplBase.m_logger.
String alma.acs.component.ComponentImplBase.name | ( | ) |
References alma.acs.component.ComponentImplBase.m_instanceName.
Referenced by alma.ACS.impl.PropertyImpl.characteristic_component_name(), alma.acs.monitoring.controller.ControllerImpl.deregisterCollector(), alma.ACS.impl.CharacteristicComponentImpl.get_characteristic_by_name(), alma.ACS.impl.PropertyImpl.getPropertyDescriptor(), alma.ACS.MasterComponentImpl.MasterComponentImplBase.initialize(), alma.acs.monitoring.blobber.BlobberImpl.initialize(), alma.ACS.impl.PropertyImpl.PropertyImpl(), alma.alarmsystemdemo.PSImpl.PSImpl.send_alarm(), alma.alarmsystemdemo.MountImpl.MountImpl.send_alarm(), and alma.alarmsystemdemo.AntennaImpl.AntennaImpl.send_alarm().
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().
String alma.acs.component.ComponentImplBase.m_instanceName [protected] |
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().