com.prosysopc.ua.server
Interface EventManagerListener


public interface EventManagerListener

Listener for OPC UA Condition control commands from the client.


Method Summary
 boolean onAcknowledge(ServiceContext serviceContext, AcknowledgeableConditionTypeNode condition, org.opcfoundation.ua.builtintypes.ByteString eventId, org.opcfoundation.ua.builtintypes.LocalizedText comment)
          Notifies that the client wants to acknowledge a condition event.
 boolean onAddComment(ServiceContext serviceContext, ConditionTypeNode condition, org.opcfoundation.ua.builtintypes.ByteString eventId, org.opcfoundation.ua.builtintypes.LocalizedText comment)
          Notifies that the client wants to add a new comment to the event.
 void onAfterCreateMonitoredEventItem(ServiceContext serviceContext, Subscription subscription, MonitoredEventItem item)
          Notification after a MonitoredEventItem was created.
 void onAfterDeleteMonitoredEventItem(ServiceContext serviceContext, Subscription subscription, MonitoredEventItem item)
          Notification after a MonitoredEventItem was deleted from the subscription.
 void onAfterModifyMonitoredEventItem(ServiceContext serviceContext, Subscription subscription, MonitoredEventItem item)
          Notification after a MonitoredEventItem was modified.
 void onConditionRefresh(ServiceContext serviceContext, Subscription subscription)
          Handle a ConditionRefresh call from a client.
 boolean onConfirm(ServiceContext serviceContext, AcknowledgeableConditionTypeNode condition, org.opcfoundation.ua.builtintypes.ByteString eventId, org.opcfoundation.ua.builtintypes.LocalizedText comment)
          Notifies that the client wants to confirm a condition event.
 void onCreateMonitoredEventItem(ServiceContext serviceContext, org.opcfoundation.ua.builtintypes.NodeId nodeId, org.opcfoundation.ua.core.EventFilter eventFilter, org.opcfoundation.ua.core.EventFilterResult eventFilterResult)
          Notification of a new MonitoredEventItem request from a client application.
 void onDeleteMonitoredEventItem(ServiceContext serviceContext, Subscription subscription, MonitoredEventItem monitoredItem)
          Notification of an event item being removed from a client subscription.
 boolean onDisable(ServiceContext serviceContext, ConditionTypeNode condition)
          Notifies that the client wants to disable a condition.
 boolean onEnable(ServiceContext serviceContext, ConditionTypeNode condition)
          Notifies that the client wants to enable a condition.
 void onModifyMonitoredEventItem(ServiceContext serviceContext, Subscription subscription, MonitoredEventItem monitoredItem, org.opcfoundation.ua.core.EventFilter eventFilter, org.opcfoundation.ua.core.EventFilterResult eventFilterResult)
          Notification of a modify request to the monitoring parameters of a monitored event item.
 boolean onOneshotShelve(ServiceContext serviceContext, AlarmConditionTypeNode condition, ShelvedStateMachineTypeNode stateMachine)
          Notification of an OneshotShelve request for an Alarm object.
 boolean onTimedShelve(ServiceContext serviceContext, AlarmConditionTypeNode condition, ShelvedStateMachineTypeNode stateMachine, double shelvingTime)
          Notification of a TimedShelve request for an Alarm object.
 boolean onUnshelve(ServiceContext serviceContext, AlarmConditionTypeNode condition, ShelvedStateMachineTypeNode stateMachine)
          Notification of an Unshelve request for an Alarm object.
 

Method Detail

onAcknowledge

boolean onAcknowledge(ServiceContext serviceContext,
                      AcknowledgeableConditionTypeNode condition,
                      org.opcfoundation.ua.builtintypes.ByteString eventId,
                      org.opcfoundation.ua.builtintypes.LocalizedText comment)
                      throws StatusException
Notifies that the client wants to acknowledge a condition event.

Parameters:
serviceContext - the client calling context
condition - the condition that should be acknowledged
eventId - the ID of the event
comment - the user comment to add to the event
Throws:
StatusException

onAddComment

boolean onAddComment(ServiceContext serviceContext,
                     ConditionTypeNode condition,
                     org.opcfoundation.ua.builtintypes.ByteString eventId,
                     org.opcfoundation.ua.builtintypes.LocalizedText comment)
                     throws StatusException
Notifies that the client wants to add a new comment to the event.

Parameters:
serviceContext - the client calling context
condition - the condition that should be acknowledged
eventId - the event occurrence being commented
comment - the user comment to add to the event
Throws:
StatusException

onAfterCreateMonitoredEventItem

void onAfterCreateMonitoredEventItem(ServiceContext serviceContext,
                                     Subscription subscription,
                                     MonitoredEventItem item)
Notification after a MonitoredEventItem was created.

Parameters:
serviceContext - the client calling context
subscription - the subscription
item - the item that was created

onAfterDeleteMonitoredEventItem

void onAfterDeleteMonitoredEventItem(ServiceContext serviceContext,
                                     Subscription subscription,
                                     MonitoredEventItem item)
Notification after a MonitoredEventItem was deleted from the subscription.

Parameters:
serviceContext - the client calling context
subscription - the subscription
item - the item that was deleted

onAfterModifyMonitoredEventItem

void onAfterModifyMonitoredEventItem(ServiceContext serviceContext,
                                     Subscription subscription,
                                     MonitoredEventItem item)
Notification after a MonitoredEventItem was modified.

The method is called whenever the item filter or the MonitoringMode is changed. The filter change is also notified in onModifyMonitoredEventItem(ServiceContext, Subscription, MonitoredEventItem, EventFilter, EventFilterResult) where you can verify it. MonitoringMode is only notified here after it has been changed.

Parameters:
serviceContext - the client calling context
subscription - the subscription
item - the item that was modified

onConditionRefresh

void onConditionRefresh(ServiceContext serviceContext,
                        Subscription subscription)
                        throws StatusException
Handle a ConditionRefresh call from a client.

Parameters:
serviceContext - the client calling context
subscription - the subscription to refresh
Throws:
StatusException

onConfirm

boolean onConfirm(ServiceContext serviceContext,
                  AcknowledgeableConditionTypeNode condition,
                  org.opcfoundation.ua.builtintypes.ByteString eventId,
                  org.opcfoundation.ua.builtintypes.LocalizedText comment)
                  throws StatusException
Notifies that the client wants to confirm a condition event.

Parameters:
serviceContext - the client calling context
condition - the condition that should be acknowledged
eventId - the ID of the event
comment - the user comment to add to the event
Throws:
StatusException

onCreateMonitoredEventItem

void onCreateMonitoredEventItem(ServiceContext serviceContext,
                                org.opcfoundation.ua.builtintypes.NodeId nodeId,
                                org.opcfoundation.ua.core.EventFilter eventFilter,
                                org.opcfoundation.ua.core.EventFilterResult eventFilterResult)
                                throws StatusException
Notification of a new MonitoredEventItem request from a client application.

Parameters:
serviceContext - the client calling context
nodeId - the node that will be monitored
eventFilter - the event filter, which defines the nodes and events to monitor
eventFilterResult - the filter results to fill in, if there is something to note about the requested filter. This is defined as OK by default.
Throws:
StatusException - if the item cannot or may not be created.

onDeleteMonitoredEventItem

void onDeleteMonitoredEventItem(ServiceContext serviceContext,
                                Subscription subscription,
                                MonitoredEventItem monitoredItem)
Notification of an event item being removed from a client subscription.

Parameters:
serviceContext - the client calling context
subscription - the subscription from which the item is being removed
monitoredItem - the monitored item to remove

onDisable

boolean onDisable(ServiceContext serviceContext,
                  ConditionTypeNode condition)
                  throws StatusException
Notifies that the client wants to disable a condition.

Parameters:
serviceContext - the client calling context
condition - the condition that should be disabled
Throws:
StatusException

onEnable

boolean onEnable(ServiceContext serviceContext,
                 ConditionTypeNode condition)
                 throws StatusException
Notifies that the client wants to enable a condition.

Parameters:
serviceContext - the client calling context
condition - the condition that should be enabled
Throws:
StatusException

onModifyMonitoredEventItem

void onModifyMonitoredEventItem(ServiceContext serviceContext,
                                Subscription subscription,
                                MonitoredEventItem monitoredItem,
                                org.opcfoundation.ua.core.EventFilter eventFilter,
                                org.opcfoundation.ua.core.EventFilterResult eventFilterResult)
                                throws StatusException
Notification of a modify request to the monitoring parameters of a monitored event item.

Parameters:
serviceContext - the client calling context
subscription - the subscription to which the item is being added
monitoredItem - the monitored event item to modify
eventFilter - the event filter, which defines the nodes and events to monitor
eventFilterResult - the filter results to fill in, if there is something to note about the requested filter. This is filled in by the default filter handler.
Throws:
StatusException

onOneshotShelve

boolean onOneshotShelve(ServiceContext serviceContext,
                        AlarmConditionTypeNode condition,
                        ShelvedStateMachineTypeNode stateMachine)
                        throws StatusException
Notification of an OneshotShelve request for an Alarm object.

Parameters:
serviceContext - the client calling context
condition - the condition object concerned
stateMachine - the state machine that is being shelved
Returns:
true if the request is handled in the listener.
Throws:
StatusException - if the arguments are incorrect or any other error needs to be returned to the client. Specifically, Bad_ConditionAlreadyShelved, if the Alarm is already in OneshotShelved state.

onTimedShelve

boolean onTimedShelve(ServiceContext serviceContext,
                      AlarmConditionTypeNode condition,
                      ShelvedStateMachineTypeNode stateMachine,
                      double shelvingTime)
                      throws StatusException
Notification of a TimedShelve request for an Alarm object.

Parameters:
serviceContext - the client calling context
condition - the condition object concerned
stateMachine - the state machine that is being shelved
shelvingTime - specifies a fixed time for which the Alarm is to be shelved (in milliseconds). The Server may refuse the provided duration. If a MaxTimeShelved Property exist on the Alarm than the Shelving time shall be less than or equal to the value of this Property.
Returns:
true if the request is handled in the listener.
Throws:
StatusException - if the arguments are incorrect or any other error needs to be returned to the client. Specifically, Bad_ConditionAlreadyShelved, if the Alarm is already in TimedShelved state and the system does not allow a reset of the shelved timer; or Bad_ShelvingTimeOutOfRange, if the requested time exceeds the MaxTimeShelved (optional property) defined in the alarm.

onUnshelve

boolean onUnshelve(ServiceContext serviceContext,
                   AlarmConditionTypeNode condition,
                   ShelvedStateMachineTypeNode stateMachine)
                   throws StatusException
Notification of an Unshelve request for an Alarm object.

Parameters:
serviceContext - the client calling context
condition - the condition object concerned
stateMachine - the state machine that is being unshelved
Returns:
true if the request is handled in the listener.
Throws:
StatusException - if the arguments are incorrect or any other error needs to be returned to the client. Specifically, Bad_ConditionNotShelved, if the Alarm is not in OneshotShelved or TimedShelved state.


Copyright © 2018. All rights reserved.