com.prosysopc.ua.server

Class EventManagerRoot

java.lang.Object

com.prosysopc.ua.server.ServiceManagerBase

com.prosysopc.ua.server.EventManager

com.prosysopc.ua.server.EventManagerUaNode

com.prosysopc.ua.server.EventManagerRoot

All Implemented Interfaces:

CallableListener

public class EventManagerRoot
extends EventManagerUaNode

A special EventManager for NodeManagerRoot. Handles ConditionReferesh methods.

Field Summary

Fields inherited from class com.prosysopc.ua.server.EventManager

listener, RESULT_OK

Constructor Summary

Constructors

Constructor and Description
EventManagerRoot(NodeManager nodeManager)

Method Summary

Modifier and Type	Method and Description
boolean	onCall(ServiceContext serviceContext, NodeId objectId, UaNode object, NodeId methodId, UaMethod method, Variant[] inputArguments, StatusCode[] inputArgumentResults, DiagnosticInfo[] inputArgumentDiagnosticInfos, Variant[] output) A method call notification.
protected boolean	refresh(ServiceContext serviceContext, Subscription subscription) Handle a ConditionRefresh call from a client.
protected boolean	refresh(ServiceContext serviceContext, Subscription subscription, MonitoredEventItem monitoredItem) Handle a ConditionRefresh2 call from a client.
protected void	refreshEndEvent(MonitoredEventItem monitoredItem) Trigger a RefreshEndEventType.
protected void	refreshEndEvent(Subscription subscription) Trigger a RefreshEndEventType.
protected void	refreshStartEvent(MonitoredEventItem monitoredItem) Trigger a RefreshStartEventType.
protected void	refreshStartEvent(Subscription subscription) Trigger a RefreshStartEventType.

Methods inherited from class com.prosysopc.ua.server.EventManagerUaNode

acknowledge, addComment, collectConditions, confirm, disable, enable, getConditions, getConditions, getConditions, oneshotshelve, refreshItem, requireUaNode, timedshelve, unshelve

Methods inherited from class com.prosysopc.ua.server.EventManager

afterCreateMonitoredEventItem, afterDeleteMonitoredEventItem, afterModifyMonitoredEventItem, createEventId, createFullEventId, createMonitoredEventItem, deleteMonitoredEventItem, extractUserEventId, fireConditionRefresh, fireConditionRefresh2, getListener, getNodeManager, methodEqualsIdOrName, modifyMonitoredEventItem, refreshItems, setListener

Methods inherited from class com.prosysopc.ua.server.ServiceManagerBase

arrayDimensionsMatch, checkIsMethod, checkIsValueNode, checkIsVariable, checkIsVariableOrVariableType, dataTypeEquals, getNode, getNode, getNode, getNode, getNodeManagerTable, getServer, getSubscriptionManager, invalidatePreviousNodeCache, isValueNode, isVariable, listenerError

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EventManagerRoot

public EventManagerRoot(NodeManager nodeManager)

Method Detail

onCall

public boolean onCall(ServiceContext serviceContext,
                      NodeId objectId,
                      UaNode object,
                      NodeId methodId,
                      UaMethod method,
                      Variant[] inputArguments,
                      StatusCode[] inputArgumentResults,
                      DiagnosticInfo[] inputArgumentDiagnosticInfos,
                      Variant[] output)
               throws StatusException

Description copied from interface: CallableListener

A method call notification.

Use onCall to check whether the called method is the one that you handle. If so, return true, and set the outputs. Do not create a new array for the outputs, just assign your values in there - it is already created for the length defined by the OutputArguments of the UaMethod.

If you find errors in the inputArguments, fill in the inputArgumentResults and inputArgumentDiagnosticInfos respectively. They are also preallocated.

Specified by:

onCall in interface CallableListener

Overrides:

onCall in class EventManagerUaNode

objectId - the ID of the node whose method is being called

object - the object node whose method is being called, if available

methodId - the ID of the method being called

method - the method node being called, if available

inputArguments - input argument values

inputArgumentResults - room for argument errors. Fill in the array if you encounter errors in the values.

inputArgumentDiagnosticInfos - room for diagnostic info, in case of errors.

output - room for output values. The array is pre-created, so just fill in the values.

Returns:

true if you handle the call, which prevents any other handler being called.

Throws:

StatusException - if there are errors in the method handling. For example, if you set inputArgumentResults, you should throw a StatusException with StatusCodes.Bad_InvalidArgument

refresh

protected boolean refresh(ServiceContext serviceContext,
                          Subscription subscription)
                   throws StatusException

Handle a ConditionRefresh call from a client.

Parameters:

serviceContext - the client calling context.

subscription - the subscription to refresh

Returns:

true if the method is handled by this method

Throws:

StatusException - if refresh is not allowed, for example

refresh

protected boolean refresh(ServiceContext serviceContext,
                          Subscription subscription,
                          MonitoredEventItem monitoredItem)
                   throws StatusException

Handle a ConditionRefresh2 call from a client.

Parameters:

serviceContext - the client calling context

subscription - the subscription in which the item to refresh exists

monitoredItem - the item to refresh.

Returns:

true if the method is handled by this method

Throws:

StatusException - if refresh is not allowed, for example

refreshEndEvent

protected void refreshEndEvent(MonitoredEventItem monitoredItem)

Trigger a RefreshEndEventType. This method is called after #refreshItem() is called. The default implementation triggers the standard event of type RefreshEndEventType for the given monitored event item.

refreshEndEvent

protected void refreshEndEvent(Subscription subscription)

Trigger a RefreshEndEventType. This method is called after #refreshItems() is called. The default implementation triggers the standard event of type RefreshEndEventType for every monitored event item.

Parameters:

subscription - must not be null

refreshStartEvent

protected void refreshStartEvent(MonitoredEventItem monitoredItem)

Trigger a RefreshStartEventType. This method is called before #refreshItem() is called. The default implementation triggers the standard event of type RefreshStartEventType for the given monitored event item.

refreshStartEvent

protected void refreshStartEvent(Subscription subscription)

Trigger a RefreshStartEventType. This method is called before #refreshItems() is called. The default implementation triggers the standard event of type RefreshStartEventType for every monitored event item.

Parameters:

subscription - must not be null