alma.COUNTER.CounterConsumerImpl

Class CounterConsumerImpl

java.lang.Object

alma.COUNTER.CounterConsumerImpl.CounterConsumerImpl

All Implemented Interfaces:

ComponentLifecycle, AcsEventSubscriber.Callback<statusBlockEvent>

public class CounterConsumerImpl
extends java.lang.Object
implements ComponentLifecycle, AcsEventSubscriber.Callback<statusBlockEvent>

CounterConsumer is a simple class that connects to the "counter" notification channel, receives events, and then disconnects from the channel.

Author:

eallaert

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_ASSERTION_MESSAGE

Constructor Summary

Constructors

Constructor and Description
CounterConsumerImpl()

Method Summary

Modifier and Type	Method and Description
void	aboutToAbort() Called when due to some error condition the component is about to be forcefully removed some unknown amount of time later (usually not very much...).
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	getBlocks()
java.lang.Class<statusBlockEvent>	getEventType() This method is needed for adding event-specific subscriptions and for the type-safety of this API (based on java generics), and should be implemented like
void	initialize(ContainerServices containerServices) Called to give the component time to initialize itself.
java.lang.String	name()
void	receive(statusBlockEvent someParam, EventDescription eventDescrip) NC receiver method.
int	waitTillDone()

Methods inherited from class java.lang.Object

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

Field Detail

PROP_ASSERTION_MESSAGE

public static final java.lang.String PROP_ASSERTION_MESSAGE

See Also:

Constant Field Values

Constructor Detail

CounterConsumerImpl

public CounterConsumerImpl()

Method Detail

initialize

public void initialize(ContainerServices containerServices)
                throws ComponentLifecycleException

Description copied from interface: ComponentLifecycle

Called to give the component time to initialize itself. For instance, the component could retrieve connections, read in configuration files/parameters, build up in-memory tables, ...

Called before ComponentLifecycle.execute(). In fact, this method might be called quite some time before functional requests can be sent to the component.

Must be implemented as a synchronous (blocking) call.

Specified by:

initialize in interface ComponentLifecycle

Parameters:

containerServices - callback object for services provided by the container

Throws:

ComponentLifecycleException

execute

public void execute()

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

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

Description copied from interface: ComponentLifecycle

Called when due to some error condition the component is about to be forcefully removed some unknown amount of time later (usually not very much...).

The component should make an effort to die as neatly as possible.

Because of its urgency, this method will be called asynchronously to the execution of any other method of the component.

Specified by:

aboutToAbort in interface ComponentLifecycle

receive

public void receive(statusBlockEvent someParam,
                    EventDescription eventDescrip)

NC receiver method.

Specified by:

receive in interface AcsEventSubscriber.Callback<statusBlockEvent>

Parameters:

someParam - The event data, e.g. an IDL-defined struct.

eventDescrip - Event meta data.

getEventType

public java.lang.Class<statusBlockEvent> getEventType()

Description copied from interface: AcsEventSubscriber.Callback

This method is needed for adding event-specific subscriptions and for the type-safety of this API (based on java generics), and should be implemented like

 public Class<MyEvent> getEventType() {
     return MyEvent.class;
 }
 

Specified by:

getEventType in interface AcsEventSubscriber.Callback<statusBlockEvent>

componentState

public ComponentStates componentState()

name

public java.lang.String name()

getBlocks

public void getBlocks()
               throws CouldntPerformActionEx

Throws:

CouldntPerformActionEx

See Also:

alma.COUNTER.CounterConsumerOperations#getBlocks()

waitTillDone

public int waitTillDone()
                 throws CouldntPerformActionEx

Throws:

CouldntPerformActionEx

See Also:

alma.COUNTER.CounterConsumerOperations#waitTillDone()