alma.acs.nc

Class ArchiveSupplier

java.lang.Object

OSPushSupplierPOA

alma.acs.nc.NCPublisher<java.lang.Object>

alma.acs.nc.ArchiveSupplier

All Implemented Interfaces:

AcsEventPublisher<java.lang.Object>, ReconnectableParticipant

public class ArchiveSupplier
extends NCPublisher<java.lang.Object>

Used to supply (BACI property) events to the archiving notification channel.

Author:

dfugate

Nested Class Summary

Nested classes/interfaces inherited from interface alma.acs.nc.AcsEventPublisher

AcsEventPublisher.EventProcessingHandler<U>

Field Summary

Fields inherited from class alma.acs.nc.NCPublisher

anyAide, channel, channelName, channelNotifyServiceDomainName, count, eventProcessingHandler, eventQueue, eventQueueSync, helper, logger, proxyConsumer, reconnectCallback, services, supplierAdmin

Constructor Summary

Constructors

Constructor and Description
ArchiveSupplier(ContainerServicesBase services) Creates a new instance of ArchiveSupplier

Method Summary

Modifier and Type	Method and Description
void	publishEvent(java.lang.Object value) Takes an object and tries to pack it into a CORBA Any and publish it to the event channel.

Methods inherited from class alma.acs.nc.NCPublisher

disconnect_structured_push_supplier, disconnect, enableEventQueue, getCORBAEvent, getEventBufferSize, getNotificationFactoryName, increaseEventBufferSize, init, publishCORBAEvent, queueUnpublishedEvent, reconnect, setAutoreconnect, setEventProcessingHandler, subscription_change

Methods inherited from class java.lang.Object

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

Constructor Detail

ArchiveSupplier

public ArchiveSupplier(ContainerServicesBase services)
                throws AcsJException

Creates a new instance of ArchiveSupplier

Parameters:

services - This is used to get the name of the component and to access the ACS logging system.

Throws:

AcsJException - There are literally dozens of CORBA exceptions that could be thrown by the ArchiveSupplier class. Instead, these are converted into an ACS Error System exception for the developer's convenience.

Method Detail

publishEvent

public void publishEvent(java.lang.Object value)
                  throws AcsJException

Takes an object and tries to pack it into a CORBA Any and publish it to the event channel.

The parameter obj can be one of the JDK classes Integer, Long, Float, Double, String. It could also be null, or come from an IDL-defined struct (thus implementing IDLEntity); at least the latter should never occur since baci properties don't have complex values.

Specified by:

publishEvent in interface AcsEventPublisher<java.lang.Object>

Overrides:

publishEvent in class NCPublisher<java.lang.Object>

Parameters:

value - Value to be published.

Throws:

AcsJException - There are an enormous amount of possibilities pertaining to why a subclass of AcsJException would be thrown by publishEvent.