alma.acs.container

Class ComponentStateManagerImpl

java.lang.Object

alma.acs.container.ComponentStateManagerImpl

All Implemented Interfaces:

ComponentStateManager

public class ComponentStateManagerImpl
extends java.lang.Object
implements ComponentStateManager

Manages the state of a component, enforcing state transition rules. An instance of ComponentStateManager is logically part of the container, but the component can access it and request a state change.

Author:

hsommer created Oct 22, 2003 5:03:07 PM

Constructor Summary

Constructors

Constructor and Description
ComponentStateManagerImpl(java.lang.String componentName, java.util.logging.Logger logger)

Method Summary

Modifier and Type	Method and Description
ComponentStates	getCurrentState() Returns the current state of the component
java.lang.String	getName(ComponentStates corbaStateObj) It seemed not worth it to create Java enum classes following the standard patterns, since the component has to return the CORBA state class anyway.
void	setState(ComponentStates newState) Requests to change the state.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentStateManagerImpl

public ComponentStateManagerImpl(java.lang.String componentName,
                                 java.util.logging.Logger logger)

Method Detail

getCurrentState

public ComponentStates getCurrentState()

Returns the current state of the component

Specified by:

getCurrentState in interface ComponentStateManager

Returns:

the component's current state

See Also:

ComponentStateManager.getCurrentState()

getName

public java.lang.String getName(ComponentStates corbaStateObj)

It seemed not worth it to create Java enum classes following the standard patterns, since the component has to return the CORBA state class anyway. Nonetheless, getting the state names for logging etc. might be useful.

Specified by:

getName in interface ComponentStateManager

Parameters:

corbaStateObj - the int-based corba enum class

Returns:

the state name as specified in IDL, e.g. "COMPSTATE_NEW".

See Also:

alma.acs.component.ComponentStateManager#getName(alma.ACS.ComponentStates)

setState

public void setState(ComponentStates newState)
              throws ComponentLifecycleException

Requests to change the state. To be called only by the component (the container will use a separate method in the implementation class to allow for different transition validation rules)

Specified by:

setState in interface ComponentStateManager

Parameters:

newState - the new component state

Throws:

ComponentLifecycleException - if the transition from the current state to the new state is not allowed.

See Also:

alma.acs.component.ComponentStateManager#setState(alma.ACS.ComponentStates)