org.omg.CosNotifyChannelAdmin
Class SequenceProxyPullSupplierPOATie

java.lang.Object
  extended by org.omg.PortableServer.Servant
      extended by org.omg.CosNotifyChannelAdmin.SequenceProxyPullSupplierPOA
          extended by org.omg.CosNotifyChannelAdmin.SequenceProxyPullSupplierPOATie
All Implemented Interfaces:
org.omg.CORBA.portable.InvokeHandler, QoSAdminOperations, ProxySupplierOperations, SequenceProxyPullSupplierOperations, NotifySubscribeOperations, SequencePullSupplierOperations, FilterAdminOperations

public class SequenceProxyPullSupplierPOATie
extends SequenceProxyPullSupplierPOA

The SequenceProxyPullSupplier interface supports connections to the channel by consumers who will pull events from the channel as sequences of Structured Events. Through inheritance of the ProxySupplier interface, the SequenceProxyPullSupplier interface supports administration of various QoS properties, administration of a list of associated filter objects, and a readonly attribute containing the reference of the ConsumerAdmin object which created it. In addition, this inheritance implies that a SequenceProxyPullSupplier instance supports an operation which will return the list of event types which the proxy supplier will potentially by supplying, and an operation which can return information about the instance?s ability to accept a per-event QoS request. The SequenceProxyPullSupplier interface also inherits from the SequencePullSupplier interface defined in the CosNotifyComm module. This interface supports the operations which enable a consumer of sequences of Structured Events to pull them from the SequenceProxyPullSupplier, and also the operation which can be invoked to close down the connection from the consumer to the SequenceProxyPullSupplier. In addition, since the SequencePullSupplier interface inherits from the NotifySubscribe interface, a SequenceProxyPullSupplier can be notified whenever the list of event types which its associated consumer is interested in receiving changes. This notification occurs via the callback mechanism described in section 2.3. Lastly, the SequenceProxyPullSupplier interface defines a method that can be invoked by a pull-style consumer of sequences of Structured Events in order to establish a connection between the consumer and a notification channel over which the consumer will proceed to receive events.


Constructor Summary
SequenceProxyPullSupplierPOATie(SequenceProxyPullSupplierOperations tieObject)
          Constructor
SequenceProxyPullSupplierPOATie(SequenceProxyPullSupplierOperations tieObject, org.omg.PortableServer.POA poa)
          Constructor
 
Method Summary
 org.omg.PortableServer.POA _default_POA()
          _default_POA method
 SequenceProxyPullSupplierOperations _delegate()
          Get the delegate
 void _delegate(SequenceProxyPullSupplierOperations delegate_)
          Set the delegate
 int add_filter(Filter new_filter)
          Operation add_filter
 void connect_sequence_pull_consumer(SequencePullConsumer pull_consumer)
          Operation connect_sequence_pull_consumer
 void disconnect_sequence_pull_supplier()
          Operation disconnect_sequence_pull_supplier
 int[] get_all_filters()
          Operation get_all_filters
 Filter get_filter(int filter)
          Operation get_filter
 Property[] get_qos()
          Operation get_qos
 MappingFilter lifetime_filter()
          Read accessor for lifetime_filter attribute
 void lifetime_filter(MappingFilter value)
          Write accessor for lifetime_filter attribute
 ConsumerAdmin MyAdmin()
          Read accessor for MyAdmin attribute
 ProxyType MyType()
          Read accessor for MyType attribute
 EventType[] obtain_offered_types(ObtainInfoMode mode)
          Operation obtain_offered_types
 MappingFilter priority_filter()
          Read accessor for priority_filter attribute
 void priority_filter(MappingFilter value)
          Write accessor for priority_filter attribute
 StructuredEvent[] pull_structured_events(int max_number)
          Operation pull_structured_events
 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 subscription_change(EventType[] added, EventType[] removed)
          Operation subscription_change
 StructuredEvent[] try_pull_structured_events(int max_number, org.omg.CORBA.BooleanHolder has_event)
          Operation try_pull_structured_events
 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.SequenceProxyPullSupplierPOA
_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

SequenceProxyPullSupplierPOATie

public SequenceProxyPullSupplierPOATie(SequenceProxyPullSupplierOperations tieObject)
Constructor


SequenceProxyPullSupplierPOATie

public SequenceProxyPullSupplierPOATie(SequenceProxyPullSupplierOperations tieObject,
                                       org.omg.PortableServer.POA poa)
Constructor

Method Detail

_delegate

public SequenceProxyPullSupplierOperations _delegate()
Get the delegate


_delegate

public void _delegate(SequenceProxyPullSupplierOperations 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_sequence_pull_consumer

public void connect_sequence_pull_consumer(SequencePullConsumer pull_consumer)
                                    throws AlreadyConnected
Operation connect_sequence_pull_consumer

Parameters:
pull_consumer - Push consumer to connect to the proxy
Throws:
AlreadyConnected

MyType

public ProxyType MyType()
Read accessor for MyType attribute


MyAdmin

public ConsumerAdmin MyAdmin()
Read accessor for MyAdmin attribute


priority_filter

public MappingFilter priority_filter()
Read accessor for priority_filter attribute


priority_filter

public void priority_filter(MappingFilter value)
Write accessor for priority_filter attribute


lifetime_filter

public MappingFilter lifetime_filter()
Read accessor for lifetime_filter attribute

Returns:
Lifetime_filter of the proxy

lifetime_filter

public void lifetime_filter(MappingFilter value)
Write accessor for lifetime_filter attribute


obtain_offered_types

public EventType[] obtain_offered_types(ObtainInfoMode mode)
Operation obtain_offered_types

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

validate_event_qos

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

Throws:
UnsupportedQoS - A Qos Properties isn't 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


pull_structured_events

public StructuredEvent[] pull_structured_events(int max_number)
                                         throws Disconnected
Operation pull_structured_events

Throws:
Disconnected

try_pull_structured_events

public StructuredEvent[] try_pull_structured_events(int max_number,
                                                    org.omg.CORBA.BooleanHolder has_event)
                                             throws Disconnected
Operation try_pull_structured_events

Throws:
Disconnected

disconnect_sequence_pull_supplier

public void disconnect_sequence_pull_supplier()
Operation disconnect_sequence_pull_supplier


subscription_change

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

Throws:
InvalidEventType