org.omg.CosNotifyChannelAdmin
Class _SequenceProxyPushSupplierStub

java.lang.Object
  extended by org.omg.CORBA.portable.ObjectImpl
      extended by org.omg.CosNotifyChannelAdmin._SequenceProxyPushSupplierStub
All Implemented Interfaces:
java.io.Serializable, org.omg.CORBA.Object, org.omg.CORBA.portable.IDLEntity, QoSAdmin, QoSAdminOperations, ProxySupplier, ProxySupplierOperations, SequenceProxyPushSupplier, SequenceProxyPushSupplierOperations, NotifySubscribe, NotifySubscribeOperations, SequencePushSupplier, SequencePushSupplierOperations, FilterAdmin, FilterAdminOperations

public class _SequenceProxyPushSupplierStub
extends org.omg.CORBA.portable.ObjectImpl
implements SequenceProxyPushSupplier

The SequenceProxyPushSupplier interface supports connections to the channel by consumers who will receive events from the channel as sequences of Structured Events. Through inheritance of the ProxySupplier interface, the SequenceProxyPushSupplier 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 SequenceProxyPushSupplier 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 SequenceProxyPushSupplier interface also inherits from the SequencePushSupplier interface defined in the CosNotifyComm module. This interface supports the operation which can be invoked to close down the connection from the consumer to the SequenceProxyPushSupplier. In addition, since the SequencePushSupplier interface inherits from the NotifySubscribe interface, a SequenceProxyPushSupplier 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 SequenceProxyPushSupplier interface defines the operation which can be invoked by a push consumer to establish the connection over which the push consumer will receive events from the channel. The SequenceProxyPushSupplier interface also defines a pair of operations which can suspend and resume the connection between a SequenceProxyPushSupplier instance and its associated SequencePushConsumer. During the time such a connection is suspended, the SequenceProxyPushSupplier will accumulate events destined for the consumer but not transmit them until the connection is resumed.

See Also:
Serialized Form

Constructor Summary
_SequenceProxyPushSupplierStub()
           
 
Method Summary
 java.lang.String[] _ids()
           
 int add_filter(Filter new_filter)
          Operation add_filter
 void connect_sequence_push_consumer(SequencePushConsumer push_consumer)
          Operation connect_sequence_push_consumer
 void disconnect_sequence_push_supplier()
          Operation disconnect_sequence_push_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
 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 subscription_change(EventType[] added, EventType[] removed)
          Operation subscription_change
 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
 

Constructor Detail

_SequenceProxyPushSupplierStub

public _SequenceProxyPushSupplierStub()
Method Detail

_ids

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

connect_sequence_push_consumer

public void connect_sequence_push_consumer(SequencePushConsumer push_consumer)
                                    throws AlreadyConnected,
                                           TypeError
Operation connect_sequence_push_consumer

Specified by:
connect_sequence_push_consumer in interface SequenceProxyPushSupplierOperations
Throws:
AlreadyConnected
TypeError

suspend_connection

public void suspend_connection()
                        throws ConnectionAlreadyInactive,
                               NotConnected
Operation suspend_connection

Specified by:
suspend_connection in interface SequenceProxyPushSupplierOperations
Throws:
ConnectionAlreadyInactive
NotConnected

resume_connection

public void resume_connection()
                       throws ConnectionAlreadyActive,
                              NotConnected
Operation resume_connection

Specified by:
resume_connection in interface SequenceProxyPushSupplierOperations
Throws:
ConnectionAlreadyActive
NotConnected

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

disconnect_sequence_push_supplier

public void disconnect_sequence_push_supplier()
Operation disconnect_sequence_push_supplier

Specified by:
disconnect_sequence_push_supplier in interface SequencePushSupplierOperations

subscription_change

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

Specified by:
subscription_change in interface NotifySubscribeOperations
Throws:
InvalidEventType