org.eclipse.milo.opcua.sdk.server.api.methods

Class AbstractMethodInvocationHandler

java.lang.Object

org.eclipse.milo.opcua.sdk.server.api.methods.AbstractMethodInvocationHandler

All Implemented Interfaces:

MethodInvocationHandler

Direct Known Subclasses:

AcknowledgeMethod, AddCertificateMethod, AddCommentMethod, ApplyChangesMethod, CloseAndUpdateMethod, CloseMethod, ConditionRefresh2Method, ConditionRefreshMethod, ConfirmMethod, CreateDirectoryMethod, CreateFileMethod, CreateSigningRequestMethod, DeleteMethod, DisableMethod, EnableMethod, ExportNamespaceMethod, GetMonitoredItemsMethod, GetPositionMethod, GetRejectedListMethod, HaltMethod, MoveOrCopyMethod, OneShotShelveMethod, OpenMethod, OpenWithMasksMethod, ReadMethod, RemoveCertificateMethod, RequestServerStateChangeMethod, ResendDataMethod, ResetMethod, RespondMethod, ResumeMethod, SetPositionMethod, SetSubscriptionDurableMethod, StartMethod, SuspendMethod, TimedShelveMethod, UnshelveMethod, UpdateCertificateMethod, WriteMethod

public abstract class AbstractMethodInvocationHandler
extends Object
implements MethodInvocationHandler

A partial implementation of MethodInvocationHandler that handles checking the Executable and UserExecutable attributes as well as validating the supplied input values against the input Arguments.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractMethodInvocationHandler.InvocationContext Extends AccessContext to provide additional context to implementations of AbstractMethodInvocationHandler.

Nested classes/interfaces inherited from interface org.eclipse.milo.opcua.sdk.server.api.methods.MethodInvocationHandler

MethodInvocationHandler.NodeIdUnknownHandler, MethodInvocationHandler.NotImplementedHandler

Field Summary

Fields inherited from interface org.eclipse.milo.opcua.sdk.server.api.methods.MethodInvocationHandler

NODE_ID_UNKNOWN, NOT_IMPLEMENTED

Constructor Summary

Constructors

Constructor and Description
AbstractMethodInvocationHandler(UaMethodNode node)

Method Summary

Modifier and Type	Method and Description
protected void	checkExecutableAttributes(AccessContext accessContext) Check that the Executable and UserExecutable attributes are true.
abstract Argument[]	getInputArguments() Get the input Arguments expected by the Method this handler is installed on.
UaMethodNode	getNode()
abstract Argument[]	getOutputArguments() Get the output Arguments expected by the Method this handler is installed on.
protected abstract Variant[]	invoke(AbstractMethodInvocationHandler.InvocationContext invocationContext, Variant[] inputValues) Invoke this method and return the values for its output arguments, if any.
CallMethodResult	invoke(AccessContext accessContext, CallMethodRequest request) Invoke the given CallMethodRequest and complete future when finished.
protected void	validateInputArgumentValues(Variant[] inputArgumentValues) Validate the input values against the expected input arguments.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMethodInvocationHandler

public AbstractMethodInvocationHandler(UaMethodNode node)

Parameters:

node - the UaMethodNode this handler will be installed on.

Method Detail

getNode

public UaMethodNode getNode()

invoke

public final CallMethodResult invoke(AccessContext accessContext,
                                     CallMethodRequest request)

Description copied from interface: MethodInvocationHandler

Invoke the given CallMethodRequest and complete future when finished.

Under no circumstances should the future be completed exceptionally.

Specified by:

invoke in interface MethodInvocationHandler

Parameters:

accessContext - the AccessContext.

request - the CallMethodRequest.

Returns:

the CallMethodResult.

checkExecutableAttributes

protected void checkExecutableAttributes(AccessContext accessContext)
                                  throws UaException

Check that the Executable and UserExecutable attributes are true.

Parameters:

accessContext - the AccessContext.

Throws:

UaException - if either Executable or UserExecutable attributes are not true.

getInputArguments

public abstract Argument[] getInputArguments()

Get the input Arguments expected by the Method this handler is installed on.

Returns:

the input Arguments expected by the Method this handler is installed on.

getOutputArguments

public abstract Argument[] getOutputArguments()

Get the output Arguments expected by the Method this handler is installed on.

Returns:

the output Arguments expected by the Method this handler is installed on.

invoke

protected abstract Variant[] invoke(AbstractMethodInvocationHandler.InvocationContext invocationContext,
                                    Variant[] inputValues)
                             throws UaException

Invoke this method and return the values for its output arguments, if any.

The Executable and UserExecutable attributes have already been checked to ensure this method is allowed to execute.

Parameters:

invocationContext - the AbstractMethodInvocationHandler.InvocationContext.

inputValues - the user-supplied values for the input arguments. Each value has been verified to be of the type specified by its Argument.

Returns:

this output values matching this Method's output arguments, if any.

Throws:

UaException - if invocation has failed for some reason.

validateInputArgumentValues

protected void validateInputArgumentValues(Variant[] inputArgumentValues)
                                    throws InvalidArgumentException

Validate the input values against the expected input arguments.

The DataType of each input value has already been verified; implementations need only verify the value is "valid", if applicable, and throw InvalidArgumentException with a StatusCode of Bad_OutOfRange for any invalid input values.

Parameters:

inputArgumentValues - the input values provided by the client for the current method call.

Throws:

InvalidArgumentException - if one or more input argument values are invalid.