Change artifactId in sal-rest-docgen

[netconf.git] / restconf / sal-rest-docgen / src / main / java / org / opendaylight / netconf / sal / rest / doc / impl / OpenApiServiceImpl.java

diff --git a/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/impl/OpenApiServiceImpl.java b/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/impl/OpenApiServiceImpl.java
deleted file mode 100644 (file)
index 67af263..0000000
--- a/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/impl/OpenApiServiceImpl.java
+++ /dev/null
@@ -1,128 +0,0 @@
-/*
- * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
- *
- * This program and the accompanying materials are made available under the
- * terms of the Eclipse Public License v1.0 which accompanies this distribution,
- * and is available at http://www.eclipse.org/legal/epl-v10.html
- */
-package org.opendaylight.netconf.sal.rest.doc.impl;
-
-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.opendaylight.mdsal.dom.api.DOMMountPointService;
-import org.opendaylight.mdsal.dom.api.DOMSchemaService;
-import org.opendaylight.netconf.sal.rest.doc.api.OpenApiService;
-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"
- * >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
- * 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.
- */
-@Component
-@Singleton
-public final class OpenApiServiceImpl implements OpenApiService {
-    // FIXME: make this configurable
-    public static final int DEFAULT_PAGESIZE = 20;
-
-    // Query parameter
-    private static final String PAGE_NUM = "pageNum";
-
-    private final MountPointOpenApi mountPointOpenApiRFC8040;
-    private final OpenApiGeneratorRFC8040 openApiGeneratorRFC8040;
-
-    @Inject
-    @Activate
-    public OpenApiServiceImpl(final @Reference DOMSchemaService schemaService,
-                             final @Reference DOMMountPointService mountPointService) {
-        this(new MountPointOpenApiGeneratorRFC8040(schemaService, mountPointService),
-            new OpenApiGeneratorRFC8040(schemaService));
-    }
-
-    public OpenApiServiceImpl(final DOMSchemaService schemaService,
-                             final DOMMountPointService mountPointService,
-                             final String basePath) {
-        this(new MountPointOpenApiGeneratorRFC8040(schemaService, mountPointService, basePath),
-            new OpenApiGeneratorRFC8040(schemaService, basePath));
-    }
-
-    @VisibleForTesting
-    OpenApiServiceImpl(final MountPointOpenApiGeneratorRFC8040 mountPointOpenApiGeneratorRFC8040,
-                       final OpenApiGeneratorRFC8040 openApiGeneratorRFC8040) {
-        mountPointOpenApiRFC8040 = requireNonNull(mountPointOpenApiGeneratorRFC8040).getMountPointOpenApi();
-        this.openApiGeneratorRFC8040 = requireNonNull(openApiGeneratorRFC8040);
-    }
-
-    @Override
-    public synchronized Response getAllModulesDoc(final UriInfo uriInfo) {
-        final DefinitionNames definitionNames = new DefinitionNames();
-        final OpenApiObject doc = openApiGeneratorRFC8040.getAllModulesDoc(uriInfo, definitionNames);
-        return Response.ok(doc).build();
-    }
-
-    /**
-     * Generates Swagger compliant document listing APIs for module.
-     */
-    @Override
-    public synchronized Response getDocByModule(final String module, final String revision, final UriInfo uriInfo) {
-        return Response.ok(
-            openApiGeneratorRFC8040.getApiDeclaration(module, revision, uriInfo))
-            .build();
-    }
-
-    /**
-     * Redirects to embedded swagger ui.
-     */
-    @Override
-    public synchronized Response getApiExplorer(final UriInfo uriInfo) {
-        return Response.seeOther(uriInfo.getBaseUriBuilder().path("../explorer/index.html").build()).build();
-    }
-
-    @Override
-    public synchronized Response getListOfMounts(final UriInfo uriInfo) {
-        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 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();
-    }
-}