org.omg.CosNotifyChannelAdmin
Interface ConsumerAdminOperations

All Superinterfaces:

ConsumerAdminOperations, FilterAdminOperations, NotifySubscribeOperations, QoSAdminOperations

All Known Subinterfaces:

ConsumerAdmin, NotifyLogFactory, NotifyLogFactoryOperations, TypedConsumerAdmin, TypedConsumerAdminOperations, TypedNotifyLogFactory, TypedNotifyLogFactoryOperations

public interface ConsumerAdminOperations
extends QoSAdminOperations, NotifySubscribeOperations, FilterAdminOperations, ConsumerAdminOperations

Method Summary

void	destroy() The destroy operation is invoked just before this ConsumerAdmin instance is destroyed, in this method, implementor must free all resources consumed by this instance.
ProxySupplier	get_proxy_supplier(int proxy_id)
MappingFilter	lifetime_filter() The lifetime_filter attribute maintains a reference to a mapping filter object that affects the way in which each proxy supplier object created by the target ConsumerAdmin instance treats each event it receives with respect to lifetime.
void	lifetime_filter(MappingFilter arg0) The lifetime_filter attribute maintains a reference to a mapping filter object that affects the way in which each proxy supplier object created by the target ConsumerAdmin instance treats each event it receives with respect to lifetime.
EventChannel	MyChannel() The MyChannel attribute is a readonly attribute that maintains the object reference of the Notification Service event channel, which created a given ConsumerAdmin instance.
int	MyID() The MyID attribute is a readonly attribute that maintains the unique identifier of the target ConsumerAdmin instance, which is assigned to it upon creation by the Notification Service event channel.
InterFilterGroupOperator	MyOperator() The MyOperator attribute is a readonly attribute that maintains the information regarding whether AND or OR semantics will be used during the evaluation of a given event against a set of filter objects, when combining the filter objects associated with the target ConsumerAdmin and those defined locally on a given proxy supplier.
ProxySupplier	obtain_notification_pull_supplier(ClientType ctype, IntHolder proxy_id) The obtain_notification_pull_supplier operation creates instances of the various types of pull-style proxy supplier objects defined within the CosNotifyChannelAdmin module.
ProxySupplier	obtain_notification_push_supplier(ClientType ctype, IntHolder proxy_id) The obtain_notification_push_supplier operation creates instances of the various types of push-style proxy supplier objects defined within the CosNotifyChannelAdmin module.
MappingFilter	priority_filter() The priority_filter attribute maintains a reference to a mapping filter object that affects the way in which each proxy supplier object created by the target ConsumerAdmin instance treats each event it receives with respect to priority.
void	priority_filter(MappingFilter arg0) The priority_filter attribute maintains a reference to a mapping filter object that affects the way in which each proxy supplier object created by the target ConsumerAdmin instance treats each event it receives with respect to priority.
int[]	pull_suppliers() The pull_suppliers attribute is a readonly attribute that contains the list of unique identifiers, which have been assigned by a ConsumerAdmin instance to each pullstyle proxy supplier object it has created.
int[]	push_suppliers() The push_suppliers attribute is a readonly attribute that contains the list of unique identifiers which have been assigned by a ConsumerAdmin instance to each pushstyle proxy supplier object it has created.

Methods inherited from interface org.omg.CosNotification.QoSAdminOperations

get_qos, set_qos, validate_qos

Methods inherited from interface org.omg.CosNotifyComm.NotifySubscribeOperations

subscription_change

Methods inherited from interface org.omg.CosNotifyFilter.FilterAdminOperations

add_filter, get_all_filters, get_filter, remove_all_filters, remove_filter

Methods inherited from interface org.omg.CosEventChannelAdmin.ConsumerAdminOperations

obtain_pull_supplier, obtain_push_supplier

Method Detail

destroy

void destroy()

The destroy operation is invoked just before this ConsumerAdmin instance is destroyed, in this method, implementor must free all resources consumed by this instance. Note that destroy can be invoked on a ConsumerAdmin instance that is currently managing proxy supplier objects that support open connections to consumers. In this case, the effect of invoking destroy on the ConsumerAdmin is that the operation will disconnect each of the proxy supplier objects being managed by the target ConsumerAdmin from their consumers, and destroy each of these proxy suppliers. Ultimately, the ConsumerAdmin instance itself will be destroyed.

obtain_notification_push_supplier

ProxySupplier obtain_notification_push_supplier(ClientType ctype,
                                                IntHolder proxy_id)
                                                throws AdminLimitExceeded

The obtain_notification_push_supplier operation creates instances of the various types of push-style proxy supplier objects defined within the CosNotifyChannelAdmin module. Three varieties of push-style proxy supplier objects are defined within this module:

• instances of the ProxyPushSupplier interface support connections to push consumers which receive events as Anys
• instances of the StructuredProxyPushSupplier interface support connections to push consumers which receive events as Structured Events
• instances of the SequenceProxyPushSupplier interface support connections to push consumers which receive events as sequences of Structured Events.

Parameters:

ctype - A flag that indicates which style of push-style proxy supplier instance should be created.

Throws:

AdminLimitExceeded - If the number of consumers currently connected to the channel with which the target ConsumerAdmin object associated exceeds the value of the MaxConsumers administrative property.

obtain_notification_pull_supplier

ProxySupplier obtain_notification_pull_supplier(ClientType ctype,
                                                IntHolder proxy_id)
                                                throws AdminLimitExceeded

The obtain_notification_pull_supplier operation creates instances of the various types of pull-style proxy supplier objects defined within the CosNotifyChannelAdmin module. Three varieties of pull-style proxy supplier objects are defined within this module:

• instances of the ProxyPullSupplier interface support connections to pull consumers that receive events as Anys
• instances of the StructuredProxyPullSupplier interface support connections to pull consumers that receive events as Structured Events
• instances of the SequenceProxyPullSupplier interface support connections to pull consumers that receive events as sequences of Structured Events.

This ConsumerAdmin implementation creates the new pull-style proxy supplier instance and assigns a numeric identifier to it that is unique among all proxy suppliers it has created.

Parameters:

ctype - An input parameter a flag that indicates which style of pull-style proxy supplier instance should be created.\

proxy_id - An output parameter of a numeric identifier uniquely identifying proxy suppliers created by this implementation.

Returns:

The reference to the newly created proxy supplier instance.

Throws:

AdminLimitExceeded - If the number of consumers currently connected to the channel with which the target ConsumerAdmin object is associated exceeds the value of the MaxConsumers administrative property.

get_proxy_supplier

ProxySupplier get_proxy_supplier(int proxy_id)
                                 throws ProxyNotFound

Parameters:

proxy_id - The numeric unique identifier associated with one of the proxy supplier objects that has been created by the target ConsumerAdmin instance.

Returns:

The proxy supplier object that has been created by the target ConsumerAdmin instance and that corresponds to the passed identifier.

Throws:

ProxyNotFound - If the input parameter does not correspond to any unique identifier of any proxy supplier object that has been created by the target ConsumerAdmin instance.

push_suppliers

int[] push_suppliers()

The push_suppliers attribute is a readonly attribute that contains the list of unique identifiers which have been assigned by a ConsumerAdmin instance to each pushstyle proxy supplier object it has created.

pull_suppliers

int[] pull_suppliers()

The pull_suppliers attribute is a readonly attribute that contains the list of unique identifiers, which have been assigned by a ConsumerAdmin instance to each pullstyle proxy supplier object it has created.

lifetime_filter

MappingFilter lifetime_filter()

The lifetime_filter attribute maintains a reference to a mapping filter object that affects the way in which each proxy supplier object created by the target ConsumerAdmin instance treats each event it receives with respect to lifetime. Note that each proxy supplier object also has an associated attribute that maintains a reference to a mapping filter object for the lifetime property. If this attribute is set to the reference of a valid mapping filter object, this mapping filter will override that set at the admin level. Otherwise, the mapping filter object referred to by the lifetime_filter attribute of the ConsumerAdmin is used.

lifetime_filter

void lifetime_filter(MappingFilter arg0)

The lifetime_filter attribute maintains a reference to a mapping filter object that affects the way in which each proxy supplier object created by the target ConsumerAdmin instance treats each event it receives with respect to lifetime. Note that each proxy supplier object also has an associated attribute that maintains a reference to a mapping filter object for the lifetime property. If this attribute is set to the reference of a valid mapping filter object, this mapping filter will override that set at the admin level. Otherwise, the mapping filter object referred to by the lifetime_filter attribute of the ConsumerAdmin is used.

priority_filter

MappingFilter priority_filter()

The priority_filter attribute maintains a reference to a mapping filter object that affects the way in which each proxy supplier object created by the target ConsumerAdmin instance treats each event it receives with respect to priority. Note that each proxy supplier object also has an associated attribute that maintains a reference to a mapping filter object for the priority property. If this attribute is set to the reference of a valid mapping filter object, this mapping filter will override that set at the admin level. Otherwise, the mapping filter object referred to by the priority_filter attribute of the ConsumerAdmin is used.

priority_filter

void priority_filter(MappingFilter arg0)

The priority_filter attribute maintains a reference to a mapping filter object that affects the way in which each proxy supplier object created by the target ConsumerAdmin instance treats each event it receives with respect to priority. Note that each proxy supplier object also has an associated attribute that maintains a reference to a mapping filter object for the priority property. If this attribute is set to the reference of a valid mapping filter object, this mapping filter will override that set at the admin level. Otherwise, the mapping filter object referred to by the priority_filter attribute of the ConsumerAdmin is used.

MyOperator

InterFilterGroupOperator MyOperator()

The MyOperator attribute is a readonly attribute that maintains the information regarding whether AND or OR semantics will be used during the evaluation of a given event against a set of filter objects, when combining the filter objects associated with the target ConsumerAdmin and those defined locally on a given proxy supplier.

MyChannel

EventChannel MyChannel()

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

MyID

int MyID()

The MyID attribute is a readonly attribute that maintains the unique identifier of the target ConsumerAdmin instance, which is assigned to it upon creation by the Notification Service event channel.