org.omg.CosNotifyChannelAdmin
Class StructuredProxyPullSupplierPOATie

java.lang.Object
  |
  +--org.omg.PortableServer.Servant
        |
        +--org.omg.CosNotifyChannelAdmin.StructuredProxyPullSupplierPOA
              |
              +--org.omg.CosNotifyChannelAdmin.StructuredProxyPullSupplierPOATie

All Implemented Interfaces:

FilterAdminOperations, org.omg.CORBA.portable.InvokeHandler, NotifySubscribeOperations, ProxySupplierOperations, QoSAdminOperations, StructuredProxyPullSupplierOperations, StructuredPullSupplierOperations

public class StructuredProxyPullSupplierPOATie

extends StructuredProxyPullSupplierPOA

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.

Constructor Summary

StructuredProxyPullSupplierPOATie(StructuredProxyPullSupplierOperations tieObject)
Constructor

StructuredProxyPullSupplierPOATie(StructuredProxyPullSupplierOperations tieObject, org.omg.PortableServer.POA poa)
Constructor

Method Summary

org.omg.PortableServer.POA	_default_POA() _default_POA method
StructuredProxyPullSupplierOperations	_delegate() Get the delegate
void	_delegate(StructuredProxyPullSupplierOperations delegate_) Set the delegate
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.CosNotifyChannelAdmin.StructuredProxyPullSupplierPOA

_all_interfaces, _invoke, _this, _this

Methods inherited from class org.omg.PortableServer.Servant

_get_delegate, _get_interface_def, _get_interface, _is_a, _non_existent, _object_id, _orb, _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

StructuredProxyPullSupplierPOATie

public StructuredProxyPullSupplierPOATie(StructuredProxyPullSupplierOperations tieObject)

Constructor

StructuredProxyPullSupplierPOATie

public StructuredProxyPullSupplierPOATie(StructuredProxyPullSupplierOperations tieObject,
                                         org.omg.PortableServer.POA poa)

Constructor

Method Detail

_delegate

public StructuredProxyPullSupplierOperations _delegate()

Get the delegate

_delegate

public void _delegate(StructuredProxyPullSupplierOperations 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_pull_consumer

public void connect_structured_pull_consumer(StructuredPullConsumer pull_consumer)
                                      throws AlreadyConnected

Operation connect_structured_pull_consumer

Following copied from interface: org.omg.CosNotifyChannelAdmin.StructuredProxyPullSupplierOperations

Parameters:

pull_consumer - Push consumer to connect to the proxy

Throws:

CosEventChannelAdmin::AlreadyConnected - The proxy is already connected

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

Following copied from interface: org.omg.CosNotifyChannelAdmin.ProxySupplierOperations

Returns:

Lifetime_filter of the proxy

lifetime_filter

public void lifetime_filter(MappingFilter value)

Write accessor for lifetime_filter attribute

Following copied from interface: org.omg.CosNotifyChannelAdmin.ProxySupplierOperations

Returns:

Lifetime_filter of the proxy

obtain_offered_types

public EventType[] obtain_offered_types(ObtainInfoMode mode)

Operation obtain_offered_types

Following copied from interface: org.omg.CosNotifyChannelAdmin.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

Following copied from interface: org.omg.CosNotifyChannelAdmin.ProxySupplierOperations

Parameters:

required_qos -

available_qos -

Throws:

UnsupportedQoS - A Qos Properties isn't supported in this implementation

get_qos

public Property[] get_qos()

Operation get_qos

Following copied from interface: org.omg.CosNotification.QoSAdminOperations

Returns:

Object QosProperties

set_qos

public void set_qos(Property[] qos)
             throws UnsupportedQoS

Operation set_qos

Following copied from interface: org.omg.CosNotification.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

Following copied from interface: org.omg.CosNotification.QoSAdminOperations

Parameters:

required_qos -

available_qos -

Throws:

UnsupportedQoS -

add_filter

public int add_filter(Filter new_filter)

Operation add_filter

Following copied from interface: org.omg.CosNotifyFilter.FilterAdminOperations

Parameters:

new_filter - filter to add

Returns:

filter id

remove_filter

public void remove_filter(int filter)
                   throws FilterNotFound

Operation remove_filter

Following copied from interface: org.omg.CosNotifyFilter.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

Following copied from interface: org.omg.CosNotifyFilter.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

Following copied from interface: org.omg.CosNotifyFilter.FilterAdminOperations

Returns:

Array of all filters's id

remove_all_filters

public void remove_all_filters()

Operation remove_all_filters

pull_structured_event

public StructuredEvent pull_structured_event()
                                      throws Disconnected

Operation pull_structured_event

try_pull_structured_event

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

Operation try_pull_structured_event

disconnect_structured_pull_supplier

public void disconnect_structured_pull_supplier()

Operation disconnect_structured_pull_supplier

subscription_change

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

Operation subscription_change