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.ParseException;
+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.swagger.Resource;
import org.opendaylight.netconf.sal.rest.doc.swagger.ResourceList;
import org.opendaylight.yangtools.yang.common.QName;
-import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
+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.opendaylight.yangtools.yang.model.api.SchemaContext;
-import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
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";
- private static final String RESTCONF_DRAFT = "18";
static final String MODULE_NAME_SUFFIX = "_module";
private final ModelGenerator jsonConverter = new ModelGenerator();
// private Map<String, ApiDeclaration> MODULE_DOC_CACHE = new HashMap<>()
private final ObjectMapper mapper = new ObjectMapper();
- private static boolean newDraft;
+ private final DOMSchemaService schemaService;
- protected BaseYangSwaggerGenerator() {
- this.mapper.registerModule(new JsonOrgModule());
+ protected BaseYangSwaggerGenerator(final Optional<DOMSchemaService> schemaService) {
+ this.schemaService = schemaService.orElse(null);
this.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.
*/
LOG.info("Modules found [{}]", modules.size());
for (final Module module : modules) {
- final String revisionString = SimpleDateFormatUtil.getRevisionFormat().format(module.getRevision());
+ final String revisionString = module.getQNameModule().getRevision().map(Revision::toString).orElse(null);
final Resource resource = new Resource();
LOG.debug("Working on [{},{}]...", module.getName(), revisionString);
final ApiDeclaration doc =
return resourceList;
}
- protected ResourceList createResourceList() {
+ public ResourceList createResourceList() {
final ResourceList resourceList = new ResourceList();
resourceList.setApiVersion(API_VERSION);
resourceList.setSwaggerVersion(SWAGGER_VERSION);
return resourceList;
}
- protected String generatePath(final UriInfo uriInfo, final String name, final String revision) {
+ 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(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) {
- Date rev = null;
+ final Optional<Revision> rev;
try {
- if (revision != null && !SourceIdentifier.NOT_PRESENT_FORMATTED_REVISION.equals(revision)) {
- rev = SimpleDateFormatUtil.getRevisionFormat().parse(revision);
- }
- } catch (final ParseException e) {
+ rev = Revision.ofNullable(revision);
+ } catch (final DateTimeParseException e) {
throw new IllegalArgumentException(e);
}
- if (rev != null) {
- final Calendar cal = new GregorianCalendar();
-
- cal.setTime(rev);
-
- if (cal.get(Calendar.YEAR) < 1970) {
- rev = null;
- }
- }
-
- final 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(final Module module, final Date revision, final UriInfo uriInfo,
+ public ApiDeclaration getApiDeclaration(final Module module, final UriInfo uriInfo,
final String context, final SchemaContext schemaContext) {
final String basePath = createBasePathFromUriInfo(uriInfo);
return null;
}
- protected String createBasePathFromUriInfo(final UriInfo uriInfo) {
+ public String createBasePathFromUriInfo(final UriInfo uriInfo) {
String portPart = "";
final int port = uriInfo.getBaseUri().getPort();
if (port != -1) {
}
final String basePath =
new StringBuilder(uriInfo.getBaseUri().getScheme()).append("://").append(uriInfo.getBaseUri().getHost())
- .append(portPart).append("/").append(RESTCONF_CONTEXT_ROOT).toString();
+ .append(portPart).toString();
return basePath;
}
- public ApiDeclaration getSwaggerDocSpec(final Module m, final String basePath, final String context,
- final SchemaContext schemaContext) {
+ public ApiDeclaration getSwaggerDocSpec(final Module module, final String basePath, final String context,
+ final SchemaContext schemaContext) {
final ApiDeclaration doc = createApiDeclaration(basePath);
final List<Api> apis = new ArrayList<>();
boolean hasAddRootPostLink = false;
- final Collection<DataSchemaNode> dataSchemaNodes = m.getChildNodes();
+ final Collection<DataSchemaNode> dataSchemaNodes = module.getChildNodes();
LOG.debug("child nodes size [{}]", dataSchemaNodes.size());
for (final DataSchemaNode node : dataSchemaNodes) {
- if ((node instanceof ListSchemaNode) || (node instanceof ContainerSchemaNode)) {
+ if (node instanceof ListSchemaNode || node instanceof ContainerSchemaNode) {
LOG.debug("Is Configuration node [{}] [{}]", node.isConfiguration(), node.getQName().getLocalName());
List<Parameter> pathParams = new ArrayList<>();
* only one root post link is added for this module.
*/
if (!hasAddRootPostLink) {
- LOG.debug("Has added root post link for module {}", m.getName());
- addRootPostLink(m, (DataNodeContainer) node, pathParams, resourcePath, "config", apis);
+ 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, m.getName(), "config");
+ addApis(node, apis, resourcePath, pathParams, schemaContext, true, module.getName(), "config");
}
pathParams = new ArrayList<>();
resourcePath = getDataStorePath("operational", context);
- addApis(node, apis, resourcePath, pathParams, schemaContext, false, m.getName(), "operational");
+ addApis(node, apis, resourcePath, pathParams, schemaContext, false, module.getName(), "operational");
}
}
- final Set<RpcDefinition> rpcs = m.getRpcs();
+ final Set<RpcDefinition> rpcs = module.getRpcs();
for (final RpcDefinition rpcDefinition : rpcs) {
final String resourcePath;
resourcePath = getDataStorePath("operations", context);
if (!apis.isEmpty()) {
doc.setApis(apis);
- JSONObject models = null;
+ ObjectNode models = null;
try {
- models = this.jsonConverter.convertToJsonSchema(m, schemaContext);
+ models = this.jsonConverter.convertToJsonSchema(module, schemaContext);
doc.setModels(models);
if (LOG.isDebugEnabled()) {
- LOG.debug(this.mapper.writeValueAsString(doc));
+ LOG.debug("Document: {}", this.mapper.writeValueAsString(doc));
}
- } catch (IOException | JSONException e) {
+ } catch (IOException e) {
LOG.error("Exception occured in ModelGenerator", e);
}
return null;
}
- private static void addRootPostLink(final Module module, final DataNodeContainer node,
+ 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.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(final String basePath) {
+ public ApiDeclaration createApiDeclaration(final String basePath) {
final ApiDeclaration doc = new ApiDeclaration();
doc.setApiVersion(API_VERSION);
doc.setSwaggerVersion(SWAGGER_VERSION);
return doc;
}
- protected String getDataStorePath(final String dataStore, final String context) {
- if (newDraft) {
- if ("config".contains(dataStore) || "operational".contains(dataStore)) {
- return "/" + RESTCONF_DRAFT + "/data" + context;
- }
- return "/" + RESTCONF_DRAFT + "/operations" + context;
- }
-
- return "/" + dataStore + context;
- }
+ public abstract String getDataStorePath(String dataStore, String context);
private static String generateCacheKey(final String module, final String revision) {
return module + "(" + revision + ")";
LOG.debug("Adding path: [{}]", resourcePath);
api.setPath(resourcePath.concat(getContent(dataStore)));
- Iterable<DataSchemaNode> childSchemaNodes = Collections.<DataSchemaNode> emptySet();
- if ((node instanceof ListSchemaNode) || (node instanceof ContainerSchemaNode)) {
+ Iterable<DataSchemaNode> childSchemaNodes = Collections.emptySet();
+ if (node instanceof ListSchemaNode || node instanceof ContainerSchemaNode) {
final DataNodeContainer dataNodeContainer = (DataNodeContainer) node;
childSchemaNodes = dataNodeContainer.getChildNodes();
}
apis.add(api);
for (final DataSchemaNode childNode : childSchemaNodes) {
- if ((childNode instanceof ListSchemaNode) || (childNode instanceof ContainerSchemaNode)) {
+ if (childNode instanceof ListSchemaNode || childNode instanceof ContainerSchemaNode) {
// keep config and operation attributes separate.
if (childNode.isConfiguration() == addConfigApi) {
final String newParent = parentName + "/" + node.getQName().getLocalName();
}
}
- protected static String getContent(final String dataStore) {
- if (newDraft) {
- if ("operational".contains(dataStore)) {
- return "?content=nonconfig";
- } else if ("config".contains(dataStore)) {
- return "?content=config";
- } else {
- return "";
- }
- } else {
- return "";
- }
- }
+ public abstract String getContent(String dataStore);
private static boolean containsListOrContainer(final Iterable<DataSchemaNode> nodes) {
for (final DataSchemaNode child : nodes) {
operations.add(getBuilder.pathParams(pathParams).build());
if (isConfig) {
- final Put putBuilder = new Put(node.getQName().getLocalName(), node.getDescription(), parentName);
+ final Put putBuilder = new Put(node.getQName().getLocalName(), node.getDescription().orElse(null),
+ parentName);
operations.add(putBuilder.pathParams(pathParams).build());
final Delete deleteBuilder = new Delete(node);
operations.add(deleteBuilder.pathParams(pathParams).build());
if (containsListOrContainer(childSchemaNodes)) {
- operations.addAll(operationPost(node.getQName().getLocalName(), node.getDescription(),
+ operations.addAll(operationPost(node.getQName().getLocalName(), node.getDescription().orElse(null),
(DataNodeContainer) node, pathParams, isConfig, parentName + "/"));
}
}
return operations;
}
- private static String createPath(final DataSchemaNode schemaNode, final List<Parameter> pathParams,
+ protected abstract ListPathBuilder newListPathBuilder();
+
+ private String createPath(final DataSchemaNode schemaNode, final List<Parameter> pathParams,
final SchemaContext schemaContext) {
- final ArrayList<LeafSchemaNode> pathListParams = new ArrayList<>();
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();
- StringBuilder keyBuilder = null;
- if (newDraft) {
- keyBuilder = new StringBuilder("=");
- }
-
for (final QName listKey : listKeys) {
- final DataSchemaNode dataChildByName = ((DataNodeContainer) schemaNode).getDataChildByName(listKey);
- pathListParams.add(((LeafSchemaNode) dataChildByName));
- final String pathParamIdentifier;
- if (newDraft) {
- pathParamIdentifier = keyBuilder.append("{").append(listKey.getLocalName()).append("}").toString();
- } else {
- pathParamIdentifier = "/{" + listKey.getLocalName() + "}";
- }
+ final ListPathBuilder keyBuilder = newListPathBuilder();
+ final String pathParamIdentifier = keyBuilder.nextParamIdentifier(listKey.getLocalName());
+
path.append(pathParamIdentifier);
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");
pathParams.add(pathParam);
- if (newDraft) {
- keyBuilder = new StringBuilder(",");
- }
}
}
return path.toString();
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) {
+ if (!rpcDefn.getOutput().getChildNodes().isEmpty()) {
operationSpec.setType("(" + rpcDefn.getQName().getLocalName() + ")output" + OperationBuilder.TOP);
}
- if (rpcDefn.getInput() != null) {
+ if (!rpcDefn.getInput().getChildNodes().isEmpty()) {
final Parameter payload = new Parameter();
payload.setParamType("body");
payload.setType("(" + rpcDefn.getQName().getLocalName() + ")input" + OperationBuilder.TOP);
final SortedSet<Module> sortedModules = new TreeSet<>((module1, module2) -> {
int result = module1.getName().compareTo(module2.getName());
if (result == 0) {
- final Date module1Revision = module1.getRevision() != null ? module1.getRevision() : new Date(0);
- final 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 sortedModules;
}
- public void setDraft(final boolean draft) {
- BaseYangSwaggerGenerator.newDraft = draft;
+ 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);
}
}
Code Review / netconf.git / blobdiff