<artifactId>action-library-rest-services</artifactId>
<version>${project.version}</version>
</dependency>
+ <dependency>
+ <groupId>org.openecomp.sdc</groupId>
+ <artifactId>unique-type-rest-services</artifactId>
+ <version>${project.version}</version>
+ </dependency>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>servlet-api</artifactId>
<bean id = "notifications" class="org.openecomp.sdcrests.notifications.rest.services.impl.NotificationsImpl"/>
<bean id = "togglz" class="org.openecomp.sdcrests.togglz.rest.services.TogglzFeaturesImpl"/>
<bean id = "items" class="org.openecomp.sdcrests.item.rest.services.ItemsImpl"/>
+ <bean id = "uniqueTypes" class="org.openecomp.sdcrests.uniquevalue.rest.services.UniqueTypesImpl"/>
<!-- RESTful Services -->
<jaxrs:server id="restContainer" address="/">
<ref bean="notifications"/>
<ref bean="togglz"/>
<ref bean="items"/>
+ <ref bean="uniqueTypes"/>
</jaxrs:serviceBeans>
<jaxrs:providers>
<module>notifications-fe</module>
<module>notifications-rest</module>
<module>togglz-rest</module>
+ <module>unique-type-rest</module>
</modules>
</project>
--- /dev/null
+<?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
--- /dev/null
+<?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
--- /dev/null
+/*
+ * 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);
+}
--- /dev/null
+/*
+ * 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();
+ }
+}
--- /dev/null
+<?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
--- /dev/null
+/*
+ * 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();
+}
<version>${project.version}</version>
</dependency>
-
- <!-- Spring -->
-<!-- <dependency>
- <groupId>org.springframework</groupId>
- <artifactId>spring-core</artifactId>
- <version>${spring.framework.version}</version>
- </dependency>
- <dependency>
- <groupId>org.springframework</groupId>
- <artifactId>spring-context</artifactId>
- <version>${spring.framework.version}</version>
- </dependency>
- <dependency>
- <groupId>org.springframework</groupId>
- <artifactId>spring-context-support</artifactId>
- <version>${spring.framework.version}</version>
- </dependency>
- <dependency>
- <groupId>org.springframework</groupId>
- <artifactId>spring-web</artifactId>
- <version>${spring.framework.version}</version>
- </dependency>
- <dependency>
- <groupId>org.springframework</groupId>
- <artifactId>spring-beans</artifactId>
- <version>${spring.framework.version}</version>
- </dependency>-->
-
<!-- CXF -->
<dependency>
<groupId>org.apache.cxf</groupId>
<version>${http.client.version}</version>
</dependency>
-<!-- <dependency>
- <groupId>javax.ws.rs</groupId>
- <artifactId>javax.ws.rs-api</artifactId>
- <version>${ws.rs.version}</version>
- </dependency>-->
-
- <!-- Other Stuff-->
- <!--dependency>
- <groupId>cglib</groupId>
- <artifactId>cglib-nodep</artifactId>
- <version>${cglib.nodep.version}</version>
- <scope>runtime</scope>
- </dependency-->
-
<!-- Java Stuff -->
<dependency>
<groupId>javax.inject</groupId>
<artifactId>item-rest-services</artifactId>
<version>${project.version}</version>
</dependency>
-
+ <dependency>
+ <groupId>org.openecomp.sdc</groupId>
+ <artifactId>unique-type-rest-types</artifactId>
+ <version>${project.version}</version>
+ </dependency>
</dependencies>
--- /dev/null
+/*
+ * 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<String, String> uniqueTypes =
+ Collections.singletonMap("VlmName", VENDOR_NAME);
+
+ @Override
+ public Map<String, String> listUniqueTypes() {
+ return uniqueTypes;
+ }
+}
--- /dev/null
+org.openecomp.sdcrests.vendorlicense.rest.services.VlmUniqueTypeProvider
\ No newline at end of file
<version>${http.client.version}</version>
</dependency>
- <!-- Other Stuff-->
- <!--dependency>
- <groupId>cglib</groupId>
- <artifactId>cglib-nodep</artifactId>
- <version>${cglib.nodep.version}</version>
- <scope>runtime</scope>
- </dependency-->
-
<!-- Java Stuff -->
<dependency>
<groupId>javax.inject</groupId>
<artifactId>woodstox-core-asl</artifactId>
<version>${woodstox.version}</version>
</dependency>
- <!--dependency>
- <groupId>org.openecomp.sdc</groupId>
- <artifactId>openecomp-sdc-vendor-software-product-manager</artifactId>
- <version>${project.version}</version>
- </dependency-->
<dependency>
<groupId>com.sun.jersey.contribs</groupId>
<artifactId>jersey-multipart</artifactId>
<artifactId>openecomp-sdc-activity-log-manager</artifactId>
<version>${project.version}</version>
</dependency>
+ <dependency>
+ <groupId>org.openecomp.sdc</groupId>
+ <artifactId>unique-type-rest-types</artifactId>
+ <version>${project.version}</version>
+ </dependency>
</dependencies>
--- /dev/null
+/*
+ * 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<String, String> uniqueTypes =
+ Collections.singletonMap("VspName", VENDOR_SOFTWARE_PRODUCT_NAME);
+
+ @Override
+ public Map<String, String> listUniqueTypes() {
+ return uniqueTypes;
+ }
+}
--- /dev/null
+org.openecomp.sdcrests.vsp.rest.services.VspUniqueTypeProvider
\ No newline at end of file
import java.util.Optional;
public class UniqueValueUtil {
+
private static final String UNIQUE_VALUE_VIOLATION = "UNIQUE_VALUE_VIOLATION";
private static final String UNIQUE_VALUE_VIOLATION_MSG = "%s with the value '%s' already exists.";
+ private static final char FORMATTED_UNIQUE_VALUE_SEPARATOR = '_';
private final UniqueValueDao uniqueValueDao;
-
public UniqueValueUtil(UniqueValueDao uniqueValueDao) {
this.uniqueValueDao = uniqueValueDao;
}
* @param uniqueCombination the unique combination
*/
public void createUniqueValue(String type, String... uniqueCombination) {
- Optional<String> value = formatValue(uniqueCombination);
- if (!value.isPresent()) {
- return;
- }
- validateUniqueValue(type, value.get(), uniqueCombination);
- uniqueValueDao.create(new UniqueValueEntity(type, value.get()));
+ formatValue(uniqueCombination).ifPresent(formattedValue -> {
+ validateUniqueValue(type, formattedValue, uniqueCombination);
+ uniqueValueDao.create(new UniqueValueEntity(type, formattedValue));
+ });
}
/**
* @param uniqueCombination the unique combination
*/
public void deleteUniqueValue(String type, String... uniqueCombination) {
- Optional<String> value = formatValue(uniqueCombination);
- if (!value.isPresent()) {
- return;
- }
- uniqueValueDao.delete(new UniqueValueEntity(type, value.get()));
+ formatValue(uniqueCombination).ifPresent(
+ formattedValue -> uniqueValueDao.delete(new UniqueValueEntity(type, formattedValue)));
+
}
/**
* @param uniqueContext the unique context
*/
public void updateUniqueValue(String type, String oldValue, String newValue,
- String... uniqueContext) {
+ String... uniqueContext) {
if (newValue == null || oldValue == null || !newValue.equalsIgnoreCase(oldValue)) {
createUniqueValue(type, CommonMethods.concat(uniqueContext, new String[]{newValue}));
deleteUniqueValue(type, CommonMethods.concat(uniqueContext, new String[]{oldValue}));
* @param uniqueCombination the unique combination
*/
public void validateUniqueValue(String type, String... uniqueCombination) {
- Optional<String> value = formatValue(uniqueCombination);
- if (!value.isPresent()) {
- return;
- }
- validateUniqueValue(type, value.get(), uniqueCombination);
+ formatValue(uniqueCombination)
+ .ifPresent(formattedValue -> validateUniqueValue(type, formattedValue, uniqueCombination));
}
- private void validateUniqueValue(String type, String value, String... uniqueCombination) {
- if (uniqueValueDao.get(new UniqueValueEntity(type, value)) != null) {
+ /**
+ * Checks if a unique value is taken.
+ *
+ * @return true if the unique value is occupied, false otherwise
+ */
+ public boolean isUniqueValueOccupied(String type, String... uniqueCombination) {
+ return formatValue(uniqueCombination)
+ .map(formattedValue -> isUniqueValueOccupied(type, formattedValue))
+ .orElse(false);
+ }
+
+ private void validateUniqueValue(String type, String formattedValue,
+ String... uniqueCombination) {
+ if (isUniqueValueOccupied(type, formattedValue)) {
throw new CoreException(new ErrorCode.ErrorCodeBuilder()
.withCategory(ErrorCategory.APPLICATION)
.withId(UNIQUE_VALUE_VIOLATION)
- .withMessage(String.format(UNIQUE_VALUE_VIOLATION_MSG, type,
- uniqueCombination[uniqueCombination.length - 1])).build());
+ .withMessage(String
+ .format(UNIQUE_VALUE_VIOLATION_MSG, type, getValueWithoutContext(uniqueCombination)))
+ .build());
}
}
+ private boolean isUniqueValueOccupied(String type, String formattedValue) {
+ return uniqueValueDao.get(new UniqueValueEntity(type, formattedValue)) != null;
+ }
+
private static Optional<String> formatValue(String[] uniqueCombination) {
if (uniqueCombination == null || uniqueCombination.length == 0
- || uniqueCombination[uniqueCombination.length - 1] == null) {
+ || getValueWithoutContext(uniqueCombination) == null) {
return Optional.empty();
}
uniqueCombination[uniqueCombination.length - 1] =
- uniqueCombination[uniqueCombination.length - 1].toLowerCase();
- return Optional.of(CommonMethods.arrayToSeparatedString(uniqueCombination, '_'));
+ getValueWithoutContext(uniqueCombination).toLowerCase();
+ return Optional.of(CommonMethods
+ .arrayToSeparatedString(uniqueCombination, FORMATTED_UNIQUE_VALUE_SEPARATOR));
+ }
+
+ private static String getValueWithoutContext(String... uniqueCombination) {
+ return uniqueCombination[uniqueCombination.length - 1];
}
}
Code Review / sdc.git / commitdiff