|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.omg.PortableServer.Servant
org.omg.CosNotifyChannelAdmin.EventChannelPOA
org.openorb.notify.impl.EventChannelImpl
public class EventChannelImpl
The EventChannel interface encapsulates the behaviors supported by a Notification Service event channel. This interface inherits from the EventChannel interface defined within the CosEventChannelAdmin module of the OMG Event Service, making an instance of the Notification Service EventChannel interface fully backward compatible with an OMG Event Service style untyped event channel. Inheritance of the EventChannel interface defined within the CosEventChannelAdmin module enables an instance of the EventChannel interface defined within the CosNotifyChannelAdmin module to create event service style ConsumerAdmin and SupplierAdmin instances. These instances can subsequently be used to create pure event service style proxy interfaces, which support connections to pure event service style suppliers and consumers. Note that while Notification Service style proxies and admin objects have unique identifiers associated with them, enabling their references to be obtained by invoking operations on the Notification Service style admin and event channel interfaces, Event Service style proxies and admin objects do not have associated unique identifiers, and thus cannot be returned by invoking an operation on the Notification Service style admin or event channel interfaces. The EventChannel interface defined within the CosNotifyChannelAdmin module also inherits from the QoSAdmin and the AdminPropertiesAdmin interfaces defined within the CosNotification module. Inheritance of these interfaces enables a Notification Service style event channel to manage lists of associated QoS and administrative properties, respectively. Locally, the EventChannel interface supports a readonly attribute which maintains a reference to the EventChannelFactory instance that created it. In addition, each instance of the EventChannel interface has an associated default ConsumerAdmin and an associated default SupplierAdmin instance, both of which exist upon creation of the channel and which have the unique identifier of zero (note that admin object identifiers only need to be unique among a given type of admin, implying that the identifiers assigned to ConsumerAdmin objects can overlap those assigned to SupplierAdmin objects). The EventChannel interface supports readonly attributes which maintain references to these default admin objects. The EventChannel interface supports operations which create new ConsumerAdmin and SupplierAdmin instances. In addition, the EventChannel interface supports operations which can return references to the ConsumerAdmin and SupplierAdmin instances associated with a given EventChannel instance, given the unique identifier of an admin object as input. Finally, the EventChannel interface supports operations which return the sequence of unique identifiers of all ConsumerAdmin and SupplierAdmin instances associated with a given EventChannel instance.
Constructor Summary | |
---|---|
EventChannelImpl(EventChannelFactoryImpl factory,
EventChannel pssEventChannel,
org.omg.PortableServer.POA poa,
Logger logger)
Constructor -- used for recovery only |
|
EventChannelImpl(EventChannelFactoryImpl factory,
org.omg.CORBA.ORB orb,
org.omg.PortableServer.POA poa,
Property[] qosProperties,
Property[] adminProperties,
int channelId,
Logger logger)
Default constructor |
Method Summary | |
---|---|
boolean |
canConnectConsumer()
Method invoked to check if the MaxConsumers admin property applies |
boolean |
canConnectSupplier()
Method invoked to check if the MaxSuppliers admin property applies |
boolean |
canDispatchNewEvent()
Method invoked to check if the MaxQueueLength admin property applies |
void |
consumerAdminRecovered(int id,
ConsumerAdminImpl consumerAdmin)
This method is invoked when a ConsumerAdmin was recovered |
ConsumerAdmin |
default_consumer_admin()
The default_consumer_admin attribute is a readonly attribute which maintains a reference to the default ConsumerAdmin instance associated with the target EventChannel instance. |
FilterFactory |
default_filter_factory()
The default_filter_factory attribute is a readonly attribute which maintains an object reference to the default factory to be used by the EventChannel instance with which it's associated for creating filter objects. |
SupplierAdmin |
default_supplier_admin()
The default_supplier_admin attribute is a readonly attribute which maintains a reference to the default SupplierAdmin instance associated with the target EventChannel instance. |
void |
destroy()
Operation destroy |
ConsumerAdmin |
for_consumers()
Operation for_consumers |
SupplierAdmin |
for_suppliers()
Operation for_suppliers |
Property[] |
get_admin()
The get_admin operation takes no input parameters, and returns a sequence of name-value pairs which encapsulates the current administrative settings for the target channel. |
int[] |
get_all_consumeradmins()
The get_all_consumeradmins operation takes no input parameters and returns a sequence of the unique identifiers assigned to all Notification Service style ConsumerAdmin instances which have been created by the target EventChannel instance. |
int[] |
get_all_supplieradmins()
The get_all_supplieradmins operation takes no input parameters and returns a sequence of the unique identifiers assigned to all Notification Service style SupplierAdmin instances which have been created by the target EventChannel instance. |
ConsumerAdmin |
get_consumeradmin(int id)
The get_consumeradmin operation returns a reference to one of the ConsumerAdmin instances associated with the target EventChannel instance. |
Property[] |
get_qos()
The get_qos operation takes no input parameters, and returns a sequence of name-value pairs which encapsulates the current quality of service settings for the target object (which could be an Event Channel, Admin, or Proxy object). |
SupplierAdmin |
get_supplieradmin(int id)
The get_supplieradmin operation returns a reference to one of the SupplierAdmin instances associated with the target EventChannel instance. |
java.lang.String |
getId()
Get the ID of the channel |
java.lang.Object |
getNotifyProperty(java.lang.String key)
Method invoked to get the value of a property defined in the notification module |
byte[] |
getPid()
Returns the pid of the persistent/transient object |
boolean |
isConsumerAdminMaxPerformance()
The methods returns true if the consumer admin threads should be configured as MaxPerformance |
boolean |
isConsumerProxyMaxPerformance()
The methods returns true if the supplier proxy threads should be configured as MaxPerformance |
boolean |
isEventQueueLogged()
TODO |
boolean |
isFilterEvaluationLogged()
TODO |
boolean |
isQueueMaxPerformance()
The methods returns true if the event queue should be configured as MaxPerformance |
boolean |
isSupplierAdminMaxPerformance()
The methods returns true if the supplier admin threads should be configured as MaxPerformance |
boolean |
isSupplierProxyMaxPerformance()
The methods returns true if the consumer proxy threads should be configured as MaxPerformance |
EventChannelFactory |
MyFactory()
The MyFactory attribute is a readonly attribute which maintains the object reference of the event channel factory that created a given Notification Service EventChannel instance. |
ConsumerAdmin |
new_for_consumers(InterFilterGroupOperator op,
org.omg.CORBA.IntHolder id)
The new_for_consumers operation is invoked to create a new Notification Service style ConsumerAdmin instance. |
SupplierAdmin |
new_for_suppliers(InterFilterGroupOperator op,
org.omg.CORBA.IntHolder id)
The new_for_suppliers operation is invoked to create a new Notification Service style SupplierAdmin instance. |
void |
receiveEvent(java.lang.Object event)
New event available |
void |
reportConsumerAdminDestruction(byte[] adminPid)
A consumer admin has been destroyed |
void |
reportConsumerConnection()
A proxy consumer has been created |
void |
reportConsumerDisconnection()
A proxy consumer has been destroyed |
void |
reportEventDelivery(int consumerAdminId,
int eventPid)
An event has been delivered or discarded |
void |
reportEventTypesPublished(EventType[] published,
EventType[] unpublished,
org.omg.CORBA.Object source)
Method invoked when an EventType is being subscribed by a consumer. |
void |
reportEventTypesSubscribed(EventType[] subscribed,
EventType[] unsubscribed,
org.omg.CORBA.Object source)
Method invoked when an EventType is being subscribed by a consumer |
void |
reportSupplierAdminDestruction(byte[] adminPid)
A supplier admin has been destroyed |
void |
reportSupplierConnection()
A proxy supplier has been created |
void |
reportSupplierDisconnection()
A proxy supplier has been destroyed |
void |
set_admin(Property[] admin)
The set_admin operation takes as an input parameter a sequence of name-value pairs which encapsulates administrative property settings that a client is requesting that the target channel support. |
void |
set_qos(Property[] qos)
The set_qos operation takes as an input parameter a sequence of name-value pairs which encapsulates quality of service property settings that a client is requesting that the target object (which could be an Event Channel, Admin, or Proxy object) support as its default quality of service. |
void |
supplierAdminRecovered(int id,
SupplierAdminImpl supplierAdmin)
This method is invoked when a SupplierAdmin was recovered |
void |
validate_qos(Property[] required_qos,
NamedPropertyRangeSeqHolder available_qos)
The validate_qos operation accepts as input a sequence of QoS property name-value pairs which specify a set of QoS settings that a client would like to know if the target object is capable of supporting. |
Methods inherited from class org.omg.CosNotifyChannelAdmin.EventChannelPOA |
---|
_all_interfaces, _invoke, _this, _this |
Methods inherited from class org.omg.PortableServer.Servant |
---|
_default_POA, _get_delegate, _get_interface_def, _is_a, _non_existent, _object_id, _orb, _poa, _set_delegate, _this_object, _this_object |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public EventChannelImpl(EventChannelFactoryImpl factory, org.omg.CORBA.ORB orb, org.omg.PortableServer.POA poa, Property[] qosProperties, Property[] adminProperties, int channelId, Logger logger)
public EventChannelImpl(EventChannelFactoryImpl factory, EventChannel pssEventChannel, org.omg.PortableServer.POA poa, Logger logger)
Method Detail |
---|
public EventChannelFactory MyFactory()
public ConsumerAdmin default_consumer_admin()
public SupplierAdmin default_supplier_admin()
public FilterFactory default_filter_factory()
public ConsumerAdmin new_for_consumers(InterFilterGroupOperator op, org.omg.CORBA.IntHolder id)
op
- Operator of Filters' composition (between consumer filters and proxies filters)id
- Id of the new consumer admin
public SupplierAdmin new_for_suppliers(InterFilterGroupOperator op, org.omg.CORBA.IntHolder id)
op
- Operator of Filters' composition (between supplier filters and proxies filters)id
- Id of the new consumer admin
public ConsumerAdmin get_consumeradmin(int id) throws AdminNotFound
id
- Id of consumer admin to retreive
AdminNotFound
- Id doesn't correspond to any consumer adminpublic SupplierAdmin get_supplieradmin(int id) throws AdminNotFound
id
- Id of supplier admin to retreive
AdminNotFound
- Id doesn't correspond to any supplier adminpublic int[] get_all_consumeradmins()
public int[] get_all_supplieradmins()
public Property[] get_qos()
get_qos
in interface QoSAdminOperations
public void set_qos(Property[] qos) throws UnsupportedQoS
set_qos
in interface QoSAdminOperations
qos
- QosProperties to assign to object
UnsupportedQoS
public void validate_qos(Property[] required_qos, NamedPropertyRangeSeqHolder available_qos) throws UnsupportedQoS
validate_qos
in interface QoSAdminOperations
required_qos
- available_qos
-
UnsupportedQoS
public Property[] get_admin()
get_admin
in interface AdminPropertiesAdminOperations
public void set_admin(Property[] admin) throws UnsupportedAdmin
set_admin
in interface AdminPropertiesAdminOperations
admin
- Array of admin property
UnsupportedAdmin
- If implementation doesn't support a propertypublic ConsumerAdmin for_consumers()
for_consumers
in interface EventChannelOperations
public SupplierAdmin for_suppliers()
for_suppliers
in interface EventChannelOperations
public void destroy()
destroy
in interface EventChannelOperations
public void receiveEvent(java.lang.Object event)
receiveEvent
in interface EventReceiver
public java.lang.String getId()
getId
in interface ChannelManagement
public void consumerAdminRecovered(int id, ConsumerAdminImpl consumerAdmin)
consumerAdminRecovered
in interface ChannelManagement
public void supplierAdminRecovered(int id, SupplierAdminImpl supplierAdmin)
supplierAdminRecovered
in interface ChannelManagement
public void reportConsumerAdminDestruction(byte[] adminPid)
reportConsumerAdminDestruction
in interface ChannelManagement
public void reportSupplierAdminDestruction(byte[] adminPid)
reportSupplierAdminDestruction
in interface ChannelManagement
public void reportSupplierConnection()
reportSupplierConnection
in interface ChannelManagement
public boolean canConnectConsumer()
canConnectConsumer
in interface ChannelManagement
public void reportConsumerConnection()
reportConsumerConnection
in interface ChannelManagement
public boolean canConnectSupplier()
canConnectSupplier
in interface ChannelManagement
public void reportSupplierDisconnection()
reportSupplierDisconnection
in interface ChannelManagement
public void reportConsumerDisconnection()
reportConsumerDisconnection
in interface ChannelManagement
public void reportEventDelivery(int consumerAdminId, int eventPid)
reportEventDelivery
in interface ChannelManagement
public boolean canDispatchNewEvent()
canDispatchNewEvent
in interface ChannelManagement
public void reportEventTypesPublished(EventType[] published, EventType[] unpublished, org.omg.CORBA.Object source)
reportEventTypesPublished
in interface ChannelManagement
public void reportEventTypesSubscribed(EventType[] subscribed, EventType[] unsubscribed, org.omg.CORBA.Object source)
reportEventTypesSubscribed
in interface ChannelManagement
public java.lang.Object getNotifyProperty(java.lang.String key)
getNotifyProperty
in interface ChannelManagement
public boolean isQueueMaxPerformance()
isQueueMaxPerformance
in interface ChannelManagement
public boolean isSupplierAdminMaxPerformance()
isSupplierAdminMaxPerformance
in interface ChannelManagement
public boolean isConsumerAdminMaxPerformance()
isConsumerAdminMaxPerformance
in interface ChannelManagement
public boolean isSupplierProxyMaxPerformance()
isSupplierProxyMaxPerformance
in interface ChannelManagement
public boolean isConsumerProxyMaxPerformance()
isConsumerProxyMaxPerformance
in interface ChannelManagement
public boolean isEventQueueLogged()
isEventQueueLogged
in interface ChannelManagement
public boolean isFilterEvaluationLogged()
isFilterEvaluationLogged
in interface ChannelManagement
public byte[] getPid()
getPid
in interface PersistenceManagement
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |