org.omg.CosTypedNotifyChannelAdmin
Interface TypedEventChannelOperations

All Superinterfaces:

AdminPropertiesAdminOperations, QoSAdminOperations, org.omg.CosTypedEventChannelAdmin.TypedEventChannelOperations

All Known Subinterfaces:

TypedEventChannel, TypedNotifyLog, TypedNotifyLogOperations

public interface TypedEventChannelOperations
extends QoSAdminOperations, AdminPropertiesAdminOperations, org.omg.CosTypedEventChannelAdmin.TypedEventChannelOperations

The TypedEventChannel interface defines the behaviors supported by the Notification Service version of a typed event channel. As previously stated, the Notification Service version of a typed event channel is really a hybrid between the Notification Service event channel defined in the CosNotifyChannelAdmin module, and the typed event channel defined in the OMG Event Service. This is evidenced by the fact that the TypedEventChannel interface defined here supports similar inheritence and defines similar attributes and operations of the former, and directly inherits from the latter.

Inheritance of the TypedEventChannel of the CosTypedEventChannel module essentially implies backward compatibility between the Notification Service style typed event channel, and the OMG Event Service style typed event channel. It means that pure OMG Event Service style typed admin instances, which can create pure OMG Event Service style typed proxy instances, which can support pure OMG Event Service style typed event clients, can be associated with the Notification Service style typed event channel. As usual, none of the pure OMG style objects will support QoS property configuration, associated filter objects, or administration by unique identifiers.

Inheritance of the QoSAdmin and AdminPropertiesAdmin interfaces defined in the CosNotification module implies that instances of the TypedEventChannel interface can have associated QoS property and administrative property settings. Locally, the TypedEventChannel interface defined here supports a readonly attribute which maintains the reference to the factory that created it, and a pair of readonly attributes that maintain references to the default TypedConsumerAdmin and TypedSupplierAdmin instances that exist upon creation of an instance of the TypedEventChannel interface. The TypedEventChannel interface also defines a readonly attribute that maintains the reference of the default filter factory used by the channel to create new filter objects.

Additionally, the TypedEventChannel interface defines operations to create new instances of the TypedConsumerAdmin and the TypedSupplierAdmin interfaces defined in the CosTypedNotifyChannelAdmin module. These instances also have associated unique identifiers. Similarly to the EventChannel interface defined in the CosNotifyChannelAdmin module, the TypedEventChannel interface defines operations that can return the lists of identifiers associated with the TypedConsumerAdmin and TypedSupplierAdmin instances it has created, and operations that given the unique identifier to one of its Admin instance, the object reference associated with it.

Method Summary

TypedConsumerAdmin	default_consumer_admin() The default_consumer_admin attribute is a readonly attribute which maintains a reference to the default TypedConsumerAdmin instance associated with the target TypedEventChannel instance.
FilterFactory	default_filter_factory() The default_filter_factory attribute is a readonly attribute, which maintains an object reference to the default factory to be used by the TypedEventChannel instance with which it?s associated for creating filter objects.
TypedSupplierAdmin	default_supplier_admin() The default_supplier_admin attribute is a readonly attribute, which maintains a reference to the default TypedSupplierAdmin instance associated with the target TypedEventChannel instance.
int[]	get_all_consumeradmins()
int[]	get_all_supplieradmins()
TypedConsumerAdmin	get_consumeradmin(int id) The get_consumeradmin operation returns a reference to one of the TypedConsumerAdmin instances associated with the target TypedEventChannel instance.
TypedSupplierAdmin	get_supplieradmin(int id) The get_supplieradmin operation returns a reference to one of the TypedSupplierAdmin instances associated with the target TypedEventChannel instance.
TypedEventChannelFactory	MyFactory() The MyFactory attribute is a readonly attribute that maintains the object reference of the event channel factory, which created a given Notification Service TypedEventChannel instance.
TypedConsumerAdmin	new_for_typed_notification_consumers(InterFilterGroupOperator op, IntHolder id) The new_for_typed_consumers operation is invoked to create a new Notification Service style TypedConsumerAdmin instance.
TypedSupplierAdmin	new_for_typed_notification_suppliers(InterFilterGroupOperator op, IntHolder id) The new_for_typed_suppliers operation is invoked to create a new Notification Service style TypedSupplierAdmin instance.

Methods inherited from interface org.omg.CosNotification.QoSAdminOperations

get_qos, set_qos, validate_qos

Methods inherited from interface org.omg.CosNotification.AdminPropertiesAdminOperations

get_admin, set_admin

Methods inherited from interface org.omg.CosTypedEventChannelAdmin.TypedEventChannelOperations

destroy, for_consumers, for_suppliers

Method Detail

get_all_supplieradmins

int[] get_all_supplieradmins()

Returns:

A sequence of the unique identifiers assigned to all Notification Service style TypedSupplierAdmin instances, which have been created by the target TypedEventChannel instance.

get_all_consumeradmins

int[] get_all_consumeradmins()

Returns:

A sequence of the unique identifiers assigned to all Notification Service style TypedConsumerAdmin instances, which have been created by the target TypedEventChannel instance.

get_supplieradmin

TypedSupplierAdmin get_supplieradmin(int id)
                                     throws AdminNotFound

The get_supplieradmin operation returns a reference to one of the TypedSupplierAdmin instances associated with the target TypedEventChannel instance.

Note that while a Notification Service style event channel can support both Event Service and Notification Service style TypedSupplierAdmin instances, only Notification Service style TypedSupplierAdmin instances have associated unique identifiers.

Parameters:

id - A numeric value, which is intended to be the unique identifier of one of the TypedSupplierAdmin instances associated with the target TypedEventChannel instance.

Returns:

The object reference of the TypedSupplierAdmin instance identified by the numeric parameter.

Throws:

AdminNotFound - If the passed identifier does not turn to identify any TypedSupplierAdmin associated with the target TypedEventChannel instance.

get_consumeradmin

TypedConsumerAdmin get_consumeradmin(int id)
                                     throws AdminNotFound

The get_consumeradmin operation returns a reference to one of the TypedConsumerAdmin instances associated with the target TypedEventChannel instance.

Note that while a Notification Service style event channel can support both Event Service and Notification Service style TypedConsumerAdmin instances, only Notification Service style TypedConsumerAdmin instances have associated unique identifiers.

Parameters:

id - A numeric value, which is intended to be the unique identifier of one of the TypedConsumerAdmin instances associated with the target TypedEventChannel instance.

Returns:

The reference to the TypedConsumerAdmin corresponding to the passed identifier.

Throws:

AdminNotFound - If the passed identifier does not turn out to correspond to any TypedConsumerAdmin instance created so far by this TypedEventChannel instance.

new_for_typed_notification_suppliers

TypedSupplierAdmin new_for_typed_notification_suppliers(InterFilterGroupOperator op,
                                                        IntHolder id)

The new_for_typed_suppliers operation is invoked to create a new Notification Service style TypedSupplierAdmin instance.

Parameters:

op - A boolean flag, which indicates whether AND or OR semantics will be used when combining the filter objects associated with the newly created TypedSupplierAdmin instance with those associated with a consumer proxy, which was created by the TypedSupplierAdmin during the evaluation of each event against a set of filter objects.

id - An output parameter containing a numeric identifier corresponding to the newly created TypedSupplierAdmin. This identifier is unique among all SupplierAdmin and TypedSupplierAdmin instances currently associated with the channel.

Returns:

The reference of the newly created TypedSupplierAdmin.

new_for_typed_notification_consumers

TypedConsumerAdmin new_for_typed_notification_consumers(InterFilterGroupOperator op,
                                                        IntHolder id)

The new_for_typed_consumers operation is invoked to create a new Notification Service style TypedConsumerAdmin instance.

Parameters:

op - A boolean flag that indicates whether AND or OR semantics will be used when combining the filter objects associated with the newly created TypedConsumerAdmin instance with those associated with a supplier proxy, which was created by the TypedConsumerAdmin during the evaluation of each event against a set of filter objects.

id - An output parameter containing a numeric identifier corresponding to the newly created TypedConsumerAdmin instance. This identifier is unique among all ConsumerAdmin and TypedConsumerAdmin instances currently associated with the channel.

Returns:

The reference to the newly created TypedConsumerAdmin instance.

default_filter_factory

FilterFactory default_filter_factory()

The default_filter_factory attribute is a readonly attribute, which maintains an object reference to the default factory to be used by the TypedEventChannel instance with which it?s associated for creating filter objects. If the target channel does not support a default filter factory, the attribute will maintain the value of OBJECT_NIL.

default_supplier_admin

TypedSupplierAdmin default_supplier_admin()

The default_supplier_admin attribute is a readonly attribute, which maintains a reference to the default TypedSupplierAdmin instance associated with the target TypedEventChannel instance. Each TypedEventChannel instance has an associated default TypedSupplierAdmin instance, which exists upon creation of the channel and is assigned the unique identifier of zero. Subsequently, clients can create additional Event Service style TypedSupplierAdmin instances by invoking the inherited for_suppliers operation, and additional Notification Service style TypedSupplierAdmin instances by invoking the new_for_typed_suppliers operation defined by the TypedEventChannel interface.

default_consumer_admin

TypedConsumerAdmin default_consumer_admin()

The default_consumer_admin attribute is a readonly attribute which maintains a reference to the default TypedConsumerAdmin instance associated with the target TypedEventChannel instance. Each TypedEventChannel instance has an associated default TypedConsumerAdmin instance, which exists upon creation of the channel and is assigned the unique identifier of zero. Subsequently, clients can create additional Event Service style TypedConsumerAdmin instances by invoking the inherited for_consumers operation, and additional Notification Service style TypedConsumerAdmin instances by invoking the new_for_typed_consumers operation defined by the TypedEventChannel interface.

MyFactory

TypedEventChannelFactory MyFactory()

The MyFactory attribute is a readonly attribute that maintains the object reference of the event channel factory, which created a given Notification Service TypedEventChannel instance.