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

Class MoveOrCopyMethod

java.lang.Object

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

org.eclipse.milo.opcua.sdk.server.model.methods.MoveOrCopyMethod

All Implemented Interfaces:

MethodInvocationHandler

public abstract class MoveOrCopyMethod
extends AbstractMethodInvocationHandler

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.milo.opcua.sdk.server.api.methods.AbstractMethodInvocationHandler

AbstractMethodInvocationHandler.InvocationContext

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

MethodInvocationHandler.NodeIdUnknownHandler, MethodInvocationHandler.NotImplementedHandler

Field Summary

Fields

Modifier and Type	Field and Description
static Argument	CREATE_COPY
static Argument	NEW_NAME
static Argument	NEW_NODE_ID
static Argument	OBJECT_TO_MOVE_OR_COPY
static Argument	TARGET_DIRECTORY

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

NODE_ID_UNKNOWN, NOT_IMPLEMENTED

Constructor Summary

Constructors

Constructor and Description
MoveOrCopyMethod(UaMethodNode node)

Method Summary

Modifier and Type	Method and Description
Argument[]	getInputArguments() Get the input Arguments expected by the Method this handler is installed on.
Argument[]	getOutputArguments() Get the output Arguments expected by the Method this handler is installed on.
protected abstract void	invoke(AbstractMethodInvocationHandler.InvocationContext context, NodeId objectToMoveOrCopy, NodeId targetDirectory, Boolean createCopy, String newName, Out<NodeId> newNodeId)
protected Variant[]	invoke(AbstractMethodInvocationHandler.InvocationContext context, Variant[] inputValues) Invoke this method and return the values for its output arguments, if any.

Methods inherited from class org.eclipse.milo.opcua.sdk.server.api.methods.AbstractMethodInvocationHandler

checkExecutableAttributes, getNode, invoke, validateInputArgumentValues

Methods inherited from class java.lang.Object

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

Field Detail

OBJECT_TO_MOVE_OR_COPY

public static final Argument OBJECT_TO_MOVE_OR_COPY

TARGET_DIRECTORY

public static final Argument TARGET_DIRECTORY

CREATE_COPY

public static final Argument CREATE_COPY

NEW_NAME

public static final Argument NEW_NAME

NEW_NODE_ID

public static final Argument NEW_NODE_ID

Constructor Detail

MoveOrCopyMethod

public MoveOrCopyMethod(UaMethodNode node)

Method Detail

getInputArguments

public Argument[] getInputArguments()

Description copied from class: AbstractMethodInvocationHandler

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

Specified by:

getInputArguments in class AbstractMethodInvocationHandler

Returns:

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

getOutputArguments

public Argument[] getOutputArguments()

Description copied from class: AbstractMethodInvocationHandler

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

Specified by:

getOutputArguments in class AbstractMethodInvocationHandler

Returns:

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

invoke

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

Description copied from class: AbstractMethodInvocationHandler

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.

Specified by:

invoke in class AbstractMethodInvocationHandler

Parameters:

context - 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.

invoke

protected abstract void invoke(AbstractMethodInvocationHandler.InvocationContext context,
                               NodeId objectToMoveOrCopy,
                               NodeId targetDirectory,
                               Boolean createCopy,
                               String newName,
                               Out<NodeId> newNodeId)
                        throws UaException

Throws:

UaException