alma::acs::component::ComponentImplBase Class Reference

Inheritance diagram for alma::acs::component::ComponentImplBase:
Inheritance graph
[legend]
Collaboration diagram for alma::acs::component::ComponentImplBase:
Collaboration graph
[legend]

List of all members.

Public Member Functions

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

Protected Attributes

String m_instanceName
ContainerServices m_containerServices
AcsLogger m_logger

Private Member Functions

void checkProperInit ()

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 (  )  [inline]

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()

Implements alma::acs::component::ComponentLifecycle.

Reimplemented in alma::test::corbareftest::component::HelloWorldImpl.

References cleanUp(), and m_logger.

void alma::acs::component::ComponentImplBase::checkProperInit (  )  [inline, private]

Asserts that m_containerServices != null.

Exceptions:
IllegalStateException with error message if initialize was not called correctly.

References m_containerServices.

Referenced by componentState(), execute(), initialize(), and name().

void alma::acs::component::ComponentImplBase::cleanUp (  )  [inline]

Called after the last functional call to the component has finished. The component should then orderly release resources etc.

Implements alma::acs::component::ComponentLifecycle.

Reimplemented in alma::test::corbareftest::component::HelloWorldImpl, alma::ACS::impl::CharacteristicComponentImpl, alma::jconttest::DummyComponentImpl::DummyComponentImpl, alma::demo::EventConsumerImpl::EventConsumerImpl, alma::demo::EventSupplierImpl::EventSupplierImpl, alma::demo::LampAccessImpl::LampAccessImpl, alma::demo::LampCallbackImpl::LampCallbackImpl, alma::demo::test::AbstractNC::NCPublisherImpl, alma::demo::test::AbstractNC::NCReceiverImpl, alma::demo::test::EventConsumerImpl::EventConsumerImpl, alma::demo::test::EventILConsumerImpl::EventConsumerImpl, alma::demo::test::EventILSupplierImpl::EventSupplierImpl, alma::demo::test::EventSupplierCDBChannel::EventSupplierCDBChannel, alma::demo::test::EventSupplierImpl::EventSupplierImpl, alma::ACS::MasterComponentImpl::MasterComponentImplBase, and alma::nctest::EventSupplierSpr2005067Impl::EventSupplierSpr2005067Impl.

Referenced by aboutToAbort().

ComponentStates alma::acs::component::ComponentImplBase::componentState (  )  [inline]
See also:
alma.ACS.ACSComponentOperations::componentState()

Implements alma::ACS::ACSComponentOperations.

Reimplemented in alma::test::corbareftest::component::HelloWorldImpl, and alma::acs::component::dynwrapper::DynamicProxyFactoryTest::XmlTestComponent.

References checkProperInit(), alma::acs::container::ContainerServices::getComponentStateManager(), alma::acs::component::ComponentStateManager::getCurrentState(), and m_containerServices.

Referenced by test::jbaci::SimpleMasterComponentImpl::CurrentStateHierarchyDataAccess::run().

void alma::acs::component::ComponentImplBase::execute (  )  throws ComponentLifecycleException [inline]

Called after ComponentLifecycle#initialize(ContainerServices) to tell the component that it has to be ready to accept incoming functional calls any time.

Examples:

  • last-minute initializations for which initialize seemed too early
  • component could start actions which aren't triggered by any functional call, e.g. the Scheduler could start to rank SBs in a separate thread.

Must be implemented as a synchronous (blocking) call (can spawn threads though).

Implements alma::acs::component::ComponentLifecycle.

Reimplemented in alma::test::corbareftest::component::HelloWorldImpl, and alma::demo::test::AbstractNC::NCReceiverImpl.

References checkProperInit().

void alma::acs::component::ComponentImplBase::initialize ( ContainerServices  containerServices  )  throws ComponentLifecycleException [inline]

Subclass must call super.initialize(containerServices) unless it overrides as well all other methods which access the member vars of this class.

See also:
alma.acs.component.ComponentLifecycle::initialize(ContainerServices)

Implements alma::acs::component::ComponentLifecycle.

Reimplemented in alma::ACSCOURSE_MOUNT::Mount6Impl::Mount6Impl, alma::test::corbareftest::component::HelloWorldImpl, alma::ACS::impl::CharacteristicComponentImpl, alma::ACS::jbaci::enumProp::test::EnumTestComponentImpl, alma::acsexmplBuilding::BuildingImpl, alma::PS::PowerSupplyImpl, alma::TT::PrimComponentImpl, alma::TT::SeqComponentImpl, test::jbaci::SimpleMasterComponentImpl, alma::demo::EventConsumerImpl::EventConsumerImpl, alma::demo::EventSupplierImpl::EventSupplierImpl, alma::demo::LampAccessImpl::LampAccessImpl, alma::demo::XmlComponentImpl::XmlComponentImpl, alma::demo::test::AbstractNC::NCPublisherImpl, alma::demo::test::AbstractNC::NCReceiverImpl, alma::demo::test::EventConsumerImpl::EventConsumerImpl, alma::demo::test::EventILConsumerImpl::EventConsumerImpl, alma::demo::test::EventILSupplierImpl::EventSupplierImpl, alma::demo::test::EventSupplierCDBChannel::EventSupplierCDBChannel, alma::demo::test::EventSupplierImpl::EventSupplierImpl, alma::ACS::MasterComponentImpl::MasterComponentImplBase, alma::ACS::SpecialTestMasterComponentImpl::SpecialTestMasterComponentImpl, and alma::nctest::EventSupplierSpr2005067Impl::EventSupplierSpr2005067Impl.

References checkProperInit(), alma::acs::container::ContainerServicesBase::getLogger(), m_containerServices, m_instanceName, and m_logger.

String alma::acs::component::ComponentImplBase::name (  )  [inline]
See also:
alma.ACS.ACSComponentOperations::name()

Implements alma::ACS::ACSComponentOperations.

Reimplemented in alma::test::corbareftest::component::HelloWorldImpl, and alma::acs::component::dynwrapper::DynamicProxyFactoryTest::XmlTestComponent.

References checkProperInit(), and m_instanceName.

Referenced by alma::ACS::impl::PropertyImpl::characteristic_component_name(), alma::ACS::impl::CharacteristicComponentImpl::get_characteristic_by_name(), alma::alarmsystemdemo::MFImpl::MFImpl::init(), alma::ACS::MasterComponentImpl::MasterComponentImplBase::initialize(), alma::ACS::impl::PropertyImpl::PropertyImpl(), alma::demo::test::AbstractNC::NCPublisherImpl::publish(), alma::alarmsystemdemo::PSImpl::PSImpl::send_alarm(), alma::alarmsystemdemo::MountImpl::MountImpl::send_alarm(), alma::alarmsystemdemo::AntennaImpl::AntennaImpl::send_alarm(), and alma::jconttest::ContainerServicesTesterImpl::ContainerServicesTesterImpl::testComponentName().

Member Data Documentation

ContainerServices alma::acs::component::ComponentImplBase::m_containerServices [protected]

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

Reimplemented in alma::test::corbareftest::component::HelloWorldImpl.

Referenced by alma::jconttest::DummyComponentWrapperImpl::DummyComponentWrapperImpl::_callDummyComponentWithTime(), checkProperInit(), alma::demo::LampCallbackImpl::LampCallbackImpl::cleanUp(), alma::demo::LampAccessImpl::LampAccessImpl::cleanUp(), componentState(), alma::ACSCOURSE_MOUNT::Mount6Impl::Mount6Impl::createMyXmlConfigData(), alma::demo::XmlComponentImpl::XmlComponentImpl::createObsProposal(), alma::ACS::impl::CharacteristicComponentImpl::execute(), alma::ACS::impl::CharacteristicComponentImpl::get_all_characteristics(), alma::ACS::impl::CharacteristicComponentImpl::get_characteristic_by_name(), alma::alarmsystemdemo::MountImpl::MountImpl::getAntenna(), alma::ACS::impl::CharacteristicComponentImpl::getComponentContainerServices(), alma::demo::LampCallbackImpl::LampCallbackImpl::getLamp(), alma::demo::LampAccessImpl::LampAccessImpl::getLampBrightnessProperty(), alma::alarmsystemdemo::PSImpl::PSImpl::getMount(), alma::demo::XmlComponentImpl::XmlComponentImpl::initialize(), alma::demo::test::AbstractNC::NCReceiverImpl::initialize(), alma::demo::test::AbstractNC::NCPublisherImpl::initialize(), alma::ACS::MasterComponentImpl::MasterComponentImplBase::initialize(), alma::nctest::EventSupplierSpr2005067Impl::EventSupplierSpr2005067Impl::initialize(), alma::demo::test::EventSupplierImpl::EventSupplierImpl::initialize(), alma::demo::EventSupplierImpl::EventSupplierImpl::initialize(), alma::demo::test::EventILConsumerImpl::EventConsumerImpl::initialize(), alma::demo::test::EventConsumerImpl::EventConsumerImpl::initialize(), alma::demo::EventConsumerImpl::EventConsumerImpl::initialize(), initialize(), alma::ACS::impl::CharacteristicComponentImpl::initialize(), alma::demo::LampCallbackImpl::LampCallbackImpl::monitorLampBrightness(), alma::demo::XmlComponentImpl::XmlComponentImpl::sayHello(), alma::demo::LampAccessImpl::LampAccessImpl::setLampBrightness(), alma::demo::LampCallbackImpl::LampCallbackImpl::stopMonitor(), alma::jconttest::ContainerServicesTesterImpl::ContainerServicesTesterImpl::testComponentName(), alma::jconttest::ContainerServicesTesterImpl::ContainerServicesTesterImpl::testFindDummyComponentsByType(), alma::jconttest::ContainerServicesTesterImpl::ContainerServicesTesterImpl::testGetCollocatedComponent(), alma::jconttest::ContainerServicesTesterImpl::ContainerServicesTesterImpl::testGetComponentNonSticky(), alma::jconttest::ContainerServicesTesterImpl::ContainerServicesTesterImpl::testGetDynamicDummyComponent(), alma::jconttest::ContainerServicesTesterImpl::ContainerServicesTesterImpl::testGetReferenceWithCustomClientSideTimeout(), alma::jconttest::ContainerServicesTesterImpl::ContainerServicesTesterImpl::testGetThreadFactory(), and alma::jconttest::ContainerServicesTesterImpl::ContainerServicesTesterImpl::testStateManager().

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(), initialize(), alma::ACS::impl::CharacteristicComponentImpl::initialize(), and name().

AcsLogger alma::acs::component::ComponentImplBase::m_logger [protected]

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

Reimplemented in alma::test::corbareftest::component::HelloWorldImpl.

Referenced by alma::jconttest::DummyComponentWrapperImpl::DummyComponentWrapperImpl::_callDummyComponentWithTime(), aboutToAbort(), 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::nctest::EventSupplierSpr2005067Impl::EventSupplierSpr2005067Impl::cleanUp(), alma::ACS::impl::CharacteristicComponentImpl::cleanUp(), alma::ACS::SpecialTestMasterComponentImpl::SpecialTestMasterComponentImpl::componentNeedsAttention(), alma::ACSCOURSE_MOUNT::Mount6Impl::Mount6Impl::createMyXmlConfigData(), alma::demo::XmlComponentImpl::XmlComponentImpl::createObsProposal(), alma::acsexmplErrorComponent::ErrorComponentImpl::ErrorComponentImpl::displayMessage(), alma::ACS::MasterComponentImpl::MasterComponentImplBase::doTransition(), alma::demo::EventSupplierImpl::EventSupplierImpl::EventProcessingCallbackImpl::eventDropped(), alma::demo::EventSupplierImpl::EventSupplierImpl::EventProcessingCallbackImpl::eventSent(), alma::demo::EventSupplierImpl::EventSupplierImpl::EventProcessingCallbackImpl::eventStoredInQueue(), alma::demo::XmlComponentImpl::XmlComponentImpl::exceptionMethod(), alma::ACS::SpecialTestMasterComponentImpl::SpecialTestMasterComponentImpl::getActionHandler(), alma::demo::LampCallbackImpl::LampCallbackImpl::getLamp(), alma::demo::LampAccessImpl::LampAccessImpl::getLampBrightness(), alma::demo::LampCallbackImpl::LampCallbackImpl::getLampBrightnessObject(), alma::demo::XmlComponentImpl::XmlComponentImpl::initialize(), alma::ACS::MasterComponentImpl::MasterComponentImplBase::initialize(), alma::demo::LampAccessImpl::LampAccessImpl::initialize(), alma::nctest::EventSupplierSpr2005067Impl::EventSupplierSpr2005067Impl::initialize(), alma::demo::test::EventSupplierImpl::EventSupplierImpl::initialize(), alma::demo::test::EventILConsumerImpl::EventConsumerImpl::initialize(), alma::demo::test::EventConsumerImpl::EventConsumerImpl::initialize(), alma::demo::EventConsumerImpl::EventConsumerImpl::initialize(), initialize(), alma::ACS::MasterComponentImpl::TestMasterComponentImpl::initSubsysPass1(), alma::ACS::MasterComponentImpl::TestMasterComponentImpl::initSubsysPass2(), alma::demo::LampCallbackImpl::LampCallbackImpl::monitorLampBrightness(), alma::ACSCOURSE_MOUNT::Mount1Impl::Mount1Impl::objfix(), alma::demo::EventConsumerImpl::EventConsumerImpl::receive(), alma::ACS::impl::CharacteristicComponentImpl::registerProperty(), alma::ACS::MasterComponentImpl::TestMasterComponentImpl::reinitSubsystem(), alma::ACS::MasterComponentImpl::MasterComponentImplBase::DefaultResourceErrorHandler< T >::resourceUnreachable(), alma::demo::XmlComponentImpl::XmlComponentImpl::sayHello(), alma::nctest::EventSupplierSpr2005067Impl::EventSupplierSpr2005067Impl::sendEvents(), alma::demo::EventSupplierImpl::EventSupplierImpl::sendEvents(), alma::demo::EventSupplierImpl::EventSupplierImpl::sendEventsSpecial(), alma::demo::LampAccessImpl::LampAccessImpl::setLampBrightness(), alma::ACS::MasterComponentImpl::TestMasterComponentImpl::shutDownSubsysPass1(), alma::ACS::MasterComponentImpl::TestMasterComponentImpl::shutDownSubsysPass2(), alma::ACS::MasterComponentImpl::MasterComponentImplBase::stateChangedNotify(), alma::demo::LampCallbackImpl::LampCallbackImpl::stopMonitor(), alma::jconttest::ContainerServicesTesterImpl::ContainerServicesTesterImpl::testComponentName(), alma::jconttest::ContainerServicesTesterImpl::ContainerServicesTesterImpl::testGetCollocatedComponent(), alma::jconttest::ContainerServicesTesterImpl::ContainerServicesTesterImpl::testGetComponentNonSticky(), alma::jconttest::ContainerServicesTesterImpl::ContainerServicesTesterImpl::testGetDynamicDummyComponent(), alma::jconttest::ContainerServicesTesterImpl::ContainerServicesTesterImpl::testGetReferenceWithCustomClientSideTimeout(), alma::jconttest::ContainerServicesTesterImpl::ContainerServicesTesterImpl::testGetThreadFactory(), alma::ACS::impl::CharacteristicComponentImpl::unregisterProperty(), and alma::ACS::MasterComponentImpl::MasterComponentImplBase::updateStateHierarchy().

The documentation for this class was generated from the following file:
Generated by  doxygen 1.6.2