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.yangtools.yang.binding.contract.Naming;
  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 @Deprecated(since = "11.0.0", forRemoval = true)
  32 final class RpcServiceGenerator extends AbstractImplicitGenerator {
  33     private static final JavaTypeName CHECK_RETURN_VALUE_ANNOTATION =
  34         // Do not refer to annotation class, as it may not be available at runtime
  35         JavaTypeName.create("edu.umd.cs.findbugs.annotations", "CheckReturnValue");
  36
  37     private final List<RpcGenerator> rpcs;
  38
  39     RpcServiceGenerator(final ModuleGenerator parent, final List<RpcGenerator> rpcs) {
  40         super(parent);
  41         this.rpcs = requireNonNull(rpcs);
  42     }
  43
  44     @Override
  45     StatementNamespace namespace() {
  46         return StatementNamespace.RPC_SERVICE;
  47     }
  48
  49     @Override
  50     String classSuffix() {
  51         return Naming.RPC_SERVICE_SUFFIX;
  52     }
  53
  54     @Override
  55     GeneratedType createTypeImpl(final TypeBuilderFactory builderFactory) {
  56         final GeneratedTypeBuilder builder = builderFactory.newGeneratedTypeBuilder(typeName());
  57         builder.addImplementsType(BindingTypes.RPC_SERVICE);
  58
  59         for (RpcGenerator rpcGen : rpcs) {
  60             final RpcEffectiveStatement rpc = rpcGen.statement();
  61             final QName qname = rpc.argument();
  62
  63             // FIXME: this may still conflict in theory
  64             final MethodSignatureBuilder method = builder.addMethod(Naming.getRpcMethodName(qname));
  65
  66             method.addParameter(getChild(rpcGen, InputEffectiveStatement.class).getGeneratedType(builderFactory),
  67                 "input");
  68             method.setReturnType(Types.listenableFutureTypeFor(BindingTypes.rpcResult(
  69                 getChild(rpcGen, OutputEffectiveStatement.class).getGeneratedType(builderFactory))));
  70
  71             // FIXME: this should not be part of runtime types
  72             method.addAnnotation(CHECK_RETURN_VALUE_ANNOTATION);
  73             final String rpcName = qname.getLocalName();
  74             method.setComment(new TypeMemberComment("Invoke {@code " + rpcName + "} RPC.",
  75                 rpc.findFirstEffectiveSubstatementArgument(DescriptionEffectiveStatement.class).orElse(null),
  76                 "@param input of {@code " + rpcName + "}\n"
  77                     + "@return output of {@code " + rpcName + '}'));
  78         }
  79
  80         // FIXME: activate this
  81         //      addCodegenInformation(interfaceBuilder, module, "RPCs", rpcDefinitions);
  82
  83         return builder.build();
  84     }
  85 }