2 * Copyright (c) 2017 Pantheon Technologies, s.r.o. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.parser.rfc7950.stmt.rpc;
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;
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.parser.rfc7950.stmt.BaseSchemaTreeStatementSupport;
28 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
29 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.SubstatementIndexingException;
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.EffectiveStmtCtx.Current;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
34 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
35 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
36 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
37 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
38 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
41 public final class RpcStatementSupport extends BaseSchemaTreeStatementSupport<RpcStatement, RpcEffectiveStatement> {
42 private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(
44 .addOptional(YangStmtMapping.DESCRIPTION)
45 .addAny(YangStmtMapping.GROUPING)
46 .addAny(YangStmtMapping.IF_FEATURE)
47 .addOptional(YangStmtMapping.INPUT)
48 .addOptional(YangStmtMapping.OUTPUT)
49 .addOptional(YangStmtMapping.REFERENCE)
50 .addOptional(YangStmtMapping.STATUS)
51 .addAny(YangStmtMapping.TYPEDEF)
53 private static final @NonNull RpcStatementSupport RFC6020_INSTANCE = new RpcStatementSupport(
54 InputStatementSupport.rfc6020Instance(), OutputStatementSupport.rfc6020Instance());
55 private static final @NonNull RpcStatementSupport RFC7950_INSTANCE = new RpcStatementSupport(
56 InputStatementSupport.rfc7950Instance(), OutputStatementSupport.rfc7950Instance());
58 private final InputStatementSupport implicitInput;
59 private final OutputStatementSupport implicitOutput;
61 private RpcStatementSupport(final InputStatementSupport implicitInput,
62 final OutputStatementSupport implicitOutput) {
63 super(YangStmtMapping.RPC, StatementPolicy.reject());
64 this.implicitInput = requireNonNull(implicitInput);
65 this.implicitOutput = requireNonNull(implicitOutput);
68 public static @NonNull RpcStatementSupport rfc6020Instance() {
69 return RFC6020_INSTANCE;
72 public static @NonNull RpcStatementSupport rfc7950Instance() {
73 return RFC7950_INSTANCE;
77 public void onFullDefinitionDeclared(final Mutable<QName, RpcStatement, RpcEffectiveStatement> stmt) {
78 super.onFullDefinitionDeclared(stmt);
80 verify(stmt instanceof StatementContextBase);
81 if (StmtContextUtils.findFirstDeclaredSubstatement(stmt, InputStatement.class) == null) {
82 ((StatementContextBase<?, ?, ?>) stmt).appendImplicitSubstatement(implicitInput, null);
84 if (StmtContextUtils.findFirstDeclaredSubstatement(stmt, OutputStatement.class) == null) {
85 ((StatementContextBase<?, ?, ?>) stmt).appendImplicitSubstatement(implicitOutput, null);
90 protected SubstatementValidator getSubstatementValidator() {
91 return SUBSTATEMENT_VALIDATOR;
95 protected RpcStatement createDeclared(final StmtContext<QName, RpcStatement, ?> ctx,
96 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
97 return new RegularRpcStatement(ctx.getArgument(), substatements);
101 protected RpcStatement createEmptyDeclared(final StmtContext<QName, RpcStatement, ?> ctx) {
102 return new EmptyRpcStatement(ctx.getArgument());
106 protected RpcEffectiveStatement createEffective(final Current<QName, RpcStatement> stmt,
107 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
108 checkState(!substatements.isEmpty(), "Missing implicit input/output statements at %s", stmt.sourceReference());
111 return new RpcEffectiveStatementImpl(stmt.declared(), substatements, computeFlags(substatements),
112 stmt.wrapSchemaPath());
113 } catch (SubstatementIndexingException e) {
114 throw new SourceException(e.getMessage(), stmt, e);
118 private static int computeFlags(final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
119 return new FlagsBuilder()
120 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))