org.omg.CosNotifyChannelAdmin
Class _StructuredProxyPullConsumerStub

java.lang.Object
  |
  +--org.omg.CORBA.portable.ObjectImpl
        |
        +--org.omg.CosNotifyChannelAdmin._StructuredProxyPullConsumerStub

All Implemented Interfaces:

FilterAdmin, FilterAdminOperations, org.omg.CORBA.portable.IDLEntity, NotifyPublish, NotifyPublishOperations, org.omg.CORBA.Object, ProxyConsumer, ProxyConsumerOperations, QoSAdmin, QoSAdminOperations, java.io.Serializable, StructuredProxyPullConsumer, StructuredProxyPullConsumerOperations, StructuredPullConsumer, StructuredPullConsumerOperations

public class _StructuredProxyPullConsumerStub

extends org.omg.CORBA.portable.ObjectImpl

implements StructuredProxyPullConsumer

The StructuredProxyPullConsumer interface supports connections to the channel by suppliers who will make events available for pulling to the channel as Structured Events. Through inheritance of the ProxyConsumer interface, the StructuredProxyPullConsumer 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 StructuredProxyPullConsumer 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 StructuredProxyPullConsumer interface also inherits from the StructuredPullConsumer interface defined in the CosNotifyComm module. This interface supports the operation which can be invoked to close down the connection from the supplier to the StructuredProxyPullConsumer. In addition, since the StructuredPullConsumer interface inherits from the NotifyPublish interface, a supplier can inform the StructuredProxyPullConsumer to which it is connected whenever the list of event types it plans to supply to the channel changes. Lastly, the StructuredProxyPullConsumer interface defines a method that can be invoked by a pull-style supplier of Structured Events in order to establish a connection between the supplier and a notification channel over which the supplier will proceed to send events. The StructuredProxyPullConsumer interface also defines a pair of operations which can suspend and resume the connection between a StructuredProxyPullConsumer instance and its associated StructuredPullSupplier. During the time such a connection is suspended, the StructuredProxyPullConsumer will not attempt to pull events from its associated StructuredPullSupplier.

See Also:

Serialized Form

Constructor Summary

_StructuredProxyPullConsumerStub()

Method Summary

java.lang.String[]	_ids()
int	add_filter(Filter new_filter) Operation add_filter
void	connect_structured_pull_supplier(StructuredPullSupplier pull_supplier) Operation connect_structured_pull_supplier
void	disconnect_structured_pull_consumer() Operation disconnect_structured_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

_StructuredProxyPullConsumerStub

public _StructuredProxyPullConsumerStub()

Method Detail

_ids

public java.lang.String[] _ids()

Overrides:

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

connect_structured_pull_supplier

public void connect_structured_pull_supplier(StructuredPullSupplier pull_supplier)
                                      throws AlreadyConnected,
                                             TypeError

Operation connect_structured_pull_supplier

Specified by:

connect_structured_pull_supplier in interface StructuredProxyPullConsumerOperations

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

Parameters:

push_supplier - Push supplier to connect to the proxy

Throws:

CosEventChannelAdmin::AlreadyConnected - The proxy is already connected

CosEventChannelAdmin::TypeError -

suspend_connection

public void suspend_connection()
                        throws ConnectionAlreadyInactive,
                               NotConnected

Operation suspend_connection

Specified by:

suspend_connection in interface StructuredProxyPullConsumerOperations

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

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 StructuredProxyPullConsumerOperations

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

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

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

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

Parameters:

required_qos -

available_qos -

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

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

Returns:

Object QosProperties

set_qos

public void set_qos(Property[] qos)
             throws UnsupportedQoS

Operation set_qos

Specified by:

set_qos in interface QoSAdminOperations

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

Specified by:

validate_qos in interface QoSAdminOperations

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

Specified by:

add_filter in interface FilterAdminOperations

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

Specified by:

remove_filter in interface FilterAdminOperations

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

Specified by:

get_filter in interface FilterAdminOperations

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

Specified by:

get_all_filters in interface FilterAdminOperations

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

Specified by:

remove_all_filters in interface FilterAdminOperations

disconnect_structured_pull_consumer

public void disconnect_structured_pull_consumer()

Operation disconnect_structured_pull_consumer

Specified by:

disconnect_structured_pull_consumer in interface StructuredPullConsumerOperations

offer_change

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

Operation offer_change

Specified by:

offer_change in interface NotifyPublishOperations