*/
package org.opendaylight.netconf.sal.rest.doc.impl;
-import java.io.ByteArrayOutputStream;
-import java.io.OutputStreamWriter;
-import java.nio.charset.StandardCharsets;
-import java.util.Map.Entry;
+import static java.util.Objects.requireNonNull;
+
+import com.google.common.annotations.VisibleForTesting;
+import java.util.List;
+import java.util.Optional;
+import java.util.stream.Collectors;
+import javax.inject.Inject;
+import javax.inject.Singleton;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.UriInfo;
-import org.json.JSONWriter;
+import org.opendaylight.mdsal.dom.api.DOMMountPointService;
+import org.opendaylight.mdsal.dom.api.DOMSchemaService;
import org.opendaylight.netconf.sal.rest.doc.api.ApiDocService;
-import org.opendaylight.netconf.sal.rest.doc.mountpoints.MountPointSwagger;
-import org.opendaylight.netconf.sal.rest.doc.swagger.ApiDeclaration;
-import org.opendaylight.netconf.sal.rest.doc.swagger.ResourceList;
+import org.opendaylight.netconf.sal.rest.doc.mountpoints.MountPointOpenApi;
+import org.opendaylight.netconf.sal.rest.doc.openapi.MountPointInstance;
+import org.opendaylight.netconf.sal.rest.doc.openapi.OpenApiObject;
+import org.osgi.service.component.annotations.Activate;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Reference;
+
/**
- * This service generates swagger (See <a
- * href="https://helloreverb.com/developers/swagger"
+ * This service generates swagger (See
+ * <a href="https://helloreverb.com/developers/swagger"
* >https://helloreverb.com/developers/swagger</a>) compliant documentation for
* RESTCONF APIs. The output of this is used by embedded Swagger UI.
*
- * <p>NOTE: These API's need to be synchronized due to bug 1198. Thread access to
+ * <p>
+ * NOTE: These API's need to be synchronized due to bug 1198. Thread access to
* the SchemaContext is not synchronized properly and thus you can end up with
* missing definitions without this synchronization. There are likely otherways
* to work around this limitation, but given that this API is a dev only tool
* and not dependent UI, this was the fastest work around.
*/
-public class ApiDocServiceImpl implements ApiDocService {
+@Component
+@Singleton
+public final class ApiDocServiceImpl implements ApiDocService {
+ // FIXME: make this configurable
+ public static final int DEFAULT_PAGESIZE = 20;
+
+ // Query parameter
+ private static final String PAGE_NUM = "pageNum";
- private static final ApiDocService INSTANCE = new ApiDocServiceImpl();
+ private final MountPointOpenApi mountPointOpenApiRFC8040;
+ private final ApiDocGeneratorRFC8040 apiDocGeneratorRFC8040;
- public static ApiDocService getInstance() {
- return INSTANCE;
+ @Inject
+ @Activate
+ public ApiDocServiceImpl(final @Reference DOMSchemaService schemaService,
+ final @Reference DOMMountPointService mountPointService) {
+ this(new MountPointOpenApiGeneratorRFC8040(schemaService, mountPointService),
+ new ApiDocGeneratorRFC8040(schemaService));
}
- /**
- * Generates index document for Swagger UI. This document lists out all
- * modules with link to get APIs for each module. The API for each module is
- * served by <code> getDocByModule()</code> method.
- */
- @Override
- public synchronized Response getRootDoc(final UriInfo uriInfo) {
- final ApiDocGenerator generator = ApiDocGenerator.getInstance();
- final ResourceList rootDoc = generator.getResourceListing(uriInfo);
+ public ApiDocServiceImpl(final DOMSchemaService schemaService,
+ final DOMMountPointService mountPointService,
+ final String basePath) {
+ this(new MountPointOpenApiGeneratorRFC8040(schemaService, mountPointService, basePath),
+ new ApiDocGeneratorRFC8040(schemaService, basePath));
+ }
- return Response.ok(rootDoc).build();
+ @VisibleForTesting
+ ApiDocServiceImpl(final MountPointOpenApiGeneratorRFC8040 mountPointOpenApiGeneratorRFC8040,
+ final ApiDocGeneratorRFC8040 apiDocGeneratorRFC8040) {
+ mountPointOpenApiRFC8040 = requireNonNull(mountPointOpenApiGeneratorRFC8040).getMountPointOpenApi();
+ this.apiDocGeneratorRFC8040 = requireNonNull(apiDocGeneratorRFC8040);
+ }
+
+ @Override
+ public synchronized Response getAllModulesDoc(final UriInfo uriInfo) {
+ final DefinitionNames definitionNames = new DefinitionNames();
+ final OpenApiObject doc = apiDocGeneratorRFC8040.getAllModulesDoc(uriInfo, definitionNames);
+ return Response.ok(doc).build();
}
/**
*/
@Override
public synchronized Response getDocByModule(final String module, final String revision, final UriInfo uriInfo) {
- final ApiDocGenerator generator = ApiDocGenerator.getInstance();
-
- final ApiDeclaration doc = generator.getApiDeclaration(module, revision, uriInfo);
- return Response.ok(doc).build();
+ return Response.ok(
+ apiDocGeneratorRFC8040.getApiDeclaration(module, revision, uriInfo))
+ .build();
}
/**
*/
@Override
public synchronized Response getApiExplorer(final UriInfo uriInfo) {
- return Response
- .seeOther(uriInfo.getBaseUriBuilder().path("../explorer/index.html").build())
- .build();
+ return Response.seeOther(uriInfo.getBaseUriBuilder().path("../explorer/index.html").build()).build();
}
@Override
public synchronized Response getListOfMounts(final UriInfo uriInfo) {
- final ByteArrayOutputStream baos = new ByteArrayOutputStream();
- try (OutputStreamWriter streamWriter = new OutputStreamWriter(baos, StandardCharsets.UTF_8)) {
- final JSONWriter writer = new JSONWriter(streamWriter);
- writer.array();
- for (final Entry<String, Long> entry : MountPointSwagger.getInstance()
- .getInstanceIdentifiers().entrySet()) {
- writer.object();
- writer.key("instance").value(entry.getKey());
- writer.key("id").value(entry.getValue());
- writer.endObject();
- }
- writer.endArray();
- } catch (final Exception e) {
- return Response.status(500).entity(e.getMessage()).build();
- }
- return Response.status(200).entity(baos.toString()).build();
- }
-
- @Override
- public synchronized Response getMountRootDoc(final String instanceNum, final UriInfo uriInfo) {
- final ResourceList resourceList = MountPointSwagger.getInstance().getResourceList(uriInfo,
- Long.parseLong(instanceNum));
- return Response.ok(resourceList).build();
+ final List<MountPointInstance> entity = mountPointOpenApiRFC8040
+ .getInstanceIdentifiers().entrySet().stream()
+ .map(MountPointInstance::new).collect(Collectors.toList());
+ return Response.ok(entity).build();
}
@Override
public synchronized Response getMountDocByModule(final String instanceNum, final String module,
final String revision, final UriInfo uriInfo) {
- final ApiDeclaration api = MountPointSwagger.getInstance().getMountPointApi(uriInfo,
- Long.parseLong(instanceNum), module, revision);
+ final OpenApiObject api = mountPointOpenApiRFC8040.getMountPointApi(uriInfo, Long.parseLong(instanceNum),
+ module, revision);
return Response.ok(api).build();
}
+ @Override
+ public synchronized Response getMountDoc(final String instanceNum, final UriInfo uriInfo) {
+ final String stringPageNum = uriInfo.getQueryParameters().getFirst(PAGE_NUM);
+ final Optional<Integer> pageNum = stringPageNum != null ? Optional.of(Integer.valueOf(stringPageNum))
+ : Optional.empty();
+ final OpenApiObject api = mountPointOpenApiRFC8040.getMountPointApi(uriInfo,
+ Long.parseLong(instanceNum), pageNum);
+ return Response.ok(api).build();
+ }
}
Code Review / netconf.git / blobdiff