From 26855ad25011c8582d45f809688dff4838950d8b Mon Sep 17 00:00:00 2001 From: talig Date: Thu, 12 Apr 2018 10:45:02 +0300 Subject: Introduce unique value RESTs Change-Id: I6c62c8794fce2a8d42b0a8c57b8714d938c3063c Issue-ID: SDC-1177 Signed-off-by: talig --- .../onboarding-rest-war/pom.xml | 5 ++ .../src/main/webapp/WEB-INF/beans-services.xml | 2 + openecomp-be/api/openecomp-sdc-rest-webapp/pom.xml | 1 + .../unique-type-rest/pom.xml | 22 ++++++ .../unique-type-rest-services/pom.xml | 49 +++++++++++++ .../sdcrests/uniquevalue/rest/UniqueTypes.java | 61 ++++++++++++++++ .../uniquevalue/rest/services/UniqueTypesImpl.java | 82 ++++++++++++++++++++++ .../unique-type-rest-types/pom.xml | 15 ++++ .../uniquevalue/types/UniqueTypesProvider.java | 29 ++++++++ .../vendor-license-rest-services/pom.xml | 48 ++----------- .../rest/services/VlmUniqueTypeProvider.java | 34 +++++++++ ....sdcrests.uniquevalue.types.UniqueTypesProvider | 1 + .../vendor-software-products-rest-services/pom.xml | 18 ++--- .../vsp/rest/services/VspUniqueTypeProvider.java | 34 +++++++++ ....sdcrests.uniquevalue.types.UniqueTypesProvider | 1 + 15 files changed, 346 insertions(+), 56 deletions(-) create mode 100644 openecomp-be/api/openecomp-sdc-rest-webapp/unique-type-rest/pom.xml create mode 100644 openecomp-be/api/openecomp-sdc-rest-webapp/unique-type-rest/unique-type-rest-services/pom.xml create mode 100644 openecomp-be/api/openecomp-sdc-rest-webapp/unique-type-rest/unique-type-rest-services/src/main/java/org/openecomp/sdcrests/uniquevalue/rest/UniqueTypes.java create mode 100644 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 create mode 100644 openecomp-be/api/openecomp-sdc-rest-webapp/unique-type-rest/unique-type-rest-types/pom.xml create mode 100644 openecomp-be/api/openecomp-sdc-rest-webapp/unique-type-rest/unique-type-rest-types/src/main/java/org/openecomp/sdcrests/uniquevalue/types/UniqueTypesProvider.java create mode 100644 openecomp-be/api/openecomp-sdc-rest-webapp/vendor-license-rest/vendor-license-rest-services/src/main/java/org/openecomp/sdcrests/vendorlicense/rest/services/VlmUniqueTypeProvider.java create mode 100644 openecomp-be/api/openecomp-sdc-rest-webapp/vendor-license-rest/vendor-license-rest-services/src/main/resources/META-INF/services/org.openecomp.sdcrests.uniquevalue.types.UniqueTypesProvider create mode 100644 openecomp-be/api/openecomp-sdc-rest-webapp/vendor-software-products-rest/vendor-software-products-rest-services/src/main/java/org/openecomp/sdcrests/vsp/rest/services/VspUniqueTypeProvider.java create mode 100644 openecomp-be/api/openecomp-sdc-rest-webapp/vendor-software-products-rest/vendor-software-products-rest-services/src/main/resources/META-INF/services/org.openecomp.sdcrests.uniquevalue.types.UniqueTypesProvider (limited to 'openecomp-be/api') diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/onboarding-rest-war/pom.xml b/openecomp-be/api/openecomp-sdc-rest-webapp/onboarding-rest-war/pom.xml index b95f0715ab..04954fee62 100644 --- a/openecomp-be/api/openecomp-sdc-rest-webapp/onboarding-rest-war/pom.xml +++ b/openecomp-be/api/openecomp-sdc-rest-webapp/onboarding-rest-war/pom.xml @@ -80,6 +80,11 @@ action-library-rest-services ${project.version} + + org.openecomp.sdc + unique-type-rest-services + ${project.version} + javax.servlet servlet-api diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/onboarding-rest-war/src/main/webapp/WEB-INF/beans-services.xml b/openecomp-be/api/openecomp-sdc-rest-webapp/onboarding-rest-war/src/main/webapp/WEB-INF/beans-services.xml index 589406df72..ef1e7247dc 100644 --- a/openecomp-be/api/openecomp-sdc-rest-webapp/onboarding-rest-war/src/main/webapp/WEB-INF/beans-services.xml +++ b/openecomp-be/api/openecomp-sdc-rest-webapp/onboarding-rest-war/src/main/webapp/WEB-INF/beans-services.xml @@ -41,6 +41,7 @@ + @@ -75,6 +76,7 @@ + diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/pom.xml b/openecomp-be/api/openecomp-sdc-rest-webapp/pom.xml index e7f1b62956..2a03fcf940 100644 --- a/openecomp-be/api/openecomp-sdc-rest-webapp/pom.xml +++ b/openecomp-be/api/openecomp-sdc-rest-webapp/pom.xml @@ -29,6 +29,7 @@ notifications-fe notifications-rest togglz-rest + unique-type-rest 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 @@ + + + 4.0.0 + + + org.openecomp.sdc + openecomp-sdc-rest-webapp + 1.2.0-SNAPSHOT + + + unique-type-rest + pom + + + + unique-type-rest-services + unique-type-rest-types + + + \ 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 @@ + + + 4.0.0 + + + org.openecomp.sdc + unique-type-rest + 1.2.0-SNAPSHOT + + + unique-type-rest-services + + + + org.openecomp.sdc + unique-type-rest-types + ${project.version} + + + org.openecomp.sdc + openecomp-sdc-common-rest + ${project.version} + + + org.openecomp.sdc.core + openecomp-nosqldb-api + ${project.version} + + + javax.inject + javax.inject + ${javax.inject.version} + + + javax.ws.rs + javax.ws.rs-api + ${ws.rs.version} + + + org.springframework + spring-context + ${spring.framework.version} + + + + + \ 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 UNIQUE_TYPE_TO_INTERNAL; + + static { + Map 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 @@ + + + 4.0.0 + + + org.openecomp.sdc + unique-type-rest + 1.2.0-SNAPSHOT + + + unique-type-rest-types + + \ 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 listUniqueTypes(); +} diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/vendor-license-rest/vendor-license-rest-services/pom.xml b/openecomp-be/api/openecomp-sdc-rest-webapp/vendor-license-rest/vendor-license-rest-services/pom.xml index 430fcea705..2999b08211 100644 --- a/openecomp-be/api/openecomp-sdc-rest-webapp/vendor-license-rest/vendor-license-rest-services/pom.xml +++ b/openecomp-be/api/openecomp-sdc-rest-webapp/vendor-license-rest/vendor-license-rest-services/pom.xml @@ -34,34 +34,6 @@ ${project.version} - - - - org.apache.cxf @@ -79,20 +51,6 @@ ${http.client.version} - - - - - javax.inject @@ -110,7 +68,11 @@ item-rest-services ${project.version} - + + org.openecomp.sdc + unique-type-rest-types + ${project.version} + diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/vendor-license-rest/vendor-license-rest-services/src/main/java/org/openecomp/sdcrests/vendorlicense/rest/services/VlmUniqueTypeProvider.java b/openecomp-be/api/openecomp-sdc-rest-webapp/vendor-license-rest/vendor-license-rest-services/src/main/java/org/openecomp/sdcrests/vendorlicense/rest/services/VlmUniqueTypeProvider.java new file mode 100644 index 0000000000..5beeec242f --- /dev/null +++ b/openecomp-be/api/openecomp-sdc-rest-webapp/vendor-license-rest/vendor-license-rest-services/src/main/java/org/openecomp/sdcrests/vendorlicense/rest/services/VlmUniqueTypeProvider.java @@ -0,0 +1,34 @@ +/* + * 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.vendorlicense.rest.services; + +import org.openecomp.sdcrests.uniquevalue.types.UniqueTypesProvider; + +import java.util.Collections; +import java.util.Map; + +import static org.openecomp.sdc.vendorlicense.VendorLicenseConstants.UniqueValues.VENDOR_NAME; + +public class VlmUniqueTypeProvider implements UniqueTypesProvider { + + private static final Map uniqueTypes = + Collections.singletonMap("VlmName", VENDOR_NAME); + + @Override + public Map listUniqueTypes() { + return uniqueTypes; + } +} diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/vendor-license-rest/vendor-license-rest-services/src/main/resources/META-INF/services/org.openecomp.sdcrests.uniquevalue.types.UniqueTypesProvider b/openecomp-be/api/openecomp-sdc-rest-webapp/vendor-license-rest/vendor-license-rest-services/src/main/resources/META-INF/services/org.openecomp.sdcrests.uniquevalue.types.UniqueTypesProvider new file mode 100644 index 0000000000..0071c2ef26 --- /dev/null +++ b/openecomp-be/api/openecomp-sdc-rest-webapp/vendor-license-rest/vendor-license-rest-services/src/main/resources/META-INF/services/org.openecomp.sdcrests.uniquevalue.types.UniqueTypesProvider @@ -0,0 +1 @@ +org.openecomp.sdcrests.vendorlicense.rest.services.VlmUniqueTypeProvider \ No newline at end of file diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/vendor-software-products-rest/vendor-software-products-rest-services/pom.xml b/openecomp-be/api/openecomp-sdc-rest-webapp/vendor-software-products-rest/vendor-software-products-rest-services/pom.xml index e54e34bdde..3271083601 100644 --- a/openecomp-be/api/openecomp-sdc-rest-webapp/vendor-software-products-rest/vendor-software-products-rest-services/pom.xml +++ b/openecomp-be/api/openecomp-sdc-rest-webapp/vendor-software-products-rest/vendor-software-products-rest-services/pom.xml @@ -51,14 +51,6 @@ ${http.client.version} - - - javax.inject @@ -102,11 +94,6 @@ woodstox-core-asl ${woodstox.version} - com.sun.jersey.contribs jersey-multipart @@ -128,6 +115,11 @@ openecomp-sdc-activity-log-manager ${project.version} + + org.openecomp.sdc + unique-type-rest-types + ${project.version} + diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/vendor-software-products-rest/vendor-software-products-rest-services/src/main/java/org/openecomp/sdcrests/vsp/rest/services/VspUniqueTypeProvider.java b/openecomp-be/api/openecomp-sdc-rest-webapp/vendor-software-products-rest/vendor-software-products-rest-services/src/main/java/org/openecomp/sdcrests/vsp/rest/services/VspUniqueTypeProvider.java new file mode 100644 index 0000000000..cb7c136969 --- /dev/null +++ b/openecomp-be/api/openecomp-sdc-rest-webapp/vendor-software-products-rest/vendor-software-products-rest-services/src/main/java/org/openecomp/sdcrests/vsp/rest/services/VspUniqueTypeProvider.java @@ -0,0 +1,34 @@ +/* + * 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.vsp.rest.services; + +import org.openecomp.sdcrests.uniquevalue.types.UniqueTypesProvider; + +import java.util.Collections; +import java.util.Map; + +import static org.openecomp.sdc.vendorsoftwareproduct.VendorSoftwareProductConstants.UniqueValues.VENDOR_SOFTWARE_PRODUCT_NAME; + +public class VspUniqueTypeProvider implements UniqueTypesProvider { + + private static final Map uniqueTypes = + Collections.singletonMap("VspName", VENDOR_SOFTWARE_PRODUCT_NAME); + + @Override + public Map listUniqueTypes() { + return uniqueTypes; + } +} diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/vendor-software-products-rest/vendor-software-products-rest-services/src/main/resources/META-INF/services/org.openecomp.sdcrests.uniquevalue.types.UniqueTypesProvider b/openecomp-be/api/openecomp-sdc-rest-webapp/vendor-software-products-rest/vendor-software-products-rest-services/src/main/resources/META-INF/services/org.openecomp.sdcrests.uniquevalue.types.UniqueTypesProvider new file mode 100644 index 0000000000..f153693e58 --- /dev/null +++ b/openecomp-be/api/openecomp-sdc-rest-webapp/vendor-software-products-rest/vendor-software-products-rest-services/src/main/resources/META-INF/services/org.openecomp.sdcrests.uniquevalue.types.UniqueTypesProvider @@ -0,0 +1 @@ +org.openecomp.sdcrests.vsp.rest.services.VspUniqueTypeProvider \ No newline at end of file -- cgit 1.2.3-korg