package org.opendaylight.netconf.sal.rest.doc.impl;
import static org.opendaylight.netconf.sal.rest.doc.util.RestDocgenUtil.resolvePathArgumentsName;
+
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
-import com.fasterxml.jackson.datatype.jsonorg.JsonOrgModule;
+import com.fasterxml.jackson.databind.node.ObjectNode;
import com.google.common.base.Preconditions;
import java.io.IOException;
import java.net.URI;
-import java.text.DateFormat;
-import java.text.ParseException;
-import java.text.SimpleDateFormat;
+import java.time.format.DateTimeParseException;
import java.util.ArrayList;
import java.util.Arrays;
-import java.util.Calendar;
import java.util.Collection;
import java.util.Collections;
-import java.util.Date;
-import java.util.GregorianCalendar;
import java.util.List;
+import java.util.Map.Entry;
+import java.util.Optional;
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeSet;
import javax.ws.rs.core.UriInfo;
-import org.json.JSONException;
-import org.json.JSONObject;
+import org.opendaylight.mdsal.dom.api.DOMSchemaService;
import org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder;
+import org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Delete;
+import org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Get;
+import org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Post;
+import org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Put;
import org.opendaylight.netconf.sal.rest.doc.swagger.Api;
import org.opendaylight.netconf.sal.rest.doc.swagger.ApiDeclaration;
import org.opendaylight.netconf.sal.rest.doc.swagger.Operation;
import org.opendaylight.netconf.sal.rest.doc.swagger.Parameter;
import org.opendaylight.netconf.sal.rest.doc.swagger.Resource;
import org.opendaylight.netconf.sal.rest.doc.swagger.ResourceList;
-import org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Delete;
-import org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Get;
-import org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Post;
-import org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Put;
import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.common.Revision;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
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.LeafSchemaNode;
import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
import org.opendaylight.yangtools.yang.model.api.Module;
import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-public class BaseYangSwaggerGenerator {
+public abstract class BaseYangSwaggerGenerator {
private static final Logger LOG = LoggerFactory.getLogger(BaseYangSwaggerGenerator.class);
protected static final String API_VERSION = "1.0.0";
protected static final String SWAGGER_VERSION = "1.2";
- protected static final String RESTCONF_CONTEXT_ROOT = "restconf";
static final String MODULE_NAME_SUFFIX = "_module";
- protected static final DateFormat SIMPLE_DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd");
private final ModelGenerator jsonConverter = new ModelGenerator();
// private Map<String, ApiDeclaration> MODULE_DOC_CACHE = new HashMap<>()
private final ObjectMapper mapper = new ObjectMapper();
+ private final DOMSchemaService schemaService;
+
+ protected BaseYangSwaggerGenerator(final Optional<DOMSchemaService> schemaService) {
+ this.schemaService = schemaService.orElse(null);
+ this.mapper.configure(SerializationFeature.INDENT_OUTPUT, true);
+ }
- protected BaseYangSwaggerGenerator() {
- mapper.registerModule(new JsonOrgModule());
- mapper.configure(SerializationFeature.INDENT_OUTPUT, true);
+ public DOMSchemaService getSchemaService() {
+ return schemaService;
+ }
+
+ public ResourceList getResourceListing(final UriInfo uriInfo) {
+ final SchemaContext schemaContext = schemaService.getGlobalContext();
+ Preconditions.checkState(schemaContext != null);
+ return getResourceListing(uriInfo, schemaContext, "");
}
/**
* Return list of modules converted to swagger compliant resource list.
*/
- public ResourceList getResourceListing(UriInfo uriInfo, SchemaContext schemaContext, String context) {
+ public ResourceList getResourceListing(final UriInfo uriInfo, final SchemaContext schemaContext,
+ final String context) {
- ResourceList resourceList = createResourceList();
+ final ResourceList resourceList = createResourceList();
- Set<Module> modules = getSortedModules(schemaContext);
+ final Set<Module> modules = getSortedModules(schemaContext);
- List<Resource> resources = new ArrayList<>(modules.size());
+ final List<Resource> resources = new ArrayList<>(modules.size());
LOG.info("Modules found [{}]", modules.size());
- for (Module module : modules) {
- String revisionString = SIMPLE_DATE_FORMAT.format(module.getRevision());
- Resource resource = new Resource();
+ for (final Module module : modules) {
+ final String revisionString = module.getQNameModule().getRevision().map(Revision::toString).orElse(null);
+ final Resource resource = new Resource();
LOG.debug("Working on [{},{}]...", module.getName(), revisionString);
- ApiDeclaration doc = getApiDeclaration(module.getName(), revisionString, uriInfo, schemaContext, context);
+ final ApiDeclaration doc =
+ getApiDeclaration(module.getName(), revisionString, uriInfo, schemaContext, context);
if (doc != null) {
resource.setPath(generatePath(uriInfo, module.getName(), revisionString));
resources.add(resource);
} else {
- LOG.debug("Could not generate doc for {},{}", module.getName(), revisionString);
+ LOG.warn("Could not generate doc for {},{}", module.getName(), revisionString);
}
}
return resourceList;
}
- protected ResourceList createResourceList() {
- ResourceList resourceList = new ResourceList();
+ public ResourceList createResourceList() {
+ final ResourceList resourceList = new ResourceList();
resourceList.setApiVersion(API_VERSION);
resourceList.setSwaggerVersion(SWAGGER_VERSION);
return resourceList;
}
- protected String generatePath(UriInfo uriInfo, String name, String revision) {
- URI uri = uriInfo.getRequestUriBuilder().path(generateCacheKey(name, revision)).build();
+ public String generatePath(final UriInfo uriInfo, final String name, final String revision) {
+ final URI uri = uriInfo.getRequestUriBuilder().path(generateCacheKey(name, revision)).build();
return uri.toASCIIString();
}
- public ApiDeclaration getApiDeclaration(String moduleName, String revision, UriInfo uriInfo, SchemaContext schemaContext, String context) {
- Date rev = null;
+ public ApiDeclaration getApiDeclaration(final String module, final String revision, final UriInfo uriInfo) {
+ final SchemaContext schemaContext = schemaService.getGlobalContext();
+ Preconditions.checkState(schemaContext != null);
+ return getApiDeclaration(module, revision, uriInfo, schemaContext, "");
+ }
+
+ public ApiDeclaration getApiDeclaration(final String moduleName, final String revision, final UriInfo uriInfo,
+ final SchemaContext schemaContext, final String context) {
+ final Optional<Revision> rev;
try {
- if (revision != null && !revision.equals("0000-00-00")) {
- rev = SIMPLE_DATE_FORMAT.parse(revision);
- }
- } catch (ParseException e) {
+ rev = Revision.ofNullable(revision);
+ } catch (final DateTimeParseException e) {
throw new IllegalArgumentException(e);
}
- if (rev != null) {
- Calendar cal = new GregorianCalendar();
-
- cal.setTime(rev);
-
- if (cal.get(Calendar.YEAR) < 1970) {
- rev = null;
- }
- }
-
- Module module = schemaContext.findModuleByName(moduleName, rev);
+ final Module module = schemaContext.findModule(moduleName, rev).orElse(null);
Preconditions.checkArgument(module != null,
"Could not find module by name,revision: " + moduleName + "," + revision);
- return getApiDeclaration(module, rev, uriInfo, context, schemaContext);
+ return getApiDeclaration(module, uriInfo, context, schemaContext);
}
- public ApiDeclaration getApiDeclaration(Module module, Date revision, UriInfo uriInfo, String context, SchemaContext schemaContext) {
- String basePath = createBasePathFromUriInfo(uriInfo);
+ public ApiDeclaration getApiDeclaration(final Module module, final UriInfo uriInfo,
+ final String context, final SchemaContext schemaContext) {
+ final String basePath = createBasePathFromUriInfo(uriInfo);
- ApiDeclaration doc = getSwaggerDocSpec(module, basePath, context, schemaContext);
+ final ApiDeclaration doc = getSwaggerDocSpec(module, basePath, context, schemaContext);
if (doc != null) {
return doc;
}
return null;
}
- protected String createBasePathFromUriInfo(UriInfo uriInfo) {
+ public String createBasePathFromUriInfo(final UriInfo uriInfo) {
String portPart = "";
- int port = uriInfo.getBaseUri().getPort();
+ final int port = uriInfo.getBaseUri().getPort();
if (port != -1) {
portPart = ":" + port;
}
- String basePath = new StringBuilder(uriInfo.getBaseUri().getScheme()).append("://")
- .append(uriInfo.getBaseUri().getHost()).append(portPart).append("/").append(RESTCONF_CONTEXT_ROOT)
- .toString();
+ final String basePath =
+ new StringBuilder(uriInfo.getBaseUri().getScheme()).append("://").append(uriInfo.getBaseUri().getHost())
+ .append(portPart).toString();
return basePath;
}
- public ApiDeclaration getSwaggerDocSpec(Module m, String basePath, String context, SchemaContext schemaContext) {
- ApiDeclaration doc = createApiDeclaration(basePath);
+ public ApiDeclaration getSwaggerDocSpec(final Module module, final String basePath, final String context,
+ final SchemaContext schemaContext) {
+ final ApiDeclaration doc = createApiDeclaration(basePath);
- List<Api> apis = new ArrayList<>();
+ final List<Api> apis = new ArrayList<>();
+ boolean hasAddRootPostLink = false;
- Collection<DataSchemaNode> dataSchemaNodes = m.getChildNodes();
+ final Collection<DataSchemaNode> dataSchemaNodes = module.getChildNodes();
LOG.debug("child nodes size [{}]", dataSchemaNodes.size());
- for (DataSchemaNode node : dataSchemaNodes) {
- if ((node instanceof ListSchemaNode) || (node instanceof ContainerSchemaNode)) {
-
+ for (final DataSchemaNode node : dataSchemaNodes) {
+ if (node instanceof ListSchemaNode || node instanceof ContainerSchemaNode) {
LOG.debug("Is Configuration node [{}] [{}]", node.isConfiguration(), node.getQName().getLocalName());
List<Parameter> pathParams = new ArrayList<>();
- String resourcePath = getDataStorePath("/config/", context);
- addRootPostLink(m, (DataNodeContainer) node, pathParams, resourcePath, apis);
- addApis(node, apis, resourcePath, pathParams, schemaContext, true);
-
+ String resourcePath;
+
+ /*
+ * Only when the node's config statement is true, such apis as
+ * GET/PUT/POST/DELETE config are added for this node.
+ */
+ if (node.isConfiguration()) { // This node's config statement is
+ // true.
+ resourcePath = getDataStorePath("config", context);
+
+ /*
+ * When there are two or more top container or list nodes
+ * whose config statement is true in module, make sure that
+ * only one root post link is added for this module.
+ */
+ if (!hasAddRootPostLink) {
+ LOG.debug("Has added root post link for module {}", module.getName());
+ addRootPostLink(module, (DataNodeContainer) node, pathParams, resourcePath, "config", apis);
+
+ hasAddRootPostLink = true;
+ }
+
+ addApis(node, apis, resourcePath, pathParams, schemaContext, true, module.getName(), "config");
+ }
pathParams = new ArrayList<>();
- resourcePath = getDataStorePath("/operational/", context);
- addApis(node, apis, resourcePath, pathParams, schemaContext, false);
+ resourcePath = getDataStorePath("operational", context);
+
+ addApis(node, apis, resourcePath, pathParams, schemaContext, false, module.getName(), "operational");
}
}
- Set<RpcDefinition> rpcs = m.getRpcs();
- for (RpcDefinition rpcDefinition : rpcs) {
- String resourcePath = getDataStorePath("/operations/", context);
+ final Set<RpcDefinition> rpcs = module.getRpcs();
+ for (final RpcDefinition rpcDefinition : rpcs) {
+ final String resourcePath;
+ resourcePath = getDataStorePath("operations", context);
+
addRpcs(rpcDefinition, apis, resourcePath, schemaContext);
}
if (!apis.isEmpty()) {
doc.setApis(apis);
- JSONObject models = null;
+ ObjectNode models = null;
try {
- models = jsonConverter.convertToJsonSchema(m, schemaContext);
+ models = this.jsonConverter.convertToJsonSchema(module, schemaContext);
doc.setModels(models);
if (LOG.isDebugEnabled()) {
- LOG.debug(mapper.writeValueAsString(doc));
+ LOG.debug("Document: {}", this.mapper.writeValueAsString(doc));
}
- } catch (IOException | JSONException e) {
- e.printStackTrace();
+ } catch (IOException e) {
+ LOG.error("Exception occured in ModelGenerator", e);
}
return doc;
return null;
}
- private void addRootPostLink(final Module module, final DataNodeContainer node, final List<Parameter> pathParams,
- final String resourcePath, final List<Api> apis) {
+ private void addRootPostLink(final Module module, final DataNodeContainer node,
+ final List<Parameter> pathParams, final String resourcePath, final String dataStore, final List<Api> apis) {
if (containsListOrContainer(module.getChildNodes())) {
final Api apiForRootPostUri = new Api();
- apiForRootPostUri.setPath(resourcePath);
+ apiForRootPostUri.setPath(resourcePath.concat(getContent(dataStore)));
apiForRootPostUri.setOperations(operationPost(module.getName() + MODULE_NAME_SUFFIX,
- module.getDescription(), module, pathParams, true));
+ module.getDescription().orElse(null), module, pathParams, true, ""));
apis.add(apiForRootPostUri);
}
}
- protected ApiDeclaration createApiDeclaration(String basePath) {
- ApiDeclaration doc = new ApiDeclaration();
+ public ApiDeclaration createApiDeclaration(final String basePath) {
+ final ApiDeclaration doc = new ApiDeclaration();
doc.setApiVersion(API_VERSION);
doc.setSwaggerVersion(SWAGGER_VERSION);
doc.setBasePath(basePath);
return doc;
}
- protected String getDataStorePath(String dataStore, String context) {
- return dataStore + context;
- }
+ public abstract String getDataStorePath(String dataStore, String context);
- private String generateCacheKey(String module, String revision) {
+ private static String generateCacheKey(final String module, final String revision) {
return module + "(" + revision + ")";
}
- private void addApis(DataSchemaNode node, List<Api> apis, String parentPath, List<Parameter> parentPathParams, SchemaContext schemaContext,
- boolean addConfigApi) {
+ private void addApis(final DataSchemaNode node, final List<Api> apis, final String parentPath,
+ final List<Parameter> parentPathParams, final SchemaContext schemaContext, final boolean addConfigApi,
+ final String parentName, final String dataStore) {
+ final Api api = new Api();
+ final List<Parameter> pathParams = new ArrayList<>(parentPathParams);
- Api api = new Api();
- List<Parameter> pathParams = new ArrayList<>(parentPathParams);
-
- String resourcePath = parentPath + createPath(node, pathParams, schemaContext) + "/";
+ final String resourcePath = parentPath + "/" + createPath(node, pathParams, schemaContext);
LOG.debug("Adding path: [{}]", resourcePath);
- api.setPath(resourcePath);
+ api.setPath(resourcePath.concat(getContent(dataStore)));
- Iterable<DataSchemaNode> childSchemaNodes = Collections.<DataSchemaNode>emptySet();
- if ((node instanceof ListSchemaNode) || (node instanceof ContainerSchemaNode)) {
- DataNodeContainer dataNodeContainer = (DataNodeContainer) node;
+ Iterable<DataSchemaNode> childSchemaNodes = Collections.emptySet();
+ if (node instanceof ListSchemaNode || node instanceof ContainerSchemaNode) {
+ final DataNodeContainer dataNodeContainer = (DataNodeContainer) node;
childSchemaNodes = dataNodeContainer.getChildNodes();
}
- api.setOperations(operation(node, pathParams, addConfigApi, childSchemaNodes));
+ api.setOperations(operation(node, pathParams, addConfigApi, childSchemaNodes, parentName));
apis.add(api);
- for (DataSchemaNode childNode : childSchemaNodes) {
+ for (final DataSchemaNode childNode : childSchemaNodes) {
if (childNode instanceof ListSchemaNode || childNode instanceof ContainerSchemaNode) {
// keep config and operation attributes separate.
if (childNode.isConfiguration() == addConfigApi) {
- addApis(childNode, apis, resourcePath, pathParams, schemaContext, addConfigApi);
+ final String newParent = parentName + "/" + node.getQName().getLocalName();
+ addApis(childNode, apis, resourcePath, pathParams, schemaContext, addConfigApi, newParent,
+ dataStore);
}
}
}
-
}
- private boolean containsListOrContainer(final Iterable<DataSchemaNode> nodes) {
- for (DataSchemaNode child : nodes) {
+ public abstract String getContent(String dataStore);
+
+ private static boolean containsListOrContainer(final Iterable<DataSchemaNode> nodes) {
+ for (final DataSchemaNode child : nodes) {
if (child instanceof ListSchemaNode || child instanceof ContainerSchemaNode) {
return true;
}
return false;
}
- private List<Operation> operation(DataSchemaNode node, List<Parameter> pathParams, boolean isConfig, Iterable<DataSchemaNode> childSchemaNodes) {
- List<Operation> operations = new ArrayList<>();
+ private static List<Operation> operation(final DataSchemaNode node, final List<Parameter> pathParams,
+ final boolean isConfig, final Iterable<DataSchemaNode> childSchemaNodes, final String parentName) {
+ final List<Operation> operations = new ArrayList<>();
- Get getBuilder = new Get(node, isConfig);
+ final Get getBuilder = new Get(node, isConfig);
operations.add(getBuilder.pathParams(pathParams).build());
if (isConfig) {
- Put putBuilder = new Put(node.getQName().getLocalName(),
- node.getDescription());
+ final Put putBuilder = new Put(node.getQName().getLocalName(), node.getDescription().orElse(null),
+ parentName);
operations.add(putBuilder.pathParams(pathParams).build());
- Delete deleteBuilder = new Delete(node);
+ final Delete deleteBuilder = new Delete(node);
operations.add(deleteBuilder.pathParams(pathParams).build());
if (containsListOrContainer(childSchemaNodes)) {
- operations.addAll(operationPost(node.getQName().getLocalName(), node.getDescription(),
- (DataNodeContainer) node, pathParams, isConfig));
+ operations.addAll(operationPost(node.getQName().getLocalName(), node.getDescription().orElse(null),
+ (DataNodeContainer) node, pathParams, isConfig, parentName + "/"));
}
}
return operations;
}
- private List<Operation> operationPost(final String name, final String description, final DataNodeContainer dataNodeContainer, List<Parameter> pathParams, boolean isConfig) {
- List<Operation> operations = new ArrayList<>();
+ private static List<Operation> operationPost(final String name, final String description,
+ final DataNodeContainer dataNodeContainer, final List<Parameter> pathParams, final boolean isConfig,
+ final String parentName) {
+ final List<Operation> operations = new ArrayList<>();
if (isConfig) {
- Post postBuilder = new Post(name, description, dataNodeContainer);
+ final Post postBuilder = new Post(name, parentName + name, description, dataNodeContainer);
operations.add(postBuilder.pathParams(pathParams).build());
}
return operations;
}
- private String createPath(final DataSchemaNode schemaNode, List<Parameter> pathParams, SchemaContext schemaContext) {
- ArrayList<LeafSchemaNode> pathListParams = new ArrayList<>();
- StringBuilder path = new StringBuilder();
- String localName = resolvePathArgumentsName(schemaNode, schemaContext);
+ protected abstract ListPathBuilder newListPathBuilder();
+
+ private String createPath(final DataSchemaNode schemaNode, final List<Parameter> pathParams,
+ final SchemaContext schemaContext) {
+ final StringBuilder path = new StringBuilder();
+ final String localName = resolvePathArgumentsName(schemaNode, schemaContext);
path.append(localName);
- if ((schemaNode instanceof ListSchemaNode)) {
+ if (schemaNode instanceof ListSchemaNode) {
final List<QName> listKeys = ((ListSchemaNode) schemaNode).getKeyDefinition();
for (final QName listKey : listKeys) {
- DataSchemaNode dataChildByName = ((DataNodeContainer) schemaNode).getDataChildByName(listKey);
- pathListParams.add(((LeafSchemaNode) dataChildByName));
+ final ListPathBuilder keyBuilder = newListPathBuilder();
+ final String pathParamIdentifier = keyBuilder.nextParamIdentifier(listKey.getLocalName());
- String pathParamIdentifier = new StringBuilder("/{").append(listKey.getLocalName()).append("}")
- .toString();
path.append(pathParamIdentifier);
- Parameter pathParam = new Parameter();
+ final Parameter pathParam = new Parameter();
pathParam.setName(listKey.getLocalName());
- pathParam.setDescription(dataChildByName.getDescription());
+
+ ((DataNodeContainer) schemaNode).findDataChildByName(listKey).flatMap(DataSchemaNode::getDescription)
+ .ifPresent(pathParam::setDescription);
+
pathParam.setType("string");
pathParam.setParamType("path");
return path.toString();
}
- protected void addRpcs(RpcDefinition rpcDefn, List<Api> apis, String parentPath, SchemaContext schemaContext) {
- Api rpc = new Api();
- String resourcePath = parentPath + resolvePathArgumentsName(rpcDefn, schemaContext);
+ protected void addRpcs(final RpcDefinition rpcDefn, final List<Api> apis, final String parentPath,
+ final SchemaContext schemaContext) {
+ final Api rpc = new Api();
+ final String resourcePath = parentPath + "/" + resolvePathArgumentsName(rpcDefn, schemaContext);
rpc.setPath(resourcePath);
- Operation operationSpec = new Operation();
+ final Operation operationSpec = new Operation();
operationSpec.setMethod("POST");
- operationSpec.setNotes(rpcDefn.getDescription());
+ operationSpec.setNotes(rpcDefn.getDescription().orElse(null));
operationSpec.setNickname(rpcDefn.getQName().getLocalName());
- if (rpcDefn.getOutput() != null) {
- operationSpec.setType("(" + rpcDefn.getQName().getLocalName() + ")output");
+ if (!rpcDefn.getOutput().getChildNodes().isEmpty()) {
+ operationSpec.setType("(" + rpcDefn.getQName().getLocalName() + ")output" + OperationBuilder.TOP);
}
- if (rpcDefn.getInput() != null) {
- Parameter payload = new Parameter();
+ if (!rpcDefn.getInput().getChildNodes().isEmpty()) {
+ final Parameter payload = new Parameter();
payload.setParamType("body");
- payload.setType("(" + rpcDefn.getQName().getLocalName() + ")input");
+ payload.setType("(" + rpcDefn.getQName().getLocalName() + ")input" + OperationBuilder.TOP);
operationSpec.setParameters(Collections.singletonList(payload));
operationSpec.setConsumes(OperationBuilder.CONSUMES_PUT_POST);
}
apis.add(rpc);
}
- protected SortedSet<Module> getSortedModules(SchemaContext schemaContext) {
+ protected SortedSet<Module> getSortedModules(final SchemaContext schemaContext) {
if (schemaContext == null) {
return new TreeSet<>();
}
- Set<Module> modules = schemaContext.getModules();
+ final Set<Module> modules = schemaContext.getModules();
- SortedSet<Module> sortedModules = new TreeSet<>((module1, module2) -> {
+ final SortedSet<Module> sortedModules = new TreeSet<>((module1, module2) -> {
int result = module1.getName().compareTo(module2.getName());
if (result == 0) {
- Date module1Revision = module1.getRevision() != null ? module1.getRevision() : new Date(0);
- Date module2Revision = module2.getRevision() != null ? module2.getRevision() : new Date(0);
- result = module1Revision.compareTo(module2Revision);
+ result = Revision.compare(module1.getRevision(), module2.getRevision());
}
if (result == 0) {
result = module1.getNamespace().compareTo(module2.getNamespace());
}
return result;
});
- for (Module m : modules) {
+ for (final Module m : modules) {
if (m != null) {
sortedModules.add(m);
}
return sortedModules;
}
+ protected abstract void appendPathKeyValue(StringBuilder builder, Object value);
+
+ public String generateUrlPrefixFromInstanceID(final YangInstanceIdentifier key, final String moduleName) {
+ final StringBuilder builder = new StringBuilder();
+ builder.append("/");
+ if (moduleName != null) {
+ builder.append(moduleName).append(':');
+ }
+ for (final PathArgument arg : key.getPathArguments()) {
+ final String name = arg.getNodeType().getLocalName();
+ if (arg instanceof YangInstanceIdentifier.NodeIdentifierWithPredicates) {
+ final NodeIdentifierWithPredicates nodeId = (NodeIdentifierWithPredicates) arg;
+ for (final Entry<QName, Object> entry : nodeId.getKeyValues().entrySet()) {
+ appendPathKeyValue(builder, entry.getValue());
+ }
+ } else {
+ builder.append(name).append('/');
+ }
+ }
+ return builder.toString();
+ }
+
+ protected interface ListPathBuilder {
+ String nextParamIdentifier(String key);
+ }
}