alma.acs.component

Class ComponentImplBase

java.lang.Object

alma.acs.component.ComponentImplBase

All Implemented Interfaces:

ComponentLifecycle

Direct Known Subclasses:

BlobberImpl, CharacteristicComponentImpl, ComponentWithXmlOffshootImpl, ControllerImpl, CorbaNotifyBaseImpl, ErrorComponentImpl, ErrorSystemImpl, EventConsumerImpl, EventSupplierImpl, LampAccessImpl, LampCallbackImpl, MFImpl, Mount1Impl, NCReceiverImpl, StatelessComponentImplBase, XmlComponentImpl, XmlFileStoreAlarmImpl, XmlFileStoreLoggerImpl

public class ComponentImplBase
extends java.lang.Object
implements ComponentLifecycle

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

Author:

hsommer May 6, 2003 11:50:18 AM

Field Summary

Fields

Modifier and Type	Field and Description
protected ContainerServices	m_containerServices API through which the container explicitly provides various services to its components.
protected java.lang.String	m_instanceName 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.
protected AcsLogger	m_logger Logger to be used by subclass for all application code logging.

Constructor Summary

Constructors

Constructor and Description
ComponentImplBase()

Method Summary

Modifier and Type	Method and Description
void	aboutToAbort() Calls cleanUp).
void	cleanUp() Called after the last functional call to the component has finished.
ComponentStates	componentState()
void	execute() Called after ComponentLifecycle.initialize(ContainerServices) to tell the component that it has to be ready to accept incoming functional calls any time.
void	initialize(ContainerServices containerServices) Subclass must call super.initialize(containerServices) unless it overrides as well all other methods which access the member vars of this class.
java.lang.String	name()

Methods inherited from class java.lang.Object

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

Field Detail

m_instanceName

protected java.lang.String m_instanceName

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

m_containerServices

protected ContainerServices m_containerServices

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

m_logger

protected AcsLogger m_logger

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

Constructor Detail

ComponentImplBase

public ComponentImplBase()

Method Detail

initialize

public void 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.

Specified by:

initialize in interface ComponentLifecycle

Parameters:

containerServices - callback object for services provided by the container

Throws:

ComponentLifecycleException

See Also:

ComponentLifecycle.initialize(ContainerServices)

execute

public void execute()
             throws ComponentLifecycleException

Description copied from interface: ComponentLifecycle

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

Specified by:

execute in interface ComponentLifecycle

Throws:

ComponentLifecycleException

cleanUp

public void cleanUp()
             throws AcsJComponentCleanUpEx

Description copied from interface: ComponentLifecycle

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

Specified by:

cleanUp in interface ComponentLifecycle

Throws:

AcsJComponentCleanUpEx

aboutToAbort

public void 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.

Specified by:

aboutToAbort in interface ComponentLifecycle

See Also:

ComponentLifecycle.aboutToAbort()

componentState

public ComponentStates componentState()

See Also:

alma.ACS.ACSComponentOperations#componentState()

name

public java.lang.String name()

See Also:

alma.ACS.ACSComponentOperations#name()