org.omg.CosNotifyChannelAdmin
Class StructuredProxyPushConsumerPOATie

java.lang.Object
  extended by org.omg.PortableServer.Servant
      extended by org.omg.CosNotifyChannelAdmin.StructuredProxyPushConsumerPOA
          extended by org.omg.CosNotifyChannelAdmin.StructuredProxyPushConsumerPOATie
All Implemented Interfaces:
org.omg.CORBA.portable.InvokeHandler, QoSAdminOperations, ProxyConsumerOperations, StructuredProxyPushConsumerOperations, NotifyPublishOperations, StructuredPushConsumerOperations, FilterAdminOperations

public class StructuredProxyPushConsumerPOATie
extends StructuredProxyPushConsumerPOA

The StructuredProxyPushConsumer interface supports connections to the channel by suppliers who will push events to the channel as Structured Events. Through inheritance of the ProxyConsumer interface, the StructuredProxyPushConsumer 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 StructuredProxyPushConsumer 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 StructuredProxyPushConsumer interface also inherits from the StructuredPushConsumer interface defined in the CosNotifyComm module. This interface supports the operation which enables a supplier of Structured Events to push them to the StructuredProxyPushConumer, and also the operation which can be invoked to close down the connection from the supplier to the StructuredProxyPushConsumer. In addition, since the StructuredPushConsumer interface inherits from the NotifyPublish interface, a supplier can inform the StructuredProxyPushConsumer to which it is connected whenever the list of event types it plans to supply to the channel changes. Lastly, the StructuredProxyPushConsumer interface defines a method that can be invoked by a push-style supplier of Structured Events in order to establish a connection between the supplier and a notification channel over which the supplier will proceed to send events.


Constructor Summary
StructuredProxyPushConsumerPOATie(StructuredProxyPushConsumerOperations tieObject)
          Constructor
StructuredProxyPushConsumerPOATie(StructuredProxyPushConsumerOperations tieObject, org.omg.PortableServer.POA poa)
          Constructor
 
Method Summary
 org.omg.PortableServer.POA _default_POA()
          _default_POA method
 StructuredProxyPushConsumerOperations _delegate()
          Get the delegate
 void _delegate(StructuredProxyPushConsumerOperations delegate_)
          Set the delegate
 int add_filter(Filter new_filter)
          Operation add_filter
 void connect_structured_push_supplier(StructuredPushSupplier push_supplier)
          Operation connect_structured_push_supplier
 void disconnect_structured_push_consumer()
          Operation disconnect_structured_push_consumer
 int[] get_all_filters()
          Operation get_all_filters
 Filter get_filter(int filter)
          Operation get_filter
 Property[] get_qos()
          Operation get_qos
 SupplierAdmin MyAdmin()
          Read accessor for MyAdmin attribute
 ProxyType MyType()
          Read accessor for MyType attribute
 EventType[] obtain_subscription_types(ObtainInfoMode mode)
          Operation obtain_subscription_types
 void offer_change(EventType[] added, EventType[] removed)
          Operation offer_change
 void push_structured_event(StructuredEvent notification)
          Operation push_structured_event
 void remove_all_filters()
          Operation remove_all_filters
 void remove_filter(int filter)
          Operation remove_filter
 void set_qos(Property[] qos)
          Operation set_qos
 void validate_event_qos(Property[] required_qos, NamedPropertyRangeSeqHolder available_qos)
          Operation validate_event_qos
 void validate_qos(Property[] required_qos, NamedPropertyRangeSeqHolder available_qos)
          Operation validate_qos
 
Methods inherited from class org.omg.CosNotifyChannelAdmin.StructuredProxyPushConsumerPOA
_all_interfaces, _invoke, _this, _this
 
Methods inherited from class org.omg.PortableServer.Servant
_get_delegate, _get_interface_def, _is_a, _non_existent, _object_id, _orb, _poa, _set_delegate, _this_object, _this_object
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StructuredProxyPushConsumerPOATie

public StructuredProxyPushConsumerPOATie(StructuredProxyPushConsumerOperations tieObject)
Constructor


StructuredProxyPushConsumerPOATie

public StructuredProxyPushConsumerPOATie(StructuredProxyPushConsumerOperations tieObject,
                                         org.omg.PortableServer.POA poa)
Constructor

Method Detail

_delegate

public StructuredProxyPushConsumerOperations _delegate()
Get the delegate


_delegate

public void _delegate(StructuredProxyPushConsumerOperations delegate_)
Set the delegate


_default_POA

public org.omg.PortableServer.POA _default_POA()
_default_POA method

Overrides:
_default_POA in class org.omg.PortableServer.Servant

connect_structured_push_supplier

public void connect_structured_push_supplier(StructuredPushSupplier push_supplier)
                                      throws AlreadyConnected
Operation connect_structured_push_supplier

Parameters:
push_supplier - Push supplier to connect to the proxy
Throws:
AlreadyConnected

MyType

public ProxyType MyType()
Read accessor for MyType attribute


MyAdmin

public SupplierAdmin MyAdmin()
Read accessor for MyAdmin attribute


obtain_subscription_types

public EventType[] obtain_subscription_types(ObtainInfoMode mode)
Operation obtain_subscription_types

Parameters:
mode - Mode of recuperation
Returns:
All subscription types

validate_event_qos

public void validate_event_qos(Property[] required_qos,
                               NamedPropertyRangeSeqHolder available_qos)
                        throws UnsupportedQoS
Operation validate_event_qos

Throws:
UnsupportedQoS - Qos Property was not supported in this implementation

get_qos

public Property[] get_qos()
Operation get_qos

Returns:
Object QosProperties

set_qos

public void set_qos(Property[] qos)
             throws UnsupportedQoS
Operation set_qos

Parameters:
qos - QosProperties to assign to object
Throws:
UnsupportedQoS

validate_qos

public void validate_qos(Property[] required_qos,
                         NamedPropertyRangeSeqHolder available_qos)
                  throws UnsupportedQoS
Operation validate_qos

Throws:
UnsupportedQoS

add_filter

public int add_filter(Filter new_filter)
Operation add_filter

Parameters:
new_filter - filter to add
Returns:
filter id

remove_filter

public void remove_filter(int filter)
                   throws FilterNotFound
Operation remove_filter

Parameters:
filter - Id of the filter
Throws:
FilterNotFound - Id doesn't match to any filter

get_filter

public Filter get_filter(int filter)
                  throws FilterNotFound
Operation get_filter

Parameters:
filter - Id of the filter to get
Returns:
The filter object
Throws:
FilterNotFound - Id doesn't match to any filter

get_all_filters

public int[] get_all_filters()
Operation get_all_filters

Returns:
Array of all filters's id

remove_all_filters

public void remove_all_filters()
Operation remove_all_filters


push_structured_event

public void push_structured_event(StructuredEvent notification)
                           throws Disconnected
Operation push_structured_event

Throws:
Disconnected

disconnect_structured_push_consumer

public void disconnect_structured_push_consumer()
Operation disconnect_structured_push_consumer


offer_change

public void offer_change(EventType[] added,
                         EventType[] removed)
                  throws InvalidEventType
Operation offer_change

Throws:
InvalidEventType