com.prosysopc.ua.server

Class MethodManager

java.lang.Object

com.prosysopc.ua.server.ServiceManagerBase

com.prosysopc.ua.server.MethodManager

Direct Known Subclasses:

MethodManagerUaNode

public abstract class MethodManager
extends ServiceManagerBase

An interface that defines the OPC UA method handling.

Constructor Summary

Constructors

Constructor and Description
MethodManager(NodeManager nodeManager) Creates new MethodManager.

Method Summary

Modifier and Type	Method and Description
Variant[]	callMethod(ServiceContext serviceContext, NodeId objectId, NodeId methodId, Variant[] inputArguments, StatusCode[] inputArgumentResults, DiagnosticInfo[] inputArgumentDiagnosticInfos) Handle a method call.
static void	checkInputArguments(Class<?>[] expectedTypes, Variant[] inputArguments, StatusCode[] inputArgumentResults, DiagnosticInfo[] inputArgumentDiagnosticInfos, boolean acceptNulls) Validates the input arguments that they are of expected type.
static void	checkInputArguments(Class<?>[] expectedTypes, Variant[] inputArguments, StatusCode[] inputArgumentResults, DiagnosticInfo[] inputArgumentDiagnosticInfos, boolean[] acceptNulls) Validates the input arguments that they are of expected type.
NodeManager	getNodeManager() Returns the nodeManager which the MethodManager is using.

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

Constructor Detail

MethodManager

public MethodManager(NodeManager nodeManager)

Creates new MethodManager. This instance is set to the given NodeManager's MethodManager via NodeManager.setMethodManager(MethodManager).

Parameters:

nodeManager - the NodeManager

Method Detail

checkInputArguments

public static void checkInputArguments(Class<?>[] expectedTypes,
                                       Variant[] inputArguments,
                                       StatusCode[] inputArgumentResults,
                                       DiagnosticInfo[] inputArgumentDiagnosticInfos,
                                       boolean acceptNulls)
                                throws StatusException

Validates the input arguments that they are of expected type. You can use this method from your own method handler to check the input arguments before actually using them. It will return correct status codes and throws a StatusException if the length of inputArguments or any of the argument types do not match the expectedTypes.

Parameters:

expectedTypes - the expected argument types

inputArguments - the actual inputArguments

inputArgumentResults - the array to fill with argument results

inputArgumentDiagnosticInfos - the array to fill with diagnosticInfos for the invalid arguments

acceptNulls - whether NULL values are accepted for any argument

Throws:

StatusException - if the length of inputArguments does not match the expectedTypes or the value types do not match

checkInputArguments

public static void checkInputArguments(Class<?>[] expectedTypes,
                                       Variant[] inputArguments,
                                       StatusCode[] inputArgumentResults,
                                       DiagnosticInfo[] inputArgumentDiagnosticInfos,
                                       boolean[] acceptNulls)
                                throws StatusException

Validates the input arguments that they are of expected type. You can use this method from your own method handler to check the input arguments before actually using them. It will return correct status codes and throws a StatusException if the length of inputArguments or any of the argument types do not match the expectedTypes.

Parameters:

expectedTypes - the expected argument types

inputArguments - the actual inputArguments

inputArgumentResults - the array to fill with argument results

inputArgumentDiagnosticInfos - the array to fill with diagnosticInfos for the invalid arguments

acceptNulls - whether NULL values are accepted - each element defines the rule for that argument.

Throws:

StatusException - if the length of inputArguments does not match the expectedTypes or the value types do not match

callMethod

public Variant[] callMethod(ServiceContext serviceContext,
                            NodeId objectId,
                            NodeId methodId,
                            Variant[] inputArguments,
                            StatusCode[] inputArgumentResults,
                            DiagnosticInfo[] inputArgumentDiagnosticInfos)
                     throws StatusException

Handle a method call.

Parameters:

serviceContext - the context of the call

objectId - The object to which method applies

methodId - The method to call

inputArguments - optional input argument values

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

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

Returns:

optional output argument values

Throws:

StatusException - if the call fails

getNodeManager

public NodeManager getNodeManager()

Returns the nodeManager which the MethodManager is using.