org.omg.CosNotifyChannelAdmin
Class _ProxySupplierStub

java.lang.Object
  extended by org.omg.CORBA.portable.ObjectImpl
      extended by org.omg.CosNotifyChannelAdmin._ProxySupplierStub
All Implemented Interfaces:
java.io.Serializable, org.omg.CORBA.Object, org.omg.CORBA.portable.IDLEntity, QoSAdmin, QoSAdminOperations, ProxySupplier, ProxySupplierOperations, FilterAdmin, FilterAdminOperations

public class _ProxySupplierStub
extends org.omg.CORBA.portable.ObjectImpl
implements ProxySupplier

The ProxySupplier interface is intended to be an abstract interface that is inherited by the different varieties of proxy suppliers that can be instantiated within a notification channel. It encapsulates the behaviors common to all Notification Service proxy suppliers. In particular, the ProxySupplier interface inherits the QoSAdmin interface defined within the CosNotification module, and the FilterAdmin interface defined within the CosNotifyFilter module. The former inheritance enables all proxy suppliers to administer a list of associated QoS properties, while the latter inheritance enables all proxy suppliers to administer a list of associated filter objects. Locally, the ProxySupplier interface defines a readonly attribute that should be set upon creation of each proxy supplier instance to indicate the specific type of proxy supplier the instance represents, and a readonly attribute which maintains a reference to the ConsumerAdmin object that created it. In addition, the ProxySupplier interface defines attributes that associate with each proxy supplier two mapping filter objects, one for priority and one for lifetime. As described in section 2.3.1, these mapping filter objects enable proxy suppliers to be configured to alter the way they treat events with respect to their priority and lifetime based on the type and contents of each individual event. Lastly, the ProxySupplier interface defines an operation that returns the list of event types that a given proxy supplier could potentially forward to its associated consumer, and an operation which can be queried to determine which message level QoS properties can be set on a per-event basis.

See Also:
Serialized Form

Constructor Summary
_ProxySupplierStub()
           
 
Method Summary
 java.lang.String[] _ids()
           
 int add_filter(Filter new_filter)
          Operation add_filter
 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 set_qos(Property[] qos)
          Operation set_qos
 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
 
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

_ProxySupplierStub

public _ProxySupplierStub()
Method Detail

_ids

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

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