models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaEntity.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP Policy Model
   4  * ================================================================================
   5  * Copyright (C) 2019-2020 Nordix Foundation.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  * SPDX-License-Identifier: Apache-2.0
  20  * ============LICENSE_END=========================================================
  21  */
  22
  23 package org.onap.policy.models.tosca.authorative.concepts;
  24
  25 import com.google.gson.annotations.SerializedName;
  26 import io.swagger.annotations.ApiModelProperty;
  27 import java.util.LinkedHashMap;
  28 import java.util.List;
  29 import java.util.Map;
  30 import java.util.Map.Entry;
  31 import javax.ws.rs.core.Response;
  32 import lombok.Data;
  33 import lombok.NoArgsConstructor;
  34 import lombok.NonNull;
  35 import org.onap.policy.models.base.PfModelRuntimeException;
  36 import org.onap.policy.models.base.PfNameVersion;
  37
  38 /**
  39  * Class to represent TOSCA data type matching input/output from/to client.
  40  *
  41  * @author Chenfei Gao (cgao@research.att.com)
  42  */
  43 @Data
  44 @NoArgsConstructor
  45 public class ToscaEntity implements PfNameVersion {
  46     private String name;
  47
  48     private String version;
  49
  50     @ApiModelProperty(name = "derived_from")
  51     @SerializedName("derived_from")
  52     private String derivedFrom;
  53
  54     private Map<String, String> metadata;
  55
  56     private String description;
  57
  58     /**
  59      * Copy Constructor.
  60      *
  61      * @param copyObject object to copy from
  62      */
  63     public ToscaEntity(@NonNull ToscaEntity copyObject) {
  64         this.name = copyObject.name;
  65         this.version = copyObject.version;
  66         this.derivedFrom = copyObject.derivedFrom;
  67         this.description = copyObject.description;
  68
  69         if (copyObject.metadata != null) {
  70             metadata = new LinkedHashMap<>();
  71             for (final Entry<String, String> metadataEntry : copyObject.metadata.entrySet()) {
  72                 metadata.put(metadataEntry.getKey(), metadataEntry.getValue());
  73             }
  74         }
  75     }
  76
  77     /**
  78      * Get a key for this entity.
  79      *
  80      * @return a ToscaEntityKey for this entry
  81      */
  82     public ToscaEntityKey getKey() {
  83         return new ToscaEntityKey(name, version);
  84     }
  85
  86     /**
  87      * Convert a list of maps of TOSCA entities into a regular map.
  88      *
  89      * @param listOfMapsOfEntities the incoming list of maps of entities
  90      * @return The entities on a regular map
  91      * @throws PfModelRuntimeException on duplicate entity entries
  92      */
  93     public static <T extends ToscaEntity> Map<ToscaEntityKey, T> getEntityListMapAsMap(
  94             List<Map<String, T>> listOfMapsOfEntities) {
  95         // Declare the return map
  96         Map<ToscaEntityKey, T> entityMap = new LinkedHashMap<>();
  97
  98         for (Map<String, T> mapOfEntities : listOfMapsOfEntities) {
  99             for (T entityEntry : mapOfEntities.values()) {
 100                 if (entityMap.containsKey(entityEntry.getKey())) {
 101                     throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR,
 102                             "list of map of entities contains more than one entity with key " + entityEntry.getKey());
 103                 }
 104
 105                 entityMap.put(entityEntry.getKey(), entityEntry);
 106             }
 107         }
 108
 109         return entityMap;
 110     }
 111
 112     /**
 113      * Convert a map of TOSCA entities into a regular map.
 114      *
 115      * @param mapOfEntities the incoming list of maps of entities
 116      * @return The entities on a regular map
 117      * @throws PfModelRuntimeException on duplicate entity entries
 118      */
 119     public static <T extends ToscaEntity> Map<ToscaEntityKey, T> getEntityMapAsMap(Map<String, T> mapOfEntities) {
 120         // Declare the return map
 121         Map<ToscaEntityKey, T> entityMap = new LinkedHashMap<>();
 122
 123         for (T entityEntry : mapOfEntities.values()) {
 124             if (entityMap.containsKey(entityEntry.getKey())) {
 125                 throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR,
 126                         "list of map of entities contains more than one entity with key " + entityEntry.getKey());
 127             }
 128
 129             entityMap.put(entityEntry.getKey(), entityEntry);
 130         }
 131
 132         return entityMap;
 133     }
 134
 135 }