org.omg.CosNotifyChannelAdmin
Class _StructuredProxyPullSupplierStub

java.lang.Object
  extended by org.omg.CORBA.portable.ObjectImpl
      extended by org.omg.CosNotifyChannelAdmin._StructuredProxyPullSupplierStub
All Implemented Interfaces:
java.io.Serializable, org.omg.CORBA.Object, org.omg.CORBA.portable.IDLEntity, QoSAdmin, QoSAdminOperations, ProxySupplier, ProxySupplierOperations, StructuredProxyPullSupplier, StructuredProxyPullSupplierOperations, NotifySubscribe, NotifySubscribeOperations, StructuredPullSupplier, StructuredPullSupplierOperations, FilterAdmin, FilterAdminOperations

public class _StructuredProxyPullSupplierStub
extends org.omg.CORBA.portable.ObjectImpl
implements StructuredProxyPullSupplier

The StructuredProxyPullSupplier interface supports connections to the channel by consumers who will pull events from the channel as Structured Events. Through inheritance of the ProxySupplier interface, the StructuredProxyPullSupplier 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 StructuredProxyPullSupplier 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 StructuredProxyPullSupplier interface also inherits from the StructuredPullSupplier interface defined in the CosNotifyComm module. This interface supports the operations which enable a consumer of Structured Events to pull them from the StructuredProxyPullSupplier, and also the operation which can be invoked to close down the connection from the consumer to the StructuredProxyPullSupplier. In addition, since the StructuredPullSupplier interface inherits from the NotifySubscribe interface, a StructuredProxyPullSupplier 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 StructuredProxyPullSupplier interface defines a method that can be invoked by a pull-style consumer 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.

See Also:
Serialized Form

Constructor Summary
_StructuredProxyPullSupplierStub()
           
 
Method Summary
 java.lang.String[] _ids()
           
 int add_filter(Filter new_filter)
          Operation add_filter
 void connect_structured_pull_consumer(StructuredPullConsumer pull_consumer)
          Operation connect_structured_pull_consumer
 void disconnect_structured_pull_supplier()
          Operation disconnect_structured_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_event()
          Operation pull_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 subscription_change(EventType[] added, EventType[] removed)
          Operation subscription_change
 StructuredEvent try_pull_structured_event(org.omg.CORBA.BooleanHolder has_event)
          Operation try_pull_structured_event
 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.CORBA.portable.ObjectImpl
_create_request, _create_request, _duplicate, _get_delegate, _get_domain_managers, _get_interface_def, _get_policy, _hash, _invoke, _is_a, _is_equivalent, _is_local, _non_existent, _orb, _release, _releaseReply, _request, _request, _servant_postinvoke, _servant_preinvoke, _set_delegate, _set_policy_override, equals, hashCode, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

_StructuredProxyPullSupplierStub

public _StructuredProxyPullSupplierStub()
Method Detail

_ids

public java.lang.String[] _ids()
Specified by:
_ids in class org.omg.CORBA.portable.ObjectImpl

connect_structured_pull_consumer

public void connect_structured_pull_consumer(StructuredPullConsumer pull_consumer)
                                      throws AlreadyConnected
Operation connect_structured_pull_consumer

Specified by:
connect_structured_pull_consumer in interface StructuredProxyPullSupplierOperations
Parameters:
pull_consumer - Push consumer to connect to the proxy
Throws:
AlreadyConnected

MyType

public ProxyType MyType()
Read accessor for MyType attribute

Specified by:
MyType in interface ProxySupplierOperations
Returns:
the attribute value

MyAdmin

public ConsumerAdmin MyAdmin()
Read accessor for MyAdmin attribute

Specified by:
MyAdmin in interface ProxySupplierOperations
Returns:
the attribute value

priority_filter

public MappingFilter priority_filter()
Read accessor for priority_filter attribute

Specified by:
priority_filter in interface ProxySupplierOperations
Returns:
the attribute value

priority_filter

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

Specified by:
priority_filter in interface ProxySupplierOperations
Parameters:
value - the attribute value

lifetime_filter

public MappingFilter lifetime_filter()
Read accessor for lifetime_filter attribute

Specified by:
lifetime_filter in interface ProxySupplierOperations
Returns:
the attribute value

lifetime_filter

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

Specified by:
lifetime_filter in interface ProxySupplierOperations
Parameters:
value - the attribute value

obtain_offered_types

public EventType[] obtain_offered_types(ObtainInfoMode mode)
Operation obtain_offered_types

Specified by:
obtain_offered_types in interface ProxySupplierOperations
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

Specified by:
validate_event_qos in interface ProxySupplierOperations
Throws:
UnsupportedQoS - A Qos Properties isn't supported in this implementation

get_qos

public Property[] get_qos()
Operation get_qos

Specified by:
get_qos in interface QoSAdminOperations
Returns:
Object QosProperties

set_qos

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

Specified by:
set_qos in interface QoSAdminOperations
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

Specified by:
validate_qos in interface QoSAdminOperations
Throws:
UnsupportedQoS

add_filter

public int add_filter(Filter new_filter)
Operation add_filter

Specified by:
add_filter in interface FilterAdminOperations
Parameters:
new_filter - filter to add
Returns:
filter id

remove_filter

public void remove_filter(int filter)
                   throws FilterNotFound
Operation remove_filter

Specified by:
remove_filter in interface FilterAdminOperations
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

Specified by:
get_filter in interface FilterAdminOperations
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

Specified by:
get_all_filters in interface FilterAdminOperations
Returns:
Array of all filters's id

remove_all_filters

public void remove_all_filters()
Operation remove_all_filters

Specified by:
remove_all_filters in interface FilterAdminOperations

pull_structured_event

public StructuredEvent pull_structured_event()
                                      throws Disconnected
Operation pull_structured_event

Specified by:
pull_structured_event in interface StructuredPullSupplierOperations
Throws:
Disconnected

try_pull_structured_event

public StructuredEvent try_pull_structured_event(org.omg.CORBA.BooleanHolder has_event)
                                          throws Disconnected
Operation try_pull_structured_event

Specified by:
try_pull_structured_event in interface StructuredPullSupplierOperations
Throws:
Disconnected

disconnect_structured_pull_supplier

public void disconnect_structured_pull_supplier()
Operation disconnect_structured_pull_supplier

Specified by:
disconnect_structured_pull_supplier in interface StructuredPullSupplierOperations

subscription_change

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

Specified by:
subscription_change in interface NotifySubscribeOperations
Throws:
InvalidEventType