org.omg.CosNotifyChannelAdmin
Class _ProxyPullConsumerStub

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

All Implemented Interfaces:

java.io.Serializable, org.omg.CORBA.Object, org.omg.CORBA.portable.IDLEntity, PullConsumer, PullConsumerOperations, QoSAdmin, QoSAdminOperations, ProxyConsumer, ProxyConsumerOperations, ProxyPullConsumer, ProxyPullConsumerOperations, NotifyPublish, NotifyPublishOperations, FilterAdmin, FilterAdminOperations

public class _ProxyPullConsumerStub
extends org.omg.CORBA.portable.ObjectImpl
implements ProxyPullConsumer

The ProxyPullConsumer interface supports connections to the channel by suppliers who will make events available for pulling to the channel as untyped Anys. Through inheritance of the ProxyConsumer interface, the ProxyPullConsumer 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 ProxyPullConsumer 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 ProxyPullConsumer interface also inherits from the PullConsumer interface defined within the CosEventComm module of the OMG Event Service. This interface supports the operation required to disconnect the ProxyPullConsumer from its associated supplier. In addition, since the inherited PullConsumer interface inherits the CosNotifyComm::NotifyPublish interface, a supplier connected to an instance supporting the ProxyPullConsumer interface can inform it whenever the list of event types the supplier plans to supply changes. Finally, the ProxyPullConsumer interface defines the operation which can be invoked by a pull supplier to establish the connection over which the pull supplier will send events to the channel. Note that this can be either a pure event service style, or a notification service style pull supplier. The ProxyPullConsumer interface also defines a pair of operations which can suspend and resume the connection between a ProxyPullConsumer instance and its associated PullSupplier. During the time such a connection is suspended, the ProxyPullConsumer will not attempt to pull events from its associated PullSupplier.

See Also:

Serialized Form

Constructor Summary

_ProxyPullConsumerStub()

Method Summary

java.lang.String[]	_ids()
int	add_filter(Filter new_filter) Operation add_filter
void	connect_any_pull_supplier(PullSupplier pull_supplier) Operation connect_any_pull_supplier
void	disconnect_pull_consumer() Operation disconnect_pull_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	remove_all_filters() Operation remove_all_filters
void	remove_filter(int filter) Operation remove_filter
void	resume_connection() Operation resume_connection
void	set_qos(Property[] qos) Operation set_qos
void	suspend_connection() Operation suspend_connection
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

_ProxyPullConsumerStub

public _ProxyPullConsumerStub()

Method Detail

_ids

public java.lang.String[] _ids()

Specified by:

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

connect_any_pull_supplier

public void connect_any_pull_supplier(PullSupplier pull_supplier)
                               throws AlreadyConnected,
                                      TypeError

Operation connect_any_pull_supplier

Specified by:

connect_any_pull_supplier in interface ProxyPullConsumerOperations

Parameters:

pull_supplier - Push supplier to connect to the proxy

Throws:

AlreadyConnected

TypeError

suspend_connection

public void suspend_connection()
                        throws ConnectionAlreadyInactive,
                               NotConnected

Operation suspend_connection

Specified by:

suspend_connection in interface ProxyPullConsumerOperations

Throws:

ConnectionAlreadyInactive - Connection is already suspended

NotConnected - Proxy isn't connected

resume_connection

public void resume_connection()
                       throws ConnectionAlreadyActive,
                              NotConnected

Operation resume_connection

Specified by:

resume_connection in interface ProxyPullConsumerOperations

Throws:

ConnectionAlreadyActive - Connection is already active

NotConnected - Proxy isn't connected

MyType

public ProxyType MyType()

Read accessor for MyType attribute

Specified by:

MyType in interface ProxyConsumerOperations

Returns:

the attribute value

MyAdmin

public SupplierAdmin MyAdmin()

Read accessor for MyAdmin attribute

Specified by:

MyAdmin in interface ProxyConsumerOperations

Returns:

the attribute value

obtain_subscription_types

public EventType[] obtain_subscription_types(ObtainInfoMode mode)

Operation obtain_subscription_types

Specified by:

obtain_subscription_types in interface ProxyConsumerOperations

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

Specified by:

validate_event_qos in interface ProxyConsumerOperations

Throws:

UnsupportedQoS - Qos Property was not 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

offer_change

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

Operation offer_change

Specified by:

offer_change in interface NotifyPublishOperations

Throws:

InvalidEventType

disconnect_pull_consumer

public void disconnect_pull_consumer()

Operation disconnect_pull_consumer

Specified by:

disconnect_pull_consumer in interface PullConsumerOperations