parser/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/meta/RpcStatementSupport.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies, 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.yangtools.yang.parser.rfc7950.stmt.meta;
   9
  10 import static com.google.common.base.Preconditions.checkState;
  11 import static com.google.common.base.Verify.verify;
  12 import static java.util.Objects.requireNonNull;
  13
  14 import com.google.common.annotations.Beta;
  15 import com.google.common.collect.ImmutableList;
  16 import org.opendaylight.yangtools.yang.common.QName;
  17 import org.opendaylight.yangtools.yang.model.api.Status;
  18 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  19 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
  20 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  21 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.InputStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.OutputStatement;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.RpcEffectiveStatement;
  25 import org.opendaylight.yangtools.yang.model.api.stmt.RpcStatement;
  26 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
  27 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
  28 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
  29 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
  30 import org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
  31 import org.opendaylight.yangtools.yang.model.spi.meta.SubstatementIndexingException;
  32 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractSchemaTreeStatementSupport;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  37 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  38 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  39 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  40 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
  41
  42 @Beta
  43 public final class RpcStatementSupport extends AbstractSchemaTreeStatementSupport<RpcStatement, RpcEffectiveStatement> {
  44     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR =
  45         SubstatementValidator.builder(YangStmtMapping.RPC)
  46             .addOptional(YangStmtMapping.DESCRIPTION)
  47             .addAny(YangStmtMapping.GROUPING)
  48             .addAny(YangStmtMapping.IF_FEATURE)
  49             .addOptional(YangStmtMapping.INPUT)
  50             .addOptional(YangStmtMapping.OUTPUT)
  51             .addOptional(YangStmtMapping.REFERENCE)
  52             .addOptional(YangStmtMapping.STATUS)
  53             .addAny(YangStmtMapping.TYPEDEF)
  54             .build();
  55
  56     private final InputStatementSupport implicitInput;
  57     private final OutputStatementSupport implicitOutput;
  58
  59     public RpcStatementSupport(final YangParserConfiguration config, final InputStatementSupport implicitInput,
  60             final OutputStatementSupport implicitOutput) {
  61         super(YangStmtMapping.RPC, StatementPolicy.reject(), config, SUBSTATEMENT_VALIDATOR);
  62         this.implicitInput = requireNonNull(implicitInput);
  63         this.implicitOutput = requireNonNull(implicitOutput);
  64     }
  65
  66     @Override
  67     public void onFullDefinitionDeclared(final Mutable<QName, RpcStatement, RpcEffectiveStatement> stmt) {
  68         super.onFullDefinitionDeclared(stmt);
  69
  70         verify(stmt instanceof StatementContextBase);
  71         if (StmtContextUtils.findFirstDeclaredSubstatement(stmt, InputStatement.class) == null) {
  72             ((StatementContextBase<?, ?, ?>) stmt).appendImplicitSubstatement(implicitInput, null);
  73         }
  74         if (StmtContextUtils.findFirstDeclaredSubstatement(stmt, OutputStatement.class) == null) {
  75             ((StatementContextBase<?, ?, ?>) stmt).appendImplicitSubstatement(implicitOutput, null);
  76         }
  77     }
  78
  79     @Override
  80     protected RpcStatement createDeclared(final StmtContext<QName, RpcStatement, ?> ctx,
  81             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  82         return DeclaredStatements.createRpc(ctx.getArgument(), substatements);
  83     }
  84
  85     @Override
  86     protected RpcStatement attachDeclarationReference(final RpcStatement stmt, final DeclarationReference reference) {
  87         return DeclaredStatementDecorators.decorateRpc(stmt, reference);
  88     }
  89
  90     @Override
  91     protected RpcEffectiveStatement createEffective(final Current<QName, RpcStatement> stmt,
  92             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
  93         checkState(!substatements.isEmpty(), "Missing implicit input/output statements at %s", stmt.sourceReference());
  94
  95         try {
  96             return EffectiveStatements.createRpc(stmt.declared(), substatements, stmt.effectivePath(),
  97                 computeFlags(substatements));
  98         } catch (SubstatementIndexingException e) {
  99             throw new SourceException(e.getMessage(), stmt, e);
 100         }
 101     }
 102
 103     private static int computeFlags(final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 104         return new FlagsBuilder()
 105                 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
 106                 .toFlags();
 107     }
 108 }