org.omg.CosNotifyChannelAdmin
Interface ProxySupplierOperations

All Superinterfaces:

FilterAdminOperations, QoSAdminOperations

All Known Subinterfaces:

ProxyPullSupplier, ProxyPullSupplierOperations, ProxyPushSupplier, ProxyPushSupplierOperations, ProxySupplier, SequenceProxyPullSupplier, SequenceProxyPullSupplierOperations, SequenceProxyPushSupplier, SequenceProxyPushSupplierOperations, StructuredProxyPullSupplier, StructuredProxyPullSupplierOperations, StructuredProxyPushSupplier, StructuredProxyPushSupplierOperations, TypedProxyPullSupplier, TypedProxyPullSupplierOperations, TypedProxyPushSupplier, TypedProxyPushSupplierOperations

public interface ProxySupplierOperations
extends QoSAdminOperations, FilterAdminOperations

The ProxySupplier interface is intended to be an abstract interface that is inherited by the different varieties of proxy suppliers that can be instantiated within a notification channel. It encapsulates the behaviors common to all Notification Service proxy suppliers. In particular, the ProxySupplier interface inherits the QoSAdmin interface defined within the CosNotification module, and the FilterAdmin interface defined within the CosNotifyFilter module. The former inheritance enables all proxy suppliers to administer a list of associated QoS properties, while the latter inheritance enables all proxy suppliers to administer a list of associated filter objects. Locally, the ProxySupplier interface defines a readonly attribute that should be set upon creation of each proxy supplier instance to indicate the specific type of proxy supplier the instance represents, and a readonly attribute which maintains a reference to the ConsumerAdmin object that created it. In addition, the ProxySupplier interface defines attributes that associate with each proxy supplier two mapping filter objects, one for priority and one for lifetime. These mapping filter objects enable proxy suppliers to be configured to alter the way they treat events with respect to their priority and lifetime based on the type and contents of each individual event. Lastly, the ProxySupplier interface defines an operation that returns the list of event types that a given proxy supplier could potentially forward to its associated consumer, and an operation which can be queried to determine which message level QoS properties can be set on a perevent basis.

Method Summary

MappingFilter	lifetime_filter() The lifetime_filter attribute contains a reference to an object supporting the MappingFilter interface defined in the CosNotifyFilter module.
void	lifetime_filter(MappingFilter arg0) The lifetime_filter attribute contains a reference to an object supporting the MappingFilter interface defined in the CosNotifyFilter module.
ConsumerAdmin	MyAdmin() The MyAdmin attribute is a readonly attribute that should be set upon creation of each proxy supplier instance to maintain the reference of the instance supporting the ConsumerAdmin interface that created it.
ProxyType	MyType() The MyType attribute is a readonly attribute that should be set upon creation of each proxy supplier instance to indicate the specific type of proxy supplier the instance represents.
EventType[]	obtain_offered_types(ObtainInfoMode mode) The obtain_offered_types operation returns a list of event type names.
MappingFilter	priority_filter() The priority_filter attribute contains a reference to an object supporting the MappingFilter interface defined in the CosNotifyFilter module.
void	priority_filter(MappingFilter arg0) The priority_filter attribute contains a reference to an object supporting the MappingFilter interface defined in the CosNotifyFilter module.
void	validate_event_qos(Property[] required_qos, org.omg.CosNotification.NamedPropertyRangeSeqHolder available_qos) This operation is essentially a check to see if the target proxy object will honor the setting of a set of QoS properties on a per-event basis to values that may conflict with those set on the proxy itself.

Methods inherited from interface org.omg.CosNotification.QoSAdminOperations

get_qos, set_qos, validate_qos

Methods inherited from interface org.omg.CosNotifyFilter.FilterAdminOperations

add_filter, get_all_filters, get_filter, remove_all_filters, remove_filter

Method Detail

validate_event_qos

void validate_event_qos(Property[] required_qos,
                        org.omg.CosNotification.NamedPropertyRangeSeqHolder available_qos)
                        throws UnsupportedQoS

This operation is essentially a check to see if the target proxy object will honor the setting of a set of QoS properties on a per-event basis to values that may conflict with those set on the proxy itself. Note that the QoS property settings contained in the optional header fields of a Structured Event may differ from those that are configured on a given proxy object.

Parameters:

required_qos - A sequence of QoS property name-value pairs, which specify a set of QoS settings that a client is interested in setting on a per-event basis.

available_qos - An output parameter that contains a sequence of PropertyRange data structures, whose each element includes the name of an additional QoS property, whose setting is supported by the target object on a perevent basis and which could have been included on the input list while still resulting in a successful return from the operation. Each element also includes the range of values that would have been acceptable for each such property.

Throws:

UnsupportedQoS - If any of the requested settings would not be honored by the target object on a per-event basis, in which case, this exception contains as data a sequence of data structures, each of which identifies the name of a QoS property in the input list whose requested setting could not be satisfied, along with an error code and a range of settings for the property which could be satisfied.

obtain_offered_types

EventType[] obtain_offered_types(ObtainInfoMode mode)

The obtain_offered_types operation returns a list of event type names. Each element of the returned list names a type of event that the target proxy supplier object could potentially forward to its associated consumer.

Parameters:

mode - The ObtainInfoMode flag that enables synchronization between the subscription information obtain through these automatic updates and that obtained through invocation of obtain_subscription_types, for all possible enumeration values for this, please see ObtainInfoMode.

Returns:

A list of event type names, whose each element names a type of event that the target proxy supplier object could potentially forward to its associated consumer.

lifetime_filter

MappingFilter lifetime_filter()

The lifetime_filter attribute contains a reference to an object supporting the MappingFilter interface defined in the CosNotifyFilter module. Such an object encapsulates a list of constraint-value pairs, where each constraint is a boolean expression based on the type and contents of an event, and the value is a possible lifetime setting for the event. Upon receipt of each event by a proxy supplier object whose lifetime_filter attribute contains a non-nil reference, the proxy supplier will invoke the appropriate variant of the match operation supported by the mapping filter object. The mapping filter object will proceed to apply its encapsulated constraints to the event, and return the one with the highest associated lifetime setting which evaluates to TRUE, or else its associated default_value if no constraints evaluate to TRUE. Upon return from the match operation, if the output parameter is TRUE, the proxy supplier treats the event with respect to its lifetime according to the return value, as opposed to a lifetime setting contained within the event. If the output parameter is FALSE, the proxy supplier will treat the event with respect to its lifetime according to the value set for the lifetime property in the event header if this property is present, otherwise it will use the output parameter returned from the match operation (i.e., the default value of the mapping filter object).

lifetime_filter

void lifetime_filter(MappingFilter arg0)

The lifetime_filter attribute contains a reference to an object supporting the MappingFilter interface defined in the CosNotifyFilter module. Such an object encapsulates a list of constraint-value pairs, where each constraint is a boolean expression based on the type and contents of an event, and the value is a possible lifetime setting for the event. Upon receipt of each event by a proxy supplier object whose lifetime_filter attribute contains a non-nil reference, the proxy supplier will invoke the appropriate variant of the match operation supported by the mapping filter object. The mapping filter object will proceed to apply its encapsulated constraints to the event, and return the one with the highest associated lifetime setting which evaluates to TRUE, or else its associated default_value if no constraints evaluate to TRUE. Upon return from the match operation, if the output parameter is TRUE, the proxy supplier treats the event with respect to its lifetime according to the return value, as opposed to a lifetime setting contained within the event. If the output parameter is FALSE, the proxy supplier will treat the event with respect to its lifetime according to the value set for the lifetime property in the event header if this property is present, otherwise it will use the output parameter returned from the match operation (i.e., the default value of the mapping filter object).

priority_filter

MappingFilter priority_filter()

The priority_filter attribute contains a reference to an object supporting the MappingFilter interface defined in the CosNotifyFilter module. Such an object encapsulates a list of constraint-value pairs, where each constraint is a boolean expression based on the type and contents of an event, and the value is a possible priority setting for the event. Upon receipt of each event by a proxy supplier object whose priority_filter attribute contains a non-nil reference, the proxy supplier will invoke the appropriate variant of the match operation supported by the mapping filter object. The mapping filter object will proceed to apply its encapsulated constraints to the event, and return the one with the highest associated priority setting that evaluates to TRUE, or else its associated default_value if no constraints evaluate to TRUE. Upon return from the match operation, if the output parameter is TRUE, the proxy supplier treats the event with respect to its priority according to the return value, as opposed to a priority setting contained within the event. If the output parameter is FALSE, the proxy supplier will treat the event with respect to its priority according to the value set for the priority property in the event header if this property is present, otherwise it will use the output parameter returned from the match operation (i.e., the default value of the mapping filter object).

priority_filter

void priority_filter(MappingFilter arg0)

The priority_filter attribute contains a reference to an object supporting the MappingFilter interface defined in the CosNotifyFilter module. Such an object encapsulates a list of constraint-value pairs, where each constraint is a boolean expression based on the type and contents of an event, and the value is a possible priority setting for the event. Upon receipt of each event by a proxy supplier object whose priority_filter attribute contains a non-nil reference, the proxy supplier will invoke the appropriate variant of the match operation supported by the mapping filter object. The mapping filter object will proceed to apply its encapsulated constraints to the event, and return the one with the highest associated priority setting that evaluates to TRUE, or else its associated default_value if no constraints evaluate to TRUE. Upon return from the match operation, if the output parameter is TRUE, the proxy supplier treats the event with respect to its priority according to the return value, as opposed to a priority setting contained within the event. If the output parameter is FALSE, the proxy supplier will treat the event with respect to its priority according to the value set for the priority property in the event header if this property is present, otherwise it will use the output parameter returned from the match operation (i.e., the default value of the mapping filter object).

MyAdmin

ConsumerAdmin MyAdmin()

The MyAdmin attribute is a readonly attribute that should be set upon creation of each proxy supplier instance to maintain the reference of the instance supporting the ConsumerAdmin interface that created it.

MyType

ProxyType MyType()

The MyType attribute is a readonly attribute that should be set upon creation of each proxy supplier instance to indicate the specific type of proxy supplier the instance represents. For all possible enumeration values for this, please see ProxyType.