yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/rpc/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.rpc;
   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.eclipse.jdt.annotation.NonNull;
  17 import org.opendaylight.yangtools.yang.common.QName;
  18 import org.opendaylight.yangtools.yang.model.api.Status;
  19 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  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.DeclaredStatements;
  28 import org.opendaylight.yangtools.yang.model.spi.meta.SubstatementIndexingException;
  29 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
  30 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.input.InputStatementSupport;
  31 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.output.OutputStatementSupport;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractSchemaTreeStatementSupport;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  37 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  38 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  39 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
  40
  41 @Beta
  42 public final class RpcStatementSupport extends AbstractSchemaTreeStatementSupport<RpcStatement, RpcEffectiveStatement> {
  43     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(
  44         YangStmtMapping.RPC)
  45         .addOptional(YangStmtMapping.DESCRIPTION)
  46         .addAny(YangStmtMapping.GROUPING)
  47         .addAny(YangStmtMapping.IF_FEATURE)
  48         .addOptional(YangStmtMapping.INPUT)
  49         .addOptional(YangStmtMapping.OUTPUT)
  50         .addOptional(YangStmtMapping.REFERENCE)
  51         .addOptional(YangStmtMapping.STATUS)
  52         .addAny(YangStmtMapping.TYPEDEF)
  53         .build();
  54     private static final @NonNull RpcStatementSupport RFC6020_INSTANCE = new RpcStatementSupport(
  55         InputStatementSupport.rfc6020Instance(), OutputStatementSupport.rfc6020Instance());
  56     private static final @NonNull RpcStatementSupport RFC7950_INSTANCE = new RpcStatementSupport(
  57         InputStatementSupport.rfc7950Instance(), OutputStatementSupport.rfc7950Instance());
  58
  59     private final InputStatementSupport implicitInput;
  60     private final OutputStatementSupport implicitOutput;
  61
  62     private RpcStatementSupport(final InputStatementSupport implicitInput,
  63             final OutputStatementSupport implicitOutput) {
  64         super(YangStmtMapping.RPC, StatementPolicy.reject());
  65         this.implicitInput = requireNonNull(implicitInput);
  66         this.implicitOutput = requireNonNull(implicitOutput);
  67     }
  68
  69     public static @NonNull RpcStatementSupport rfc6020Instance() {
  70         return RFC6020_INSTANCE;
  71     }
  72
  73     public static @NonNull RpcStatementSupport rfc7950Instance() {
  74         return RFC7950_INSTANCE;
  75     }
  76
  77     @Override
  78     public void onFullDefinitionDeclared(final Mutable<QName, RpcStatement, RpcEffectiveStatement> stmt) {
  79         super.onFullDefinitionDeclared(stmt);
  80
  81         verify(stmt instanceof StatementContextBase);
  82         if (StmtContextUtils.findFirstDeclaredSubstatement(stmt, InputStatement.class) == null) {
  83             ((StatementContextBase<?, ?, ?>) stmt).appendImplicitSubstatement(implicitInput, null);
  84         }
  85         if (StmtContextUtils.findFirstDeclaredSubstatement(stmt, OutputStatement.class) == null) {
  86             ((StatementContextBase<?, ?, ?>) stmt).appendImplicitSubstatement(implicitOutput, null);
  87         }
  88     }
  89
  90     @Override
  91     protected SubstatementValidator getSubstatementValidator() {
  92         return SUBSTATEMENT_VALIDATOR;
  93     }
  94
  95     @Override
  96     protected RpcStatement createDeclared(final StmtContext<QName, RpcStatement, ?> ctx,
  97             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  98         return DeclaredStatements.createRpc(ctx.getArgument(), substatements);
  99     }
 100
 101     @Override
 102     protected RpcStatement createEmptyDeclared(final StmtContext<QName, RpcStatement, ?> ctx) {
 103         return DeclaredStatements.createRpc(ctx.getArgument());
 104     }
 105
 106     @Override
 107     protected RpcEffectiveStatement createEffective(final Current<QName, RpcStatement> stmt,
 108             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 109         checkState(!substatements.isEmpty(), "Missing implicit input/output statements at %s", stmt.sourceReference());
 110
 111         try {
 112             return new RpcEffectiveStatementImpl(stmt.declared(), substatements, stmt.effectivePath(),
 113                 computeFlags(substatements));
 114         } catch (SubstatementIndexingException e) {
 115             throw new SourceException(e.getMessage(), stmt, e);
 116         }
 117     }
 118
 119     private static int computeFlags(final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 120         return new FlagsBuilder()
 121                 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
 122                 .toFlags();
 123     }
 124 }