com.prosysopc.ua.server

Class EventManager

java.lang.Object

com.prosysopc.ua.server.ServiceManagerBase

com.prosysopc.ua.server.EventManager

All Implemented Interfaces:

CallableListener

Direct Known Subclasses:

EventManagerUaNode

public abstract class EventManager
extends ServiceManagerBase
implements CallableListener

OPC UA Event Manager interface. The Event Manager is the OPC UA server component that is responsible of handling event generation and client requests related to event handling.

The base implementation simply dispatches the calls to the registered listener.

Field Summary

Fields

Modifier and Type	Field and Description
protected AtomicReference<EventManagerListener>	listener
protected static org.slf4j.Logger	logger
protected static EventFilterResult	RESULT_OK

Constructor Summary

Constructors

Constructor and Description
EventManager(NodeManager nodeManager) The constructor used to create a new EventManager.

Method Summary

Modifier and Type	Method and Description
protected void	afterCreateMonitoredEventItem(ServiceContext serviceContext, Subscription subscription, MonitoredEventItem item)
protected void	afterDeleteMonitoredEventItem(ServiceContext serviceContext, Subscription subscription, MonitoredEventItem item)
protected void	afterModifyMonitoredEventItem(ServiceContext serviceContext, Subscription subscription, MonitoredEventItem item)
static ByteString	createEventId(long value) Deprecated. use ByteString.fromLong(long) instead (this method delegates to it).
static ByteString	createFullEventId(ByteString userEventId) Creates a new eventId using a user specific ID.
protected void	createMonitoredEventItem(ServiceContext serviceContext, Subscription subscription, NodeId nodeId, EventFilter filter, EventFilterResult eventFilterResult)
protected void	deleteMonitoredEventItem(ServiceContext serviceContext, Subscription subscription, MonitoredEventItem monitoredItem)
static ByteString	extractUserEventId(ByteString fullEventId) Extract the custom part from the event ID by removing the first 16 bytes (returns null if given less than 16 bytes ByteString.getLength().
protected void	fireConditionRefresh(ServiceContext serviceContext, Subscription subscription)
protected void	fireConditionRefresh2(ServiceContext serviceContext, MonitoredEventItem item)
EventManagerListener	getListener() The listener implementation that gets notified about event manager related actions.
NodeManager	getNodeManager() The NodeManager that the event manager is serving.
protected boolean	methodEqualsIdOrName(UaMethod method, NodeId methodId, String methodName)
protected void	modifyMonitoredEventItem(ServiceContext serviceContext, Subscription subscription, MonitoredEventItem item, EventFilter eventFilter, EventFilterResult eventFilterResult)
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 abstract void	refreshItem(MonitoredEventItem item) Handle refreshing the item in the context of a ConditionRefresh or ConditionRefresh2 Method Call.
protected void	refreshItems(ServiceContext serviceContext, Subscription subscription) Handles condition refresh for a subscription.
void	setListener(EventManagerListener l) Define a listener to the Event Manager to get notifications about client actions.

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, requireUaNode

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

RESULT_OK

protected static final EventFilterResult RESULT_OK

listener

protected final AtomicReference<EventManagerListener> listener

Constructor Detail

EventManager

public EventManager(NodeManager nodeManager)

The constructor used to create a new EventManager.

The event manager is automatically connected to the node manager.

Parameters:

nodeManager - the node manager that the event manager is serving. Must not be null.

Method Detail

createEventId

@Deprecated
public static ByteString createEventId(long value)

Deprecated. use ByteString.fromLong(long) instead (this method delegates to it).

Converts the given long value to ByteString.

createFullEventId

public static ByteString createFullEventId(ByteString userEventId)

Creates a new eventId using a user specific ID. The base of the ID is UUID.randomUUID() converted via ByteString.fromUUID(UUID). The given userEventId is ByteString.append(ByteString) to this. Returns just the base ID if given null/empty userEventId.

The method is used from triggerEvent methods of the Event types and and you do not normally need to use it.

You can use createEventId(long) to create the user specific part which you can provide to this method or to triggerEvent.

Use #extractUserEventId(byte[]) to get the userEventId out of a full event ID.

extractUserEventId

public static ByteString extractUserEventId(ByteString fullEventId)

Extract the custom part from the event ID by removing the first 16 bytes (returns null if given less than 16 bytes ByteString.getLength().

getListener

public EventManagerListener getListener()

The listener implementation that gets notified about event manager related actions.

Returns:

the current listener

getNodeManager

public NodeManager getNodeManager()

The NodeManager that the event manager is serving.

Returns:

the nodeManager

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

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

setListener

public void setListener(EventManagerListener l)

Define a listener to the Event Manager to get notifications about client actions.

The listener gives you a simple mechanism to react to actions in any node manager. The alternative is to implement your own event manager, but the listener is typically a simpler way to do the same.

Parameters:

l - your EventManagerListener implementation. Use null to clear the setting (it will change the listener to an internal NULL_LISTENER).

See Also:

EventManagerListener

afterCreateMonitoredEventItem

protected void afterCreateMonitoredEventItem(ServiceContext serviceContext,
                                             Subscription subscription,
                                             MonitoredEventItem item)

Parameters:

serviceContext -

subscription -

item -

afterDeleteMonitoredEventItem

protected void afterDeleteMonitoredEventItem(ServiceContext serviceContext,
                                             Subscription subscription,
                                             MonitoredEventItem item)

Parameters:

serviceContext -

subscription -

item -

afterModifyMonitoredEventItem

protected void afterModifyMonitoredEventItem(ServiceContext serviceContext,
                                             Subscription subscription,
                                             MonitoredEventItem item)

Parameters:

serviceContext -

subscription -

item -

createMonitoredEventItem

protected void createMonitoredEventItem(ServiceContext serviceContext,
                                        Subscription subscription,
                                        NodeId nodeId,
                                        EventFilter filter,
                                        EventFilterResult eventFilterResult)
                                 throws StatusException

Throws:

StatusException

deleteMonitoredEventItem

protected void deleteMonitoredEventItem(ServiceContext serviceContext,
                                        Subscription subscription,
                                        MonitoredEventItem monitoredItem)

fireConditionRefresh

protected void fireConditionRefresh(ServiceContext serviceContext,
                                    Subscription subscription)
                             throws StatusException

Throws:

StatusException

fireConditionRefresh2

protected void fireConditionRefresh2(ServiceContext serviceContext,
                                     MonitoredEventItem item)
                              throws StatusException

Throws:

StatusException

methodEqualsIdOrName

protected boolean methodEqualsIdOrName(UaMethod method,
                                       NodeId methodId,
                                       String methodName)

Parameters:

method -

methodId -

methodName -

Returns:

modifyMonitoredEventItem

protected void modifyMonitoredEventItem(ServiceContext serviceContext,
                                        Subscription subscription,
                                        MonitoredEventItem item,
                                        EventFilter eventFilter,
                                        EventFilterResult eventFilterResult)
                                 throws StatusException

Throws:

StatusException

refreshItem

protected abstract void refreshItem(MonitoredEventItem item)

Handle refreshing the item in the context of a ConditionRefresh or ConditionRefresh2 Method Call.

refreshItems

protected void refreshItems(ServiceContext serviceContext,
                            Subscription subscription)
                     throws StatusException

Handles condition refresh for a subscription.

Parameters:

serviceContext - the client calling context.

subscription - must not be null

Throws:

StatusException - if refresh is not allowed or cannot be done