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
  78     private final DefinitionGenerator jsonConverter = new DefinitionGenerator();
  79
  80     private final ObjectMapper mapper = new ObjectMapper();
  81     private final DOMSchemaService schemaService;
  82
  83     public static final String BASE_PATH = "/";
  84     public static final String MODULE_NAME_SUFFIX = "_module";
  85
  86     protected BaseYangSwaggerGenerator(final Optional<DOMSchemaService> schemaService) {
  87         this.schemaService = schemaService.orElse(null);
  88         mapper.configure(SerializationFeature.INDENT_OUTPUT, true);
  89     }
  90
  91     public DOMSchemaService getSchemaService() {
  92         return schemaService;
  93     }
  94
  95     public SwaggerObject getAllModulesDoc(final UriInfo uriInfo, final DefinitionNames definitionNames,
  96                                           final OAversion oaversion) {
  97         final EffectiveModelContext schemaContext = schemaService.getGlobalContext();
  98         Preconditions.checkState(schemaContext != null);
  99         return getAllModulesDoc(uriInfo, Optional.empty(), schemaContext, Optional.empty(), "", definitionNames,
 100                 oaversion);
 101     }
 102
 103     public SwaggerObject getAllModulesDoc(final UriInfo uriInfo, final Optional<Range<Integer>> range,
 104                                           final EffectiveModelContext schemaContext, final Optional<String> deviceName,
 105                                           final String context, final DefinitionNames definitionNames,
 106                                           final OAversion oaversion) {
 107         final String schema = createSchemaFromUriInfo(uriInfo);
 108         final String host = createHostFromUriInfo(uriInfo);
 109         String name = "Controller";
 110         if (deviceName.isPresent()) {
 111             name = deviceName.get();
 112         }
 113
 114         final String title = name + " modules of RESTCONF";
 115         final SwaggerObject doc = createSwaggerObject(schema, host, BASE_PATH, title);
 116         doc.setDefinitions(JsonNodeFactory.instance.objectNode());
 117         doc.setPaths(JsonNodeFactory.instance.objectNode());
 118
 119         fillDoc(doc, range, schemaContext, context, deviceName, oaversion, definitionNames);
 120
 121         return doc;
 122     }
 123
 124     public void fillDoc(final SwaggerObject doc, final Optional<Range<Integer>> range,
 125                         final EffectiveModelContext schemaContext, final String context,
 126                         final Optional<String> deviceName, final OAversion oaversion,
 127                         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,
 180                                            final OAversion oaversion) {
 181         final Optional<Revision> rev;
 182
 183         try {
 184             rev = Revision.ofNullable(revision);
 185         } catch (final DateTimeParseException e) {
 186             throw new IllegalArgumentException(e);
 187         }
 188
 189         final Module module = schemaContext.findModule(moduleName, rev).orElse(null);
 190         Preconditions.checkArgument(module != null,
 191                 "Could not find module by name,revision: " + moduleName + "," + revision);
 192
 193         return getApiDeclaration(module, uriInfo, context, schemaContext, oaversion);
 194     }
 195
 196     public SwaggerObject getApiDeclaration(final Module module, final UriInfo uriInfo, final String context,
 197                                            final EffectiveModelContext schemaContext, final OAversion oaversion) {
 198         final String schema = createSchemaFromUriInfo(uriInfo);
 199         final String host = createHostFromUriInfo(uriInfo);
 200
 201         return getSwaggerDocSpec(module, schema, host, BASE_PATH, context, schemaContext, oaversion);
 202     }
 203
 204     public String createHostFromUriInfo(final UriInfo uriInfo) {
 205         String portPart = "";
 206         final int port = uriInfo.getBaseUri().getPort();
 207         if (port != -1) {
 208             portPart = ":" + port;
 209         }
 210         return uriInfo.getBaseUri().getHost() + portPart;
 211     }
 212
 213     public String createSchemaFromUriInfo(final UriInfo uriInfo) {
 214         return uriInfo.getBaseUri().getScheme();
 215     }
 216
 217     public SwaggerObject getSwaggerDocSpec(final Module module, final String schema, final String host,
 218                                            final String basePath, final String context,
 219                                            final EffectiveModelContext schemaContext, final OAversion oaversion) {
 220         final SwaggerObject doc = createSwaggerObject(schema, host, basePath, module.getName());
 221         final DefinitionNames definitionNames = new DefinitionNames();
 222         return getSwaggerDocSpec(module, context, Optional.empty(), schemaContext, oaversion, definitionNames, doc,
 223             true);
 224     }
 225
 226     public SwaggerObject getSwaggerDocSpec(final Module module, final String context, final Optional<String> deviceName,
 227                                            final EffectiveModelContext schemaContext, final OAversion oaversion,
 228                                            final DefinitionNames definitionNames, final SwaggerObject doc,
 229                                            final boolean isForSingleModule) {
 230         final ObjectNode definitions;
 231
 232         try {
 233             if (isForSingleModule) {
 234                 definitions = jsonConverter.convertToJsonSchema(module, schemaContext, definitionNames, oaversion,
 235                         true);
 236                 doc.setDefinitions(definitions);
 237             } else {
 238                 definitions = jsonConverter.convertToJsonSchema(module, schemaContext, definitionNames, oaversion,
 239                         false);
 240                 addFields(doc.getDefinitions(), definitions.fields());
 241             }
 242             if (LOG.isDebugEnabled()) {
 243                 LOG.debug("Document: {}", mapper.writeValueAsString(doc));
 244             }
 245         } catch (final IOException e) {
 246             LOG.error("Exception occured in DefinitionGenerator", e);
 247         }
 248
 249         final ObjectNode paths = JsonNodeFactory.instance.objectNode();
 250         final String moduleName = module.getName();
 251
 252         boolean hasAddRootPostLink = false;
 253
 254         final Collection<? extends DataSchemaNode> dataSchemaNodes = module.getChildNodes();
 255         LOG.debug("child nodes size [{}]", dataSchemaNodes.size());
 256         for (final DataSchemaNode node : dataSchemaNodes) {
 257             if (node instanceof ListSchemaNode || node instanceof ContainerSchemaNode) {
 258                 LOG.debug("Is Configuration node [{}] [{}]", node.isConfiguration(), node.getQName().getLocalName());
 259
 260                 final String localName = module.getName() + ":" + node.getQName().getLocalName();
 261                 ArrayNode pathParams = JsonNodeFactory.instance.arrayNode();
 262                 String resourcePath;
 263
 264                 if (node.isConfiguration()) { // This node's config statement is
 265                     // true.
 266                     resourcePath = getResourcePath("config", context);
 267
 268                     /*
 269                      * When there are two or more top container or list nodes
 270                      * whose config statement is true in module, make sure that
 271                      * only one root post link is added for this module.
 272                      */
 273                     if (isForSingleModule && !hasAddRootPostLink) {
 274                         LOG.debug("Has added root post link for module {}", module.getName());
 275                         addRootPostLink(module, deviceName, pathParams, resourcePath, paths, oaversion);
 276
 277                         hasAddRootPostLink = true;
 278                     }
 279
 280                     final String resolvedPath = resourcePath + "/" + createPath(node, pathParams, oaversion, localName);
 281                     addPaths(node, deviceName, moduleName, paths, pathParams, schemaContext, true, module.getName(),
 282                         definitionNames, oaversion, resolvedPath);
 283                 }
 284                 pathParams = JsonNodeFactory.instance.arrayNode();
 285                 resourcePath = getResourcePath("operational", context);
 286
 287                 if (!node.isConfiguration()) {
 288                     final String resolvedPath = resourcePath + "/" + createPath(node, pathParams, oaversion, localName);
 289                     addPaths(node, deviceName, moduleName, paths, pathParams, schemaContext, false, moduleName,
 290                         definitionNames, oaversion, resolvedPath);
 291                 }
 292             }
 293         }
 294
 295         for (final RpcDefinition rpcDefinition : module.getRpcs()) {
 296             final String resolvedPath = getResourcePath("operations", context) + "/" + moduleName + ":"
 297                     + rpcDefinition.getQName().getLocalName();
 298             addOperations(rpcDefinition, moduleName, deviceName, paths, module.getName(), definitionNames, oaversion,
 299                     resolvedPath);
 300         }
 301
 302         LOG.debug("Number of Paths found [{}]", paths.size());
 303
 304         if (isForSingleModule) {
 305             doc.setPaths(paths);
 306         } else {
 307             addFields(doc.getPaths(), paths.fields());
 308         }
 309
 310         return doc;
 311     }
 312
 313     private static void addRootPostLink(final Module module, final Optional<String> deviceName,
 314             final ArrayNode pathParams, final String resourcePath, final ObjectNode paths, final OAversion oaversion) {
 315         if (containsListOrContainer(module.getChildNodes())) {
 316             final ObjectNode post = JsonNodeFactory.instance.objectNode();
 317             final String moduleName = module.getName();
 318             final String name = moduleName + MODULE_NAME_SUFFIX;
 319             post.set("post", buildPost("", name, "", moduleName, deviceName,
 320                     module.getDescription().orElse(""), pathParams, oaversion));
 321             paths.set(resourcePath, post);
 322         }
 323     }
 324
 325     public SwaggerObject createSwaggerObject(final String schema, final String host, final String basePath,
 326                                              final String title) {
 327         final SwaggerObject doc = new SwaggerObject();
 328         doc.setSwagger(SWAGGER_VERSION);
 329         final Info info = new Info();
 330         info.setTitle(title);
 331         info.setVersion(API_VERSION);
 332         doc.setInfo(info);
 333         doc.setSchemes(ImmutableList.of(schema));
 334         doc.setHost(host);
 335         doc.setBasePath(basePath);
 336         doc.setProduces(Arrays.asList("application/xml", "application/json"));
 337         return doc;
 338     }
 339
 340     public static CommonApiObject getAppropriateDoc(final SwaggerObject swaggerObject, final OAversion oaversion) {
 341         if (oaversion.equals(OAversion.V3_0)) {
 342             return convertToOpenApi(swaggerObject);
 343         }
 344         return swaggerObject;
 345     }
 346
 347     private static OpenApiObject convertToOpenApi(final SwaggerObject swaggerObject) {
 348         final OpenApiObject doc = new OpenApiObject();
 349         doc.setOpenapi(OPEN_API_VERSION);
 350         doc.setInfo(swaggerObject.getInfo());
 351         doc.setServers(convertToServers(swaggerObject.getSchemes(), swaggerObject.getHost(),
 352                 swaggerObject.getBasePath()));
 353         doc.setPaths(swaggerObject.getPaths());
 354         doc.setComponents(new Components(swaggerObject.getDefinitions()));
 355         return doc;
 356     }
 357
 358
 359     private static List<Server> convertToServers(final List<String> schemes, final String host, final String basePath) {
 360         return ImmutableList.of(new Server(schemes.get(0) + "://" + host + basePath));
 361     }
 362
 363     protected abstract String getPathVersion();
 364
 365     public abstract String getResourcePath(String resourceType, String context);
 366
 367     public abstract String getResourcePathPart(String resourceType);
 368
 369     private void addPaths(final DataSchemaNode node, final Optional<String> deviceName, final String moduleName,
 370                           final ObjectNode paths, final ArrayNode parentPathParams,
 371                           final EffectiveModelContext schemaContext, final boolean isConfig, final String parentName,
 372                           final DefinitionNames definitionNames, final OAversion oaversion, final String resourcePath) {
 373         LOG.debug("Adding path: [{}]", resourcePath);
 374
 375         final ArrayNode pathParams = JsonUtil.copy(parentPathParams);
 376         Iterable<? extends DataSchemaNode> childSchemaNodes = Collections.emptySet();
 377         if (node instanceof ListSchemaNode || node instanceof ContainerSchemaNode) {
 378             final DataNodeContainer dataNodeContainer = (DataNodeContainer) node;
 379             childSchemaNodes = dataNodeContainer.getChildNodes();
 380         }
 381
 382         final ObjectNode path = JsonNodeFactory.instance.objectNode();
 383         path.setAll(operations(node, moduleName, deviceName, pathParams, isConfig, parentName, definitionNames,
 384                 oaversion));
 385         paths.set(resourcePath, path);
 386
 387         if (node instanceof ActionNodeContainer) {
 388             ((ActionNodeContainer) node).getActions().forEach(actionDef -> {
 389                 final String resolvedPath = "rests/operations" + resourcePath.substring(11)
 390                         + "/" + resolvePathArgumentsName(actionDef.getQName(), node.getQName(), schemaContext);
 391                 addOperations(actionDef, moduleName, deviceName, paths, parentName, definitionNames, oaversion,
 392                         resolvedPath);
 393             });
 394         }
 395
 396         for (final DataSchemaNode childNode : childSchemaNodes) {
 397             if (childNode instanceof ListSchemaNode || childNode instanceof ContainerSchemaNode) {
 398                 final String newParent = parentName + "_" + node.getQName().getLocalName();
 399                 final String localName = resolvePathArgumentsName(childNode.getQName(), node.getQName(), schemaContext);
 400                 final String newResourcePath = resourcePath + "/" + createPath(childNode, pathParams, oaversion,
 401                         localName);
 402                 final boolean newIsConfig = isConfig && childNode.isConfiguration();
 403                 addPaths(childNode, deviceName, moduleName, paths, pathParams, schemaContext,
 404                     newIsConfig, newParent, definitionNames, oaversion, newResourcePath);
 405             }
 406         }
 407     }
 408
 409     private static boolean containsListOrContainer(final Iterable<? extends DataSchemaNode> nodes) {
 410         for (final DataSchemaNode child : nodes) {
 411             if (child instanceof ListSchemaNode || child instanceof ContainerSchemaNode) {
 412                 return true;
 413             }
 414         }
 415         return false;
 416     }
 417
 418     private static Map<String, ObjectNode> operations(final DataSchemaNode node, final String moduleName,
 419                                                       final Optional<String> deviceName, final ArrayNode pathParams,
 420                                                       final boolean isConfig, final String parentName,
 421                                                       final DefinitionNames definitionNames,
 422                                                       final OAversion oaversion) {
 423         final Map<String, ObjectNode> operations = new HashMap<>();
 424         final String discriminator = definitionNames.getDiscriminator(node);
 425
 426         final String nodeName = node.getQName().getLocalName();
 427
 428         final String defName = parentName + "_" + nodeName + TOP + discriminator;
 429         final ObjectNode get = buildGet(node, moduleName, deviceName, pathParams, defName, isConfig, oaversion);
 430         operations.put("get", get);
 431
 432
 433         if (isConfig) {
 434             final ObjectNode put = buildPut(parentName, nodeName, discriminator, moduleName, deviceName,
 435                     node.getDescription().orElse(""), pathParams, oaversion);
 436             operations.put("put", put);
 437
 438             final ObjectNode delete = buildDelete(node, moduleName, deviceName, pathParams, oaversion);
 439             operations.put("delete", delete);
 440
 441             operations.put("post", buildPost(parentName, nodeName, discriminator, moduleName, deviceName,
 442                     node.getDescription().orElse(""), pathParams, oaversion));
 443         }
 444         return operations;
 445     }
 446
 447     protected abstract ListPathBuilder newListPathBuilder();
 448
 449     private String createPath(final DataSchemaNode schemaNode, final ArrayNode pathParams,
 450                               final OAversion oaversion, final String localName) {
 451         final StringBuilder path = new StringBuilder();
 452         path.append(localName);
 453
 454         if (schemaNode instanceof ListSchemaNode) {
 455             final ListPathBuilder keyBuilder = newListPathBuilder();
 456             for (final QName listKey : ((ListSchemaNode) schemaNode).getKeyDefinition()) {
 457                 final String paramName = createUniquePathParamName(listKey.getLocalName(), pathParams);
 458                 final String pathParamIdentifier = keyBuilder.nextParamIdentifier(paramName);
 459
 460                 path.append(pathParamIdentifier);
 461
 462                 final ObjectNode pathParam = JsonNodeFactory.instance.objectNode();
 463                 pathParam.put("name", paramName);
 464
 465                 ((DataNodeContainer) schemaNode).findDataChildByName(listKey).flatMap(DataSchemaNode::getDescription)
 466                         .ifPresent(desc -> pathParam.put("description", desc));
 467
 468                 final ObjectNode typeParent = getTypeParentNode(pathParam, oaversion);
 469
 470                 typeParent.put("type", "string");
 471                 pathParam.put("in", "path");
 472                 pathParam.put("required", true);
 473
 474                 pathParams.add(pathParam);
 475             }
 476         }
 477         return path.toString();
 478     }
 479
 480     private String createUniquePathParamName(final String clearName, final ArrayNode pathParams) {
 481         for (final JsonNode pathParam : pathParams) {
 482             if (isNamePicked(clearName, pathParam)) {
 483                 return createUniquePathParamName(clearName, pathParams, 1);
 484             }
 485         }
 486         return clearName;
 487     }
 488
 489     private String createUniquePathParamName(final String clearName, final ArrayNode pathParams,
 490                                              final int discriminator) {
 491         final String newName = clearName + discriminator;
 492         for (final JsonNode pathParam : pathParams) {
 493             if (isNamePicked(newName, pathParam)) {
 494                 return createUniquePathParamName(clearName, pathParams, discriminator + 1);
 495             }
 496         }
 497         return newName;
 498     }
 499
 500     private static boolean isNamePicked(final String name, final JsonNode pathParam) {
 501         return name.equals(pathParam.get("name").asText());
 502     }
 503
 504     public SortedSet<Module> getSortedModules(final EffectiveModelContext schemaContext) {
 505         if (schemaContext == null) {
 506             return Collections.emptySortedSet();
 507         }
 508
 509         final SortedSet<Module> sortedModules = new TreeSet<>((module1, module2) -> {
 510             int result = module1.getName().compareTo(module2.getName());
 511             if (result == 0) {
 512                 result = Revision.compare(module1.getRevision(), module2.getRevision());
 513             }
 514             if (result == 0) {
 515                 result = module1.getNamespace().compareTo(module2.getNamespace());
 516             }
 517             return result;
 518         });
 519         for (final Module m : schemaContext.getModules()) {
 520             if (m != null) {
 521                 sortedModules.add(m);
 522             }
 523         }
 524         return sortedModules;
 525     }
 526
 527     private static void addOperations(final OperationDefinition operDef, final String moduleName,
 528             final Optional<String> deviceName, final ObjectNode paths, final String parentName,
 529             final DefinitionNames definitionNames, final OAversion oaversion, final String resourcePath) {
 530         final ObjectNode operations = JsonNodeFactory.instance.objectNode();
 531         operations.set("post", buildPostOperation(operDef, moduleName, deviceName, parentName, definitionNames,
 532                 oaversion));
 533         paths.set(resourcePath, operations);
 534     }
 535
 536     protected abstract void appendPathKeyValue(StringBuilder builder, Object value);
 537
 538     public String generateUrlPrefixFromInstanceID(final YangInstanceIdentifier key, final String moduleName) {
 539         final StringBuilder builder = new StringBuilder();
 540         builder.append("/");
 541         if (moduleName != null) {
 542             builder.append(moduleName).append(':');
 543         }
 544         for (final PathArgument arg : key.getPathArguments()) {
 545             final String name = arg.getNodeType().getLocalName();
 546             if (arg instanceof NodeIdentifierWithPredicates) {
 547                 final NodeIdentifierWithPredicates nodeId = (NodeIdentifierWithPredicates) arg;
 548                 for (final Entry<QName, Object> entry : nodeId.entrySet()) {
 549                     appendPathKeyValue(builder, entry.getValue());
 550                 }
 551             } else {
 552                 builder.append(name).append('/');
 553             }
 554         }
 555         return builder.toString();
 556     }
 557
 558     protected interface ListPathBuilder {
 559         String nextParamIdentifier(String key);
 560     }
 561 }