Examples with CallMethodResult org.eclipse.milo.opcua.stack.core.types.structured.CallMethodResult used on opensource projects

Example 1 with CallMethodResult

use of org.eclipse.milo.opcua.stack.core.types.structured.CallMethodResult in project FAAAST-Service by FraunhoferIOSB.

the class OpcUaAssetConnection method registerOperationProvider.

/**
 * {@inheritdoc}
 *
 * @throws AssetConnectionException if nodeId could not be parsed
 * @throws AssetConnectionException if nodeId does not refer to a method
 *             node
 * @throws AssetConnectionException if parent node of nodeId could not be
 *             resolved
 * @throws AssetConnectionException if output variables are null or do
 *             contain any other type than
 *             {@link de.fraunhofer.iosb.ilt.faaast.service.model.value.PropertyValue}
 */
@Override
public void registerOperationProvider(Reference reference, OpcUaOperationProviderConfig operationProvider) throws AssetConnectionException {
    String baseErrorMessage = "error registering operation provider";
    final NodeId nodeId = parseNodeId(operationProvider.getNodeId());
    final UaNode node;
    try {
        node = client.getAddressSpace().getNode(nodeId);
    } catch (UaException ex) {
        throw new AssetConnectionException(String.format("%s - could not resolve nodeId (nodeId: %s)", baseErrorMessage, operationProvider.getNodeId()), ex);
    }
    if (!UaMethodNode.class.isAssignableFrom(node.getClass())) {
        throw new AssetConnectionException(String.format("%s - provided node must be a method (nodeId: %s", baseErrorMessage, operationProvider.getNodeId()));
    }
    final UaMethodNode methodNode = (UaMethodNode) node;
    final NodeId parentNodeId;
    try {
        parentNodeId = client.getAddressSpace().getNode(nodeId).browseNodes(AddressSpace.BrowseOptions.builder().setBrowseDirection(BrowseDirection.Inverse).build()).get(0).getNodeId();
    } catch (UaException ex) {
        throw new AssetConnectionException(String.format("%s - could not resolve parent node (nodeId: %s)", baseErrorMessage, operationProvider.getNodeId()), ex);
    }
    final Argument[] methodArguments;
    try {
        methodArguments = methodNode.readInputArgumentsAsync().get() != null ? methodNode.readInputArgumentsAsync().get() : new Argument[0];
    } catch (InterruptedException | ExecutionException ex) {
        throw new AssetConnectionException(String.format("%s - could not read input arguments (nodeId: %s)", baseErrorMessage, operationProvider.getNodeId()), ex);
    }
    final Argument[] methodOutputArguments;
    try {
        methodOutputArguments = methodNode.readOutputArgumentsAsync().get() != null ? methodNode.readOutputArgumentsAsync().get() : new Argument[0];
    } catch (InterruptedException | ExecutionException ex) {
        throw new AssetConnectionException(String.format("%s - could not read ouput arguments (nodeId: %s)", baseErrorMessage, operationProvider.getNodeId()), ex);
    }
    final OperationVariable[] outputVariables = serviceContext.getOperationOutputVariables(reference) != null ? serviceContext.getOperationOutputVariables(reference) : new OperationVariable[0];
    for (var outputVariable : outputVariables) {
        if (outputVariable == null) {
            throw new AssetConnectionException(String.format("%s - output variable must be non-null (nodeId: %s)", baseErrorMessage, operationProvider.getNodeId()));
        }
        SubmodelElement submodelElement = outputVariable.getValue();
        if (submodelElement == null) {
            throw new AssetConnectionException(String.format("%s - output variable must contain non-null submodel element (nodeId: %s)", baseErrorMessage, operationProvider.getNodeId()));
        }
        if (!Property.class.isAssignableFrom(submodelElement.getClass())) {
            throw new AssetConnectionException(String.format("%s - unsupported element type (nodeId: %s, element type: %s)", baseErrorMessage, submodelElement.getClass(), operationProvider.getNodeId()));
        }
    }
    this.operationProviders.put(reference, new AssetOperationProvider() {

        @Override
        public OperationVariable[] invoke(OperationVariable[] input, OperationVariable[] inoutput) throws AssetConnectionException {
            String baseErrorMessage = "error invoking operation on asset connection";
            Map<String, ElementValue> inputParameter = input == null ? new HashMap<>() : Stream.of(input).collect(Collectors.toMap(x -> x.getValue().getIdShort(), x -> ElementValueMapper.toValue(x.getValue())));
            Map<String, ElementValue> inoutputParameter = inoutput == null ? new HashMap<>() : Stream.of(inoutput).collect(Collectors.toMap(x -> x.getValue().getIdShort(), x -> ElementValueMapper.toValue(x.getValue())));
            if (methodArguments.length != (inputParameter.size() + inoutputParameter.size())) {
                throw new AssetConnectionException(String.format("%s - argument count mismatch (expected: %d, provided input arguments: %d, provided inoutput arguments: %d)", baseErrorMessage, methodArguments.length, inputParameter.size(), inoutputParameter.size()));
            }
            Variant[] actualParameters = new Variant[methodArguments.length];
            for (int i = 0; i < methodArguments.length; i++) {
                String argumentName = methodArguments[i].getName();
                ElementValue parameterValue;
                if (inputParameter.containsKey(argumentName)) {
                    parameterValue = inputParameter.get(argumentName);
                } else if (inoutputParameter.containsKey(argumentName)) {
                    parameterValue = inoutputParameter.get(argumentName);
                } else {
                    throw new AssetConnectionException(String.format("%s - missing argument (argument name: %s)", baseErrorMessage, argumentName));
                }
                if (parameterValue == null) {
                    throw new AssetConnectionException(String.format("%s - parameter value must be non-null (argument name: %s)", baseErrorMessage, argumentName));
                }
                if (!PropertyValue.class.isAssignableFrom(parameterValue.getClass())) {
                    throw new AssetConnectionException(String.format("%s - currently only parameters of the Property are supported (argument name: %s, provided type: %s)", baseErrorMessage, argumentName, parameterValue.getClass()));
                }
                actualParameters[i] = valueConverter.convert(((PropertyValue) parameterValue).getValue(), methodArguments[i].getDataType());
            }
            CallMethodResult methodResult;
            try {
                methodResult = client.call(new CallMethodRequest(parentNodeId, nodeId, actualParameters)).get();
            } catch (InterruptedException | ExecutionException ex) {
                throw new AssetConnectionException(String.format("%s - executing OPC UA method failed (nodeId: %s)", baseErrorMessage, operationProvider.getNodeId()));
            }
            OperationVariable[] result = new OperationVariable[outputVariables.length];
            for (int i = 0; i < methodOutputArguments.length; i++) {
                String argumentName = methodArguments[i].getName();
                for (int j = 0; j < outputVariables.length; j++) {
                    if (Objects.equals(argumentName, outputVariables[j].getValue().getIdShort())) {
                        SubmodelElement element = outputVariables[j].getValue();
                        Datatype targetType = ((PropertyValue) ElementValueMapper.toValue(element)).getValue().getDataType();
                        TypedValue<?> newValue = valueConverter.convert(methodResult.getOutputArguments()[i], targetType);
                        // TODO better use deep copy?
                        DefaultProperty newProperty = new DefaultProperty.Builder().idShort(element.getIdShort()).build();
                        ElementValueMapper.setValue(newProperty, PropertyValue.builder().value(newValue).build());
                        result[j] = new DefaultOperationVariable.Builder().value(newProperty).build();
                    }
                }
                // update inoutput variable values
                if (inoutputParameter.containsKey(argumentName)) {
                    // find in original array and set there
                    for (int j = 0; j < inoutput.length; j++) {
                        if (Objects.equals(argumentName, inoutput[j].getValue().getIdShort())) {
                            ElementValueMapper.setValue(inoutput[j].getValue(), new PropertyValue(valueConverter.convert(methodResult.getOutputArguments()[i], ((PropertyValue) inoutputParameter.get(argumentName)).getValue().getDataType())));
                        }
                    }
                }
            }
            return result;
        }
    });
}

Example 2 with CallMethodResult

use of org.eclipse.milo.opcua.stack.core.types.structured.CallMethodResult in project milo by eclipse.

the class AbstractMethodInvocationHandlerTest method inputArgumentResultsIsEmptyOnSuccess.

@Test
public void inputArgumentResultsIsEmptyOnSuccess() throws ExecutionException, InterruptedException {
    CallMethodResult result = client.call(new CallMethodRequest(Identifiers.ObjectsFolder, NodeId.parse("ns=2;s=onlyAcceptsPositiveInputs()"), new Variant[] { new Variant(1) })).get();
    assertEquals(StatusCode.GOOD, result.getStatusCode());
    assertEquals(0, result.getInputArgumentResults().length);
}

Example 3 with CallMethodResult

use of org.eclipse.milo.opcua.stack.core.types.structured.CallMethodResult in project milo by eclipse.

the class AbstractMethodInvocationHandler method invoke.

@Override
public final CallMethodResult invoke(AccessContext accessContext, CallMethodRequest request) {
    try {
        checkExecutableAttributes(accessContext);
        Variant[] inputArgumentValues = request.getInputArguments();
        if (inputArgumentValues == null)
            inputArgumentValues = new Variant[0];
        if (inputArgumentValues.length != getInputArguments().length) {
            throw new UaException(StatusCodes.Bad_ArgumentsMissing);
        }
        StatusCode[] inputDataTypeCheckResults = new StatusCode[inputArgumentValues.length];
        for (int i = 0; i < inputArgumentValues.length; i++) {
            Argument argument = getInputArguments()[i];
            Variant variant = inputArgumentValues[i];
            Object value = variant.getValue();
            // TODO this needs to be able to match when argument DataType is an alias type
            // extract subtype logic from AttributeWriter...
            boolean dataTypeMatch = value == null || variant.getDataType().flatMap(xni -> xni.toNodeId(node.getNodeContext().getNamespaceTable())).map(type -> {
                if (type.equals(argument.getDataType())) {
                    return true;
                } else {
                    if (Identifiers.Structure.equals(type) && value instanceof ExtensionObject) {
                        SerializationContext serializationContext = getNode().getNodeContext().getServer().getSerializationContext();
                        try {
                            Object decoded = ((ExtensionObject) value).decode(serializationContext);
                            if (decoded instanceof UaStructure) {
                                return ((UaStructure) decoded).getTypeId().toNodeId(node.getNodeContext().getNamespaceTable()).map(argument.getDataType()::equals).orElse(false);
                            }
                        } catch (UaSerializationException e) {
                            LoggerFactory.getLogger(getClass()).warn("Error decoding argument value", e);
                        }
                    }
                    return false;
                }
            }).orElse(false);
            switch(argument.getValueRank()) {
                case ValueRanks.Scalar:
                    if (value != null && value.getClass().isArray()) {
                        dataTypeMatch = false;
                    }
                    break;
                case ValueRanks.OneDimension:
                case ValueRanks.OneOrMoreDimensions:
                    if (value != null && !value.getClass().isArray()) {
                        dataTypeMatch = false;
                    }
                    break;
                default:
                    break;
            }
            if (dataTypeMatch) {
                inputDataTypeCheckResults[i] = StatusCode.GOOD;
            } else {
                inputDataTypeCheckResults[i] = new StatusCode(StatusCodes.Bad_TypeMismatch);
            }
        }
        if (Arrays.stream(inputDataTypeCheckResults).anyMatch(StatusCode::isBad)) {
            throw new InvalidArgumentException(inputDataTypeCheckResults);
        }
        validateInputArgumentValues(inputArgumentValues);
        InvocationContext invocationContext = new InvocationContext() {

            @Override
            public OpcUaServer getServer() {
                return node.getNodeContext().getServer();
            }

            @Override
            public NodeId getObjectId() {
                return request.getObjectId();
            }

            @Override
            public UaMethodNode getMethodNode() {
                return node;
            }

            @Override
            public Optional<Session> getSession() {
                return accessContext.getSession();
            }
        };
        Variant[] outputValues = invoke(invocationContext, inputArgumentValues);
        return new CallMethodResult(StatusCode.GOOD, new StatusCode[0], new DiagnosticInfo[0], outputValues);
    } catch (InvalidArgumentException e) {
        return new CallMethodResult(e.getStatusCode(), e.getInputArgumentResults(), e.getInputArgumentDiagnosticInfos(), new Variant[0]);
    } catch (UaException e) {
        return new CallMethodResult(e.getStatusCode(), new StatusCode[0], new DiagnosticInfo[0], new Variant[0]);
    }
}

Example 4 with CallMethodResult

use of org.eclipse.milo.opcua.stack.core.types.structured.CallMethodResult in project milo by eclipse.

the class MethodServices method call.

/**
 * Invoke one or more methods belonging to this {@link MethodServices}.
 *
 * @param context  the {@link CallContext}.
 * @param requests The {@link CallMethodRequest}s for the methods to invoke.
 */
default void call(CallContext context, List<CallMethodRequest> requests) {
    CallMethodResult result = new CallMethodResult(new StatusCode(StatusCodes.Bad_NotImplemented), new StatusCode[0], new DiagnosticInfo[0], new Variant[0]);
    context.success(nCopies(requests.size(), result));
}

Example 5 with CallMethodResult

use of org.eclipse.milo.opcua.stack.core.types.structured.CallMethodResult in project milo by eclipse.

the class ManagedAddressSpace method call.

/**
 * Invoke one or more methods belonging to this {@link MethodServices}.
 *
 * @param context  the {@link CallContext}.
 * @param requests The {@link CallMethodRequest}s for the methods to invoke.
 */
@Override
public void call(CallContext context, List<CallMethodRequest> requests) {
    List<CallMethodResult> results = Lists.newArrayListWithCapacity(requests.size());
    for (CallMethodRequest request : requests) {
        MethodInvocationHandler handler = getInvocationHandler(request.getObjectId(), request.getMethodId()).orElse(MethodInvocationHandler.NODE_ID_UNKNOWN);
        try {
            results.add(handler.invoke(context, request));
        } catch (Throwable t) {
            LoggerFactory.getLogger(getClass()).error("Uncaught Throwable invoking method handler for methodId={}.", request.getMethodId(), t);
            results.add(new CallMethodResult(new StatusCode(StatusCodes.Bad_InternalError), new StatusCode[0], new DiagnosticInfo[0], new Variant[0]));
        }
    }
    context.success(results);
}