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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP Policy Models
   4  * ================================================================================
   5  * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
   6  * Modifications Copyright (C) 2020-2021 Nordix Foundation.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.models.tosca.authorative.concepts;
  23
  24 import java.io.Serializable;
  25 import lombok.Data;
  26 import lombok.NoArgsConstructor;
  27 import lombok.NonNull;
  28 import org.apache.commons.lang3.ObjectUtils;
  29 import org.onap.policy.common.parameters.BeanValidationResult;
  30 import org.onap.policy.common.parameters.ValidationResult;
  31 import org.onap.policy.models.base.PfConceptKey;
  32 import org.onap.policy.models.base.PfKey;
  33
  34 /**
  35  * Identifies a concept. Both the name and version must be non-null.
  36  */
  37 @Data
  38 @NoArgsConstructor
  39 public class ToscaConceptIdentifier implements Serializable, Comparable<ToscaConceptIdentifier> {
  40     private static final long serialVersionUID = 8010649773816325786L;
  41
  42     @NonNull
  43     private String name;
  44
  45     @NonNull
  46     private String version;
  47
  48
  49     public ToscaConceptIdentifier(@NonNull String name, @NonNull String version) {
  50         this.name = name;
  51         this.version = version;
  52     }
  53
  54     public ToscaConceptIdentifier(@NonNull PfKey key) {
  55         this.name = key.getName();
  56         this.version = key.getVersion();
  57     }
  58
  59     public ToscaConceptIdentifier(ToscaConceptIdentifier source) {
  60         this.name = source.name;
  61         this.version = source.version;
  62     }
  63
  64     /**
  65      * Validates that appropriate fields are populated for an incoming call to the PAP REST API.
  66      *
  67      * @return the validation result
  68      */
  69     public ValidationResult validatePapRest() {
  70         BeanValidationResult result = new BeanValidationResult("group", this);
  71
  72         result.validateNotNull("name", name);
  73         result.validateNotNull("version", version);
  74
  75         return result;
  76     }
  77
  78     /**
  79      * Create a PfConcceptKey from the TOSCA identifier.
  80      *
  81      * @return the key
  82      */
  83     public PfConceptKey asConceptKey() {
  84         return new PfConceptKey(name, version);
  85     }
  86
  87     @Override
  88     public int compareTo(ToscaConceptIdentifier other) {
  89         if (this == other) {
  90             return 0;
  91         }
  92
  93         if (other == null) {
  94             return 1;
  95         }
  96
  97         int result = ObjectUtils.compare(getName(), other.getName());
  98         if (result != 0) {
  99             return result;
 100         }
 101
 102         return ObjectUtils.compare(getVersion(), other.getVersion());
 103     }
 104
 105     @Override
 106     public String toString() {
 107         return this.name + " " + this.version;
 108     }
 109 }