VisiBroker for Java

org.omg.CosNotifyChannelAdmin
Interface ProxyPushConsumerOperations

All Superinterfaces:
FilterAdminOperations, NotifyPublishOperations, ProxyConsumerOperations, PushConsumerOperations, QoSAdminOperations
All Known Subinterfaces:
ProxyPushConsumer

public interface ProxyPushConsumerOperations
extends ProxyConsumerOperations, PushConsumerOperations

The ProxyPushConsumer interface supports connections to the channel by suppliers who will push events to the channel as untyped Anys.

Through inheritance of the ProxyConsumer interface, the ProxyPushConsumer interface supports administration of various QoS properties, administration of a list of associated filter objects, and a readonly attribute containing the reference of the SupplierAdmin object which created it. In addition, this inheritance implies that a ProxyPushConsumer instance supports an operation which will return the list of event types which consumers connected to the same channel are interested in receiving, and an operation which can return information about the instance?s ability to accept a per-event QoS request.

The ProxyPushConsumer interface also inherits from the PushConsumer interface defined within the CosNotifyComm module. This interface supports the push operation, which the supplier connected to a ProxyPushConsumer instance will invoke to send an event to the channel in the form of an Any, and the operation required to disconnect the ProxyPushConsumer from its associated supplier. In addition, since the inherited PushConsumer interface inherits the CosNotifyComm::NotifyPublish interface, a supplier connected to an instance supporting the ProxyPushConsumer interface can inform it whenever the list of event types the supplier plans to supply changes.

Finally, the ProxyPushConsumer interface defines the operation which can be invoked by a push supplier to establish the connection over which the push supplier will send events to the channel. Note that this can be either a pure event service style, or a notification service style push supplier.


Method Summary
 void connect_any_push_supplier(PushSupplier push_supplier)
          This operation establishes a connection between a push-style supplier of events in the form of Anys, and the notification channel.
 
Methods inherited from interface org.omg.CosNotifyChannelAdmin.ProxyConsumerOperations
MyAdmin, MyType, obtain_subscription_types, validate_event_qos
 
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
 
Methods inherited from interface org.omg.CosNotifyComm.NotifyPublishOperations
offer_change
 
Methods inherited from interface org.omg.CosEventComm.PushConsumerOperations
disconnect_push_consumer, push
 

Method Detail

connect_any_push_supplier

void connect_any_push_supplier(PushSupplier push_supplier)
                               throws AlreadyConnected
This operation establishes a connection between a push-style supplier of events in the form of Anys, and the notification channel. Once established, the supplier can proceed to send events to the channel by invoking the push operation supported by the target ProxyPushConsumer instance.

Note that because the PushSupplier interface defined in the CosNotifyComm module inherits from the PushSupplier interface defined in the CosEventComm module, the input parameter to this operation could be either a pure event service style, or a notification service style push supplier. The only difference between the two are that the latter also supports the NotifySubscribe interface, and thus can be the target of subscription_change invocations. The implementation of the ProxyPushConsumer interface should attempt to narrow the input parameter to CosNotifyComm::PushSupplier in order to determine which style of push supplier is connecting to it.

Parameters:
push_supplier - The PushSupplier, which plans to push events to the channel with which the target object is associated in the form of untyped Anys.
Throws:
AlreadyConnected - If the target object of this operation is already connected to a push supplier object.

Borland Software Corporation
http://www.borland.com
100 Enterprise Way
Scotts Valley, CA 95066
Voice: (831) 431-1000
pubsweb@borland.com

Read the latest documentation online