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

Inheritance diagram for alma::acs::component::ComponentImplBase:

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

[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.

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

Asserts that m_containerServices != null. Exceptions: IllegalStateException  with error message if initialize was not called correctly.

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.

ComponentStates alma::acs::component::ComponentImplBase::componentState (   )  [inline]

See also: alma.ACS.ACSComponentOperations::componentState()

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.

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.

String alma::acs::component::ComponentImplBase::name (   )  [inline]

See also: alma.ACS.ACSComponentOperations::name()

---

Member Data Documentation

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

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

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

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

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

---

The documentation for this class was generated from the following file:

• ComponentImplBase.java

---