restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/impl/BaseYangSwaggerGenerator.java

   1 /*
   2  * Copyright (c) 2014 Brocade Communications Systems, Inc. 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.netconf.sal.rest.doc.impl;
   9
  10 import static org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.TOP;
  11 import static org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.buildDelete;
  12 import static org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.buildGet;
  13 import static org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.buildPost;
  14 import static org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.buildPostOperation;
  15 import static org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.buildPut;
  16 import static org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.getTypeParentNode;
  17 import static org.opendaylight.netconf.sal.rest.doc.util.JsonUtil.addFields;
  18 import static org.opendaylight.netconf.sal.rest.doc.util.RestDocgenUtil.resolvePathArgumentsName;
  19
  20 import com.fasterxml.jackson.databind.JsonNode;
  21 import com.fasterxml.jackson.databind.ObjectMapper;
  22 import com.fasterxml.jackson.databind.SerializationFeature;
  23 import com.fasterxml.jackson.databind.node.ArrayNode;
  24 import com.fasterxml.jackson.databind.node.JsonNodeFactory;
  25 import com.fasterxml.jackson.databind.node.ObjectNode;
  26 import com.google.common.base.Preconditions;
  27 import com.google.common.collect.ImmutableList;
  28 import com.google.common.collect.Range;
  29 import java.io.IOException;
  30 import java.time.format.DateTimeParseException;
  31 import java.util.Arrays;
  32 import java.util.Collection;
  33 import java.util.Collections;
  34 import java.util.HashMap;
  35 import java.util.Iterator;
  36 import java.util.List;
  37 import java.util.Map;
  38 import java.util.Map.Entry;
  39 import java.util.Optional;
  40 import java.util.Set;
  41 import java.util.SortedSet;
  42 import java.util.TreeSet;
  43 import javax.ws.rs.core.UriInfo;
  44 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
  45 import org.opendaylight.netconf.sal.rest.doc.impl.ApiDocServiceImpl.OAversion;
  46 import org.opendaylight.netconf.sal.rest.doc.swagger.CommonApiObject;
  47 import org.opendaylight.netconf.sal.rest.doc.swagger.Components;
  48 import org.opendaylight.netconf.sal.rest.doc.swagger.Info;
  49 import org.opendaylight.netconf.sal.rest.doc.swagger.OpenApiObject;
  50 import org.opendaylight.netconf.sal.rest.doc.swagger.Server;
  51 import org.opendaylight.netconf.sal.rest.doc.swagger.SwaggerObject;
  52 import org.opendaylight.netconf.sal.rest.doc.util.JsonUtil;
  53 import org.opendaylight.yangtools.yang.common.QName;
  54 import org.opendaylight.yangtools.yang.common.Revision;
  55 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  56 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  57 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  58 import org.opendaylight.yangtools.yang.model.api.ActionNodeContainer;
  59 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  60 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  61 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  62 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  63 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  64 import org.opendaylight.yangtools.yang.model.api.Module;
  65 import org.opendaylight.yangtools.yang.model.api.OperationDefinition;
  66 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  67 import org.slf4j.Logger;
  68 import org.slf4j.LoggerFactory;
  69
  70 public abstract class BaseYangSwaggerGenerator {
  71
  72     private static final Logger LOG = LoggerFactory.getLogger(BaseYangSwaggerGenerator.class);
  73
  74     private static final String API_VERSION = "1.0.0";
  75     private static final String SWAGGER_VERSION = "2.0";
  76     private static final String OPEN_API_VERSION = "3.0.3";
  77     private static final ObjectMapper MAPPER = new ObjectMapper();
  78
  79     private final DefinitionGenerator jsonConverter = new DefinitionGenerator();
  80     private final DOMSchemaService schemaService;
  81
  82     public static final String BASE_PATH = "/";
  83     public static final String MODULE_NAME_SUFFIX = "_module";
  84
  85     static {
  86         MAPPER.configure(SerializationFeature.INDENT_OUTPUT, true);
  87     }
  88
  89     protected BaseYangSwaggerGenerator(final Optional<DOMSchemaService> schemaService) {
  90         this.schemaService = schemaService.orElse(null);
  91     }
  92
  93     public DOMSchemaService getSchemaService() {
  94         return schemaService;
  95     }
  96
  97     public SwaggerObject getAllModulesDoc(final UriInfo uriInfo, final DefinitionNames definitionNames,
  98             final OAversion oaversion) {
  99         final EffectiveModelContext schemaContext = schemaService.getGlobalContext();
 100         Preconditions.checkState(schemaContext != null);
 101         return getAllModulesDoc(uriInfo, Optional.empty(), schemaContext, Optional.empty(), "", definitionNames,
 102                 oaversion);
 103     }
 104
 105     public SwaggerObject getAllModulesDoc(final UriInfo uriInfo, final Optional<Range<Integer>> range,
 106             final EffectiveModelContext schemaContext, final Optional<String> deviceName, final String context,
 107             final DefinitionNames definitionNames, final OAversion oaversion) {
 108         final String schema = createSchemaFromUriInfo(uriInfo);
 109         final String host = createHostFromUriInfo(uriInfo);
 110         String name = "Controller";
 111         if (deviceName.isPresent()) {
 112             name = deviceName.get();
 113         }
 114
 115         final String title = name + " modules of RESTCONF";
 116         final SwaggerObject doc = createSwaggerObject(schema, host, BASE_PATH, title);
 117         doc.setDefinitions(JsonNodeFactory.instance.objectNode());
 118         doc.setPaths(JsonNodeFactory.instance.objectNode());
 119
 120         fillDoc(doc, range, schemaContext, context, deviceName, oaversion, definitionNames);
 121
 122         return doc;
 123     }
 124
 125     public void fillDoc(final SwaggerObject doc, final Optional<Range<Integer>> range,
 126             final EffectiveModelContext schemaContext, final String context,  final Optional<String> deviceName,
 127             final OAversion oaversion, final DefinitionNames definitionNames) {
 128         final SortedSet<Module> modules = getSortedModules(schemaContext);
 129         final Set<Module> filteredModules;
 130         if (range.isPresent()) {
 131             filteredModules = filterByRange(modules, range.get());
 132         } else {
 133             filteredModules = modules;
 134         }
 135
 136         for (final Module module : filteredModules) {
 137             final String revisionString = module.getQNameModule().getRevision().map(Revision::toString).orElse(null);
 138
 139             LOG.debug("Working on [{},{}]...", module.getName(), revisionString);
 140
 141             getSwaggerDocSpec(module, context, deviceName, schemaContext, oaversion, definitionNames, doc, false);
 142         }
 143     }
 144
 145     private static Set<Module> filterByRange(final SortedSet<Module> modules, final Range<Integer> range) {
 146         final int begin = range.lowerEndpoint();
 147         final int end = range.upperEndpoint();
 148
 149         Module firstModule = null;
 150
 151         final Iterator<Module> iterator = modules.iterator();
 152         int counter = 0;
 153         while (iterator.hasNext() && counter < end) {
 154             final Module module = iterator.next();
 155             if (containsListOrContainer(module.getChildNodes()) || !module.getRpcs().isEmpty()) {
 156                 if (counter == begin) {
 157                     firstModule = module;
 158                 }
 159                 counter++;
 160             }
 161         }
 162
 163         if (iterator.hasNext()) {
 164             return modules.subSet(firstModule, iterator.next());
 165         } else {
 166             return modules.tailSet(firstModule);
 167         }
 168     }
 169
 170     public CommonApiObject getApiDeclaration(final String module, final String revision, final UriInfo uriInfo,
 171             final OAversion oaversion) {
 172         final EffectiveModelContext schemaContext = schemaService.getGlobalContext();
 173         Preconditions.checkState(schemaContext != null);
 174         final SwaggerObject doc = getApiDeclaration(module, revision, uriInfo, schemaContext, "", oaversion);
 175         return getAppropriateDoc(doc, oaversion);
 176     }
 177
 178     public SwaggerObject getApiDeclaration(final String moduleName, final String revision, final UriInfo uriInfo,
 179             final EffectiveModelContext schemaContext, final String context, final OAversion oaversion) {
 180         final Optional<Revision> rev;
 181
 182         try {
 183             rev = Revision.ofNullable(revision);
 184         } catch (final DateTimeParseException e) {
 185             throw new IllegalArgumentException(e);
 186         }
 187
 188         final Module module = schemaContext.findModule(moduleName, rev).orElse(null);
 189         Preconditions.checkArgument(module != null,
 190                 "Could not find module by name,revision: " + moduleName + "," + revision);
 191
 192         return getApiDeclaration(module, uriInfo, context, schemaContext, oaversion);
 193     }
 194
 195     public SwaggerObject getApiDeclaration(final Module module, final UriInfo uriInfo, final String context,
 196             final EffectiveModelContext schemaContext, final OAversion oaversion) {
 197         final String schema = createSchemaFromUriInfo(uriInfo);
 198         final String host = createHostFromUriInfo(uriInfo);
 199
 200         return getSwaggerDocSpec(module, schema, host, BASE_PATH, context, schemaContext, oaversion);
 201     }
 202
 203     public String createHostFromUriInfo(final UriInfo uriInfo) {
 204         String portPart = "";
 205         final int port = uriInfo.getBaseUri().getPort();
 206         if (port != -1) {
 207             portPart = ":" + port;
 208         }
 209         return uriInfo.getBaseUri().getHost() + portPart;
 210     }
 211
 212     public String createSchemaFromUriInfo(final UriInfo uriInfo) {
 213         return uriInfo.getBaseUri().getScheme();
 214     }
 215
 216     public SwaggerObject getSwaggerDocSpec(final Module module, final String schema, final String host,
 217             final String basePath, final String context, final EffectiveModelContext schemaContext,
 218             final OAversion oaversion) {
 219         final SwaggerObject doc = createSwaggerObject(schema, host, basePath, module.getName());
 220         final DefinitionNames definitionNames = new DefinitionNames();
 221         return getSwaggerDocSpec(module, context, Optional.empty(), schemaContext, oaversion, definitionNames, doc,
 222             true);
 223     }
 224
 225     public SwaggerObject getSwaggerDocSpec(final Module module, final String context, final Optional<String> deviceName,
 226             final EffectiveModelContext schemaContext, final OAversion oaversion, final DefinitionNames definitionNames,
 227             final SwaggerObject doc, final boolean isForSingleModule) {
 228         final ObjectNode definitions;
 229
 230         try {
 231             if (isForSingleModule) {
 232                 definitions = jsonConverter.convertToJsonSchema(module, schemaContext, definitionNames, oaversion,
 233                         true);
 234                 doc.setDefinitions(definitions);
 235             } else {
 236                 definitions = jsonConverter.convertToJsonSchema(module, schemaContext, definitionNames, oaversion,
 237                         false);
 238                 addFields(doc.getDefinitions(), definitions.fields());
 239             }
 240             if (LOG.isDebugEnabled()) {
 241                 LOG.debug("Document: {}", MAPPER.writeValueAsString(doc));
 242             }
 243         } catch (final IOException e) {
 244             LOG.error("Exception occured in DefinitionGenerator", e);
 245         }
 246
 247         final ObjectNode paths = JsonNodeFactory.instance.objectNode();
 248         final String moduleName = module.getName();
 249
 250         boolean hasAddRootPostLink = false;
 251
 252         final Collection<? extends DataSchemaNode> dataSchemaNodes = module.getChildNodes();
 253         LOG.debug("child nodes size [{}]", dataSchemaNodes.size());
 254         for (final DataSchemaNode node : dataSchemaNodes) {
 255             if (node instanceof ListSchemaNode || node instanceof ContainerSchemaNode) {
 256                 LOG.debug("Is Configuration node [{}] [{}]", node.isConfiguration(), node.getQName().getLocalName());
 257
 258                 final String localName = module.getName() + ":" + node.getQName().getLocalName();
 259                 ArrayNode pathParams = JsonNodeFactory.instance.arrayNode();
 260                 String resourcePath;
 261
 262                 if (node.isConfiguration()) { // This node's config statement is
 263                     // true.
 264                     resourcePath = getResourcePath("config", context);
 265
 266                     /*
 267                      * When there are two or more top container or list nodes
 268                      * whose config statement is true in module, make sure that
 269                      * only one root post link is added for this module.
 270                      */
 271                     if (isForSingleModule && !hasAddRootPostLink) {
 272                         LOG.debug("Has added root post link for module {}", module.getName());
 273                         addRootPostLink(module, deviceName, pathParams, resourcePath, paths, oaversion);
 274
 275                         hasAddRootPostLink = true;
 276                     }
 277
 278                     final String resolvedPath = resourcePath + "/" + createPath(node, pathParams, oaversion, localName);
 279                     addPaths(node, deviceName, moduleName, paths, pathParams, schemaContext, true, module.getName(),
 280                         definitionNames, oaversion, resolvedPath);
 281                 }
 282                 pathParams = JsonNodeFactory.instance.arrayNode();
 283                 resourcePath = getResourcePath("operational", context);
 284
 285                 if (!node.isConfiguration()) {
 286                     final String resolvedPath = resourcePath + "/" + createPath(node, pathParams, oaversion, localName);
 287                     addPaths(node, deviceName, moduleName, paths, pathParams, schemaContext, false, moduleName,
 288                         definitionNames, oaversion, resolvedPath);
 289                 }
 290             }
 291         }
 292
 293         for (final RpcDefinition rpcDefinition : module.getRpcs()) {
 294             final String resolvedPath = getResourcePath("operations", context) + "/" + moduleName + ":"
 295                     + rpcDefinition.getQName().getLocalName();
 296             addOperations(rpcDefinition, moduleName, deviceName, paths, module.getName(), definitionNames, oaversion,
 297                     resolvedPath);
 298         }
 299
 300         LOG.debug("Number of Paths found [{}]", paths.size());
 301
 302         if (isForSingleModule) {
 303             doc.setPaths(paths);
 304         } else {
 305             addFields(doc.getPaths(), paths.fields());
 306         }
 307
 308         return doc;
 309     }
 310
 311     private static void addRootPostLink(final Module module, final Optional<String> deviceName,
 312             final ArrayNode pathParams, final String resourcePath, final ObjectNode paths, final OAversion oaversion) {
 313         if (containsListOrContainer(module.getChildNodes())) {
 314             final ObjectNode post = JsonNodeFactory.instance.objectNode();
 315             final String moduleName = module.getName();
 316             final String name = moduleName + MODULE_NAME_SUFFIX;
 317             post.set("post", buildPost("", name, "", moduleName, deviceName,
 318                     module.getDescription().orElse(""), pathParams, oaversion));
 319             paths.set(resourcePath, post);
 320         }
 321     }
 322
 323     public SwaggerObject createSwaggerObject(final String schema, final String host, final String basePath,
 324             final String title) {
 325         final SwaggerObject doc = new SwaggerObject();
 326         doc.setSwagger(SWAGGER_VERSION);
 327         final Info info = new Info();
 328         info.setTitle(title);
 329         info.setVersion(API_VERSION);
 330         doc.setInfo(info);
 331         doc.setSchemes(ImmutableList.of(schema));
 332         doc.setHost(host);
 333         doc.setBasePath(basePath);
 334         doc.setProduces(Arrays.asList("application/xml", "application/json"));
 335         return doc;
 336     }
 337
 338     public static CommonApiObject getAppropriateDoc(final SwaggerObject swaggerObject, final OAversion oaversion) {
 339         if (oaversion.equals(OAversion.V3_0)) {
 340             return convertToOpenApi(swaggerObject);
 341         }
 342         return swaggerObject;
 343     }
 344
 345     private static OpenApiObject convertToOpenApi(final SwaggerObject swaggerObject) {
 346         final OpenApiObject doc = new OpenApiObject();
 347         doc.setOpenapi(OPEN_API_VERSION);
 348         doc.setInfo(swaggerObject.getInfo());
 349         doc.setServers(convertToServers(swaggerObject.getSchemes(), swaggerObject.getHost(),
 350                 swaggerObject.getBasePath()));
 351         doc.setPaths(swaggerObject.getPaths());
 352         doc.setComponents(new Components(swaggerObject.getDefinitions()));
 353         return doc;
 354     }
 355
 356
 357     private static List<Server> convertToServers(final List<String> schemes, final String host, final String basePath) {
 358         return ImmutableList.of(new Server(schemes.get(0) + "://" + host + basePath));
 359     }
 360
 361     protected abstract String getPathVersion();
 362
 363     public abstract String getResourcePath(String resourceType, String context);
 364
 365     public abstract String getResourcePathPart(String resourceType);
 366
 367     private void addPaths(final DataSchemaNode node, final Optional<String> deviceName, final String moduleName,
 368             final ObjectNode paths, final ArrayNode parentPathParams, final EffectiveModelContext schemaContext,
 369             final boolean isConfig, final String parentName, final DefinitionNames definitionNames,
 370             final OAversion oaversion, final String resourcePath) {
 371         LOG.debug("Adding path: [{}]", resourcePath);
 372
 373         final ArrayNode pathParams = JsonUtil.copy(parentPathParams);
 374         Iterable<? extends DataSchemaNode> childSchemaNodes = Collections.emptySet();
 375         if (node instanceof ListSchemaNode || node instanceof ContainerSchemaNode) {
 376             final DataNodeContainer dataNodeContainer = (DataNodeContainer) node;
 377             childSchemaNodes = dataNodeContainer.getChildNodes();
 378         }
 379
 380         final ObjectNode path = JsonNodeFactory.instance.objectNode();
 381         path.setAll(operations(node, moduleName, deviceName, pathParams, isConfig, parentName, definitionNames,
 382                 oaversion));
 383         paths.set(resourcePath, path);
 384
 385         if (node instanceof ActionNodeContainer) {
 386             ((ActionNodeContainer) node).getActions().forEach(actionDef -> {
 387                 final String resolvedPath = "rests/operations" + resourcePath.substring(11)
 388                         + "/" + resolvePathArgumentsName(actionDef.getQName(), node.getQName(), schemaContext);
 389                 addOperations(actionDef, moduleName, deviceName, paths, parentName, definitionNames, oaversion,
 390                         resolvedPath);
 391             });
 392         }
 393
 394         for (final DataSchemaNode childNode : childSchemaNodes) {
 395             if (childNode instanceof ListSchemaNode || childNode instanceof ContainerSchemaNode) {
 396                 final String newParent = parentName + "_" + node.getQName().getLocalName();
 397                 final String localName = resolvePathArgumentsName(childNode.getQName(), node.getQName(), schemaContext);
 398                 final String newResourcePath = resourcePath + "/" + createPath(childNode, pathParams, oaversion,
 399                         localName);
 400                 final boolean newIsConfig = isConfig && childNode.isConfiguration();
 401                 addPaths(childNode, deviceName, moduleName, paths, pathParams, schemaContext,
 402                     newIsConfig, newParent, definitionNames, oaversion, newResourcePath);
 403             }
 404         }
 405     }
 406
 407     private static boolean containsListOrContainer(final Iterable<? extends DataSchemaNode> nodes) {
 408         for (final DataSchemaNode child : nodes) {
 409             if (child instanceof ListSchemaNode || child instanceof ContainerSchemaNode) {
 410                 return true;
 411             }
 412         }
 413         return false;
 414     }
 415
 416     private static Map<String, ObjectNode> operations(final DataSchemaNode node, final String moduleName,
 417             final Optional<String> deviceName, final ArrayNode pathParams, final boolean isConfig,
 418             final String parentName, final DefinitionNames definitionNames, final OAversion oaversion) {
 419         final Map<String, ObjectNode> operations = new HashMap<>();
 420         final String discriminator = definitionNames.getDiscriminator(node);
 421
 422         final String nodeName = node.getQName().getLocalName();
 423
 424         final String defName = parentName + "_" + nodeName + TOP + discriminator;
 425         final ObjectNode get = buildGet(node, moduleName, deviceName, pathParams, defName, isConfig, oaversion);
 426         operations.put("get", get);
 427
 428
 429         if (isConfig) {
 430             final ObjectNode put = buildPut(parentName, nodeName, discriminator, moduleName, deviceName,
 431                     node.getDescription().orElse(""), pathParams, oaversion);
 432             operations.put("put", put);
 433
 434             final ObjectNode delete = buildDelete(node, moduleName, deviceName, pathParams, oaversion);
 435             operations.put("delete", delete);
 436
 437             operations.put("post", buildPost(parentName, nodeName, discriminator, moduleName, deviceName,
 438                     node.getDescription().orElse(""), pathParams, oaversion));
 439         }
 440         return operations;
 441     }
 442
 443     protected abstract ListPathBuilder newListPathBuilder();
 444
 445     private String createPath(final DataSchemaNode schemaNode, final ArrayNode pathParams,
 446             final OAversion oaversion, final String localName) {
 447         final StringBuilder path = new StringBuilder();
 448         path.append(localName);
 449
 450         if (schemaNode instanceof ListSchemaNode) {
 451             final ListPathBuilder keyBuilder = newListPathBuilder();
 452             for (final QName listKey : ((ListSchemaNode) schemaNode).getKeyDefinition()) {
 453                 final String paramName = createUniquePathParamName(listKey.getLocalName(), pathParams);
 454                 final String pathParamIdentifier = keyBuilder.nextParamIdentifier(paramName);
 455
 456                 path.append(pathParamIdentifier);
 457
 458                 final ObjectNode pathParam = JsonNodeFactory.instance.objectNode();
 459                 pathParam.put("name", paramName);
 460
 461                 ((DataNodeContainer) schemaNode).findDataChildByName(listKey).flatMap(DataSchemaNode::getDescription)
 462                         .ifPresent(desc -> pathParam.put("description", desc));
 463
 464                 final ObjectNode typeParent = getTypeParentNode(pathParam, oaversion);
 465
 466                 typeParent.put("type", "string");
 467                 pathParam.put("in", "path");
 468                 pathParam.put("required", true);
 469
 470                 pathParams.add(pathParam);
 471             }
 472         }
 473         return path.toString();
 474     }
 475
 476     private String createUniquePathParamName(final String clearName, final ArrayNode pathParams) {
 477         for (final JsonNode pathParam : pathParams) {
 478             if (isNamePicked(clearName, pathParam)) {
 479                 return createUniquePathParamName(clearName, pathParams, 1);
 480             }
 481         }
 482         return clearName;
 483     }
 484
 485     private String createUniquePathParamName(final String clearName, final ArrayNode pathParams,
 486             final int discriminator) {
 487         final String newName = clearName + discriminator;
 488         for (final JsonNode pathParam : pathParams) {
 489             if (isNamePicked(newName, pathParam)) {
 490                 return createUniquePathParamName(clearName, pathParams, discriminator + 1);
 491             }
 492         }
 493         return newName;
 494     }
 495
 496     private static boolean isNamePicked(final String name, final JsonNode pathParam) {
 497         return name.equals(pathParam.get("name").asText());
 498     }
 499
 500     public SortedSet<Module> getSortedModules(final EffectiveModelContext schemaContext) {
 501         if (schemaContext == null) {
 502             return Collections.emptySortedSet();
 503         }
 504
 505         final SortedSet<Module> sortedModules = new TreeSet<>((module1, module2) -> {
 506             int result = module1.getName().compareTo(module2.getName());
 507             if (result == 0) {
 508                 result = Revision.compare(module1.getRevision(), module2.getRevision());
 509             }
 510             if (result == 0) {
 511                 result = module1.getNamespace().compareTo(module2.getNamespace());
 512             }
 513             return result;
 514         });
 515         for (final Module m : schemaContext.getModules()) {
 516             if (m != null) {
 517                 sortedModules.add(m);
 518             }
 519         }
 520         return sortedModules;
 521     }
 522
 523     private static void addOperations(final OperationDefinition operDef, final String moduleName,
 524             final Optional<String> deviceName, final ObjectNode paths, final String parentName,
 525             final DefinitionNames definitionNames, final OAversion oaversion, final String resourcePath) {
 526         final ObjectNode operations = JsonNodeFactory.instance.objectNode();
 527         operations.set("post", buildPostOperation(operDef, moduleName, deviceName, parentName, definitionNames,
 528                 oaversion));
 529         paths.set(resourcePath, operations);
 530     }
 531
 532     protected abstract void appendPathKeyValue(StringBuilder builder, Object value);
 533
 534     public String generateUrlPrefixFromInstanceID(final YangInstanceIdentifier key, final String moduleName) {
 535         final StringBuilder builder = new StringBuilder();
 536         builder.append("/");
 537         if (moduleName != null) {
 538             builder.append(moduleName).append(':');
 539         }
 540         for (final PathArgument arg : key.getPathArguments()) {
 541             final String name = arg.getNodeType().getLocalName();
 542             if (arg instanceof NodeIdentifierWithPredicates) {
 543                 final NodeIdentifierWithPredicates nodeId = (NodeIdentifierWithPredicates) arg;
 544                 for (final Entry<QName, Object> entry : nodeId.entrySet()) {
 545                     appendPathKeyValue(builder, entry.getValue());
 546                 }
 547             } else {
 548                 builder.append(name).append('/');
 549             }
 550         }
 551         return builder.toString();
 552     }
 553
 554     protected interface ListPathBuilder {
 555         String nextParamIdentifier(String key);
 556     }
 557 }