Public Member Functions | Protected Member Functions

alma.acs.nc.ArchiveConsumer Class Reference

Inheritance diagram for alma.acs.nc.ArchiveConsumer:
alma.acs.nc.Consumer alma.acs.nc.ReconnectableSubscriber

List of all members.

Public Member Functions

 ArchiveConsumer (ContainerServicesBase services, Object receiver) throws AcsJException
void push_structured_event (StructuredEvent structuredEvent)

Protected Member Functions

String getChannelKind ()
String getNotificationFactoryName ()
void configSubscriptions ()

Detailed Description

ArchiveConsumer is a a Consumer-derived class designed solely for the purpose of processing notification channel structured events sent automatically by BACI properties under certain conditions. Basically all one has to do to use this class is create an ArchiveConsumer object providing an object with implements "receive(Long timeStamp, String device, String parameter, Object value)" and then invoke the consumerReady() method. Since archive events do not contain complex IDL structs, filtering using the extended trader constraint language should work as well.

HSO 2009: Note that the base class Consumer is getting replaced with NCSubscriber, and also that in Alma this ArchiveConsumer is being replaced with the new TMCDB monitoring code.

Author:
dfugate

Constructor & Destructor Documentation

alma.acs.nc.ArchiveConsumer.ArchiveConsumer ( ContainerServicesBase  services,
Object  receiver 
) throws AcsJException

Creates a new instance of ArchiveConsumer

Parameters:
services This is used to access ACS logging system.
receiver An object which implements a method called "receive". The "receive" method must accept four parameters which are: timeStamp(long), device(string), parameter(string), and value(Object).
Exceptions:
AcsJException Thrown on any really bad error conditions encountered.

References alma.acs.nc.Consumer.m_logger, and alma.acs.nc.Consumer.RECEIVE_METHOD_NAME.


Member Function Documentation

void alma.acs.nc.ArchiveConsumer.configSubscriptions (  )  [protected]

Overridden so that super constructor subscribes to all events.

Exceptions:
AcsJException 

Reimplemented from alma.acs.nc.Consumer.

References alma.acs.nc.Consumer.addSubscription(), and alma.acs.nc.Consumer.m_logger.

String alma.acs.nc.ArchiveConsumer.getChannelKind (  )  [protected]

Overridden

Returns:
string

Reimplemented from alma.acs.nc.Consumer.

String alma.acs.nc.ArchiveConsumer.getNotificationFactoryName (  )  [protected]

Overridden.

Returns:
string

Reimplemented from alma.acs.nc.Consumer.

void alma.acs.nc.ArchiveConsumer.push_structured_event ( StructuredEvent  structuredEvent  ) 

Overridden.

: add reference to documentation about the expected event data, i.e. timeStamp, device, parameter, value.

Parameters:
structuredEvent CORBA NC StructuredEvent

Reimplemented from alma.acs.nc.Consumer.

References alma.acs.nc.AnyAide.corbaAnyToObject(), alma.acs.nc.Consumer.m_anyAide, alma.acs.nc.Consumer.m_channelName, and alma.acs.nc.Consumer.m_logger.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties