+++ /dev/null
-/*
- * Copyright (c) 2017 Cisco Systems, Inc. and others. All rights reserved.
- *
- * This program and the accompanying materials are made available under the
- * terms of the Eclipse Public License v1.0 which accompanies this distribution,
- * and is available at http://www.eclipse.org/legal/epl-v10.html
- */
-
-package org.opendaylight.mdsal.binding.javav2.generator.impl;
-
-import static com.google.common.base.Preconditions.checkState;
-import static java.util.Objects.requireNonNull;
-import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.annotateDeprecatedIfNecessary;
-import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.checkModuleAndModuleName;
-import static org.opendaylight.mdsal.binding.javav2.generator.impl.GenHelperUtil.addImplementedInterfaceFromUses;
-import static org.opendaylight.mdsal.binding.javav2.generator.impl.GenHelperUtil.addRawInterfaceDefinition;
-import static org.opendaylight.mdsal.binding.javav2.generator.impl.GenHelperUtil.moduleTypeBuilder;
-import static org.opendaylight.mdsal.binding.javav2.generator.impl.GenHelperUtil.processUsesImplements;
-import static org.opendaylight.mdsal.binding.javav2.generator.impl.GenHelperUtil.resolveDataSchemaNodesCheck;
-import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil.encodeAngleBrackets;
-import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes.ACTION;
-import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes.INPUT;
-import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes.INSTANCE_IDENTIFIER;
-import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes.INSTANTIABLE;
-import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes.KEYED_INSTANCE_IDENTIFIER;
-import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes.LIST_ACTION;
-import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes.OUTPUT;
-import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes.RPC;
-import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes.RPC_CALLBACK;
-import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes.TREE_NODE;
-import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes.augmentable;
-import static org.opendaylight.mdsal.binding.javav2.generator.util.Types.CLASS;
-import static org.opendaylight.mdsal.binding.javav2.generator.util.Types.VOID;
-import static org.opendaylight.mdsal.binding.javav2.generator.util.Types.parameterizedTypeFor;
-
-import com.google.common.annotations.Beta;
-import com.google.common.annotations.VisibleForTesting;
-import java.util.Collection;
-import java.util.Map;
-import java.util.Optional;
-import java.util.Set;
-import org.opendaylight.mdsal.binding.javav2.generator.context.ModuleContext;
-import org.opendaylight.mdsal.binding.javav2.generator.spi.TypeProvider;
-import org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes;
-import org.opendaylight.mdsal.binding.javav2.generator.util.TypeComments;
-import org.opendaylight.mdsal.binding.javav2.model.api.GeneratedTransferObject;
-import org.opendaylight.mdsal.binding.javav2.model.api.GeneratedType;
-import org.opendaylight.mdsal.binding.javav2.model.api.YangSourceDefinition;
-import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedTypeBuilder;
-import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.MethodSignatureBuilder;
-import org.opendaylight.mdsal.binding.javav2.spec.runtime.BindingNamespaceType;
-import org.opendaylight.yangtools.yang.common.QName;
-import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
-import org.opendaylight.yangtools.yang.model.api.ActionNodeContainer;
-import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
-import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
-import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
-import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
-import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
-import org.opendaylight.yangtools.yang.model.api.Module;
-import org.opendaylight.yangtools.yang.model.api.OperationDefinition;
-import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
-import org.opendaylight.yangtools.yang.model.api.SchemaContext;
-import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
-
-/**
- * Util class used for generation of types for RPCs, routedRPCs and Actions (YANG 1.1 only)
- * in Binding spec. v2. In case of routed RPC detected in input YANG, RPC is turned to Action.
- */
-@Beta
-final class RpcActionGenHelper {
- @VisibleForTesting
- static final QName CONTEXT_REFERENCE =
- QName.create("urn:opendaylight:yang:extension:yang-ext", "2013-07-09", "context-reference").intern();
-
- private RpcActionGenHelper() {
- throw new UnsupportedOperationException("Util class");
- }
-
- /**
- * Let's find out what context we are talking about
- * 1. routed RPC
- * 2. global RPC
- *
- * <p>
- * In 1st case, we need Binding Generator behave like YANG 1.1 Action
- *
- * @param schemaNode RPC input node
- * @return presence optional
- */
- @VisibleForTesting
- static Optional<QName> getRoutingContext(final DataSchemaNode schemaNode) {
- for (UnknownSchemaNode extension : schemaNode.getUnknownSchemaNodes()) {
- if (CONTEXT_REFERENCE.equals(extension.getNodeType())) {
- return Optional.ofNullable(extension.getQName());
- }
- }
- return Optional.empty();
- }
-
- private static void resolveActions(final DataNodeContainer parent, final Module module,
- final SchemaContext schemaContext, final boolean verboseClassComments,
- final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final
- Map<Module, ModuleContext> genCtx,
- final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
- requireNonNull(parent, "Parent should not be NULL.");
- final Collection<DataSchemaNode> potentials = parent.getChildNodes();
- for (DataSchemaNode potential : potentials) {
- if (resolveDataSchemaNodesCheck(module, schemaContext, potential)) {
- BindingNamespaceType namespaceType1 = namespaceType;
- if (BindingNamespaceType.isData(namespaceType)) {
- if (potential instanceof GroupingDefinition) {
- namespaceType1 = BindingNamespaceType.Grouping;
- }
- }
-
- if (potential instanceof ActionNodeContainer) {
- final Set<ActionDefinition> actions = ((ActionNodeContainer) potential).getActions();
- for (ActionDefinition action : actions) {
- final GeneratedTypeBuilder typeBuilder = resolveOperation(potential, action, module,
- schemaContext, verboseClassComments, genTypeBuilders, genCtx, typeProvider, true,
- namespaceType1);
- genCtx.get(module).addTopLevelNodeType(typeBuilder);
- genCtx.get(module).addTypeToSchema(typeBuilder, action);
- }
- }
-
- if (potential instanceof DataNodeContainer) {
- resolveActions((DataNodeContainer) potential, module, schemaContext, verboseClassComments,
- genTypeBuilders, genCtx, typeProvider, namespaceType1);
- }
- }
- }
- }
-
- /**
- * Converts Yang 1.1 <b>Actions</b> to list of <code>Type</code> objects.
- *
- * @param module module from which is obtained set of all Action objects to
- * iterate over them
- * @param genCtx input, generated context
- * @param verboseClassComments verbosity switch
- * @return generated context
- */
- static Map<Module, ModuleContext> actionMethodsToGenType(final Module module, final Map<Module, ModuleContext>
- genCtx,
- final SchemaContext schemaContext, final boolean
- verboseClassComments,
- final Map<String, Map<String, GeneratedTypeBuilder>>
- genTypeBuilders, final TypeProvider typeProvider) {
-
- checkModuleAndModuleName(module);
- resolveActions(module, module, schemaContext, verboseClassComments, genTypeBuilders, genCtx, typeProvider,
- BindingNamespaceType.Operation);
- return genCtx;
- }
-
- /**
- * Converts global <b>RPCs</b> inputs and outputs sub-statements of the module
- * to the list of <code>Type</code> objects. In addition, containers
- * and lists which belong to input or output are also part of returning list.
- * Detected routed RPCs are turned to Yang 1.1 Actions
- *
- * @param module module from which is obtained set of all RPC objects to
- * iterate over them
- * @param genCtx input, generated context
- * @param verboseClassComments verbosity switch
- * @return generated context
- * @throws IllegalArgumentException <ul>
- * <li>if the module is null</li>
- * <li>if the name of module is null</li>
- * </ul>
- * @throws IllegalStateException if set of RPCs from module is null
- */
- static Map<Module, ModuleContext> rpcMethodsToGenType(final Module module, final Map<Module, ModuleContext> genCtx,
- final SchemaContext schemaContext, final boolean
- verboseClassComments, final Map<String, Map<String,
- GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
-
- checkModuleAndModuleName(module);
- final Set<RpcDefinition> rpcDefinitions = module.getRpcs();
- checkState(rpcDefinitions != null, "Set of RPCs from module " + module.getName() + " cannot be NULL.");
- if (rpcDefinitions.isEmpty()) {
- return genCtx;
- }
-
- for (final RpcDefinition rpc : rpcDefinitions) {
- final GeneratedTypeBuilder typeBuilder = resolveOperation(null, rpc, module, schemaContext,
- verboseClassComments, genTypeBuilders, genCtx, typeProvider, false,
- BindingNamespaceType.Operation);
- genCtx.get(module).addTopLevelNodeType(typeBuilder);
- genCtx.get(module).addTypeToSchema(typeBuilder, rpc);
- }
-
- return genCtx;
- }
-
- /**
- * Converts RPC, Action or routed RPC into generated type.
- *
- * @return generated type
- */
- private static GeneratedTypeBuilder resolveOperation(final DataSchemaNode parent, final OperationDefinition
- operation,
- final Module module, final SchemaContext schemaContext,
- final boolean verboseClassComments,
- final Map<String, Map<String, GeneratedTypeBuilder>>
- genTypeBuilders, final Map<Module, ModuleContext>
- genCtx,
- final TypeProvider typeProvider, final boolean isAction,
- final BindingNamespaceType namespaceType) {
-
- //operation name
- final String operationName = operation.getQName().getLocalName();
- //concrete operation name
- final StringBuilder sb = new StringBuilder(operationName).append('_');
- if (isAction) {
- sb.append("Action");
- } else {
- sb.append("Rpc");
- }
- final GeneratedTypeBuilder interfaceBuilder = moduleTypeBuilder(module, sb.toString(),
- verboseClassComments, genCtx.get(module));
-
- final String basePackageName = interfaceBuilder.getPackageName();
-
- if (verboseClassComments) {
- interfaceBuilder.addComment(TypeComments.javadoc(
- "Interface for implementing the following YANG Operation defined in module <b>"
- + module.getName() + "</b>").get());
- YangSourceDefinition.of(module, operation).ifPresent(interfaceBuilder::setYangSourceDefinition);
- }
-
- final String operationComment = encodeAngleBrackets(operation.getDescription().orElse(null));
- final MethodSignatureBuilder operationMethod = interfaceBuilder.addMethod("invoke");
-
- //input
- final ContainerSchemaNode input = operation.getInput();
- final GeneratedTypeBuilder inType = resolveOperationNode(interfaceBuilder, module, operation.getInput(),
- basePackageName, schemaContext, operationName, verboseClassComments, typeProvider, genTypeBuilders,
- genCtx, true, namespaceType);
- annotateDeprecatedIfNecessary(operation.getStatus(), inType);
- inType.setParentTypeForBuilder(interfaceBuilder);
- genCtx.get(module).addChildNodeType(input, inType);
-
- //output
- final ContainerSchemaNode output = operation.getOutput();
- final GeneratedTypeBuilder outType = resolveOperationNode(interfaceBuilder, module, operation.getOutput(),
- basePackageName, schemaContext, operationName, verboseClassComments, typeProvider, genTypeBuilders,
- genCtx, false, namespaceType);
- annotateDeprecatedIfNecessary(operation.getStatus(), outType);
- outType.setParentTypeForBuilder(interfaceBuilder);
- genCtx.get(module).addChildNodeType(output, outType);
-
- final GeneratedType inTypeInstance = inType.toInstance();
- operationMethod.addParameter(inTypeInstance, "input");
-
- if (isAction) {
- requireNonNull(parent, "Parent must be specified for action.");
- //action
- GeneratedTypeBuilder parentType = genCtx.get(module).getChildNode(parent.getPath());
- checkState(parentType != null, "Parent generated type for " + parent
- + " data schema node must have been generated already");
- annotateDeprecatedIfNecessary(parent.getStatus(), parentType);
-
- if (parent instanceof ListSchemaNode) {
- //ListAction
- GeneratedTransferObject keyType = null;
- for (MethodSignatureBuilder method : parentType.getMethodDefinitions()) {
- if (method.getName().equals("getIdentifier")) {
- keyType = (GeneratedTransferObject) method.toInstance(parentType).getReturnType();
- }
- }
-
- operationMethod.addParameter(parameterizedTypeFor(KEYED_INSTANCE_IDENTIFIER, parentType, keyType),
- "kii");
- interfaceBuilder.addImplementsType(parameterizedTypeFor(LIST_ACTION, parentType, keyType, inType,
- outType));
- } else {
- //Action
- operationMethod.addParameter(parameterizedTypeFor(INSTANCE_IDENTIFIER, parentType), "ii");
- interfaceBuilder.addImplementsType(parameterizedTypeFor(ACTION, parentType,
- parameterizedTypeFor(INSTANCE_IDENTIFIER, parentType), inType, outType));
- }
- } else {
- //RPC
- interfaceBuilder.addImplementsType(parameterizedTypeFor(RPC, inType, outType));
- }
-
- interfaceBuilder.addImplementsType(TREE_NODE);
- operationMethod.addParameter(parameterizedTypeFor(RPC_CALLBACK, outType), "callback");
-
- operationMethod.setComment(operationComment);
- operationMethod.setReturnType(VOID);
-
- return interfaceBuilder;
- }
-
- private static GeneratedTypeBuilder resolveOperationNode(final GeneratedTypeBuilder parent, final Module module,
- final ContainerSchemaNode operationNode, final String basePackageName, final SchemaContext schemaContext,
- final String operationName, final boolean verboseClassComments, final TypeProvider typeProvider,
- final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
- final Map<Module, ModuleContext> genCtx, final boolean isInput, final BindingNamespaceType namespaceType) {
- final GeneratedTypeBuilder nodeType = addRawInterfaceDefinition(basePackageName, operationNode, schemaContext,
- operationName, "", verboseClassComments, genTypeBuilders, namespaceType, genCtx.get(module));
- addImplementedInterfaceFromUses(operationNode, nodeType, genCtx);
-
- nodeType.addImplementsType(parameterizedTypeFor(BindingTypes.TREE_CHILD_NODE, parent,
- parameterizedTypeFor(BindingTypes.ITEM, nodeType)));
-
- if (isInput) {
- nodeType.addImplementsType(parameterizedTypeFor(INPUT, nodeType));
- } else {
- nodeType.addImplementsType(parameterizedTypeFor(OUTPUT, nodeType));
- }
- nodeType.addImplementsType(parameterizedTypeFor(INSTANTIABLE, nodeType));
- nodeType.addImplementsType(augmentable(nodeType));
- GenHelperUtil.resolveDataSchemaNodes(module, basePackageName, nodeType, nodeType, operationNode.getChildNodes(),
- genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
-
- final MethodSignatureBuilder nodeMethod = nodeType.addMethod("implementedInterface");
- nodeMethod.setReturnType(parameterizedTypeFor(CLASS, nodeType));
- nodeMethod.addAnnotation("", "Override");
-
- processUsesImplements(operationNode, module, schemaContext, genCtx, namespaceType);
-
- return nodeType;
- }
-}
Code Review / mdsal.git / blobdiff