org.omg.CosNotifyChannelAdmin
Class _ProxyPullSupplierStub

java.lang.Object
  org.omg.CORBA.portable.ObjectImpl
      org.omg.CosNotifyChannelAdmin._ProxyPullSupplierStub

All Implemented Interfaces:

java.io.Serializable, org.omg.CORBA.Object, org.omg.CORBA.portable.IDLEntity, PullSupplier, PullSupplierOperations, QoSAdmin, QoSAdminOperations, ProxyPullSupplier, ProxyPullSupplierOperations, ProxySupplier, ProxySupplierOperations, NotifySubscribe, NotifySubscribeOperations, FilterAdmin, FilterAdminOperations

public class _ProxyPullSupplierStub
extends org.omg.CORBA.portable.ObjectImpl
implements ProxyPullSupplier

The ProxyPullSupplier interface supports connections to the channel by consumers who will pull events from the channel as untyped Anys. Through inheritance of the ProxySupplier interface, the ProxyPullSupplier interface supports administration of various QoS properties, administration of a list of associated filter objects, mapping filters for event priority and lifetime, and a readonly attribute containing the reference of the ConsumerAdmin object which created it. In addition, this inheritance implies that a ProxyPullSupplier 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 ProxyPullSupplier interface also inherits from the PullSupplier interface defined within the CosNotifyComm module. This interface supports the pull and try_pull operations which the consumer connected to a ProxyPullSupplier instance will invoke to receive an event from the channel in the form of an Any, and the operation required to disconnect the ProxyPullSupplier from its associated consumer. In addition, since the inherited PullSupplier interface inherits the CosNotifyComm::NotifySubscribe interface, an instance supporting the ProxyPullSupplier interface can be informed whenever the list of event types that the consumer connected to it is interested in receiving changes. Finally, the ProxyPullSupplier interface defines the operation which can be invoked by a pull consumer to establish the connection over which the pull consumer will receive events from the channel. Note that this can be either a pure event service style, or a notification service style pull consumer.

See Also:

Serialized Form

Constructor Summary

_ProxyPullSupplierStub()

Method Summary

java.lang.String[]	_ids()
int	add_filter(Filter new_filter) Operation add_filter
void	connect_any_pull_consumer(PullConsumer pull_consumer) Operation connect_any_pull_consumer
void	disconnect_pull_supplier() Operation disconnect_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
org.omg.CORBA.Any	pull() Operation pull
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
org.omg.CORBA.Any	try_pull(org.omg.CORBA.BooleanHolder has_event) Operation try_pull
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

Methods inherited from interface org.omg.CORBA.Object

_create_request, _create_request, _duplicate, _get_domain_managers, _get_interface_def, _get_policy, _hash, _is_a, _is_equivalent, _non_existent, _release, _request, _set_policy_override

Constructor Detail

_ProxyPullSupplierStub

public _ProxyPullSupplierStub()

Method Detail

_ids

public java.lang.String[] _ids()

Specified by:

_ids in class org.omg.CORBA.portable.ObjectImpl

connect_any_pull_consumer

public void connect_any_pull_consumer(PullConsumer pull_consumer)
                               throws AlreadyConnected

Operation connect_any_pull_consumer

Specified by:

connect_any_pull_consumer in interface ProxyPullSupplierOperations

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

subscription_change

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

Operation subscription_change

Specified by:

subscription_change in interface NotifySubscribeOperations

Throws:

InvalidEventType

pull

public org.omg.CORBA.Any pull()
                       throws Disconnected

Operation pull

Specified by:

pull in interface PullSupplierOperations

Throws:

Disconnected

try_pull

public org.omg.CORBA.Any try_pull(org.omg.CORBA.BooleanHolder has_event)
                           throws Disconnected

Operation try_pull

Specified by:

try_pull in interface PullSupplierOperations

Throws:

Disconnected

disconnect_pull_supplier

public void disconnect_pull_supplier()

Operation disconnect_pull_supplier

Specified by:

disconnect_pull_supplier in interface PullSupplierOperations