Set CPS Project Status to 'Mature'
[cps.git] / cps-ncmp-service / src / main / java / org / onap / cps / ncmp / api / models / DmiPluginRegistration.java
1 /*
2  *  ============LICENSE_START=======================================================
3  *  Copyright (C) 2021-2024 Nordix Foundation
4  *  ================================================================================
5  *  Licensed under the Apache License, Version 2.0 (the "License");
6  *  you may not use this file except in compliance with the License.
7  *  You may obtain a copy of the License at
8  *
9  *        http://www.apache.org/licenses/LICENSE-2.0
10  *
11  *  Unless required by applicable law or agreed to in writing, software
12  *  distributed under the License is distributed on an "AS IS" BASIS,
13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  *  See the License for the specific language governing permissions and
15  *  limitations under the License.
16  *
17  *  SPDX-License-Identifier: Apache-2.0
18  *  ============LICENSE_END=========================================================
19  */
20
21 package org.onap.cps.ncmp.api.models;
22
23 import com.fasterxml.jackson.annotation.JsonInclude;
24 import com.fasterxml.jackson.annotation.JsonInclude.Include;
25 import com.google.common.base.Strings;
26 import java.util.Collections;
27 import java.util.List;
28 import lombok.Getter;
29 import lombok.Setter;
30 import org.onap.cps.ncmp.api.impl.exception.DmiRequestException;
31 import org.onap.cps.ncmp.api.impl.exception.NcmpException;
32
33 /**
34  * Dmi Registry request object.
35  */
36 @Getter
37 @Setter
38 @JsonInclude(Include.NON_NULL)
39 public class DmiPluginRegistration {
40
41     private String dmiPlugin;
42
43     private String dmiDataPlugin;
44
45     private String dmiModelPlugin;
46
47     private List<NcmpServiceCmHandle> createdCmHandles = Collections.emptyList();
48
49     private List<NcmpServiceCmHandle> updatedCmHandles = Collections.emptyList();
50
51     private List<String> removedCmHandles = Collections.emptyList();
52
53     private UpgradedCmHandles upgradedCmHandles = new UpgradedCmHandles();
54
55     /**
56      * Validates plugin service names.
57      * @throws NcmpException if validation fails.
58      */
59     public void validateDmiPluginRegistration() throws NcmpException {
60         final String combinedServiceName = dmiPlugin;
61         final String dataServiceName = dmiDataPlugin;
62         final String modelsServiceName = dmiModelPlugin;
63
64         String errorMessage = null;
65
66         if (isNullEmptyOrBlank(combinedServiceName)) {
67             if ((isNullEmptyOrBlank(dataServiceName) && isNullEmptyOrBlank(modelsServiceName))) {
68                 errorMessage = "No DMI plugin service names";
69             } else {
70                 if (isNullEmptyOrBlank(dataServiceName) || isNullEmptyOrBlank(modelsServiceName)) {
71                     errorMessage = "Cannot register just a Data or Model plugin service name";
72                 }
73             }
74         } else {
75             if (!isNullEmptyOrBlank(dataServiceName) || !isNullEmptyOrBlank(modelsServiceName)) {
76                 errorMessage = "Cannot register combined plugin service name and other service names";
77             }
78         }
79
80         if (errorMessage != null) {
81             throw new DmiRequestException(errorMessage, "Please supply correct plugin information.");
82         }
83     }
84
85     public static boolean isNullEmptyOrBlank(final String serviceName) {
86         return Strings.isNullOrEmpty(serviceName) || serviceName.isBlank();
87     }
88
89 }