org.omg.CosNotifyChannelAdmin
Interface EventChannelOperations
public
interface
EventChannelOperations
extends QoSAdminOperations, AdminPropertiesAdminOperations, EventChannelOperations
The EventChannel interface encapsulates the behaviors supported by a Notification
Service event channel. This interface inherits from the EventChannel interface
defined within the CosEventChannelAdmin module of the OMG Event Service,
making an instance of the Notification Service EventChannel interface fully backward
compatible with an OMG Event Service style untyped event channel.
Inheritance of the EventChannel interface defined within the
CosEventChannelAdmin module enables an instance of the EventChannel interface
defined within the CosNotifyChannelAdmin module to create event service style
ConsumerAdmin and SupplierAdmin instances. These instances can subsequently be
used to create pure event service style proxy interfaces, which support connections to
pure event service style suppliers and consumers. Note that while Notification Service
style proxies and admin objects have unique identifiers associated with them, enabling
their references to be obtained by invoking operations on the Notification Service style
admin and event channel interfaces, Event Service style proxies and admin objects do
not have associated unique identifiers, and thus cannot be returned by invoking an
operation on the Notification Service style admin or event channel interfaces.
The EventChannel interface defined within the CosNotifyChannelAdmin module
also inherits from the QoSAdmin and the AdminPropertiesAdmin interfaces defined
within the CosNotification module. Inheritance of these interfaces enables a
Notification Service style event channel to manage lists of associated QoS and
administrative properties, respectively.
Locally, the EventChannel interface supports a readonly attribute which maintains a
reference to the EventChannelFactory instance that created it. In addition, each
instance of the EventChannel interface has an associated default ConsumerAdmin
and an associated default SupplierAdmin instance, both of which exist upon creation
of the channel and which have the unique identifier of zero (note that admin object
identifiers only need to be unique among a given type of admin, implying that the
identifiers assigned to ConsumerAdmin objects can overlap those assigned to
SupplierAdmin objects). The EventChannel interface supports readonly attributes
which maintain references to these default admin objects.
The EventChannel interface supports operations which create new ConsumerAdmin
and SupplierAdmin instances. In addition, the EventChannel interface supports
operations which can return references to the ConsumerAdmin and SupplierAdmin
instances associated with a given EventChannel instance, given the unique identifier
of an admin object as input. Finally, the EventChannel interface supports operations
which return the sequence of unique identifiers of all ConsumerAdmin and
SupplierAdmin instances associated with a given EventChannel instance.
Method Summary |
ConsumerAdmin | default_consumer_admin()
The default_consumer_admin attribute is a readonly attribute which maintains a
reference to the default ConsumerAdmin instance associated with the target
EventChannel 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 EventChannel instance with which
it is associated for creating filter objects. |
SupplierAdmin | default_supplier_admin()
The default_supplier_admin attribute is a readonly attribute which maintains a
reference to the default SupplierAdmin instance associated with the target
EventChannel instance. |
int[] | get_all_consumeradmins()
The get_all_consumeradmins operation takes no input parameters and returns a
sequence of the unique identifiers assigned to all Notification Service style
ConsumerAdmin instances which have been created by the target EventChannel
instance.
|
int[] | get_all_supplieradmins()
The get_all_supplieradmins operation takes no input parameters and returns a
sequence of the unique identifiers assigned to all Notification Service style
SupplierAdmin instances which have been created by the target EventChannel
instance.
|
ConsumerAdmin | get_consumeradmin(int id)
The get_consumeradmin operation returns a reference to one of the ConsumerAdmin
instances associated with the target EventChannel instance. |
SupplierAdmin | get_supplieradmin(int id)
The get_supplieradmin operation returns a reference to one of the SupplierAdmin
instances associated with the target EventChannel instance. |
EventChannelFactory | MyFactory()
The MyFactory attribute is a readonly attribute which maintains the object reference of
the event channel factory that created a given Notification Service EventChannel
instance.
|
ConsumerAdmin | new_for_consumers(InterFilterGroupOperator op, IntHolder id)
The new_for_consumers operation is invoked to create a new Notification Service style
ConsumerAdmin instance. |
SupplierAdmin | new_for_suppliers(InterFilterGroupOperator op, IntHolder id)
The new_for_suppliers operation is invoked to create a new Notification Service style
SupplierAdmin instance. |
The default_consumer_admin attribute is a readonly attribute which maintains a
reference to the default ConsumerAdmin instance associated with the target
EventChannel instance. Each EventChannel instance has an associated default
ConsumerAdmin instance, which exists upon creation of the channel and is assigned
the unique identifier of zero. Subsequently, clients can create additional Event Service
style ConsumerAdmin instances by invoking the inherited for_consumers operation,
and additional Notification Service style ConsumerAdmin instances by invoking the
new_for_consumers operation defined by the EventChannel interface.
Returns: the default consumer admin
The default_filter_factory attribute is a readonly attribute which maintains an object
reference to the default factory to be used by the EventChannel instance with which
it is 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.
Returns: the default filter factory
The default_supplier_admin attribute is a readonly attribute which maintains a
reference to the default SupplierAdmin instance associated with the target
EventChannel instance. Each EventChannel instance has an associated default
SupplierAdmin instance, which exists upon creation of the channel and is assigned
the unique identifier of zero. Subsequently, clients can create additional Event Service
style SupplierAdmin instances by invoking the inherited for_suppliers operation, and
additional Notification Service style SupplierAdmin instances by invoking the
new_for_suppliers operation defined by the EventChannel interface.
Returns: the default supplier admin
public int[] get_all_consumeradmins()
The get_all_consumeradmins operation takes no input parameters and returns a
sequence of the unique identifiers assigned to all Notification Service style
ConsumerAdmin instances which have been created by the target EventChannel
instance.
Returns: Array of all consumer admin ID
public int[] get_all_supplieradmins()
The get_all_supplieradmins operation takes no input parameters and returns a
sequence of the unique identifiers assigned to all Notification Service style
SupplierAdmin instances which have been created by the target EventChannel
instance.
Returns: Array of all supplier admin ID
The get_consumeradmin operation returns a reference to one of the ConsumerAdmin
instances associated with the target EventChannel instance. The operation accepts as
an input parameter a numeric value which is intended to be the unique identifier of one
of the ConsumerAdmin instances associated with the target EventChannel instance.
If this turns out to be the case, the object reference of the associated ConsumerAdmin
instance is returned as the operation result. Otherwise, the AdminNotFound exception
is raised.
Note that while a Notification Service style event channel can support both Event
Service and Notification Service style ConsumerAdmin instances, only Notification
Service style ConsumerAdmin instances have associated unique identifiers.
Parameters: id Id of consumer admin to retreive
Returns: The requested consumer admin
Throws: org.omg.CosNotifyChannelAdmin.AdminNotFound Id doesn't correspond to any consumer admin
The get_supplieradmin operation returns a reference to one of the SupplierAdmin
instances associated with the target EventChannel instance. The operation accepts as
an input parameter a numeric value which is intended to be the unique identifier of one
of the SupplierAdmin instances associated with the target EventChannel instance. If
this turns out to be the case, the object reference of the associated SupplierAdmin
instance is returned as the operation result. Otherwise, the AdminNotFound exception
is raised.
Note that while a Notification Service style event channel can support both Event
Service and Notification Service style SupplierAdmin instances, only Notification
Service style SupplierAdmin instances have associated unique identifiers.
Parameters: id Id of supplier admin to retreive
Returns: The requested supplier admin
Throws: org.omg.CosNotifyChannelAdmin.AdminNotFound Id doesn't correspond to any supplier admin
The MyFactory attribute is a readonly attribute which maintains the object reference of
the event channel factory that created a given Notification Service EventChannel
instance.
Returns: Channel's factory
The new_for_consumers operation is invoked to create a new Notification Service style
ConsumerAdmin instance. The operation accepts as an input parameter a boolean flag
which indicates whether AND or OR semantics will be used when combining the filter
objects associated with the newly created ConsumerAdmin instance with those
associated with a supplier proxy which was created by the ConsumerAdmin during
the evaluation of each event against a set of filter objects. The new instance is assigned
a unique identifier by the target EventChannel instance that is unique among all
ConsumerAdmin instances currently associated with the channel. Upon completion,
the operation returns the reference to the new ConsumerAdmin instance as the result
of the operation, and the unique identifier assigned to the new ConsumerAdmin
instance as the output parameter.
Parameters: op Operator of Filters' composition (between consumer filters and proxies filters) id Id of the new consumer admin
Returns: The new consumer Admin
The new_for_suppliers operation is invoked to create a new Notification Service style
SupplierAdmin instance. The operation accepts as an input parameter a boolean flag
which indicates whether AND or OR semantics will be used when combining the filter
objects associated with the newly created SupplierAdmin instance with those
associated with a consumer proxy which was created by the SupplierAdmin during
the evaluation of each event against a set of filter objects. The new instance is assigned
a unique identifier by the target EventChannel instance that is unique among all
SupplierAdmin instances currently associated with the channel. Upon completion, the
operation returns the reference to the new SupplierAdmin instance as the result of the
operation, and the unique identifier assigned to the new SupplierAdmin instance as
the output parameter.
Parameters: op Operator of Filters' composition (between supplier filters and proxies filters) id Id of the new consumer admin
Returns: The new supplier Admin