Introduce unique value RESTs

Change-Id: I6c62c8794fce2a8d42b0a8c57b8714d938c3063c
Issue-ID: SDC-1177
Signed-off-by: talig <talig@amdocs.com>

6 files changed, 258 insertions, 0 deletions

diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/unique-type-rest/pom.xml b/openecomp-be/api/openecomp-sdc-rest-webapp/unique-type-rest/pom.xml
new file mode 100644
index 0000000000..c057e56b1c
--- /dev/null
+++ b/openecomp-be/api/openecomp-sdc-rest-webapp/unique-type-rest/pom.xml
@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>org.openecomp.sdc</groupId>
+        <artifactId>openecomp-sdc-rest-webapp</artifactId>
+        <version>1.2.0-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>unique-type-rest</artifactId>
+    <packaging>pom</packaging>
+
+
+    <modules>
+        <module>unique-type-rest-services</module>
+        <module>unique-type-rest-types</module>
+    </modules>
+
+</project>
\ No newline at end of file
diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/unique-type-rest/unique-type-rest-services/pom.xml b/openecomp-be/api/openecomp-sdc-rest-webapp/unique-type-rest/unique-type-rest-services/pom.xml
new file mode 100644
index 0000000000..686dee6f42
--- /dev/null
+++ b/openecomp-be/api/openecomp-sdc-rest-webapp/unique-type-rest/unique-type-rest-services/pom.xml
@@ -0,0 +1,49 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>org.openecomp.sdc</groupId>
+        <artifactId>unique-type-rest</artifactId>
+        <version>1.2.0-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>unique-type-rest-services</artifactId>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.openecomp.sdc</groupId>
+            <artifactId>unique-type-rest-types</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.openecomp.sdc</groupId>
+            <artifactId>openecomp-sdc-common-rest</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.openecomp.sdc.core</groupId>
+            <artifactId>openecomp-nosqldb-api</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>javax.inject</groupId>
+            <artifactId>javax.inject</artifactId>
+            <version>${javax.inject.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>javax.ws.rs</groupId>
+            <artifactId>javax.ws.rs-api</artifactId>
+            <version>${ws.rs.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework</groupId>
+            <artifactId>spring-context</artifactId>
+            <version>${spring.framework.version}</version>
+        </dependency>
+    </dependencies>
+
+
+</project>
\ No newline at end of file
diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/unique-type-rest/unique-type-rest-services/src/main/java/org/openecomp/sdcrests/uniquevalue/rest/UniqueTypes.java b/openecomp-be/api/openecomp-sdc-rest-webapp/unique-type-rest/unique-type-rest-services/src/main/java/org/openecomp/sdcrests/uniquevalue/rest/UniqueTypes.java
new file mode 100644
index 0000000000..152c2f5a47
--- /dev/null
+++ b/openecomp-be/api/openecomp-sdc-rest-webapp/unique-type-rest/unique-type-rest-services/src/main/java/org/openecomp/sdcrests/uniquevalue/rest/UniqueTypes.java
@@ -0,0 +1,61 @@
+/*
+ * Copyright © 2018 European Support Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.openecomp.sdcrests.uniquevalue.rest;
+
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
+import io.swagger.annotations.ApiResponse;
+import io.swagger.annotations.ApiResponses;
+import org.springframework.validation.annotation.Validated;
+
+import javax.validation.constraints.NotNull;
+import javax.ws.rs.Consumes;
+import javax.ws.rs.GET;
+import javax.ws.rs.HeaderParam;
+import javax.ws.rs.Path;
+import javax.ws.rs.PathParam;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.MediaType;
+import javax.ws.rs.core.Response;
+
+import static org.openecomp.sdcrests.common.RestConstants.USER_ID_HEADER_PARAM;
+import static org.openecomp.sdcrests.common.RestConstants.USER_MISSING_ERROR_MSG;
+
+@Path("/v1.0/unique-types")
+@Produces(MediaType.APPLICATION_JSON)
+@Consumes(MediaType.APPLICATION_JSON)
+@Api(value = "Unique Types")
+@Validated
+public interface UniqueTypes {
+
+  @GET
+  @Path("/")
+  @ApiOperation(value = "Lists unique value types")
+  Response listUniqueTypes(@NotNull(message = USER_MISSING_ERROR_MSG)
+                           @HeaderParam(USER_ID_HEADER_PARAM) String user);
+
+  @GET
+  @Path("/{type}/values/{value}")
+  @ApiOperation(value = "Gets unique value")
+  @ApiResponses(value = {
+      @ApiResponse(code = 200, message = "Indication whether the unique value is occupied"),
+      @ApiResponse(code = 404, message = "Unsupported unique type")})
+  Response getUniqueValue(
+      @ApiParam("The unique value type, for example: 'VlmName'") @PathParam("type") String type,
+      @ApiParam("The unique value") @PathParam("value") String value,
+      @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM) String user);
+}
diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/unique-type-rest/unique-type-rest-services/src/main/java/org/openecomp/sdcrests/uniquevalue/rest/services/UniqueTypesImpl.java b/openecomp-be/api/openecomp-sdc-rest-webapp/unique-type-rest/unique-type-rest-services/src/main/java/org/openecomp/sdcrests/uniquevalue/rest/services/UniqueTypesImpl.java
new file mode 100644
index 0000000000..752c863564
--- /dev/null
+++ b/openecomp-be/api/openecomp-sdc-rest-webapp/unique-type-rest/unique-type-rest-services/src/main/java/org/openecomp/sdcrests/uniquevalue/rest/services/UniqueTypesImpl.java
@@ -0,0 +1,82 @@
+/*
+ * Copyright © 2018 European Support Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.openecomp.sdcrests.uniquevalue.rest.services;
+
+import org.openecomp.core.dao.UniqueValueDaoFactory;
+import org.openecomp.core.util.UniqueValueUtil;
+import org.openecomp.sdc.common.errors.ErrorCategory;
+import org.openecomp.sdc.common.errors.ErrorCode;
+import org.openecomp.sdc.common.errors.ErrorCodeAndMessage;
+import org.openecomp.sdcrests.uniquevalue.rest.UniqueTypes;
+import org.openecomp.sdcrests.uniquevalue.types.UniqueTypesProvider;
+import org.openecomp.sdcrests.wrappers.GenericCollectionWrapper;
+import org.springframework.context.annotation.Scope;
+import org.springframework.stereotype.Service;
+
+import javax.inject.Named;
+import javax.ws.rs.core.Response;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.ServiceLoader;
+
+import static javax.ws.rs.core.Response.Status.NOT_FOUND;
+
+@Named
+@Service("uniqueTypes")
+@Scope(value = "prototype")
+public class UniqueTypesImpl implements UniqueTypes {
+
+  private static final String UNIQUE_TYPE_NOT_FOUND_ERR_ID = "UNIQUE_TYPE_NOT_FOUND";
+  private static final String UNIQUE_TYPE_NOT_FOUND_MSG = "%s is not a supported unique type.";
+
+  private static final Map<String, String> UNIQUE_TYPE_TO_INTERNAL;
+
+  static {
+    Map<String, String> uniqueTypes = new HashMap<>();
+    ServiceLoader.load(UniqueTypesProvider.class)
+        .forEach(typesProvider -> uniqueTypes.putAll(typesProvider.listUniqueTypes()));
+    UNIQUE_TYPE_TO_INTERNAL = Collections.unmodifiableMap(uniqueTypes);
+  }
+
+  private final UniqueValueUtil uniqueValueUtil =
+      new UniqueValueUtil(UniqueValueDaoFactory.getInstance().createInterface());
+
+  @Override
+  public Response listUniqueTypes(String user) {
+    return Response.ok(
+        new GenericCollectionWrapper<>(new ArrayList<>(UNIQUE_TYPE_TO_INTERNAL.keySet())))
+        .build();
+  }
+
+  @Override
+  public Response getUniqueValue(String type, String value, String user) {
+    String internalType = UNIQUE_TYPE_TO_INTERNAL.get(type);
+
+    if (internalType == null) {
+      ErrorCode error = new ErrorCode.ErrorCodeBuilder()
+          .withCategory(ErrorCategory.APPLICATION)
+          .withId(UNIQUE_TYPE_NOT_FOUND_ERR_ID)
+          .withMessage(String.format(UNIQUE_TYPE_NOT_FOUND_MSG, type)).build();
+      return Response.status(NOT_FOUND).entity(new ErrorCodeAndMessage(NOT_FOUND, error)).build();
+    }
+
+    return Response.ok(Collections
+        .singletonMap("occupied", uniqueValueUtil.isUniqueValueOccupied(internalType, value)))
+        .build();
+  }
+}
diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/unique-type-rest/unique-type-rest-types/pom.xml b/openecomp-be/api/openecomp-sdc-rest-webapp/unique-type-rest/unique-type-rest-types/pom.xml
new file mode 100644
index 0000000000..d4a17439af
--- /dev/null
+++ b/openecomp-be/api/openecomp-sdc-rest-webapp/unique-type-rest/unique-type-rest-types/pom.xml
@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>org.openecomp.sdc</groupId>
+        <artifactId>unique-type-rest</artifactId>
+        <version>1.2.0-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>unique-type-rest-types</artifactId>
+
+</project>
\ No newline at end of file
diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/unique-type-rest/unique-type-rest-types/src/main/java/org/openecomp/sdcrests/uniquevalue/types/UniqueTypesProvider.java b/openecomp-be/api/openecomp-sdc-rest-webapp/unique-type-rest/unique-type-rest-types/src/main/java/org/openecomp/sdcrests/uniquevalue/types/UniqueTypesProvider.java
new file mode 100644
index 0000000000..986667227c
--- /dev/null
+++ b/openecomp-be/api/openecomp-sdc-rest-webapp/unique-type-rest/unique-type-rest-types/src/main/java/org/openecomp/sdcrests/uniquevalue/types/UniqueTypesProvider.java
@@ -0,0 +1,29 @@
+/*
+ * Copyright © 2018 European Support Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.openecomp.sdcrests.uniquevalue.types;
+
+import java.util.Map;
+
+/**
+ * The unique value service exposes APIs to list unique types and check whether a value is
+ * already taken.
+ * The modules which uses the unique value logic and would like to enable these APIs must
+ * implement this class.
+ */
+public interface UniqueTypesProvider {
+
+  Map<String, String> listUniqueTypes();
+}