binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/RpcServiceGenerator.java

   1 /*
   2  * Copyright (c) 2021 PANTHEON.tech, s.r.o. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.mdsal.binding.generator.impl.reactor;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import java.util.List;
  13 import org.opendaylight.mdsal.binding.model.api.GeneratedType;
  14 import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
  15 import org.opendaylight.mdsal.binding.model.api.TypeMemberComment;
  16 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilder;
  17 import org.opendaylight.mdsal.binding.model.api.type.builder.MethodSignatureBuilder;
  18 import org.opendaylight.mdsal.binding.model.ri.BindingTypes;
  19 import org.opendaylight.mdsal.binding.model.ri.Types;
  20 import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
  21 import org.opendaylight.yangtools.yang.common.QName;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.DescriptionEffectiveStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.InputEffectiveStatement;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.OutputEffectiveStatement;
  25 import org.opendaylight.yangtools.yang.model.api.stmt.RpcEffectiveStatement;
  26
  27 /**
  28  * Aggregate service for top-level {@code rpc} statements for a particular module.
  29  */
  30 // FIXME: eventually remove this generator
  31 final class RpcServiceGenerator extends AbstractImplicitGenerator {
  32     private static final JavaTypeName CHECK_RETURN_VALUE_ANNOTATION =
  33         // Do not refer to annotation class, as it may not be available at runtime
  34         JavaTypeName.create("edu.umd.cs.findbugs.annotations", "CheckReturnValue");
  35
  36     private final List<RpcGenerator> rpcs;
  37
  38     RpcServiceGenerator(final ModuleGenerator parent, final List<RpcGenerator> rpcs) {
  39         super(parent);
  40         this.rpcs = requireNonNull(rpcs);
  41     }
  42
  43     @Override
  44     String classSuffix() {
  45         return BindingMapping.RPC_SERVICE_SUFFIX;
  46     }
  47
  48     @Override
  49     GeneratedType createTypeImpl(final TypeBuilderFactory builderFactory) {
  50         final GeneratedTypeBuilder builder = builderFactory.newGeneratedTypeBuilder(typeName());
  51         builder.addImplementsType(BindingTypes.RPC_SERVICE);
  52
  53         for (RpcGenerator rpcGen : rpcs) {
  54             final RpcEffectiveStatement rpc = rpcGen.statement();
  55             final QName qname = rpc.argument();
  56
  57             // FIXME: this may still conflict in theory
  58             final MethodSignatureBuilder method = builder.addMethod(BindingMapping.getRpcMethodName(qname));
  59
  60             method.addParameter(getChild(rpcGen, InputEffectiveStatement.class).getGeneratedType(builderFactory),
  61                 "input");
  62             method.setReturnType(Types.listenableFutureTypeFor(BindingTypes.rpcResult(
  63                 getChild(rpcGen, OutputEffectiveStatement.class).getGeneratedType(builderFactory))));
  64
  65             // FIXME: this should not be part of runtime types
  66             method.addAnnotation(CHECK_RETURN_VALUE_ANNOTATION);
  67             final String rpcName = qname.getLocalName();
  68             method.setComment(new TypeMemberComment("Invoke {@code " + rpcName + "} RPC.",
  69                 rpc.findFirstEffectiveSubstatementArgument(DescriptionEffectiveStatement.class).orElse(null),
  70                 "@param input of {@code " + rpcName + "}\n"
  71                     + "@return output of {@code " + rpcName + '}'));
  72         }
  73
  74         // FIXME: activate this
  75         //      addCodegenInformation(interfaceBuilder, module, "RPCs", rpcDefinitions);
  76
  77         return builder.build();
  78     }
  79 }