alma::acs::nc::AbstractNotificationChannel Class Reference

Inheritance diagram for alma::acs::nc::AbstractNotificationChannel:

[legend]Collaboration diagram for alma::acs::nc::AbstractNotificationChannel:

[legend]List of all members.


Public Member Functions
abstract Publisher	getPublisher ()
abstract void	deactivate () throws AcsJException
String	getChannelName ()
Static Public Member Functions
AbstractNotificationChannel	createNotificationChannel (int type, String channelName, ContainerServicesBase cs) throws AcsJException
Receiver	getReceiver (int type, String channelName, ContainerServicesBase cs)
Static Public Attributes
final int	LOCAL = 0
final int	CORBA = 1
Protected Member Functions
	AbstractNotificationChannel (String inChannelName, ContainerServicesBase cs)
Protected Attributes
final String	channelName
Static Package Functions
String	checkReceiver (String eventTypeName, Object receiver)

Detailed Description

The AbstractNotificationChannel class forms the base class from which Local and CORBA Notification Channel classes are extended.

Version:: 1.00 Apr 17, 2003

Author:: Allen Farris

Deprecated:: since ACS 7.0.2, see COMP-1786. Will be merged into CorbaNotificationChannel which should be created directly without using this class.

Constructor & Destructor Documentation

alma::acs::nc::AbstractNotificationChannel::AbstractNotificationChannel ( String inChannelName,

ContainerServicesBase cs

) [inline, protected]

Create an AbstractNotification Channel.
Parameters:

inChannelName The name of this channel.

cs container services

Member Function Documentation

String alma::acs::nc::AbstractNotificationChannel::checkReceiver ( String eventTypeName,

Object receiver

) [inline, static, package]

Return an error message if the receiver object does not contain a method of the type "receive(EventType)"; otherwise return null.
Parameters:

eventTypeName The name of the event type that this receiver wishes to receive.

receiver An object that receives and processes this event. It must have a public method of the form "receive(EventType)", where the EventType parameter in the method signature is the name of an IDL structure that defines the event.

Returns:
Error message string if there's a problem.

AbstractNotificationChannel alma::acs::nc::AbstractNotificationChannel::createNotificationChannel ( int type,

String channelName,

ContainerServicesBase cs

) throws AcsJException [inline, static]

Create a Notification Channel.
Parameters:

type must be CORBA.

channelName The name of this channel.

cs container services

Returns:
notification channel

Exceptions:

AcsJException

Deprecated:
use CorbaNotificationChannel directly

abstract void alma::acs::nc::AbstractNotificationChannel::deactivate ( ) throws AcsJException [pure virtual]

Deactivate this notification channel.
Implemented in alma::acs::nc::CorbaNotificationChannel.

String alma::acs::nc::AbstractNotificationChannel::getChannelName ( ) [inline]

Get the channelName.
Returns:
String

abstract Publisher alma::acs::nc::AbstractNotificationChannel::getPublisher ( ) [pure virtual]

Get the Publisher interface to a currently created channel.
Returns:
A Publisher interface to the specified channel.

Implements alma::acs::nc::NotificationChannel.

Implemented in alma::acs::nc::CorbaNotificationChannel.

Receiver alma::acs::nc::AbstractNotificationChannel::getReceiver ( int type,

String channelName,

ContainerServicesBase cs

) [inline, static]

Get the Receiver interface to a currently created channel.
Parameters:

type Either LOCAL or CORBA.

channelName The name of the requested channel.

cs

Returns:
The receiver interface.

Deprecated:
will be removed at the latest with ACS 8.0