/*-
* ============LICENSE_START=======================================================
- * Copyright (C) 2019-2020 Nordix Foundation.
- * Modifications Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
+ * Copyright (C) 2019-2021, 2023 Nordix Foundation.
+ * Modifications Copyright (C) 2019-2021 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
package org.onap.policy.models.tosca.simple.concepts;
import com.google.gson.annotations.SerializedName;
+import jakarta.persistence.CascadeType;
+import jakarta.persistence.Column;
+import jakarta.persistence.Entity;
+import jakarta.persistence.FetchType;
+import jakarta.persistence.Inheritance;
+import jakarta.persistence.InheritanceType;
+import jakarta.persistence.JoinColumn;
+import jakarta.persistence.OneToOne;
+import jakarta.persistence.Table;
+import java.io.Serial;
import java.util.Collection;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
-import javax.persistence.CascadeType;
-import javax.persistence.Column;
-import javax.persistence.Entity;
-import javax.persistence.FetchType;
-import javax.persistence.Inheritance;
-import javax.persistence.InheritanceType;
-import javax.persistence.JoinColumn;
-import javax.persistence.JoinColumns;
-import javax.persistence.OneToOne;
-import javax.persistence.Table;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.NonNull;
import org.apache.commons.lang3.ObjectUtils;
-import org.onap.policy.common.utils.validation.ParameterValidationUtils;
+import org.onap.policy.common.parameters.BeanValidationResult;
+import org.onap.policy.common.parameters.annotations.NotBlank;
+import org.onap.policy.common.parameters.annotations.NotNull;
+import org.onap.policy.common.parameters.annotations.Valid;
import org.onap.policy.models.base.PfAuthorative;
import org.onap.policy.models.base.PfConcept;
import org.onap.policy.models.base.PfConceptKey;
import org.onap.policy.models.base.PfKey;
-import org.onap.policy.models.base.PfValidationMessage;
-import org.onap.policy.models.base.PfValidationResult;
-import org.onap.policy.models.base.PfValidationResult.ValidationResult;
-import org.onap.policy.models.tosca.authorative.concepts.ToscaDataType;
-import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyType;
import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
/**
@Data
@EqualsAndHashCode(callSuper = true)
public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemplate>
- implements PfAuthorative<ToscaServiceTemplate> {
+ implements PfAuthorative<ToscaServiceTemplate> {
+ @Serial
private static final long serialVersionUID = 8084846046148349401L;
- public static final String DEFAULT_TOSCA_DEFINTIONS_VERISON = "tosca_simple_yaml_1_1_0";
+ public static final String DEFAULT_TOSCA_DEFINITIONS_VERSION = "tosca_simple_yaml_1_1_0";
public static final String DEFAULT_NAME = "ToscaServiceTemplateSimple";
public static final String DEFAULT_VERSION = "1.0.0";
// @formatter:off
@Column
@SerializedName("tosca_definitions_version")
+ @NotNull
+ @NotBlank
private String toscaDefinitionsVersion;
@OneToOne(fetch = FetchType.EAGER, cascade = CascadeType.ALL, orphanRemoval = true)
- @JoinColumns(
- {
- @JoinColumn(name = "dataTypesName", referencedColumnName = "name"),
- @JoinColumn(name = "dataTypesVersion", referencedColumnName = "version")
- }
- )
+ @JoinColumn(name = "dataTypesName", referencedColumnName = "name")
+ @JoinColumn(name = "dataTypesVersion", referencedColumnName = "version")
@SerializedName("data_types")
+ @Valid
private JpaToscaDataTypes dataTypes;
@OneToOne(fetch = FetchType.EAGER, cascade = CascadeType.ALL, orphanRemoval = true)
- @JoinColumns(
- {
- @JoinColumn(name = "policyTypesName", referencedColumnName = "name"),
- @JoinColumn(name = "policyTypesVersion", referencedColumnName = "version")
- }
- )
+ @JoinColumn(name = "capabilityTypesName", referencedColumnName = "name")
+ @JoinColumn(name = "capabilityTypesVersion", referencedColumnName = "version")
+ @SerializedName("capability_types")
+ @Valid
+ private JpaToscaCapabilityTypes capabilityTypes;
+
+ @OneToOne(fetch = FetchType.EAGER, cascade = CascadeType.ALL, orphanRemoval = true)
+ @JoinColumn(name = "relationshipTypesName", referencedColumnName = "name")
+ @JoinColumn(name = "relationshipTypesVersion", referencedColumnName = "version")
+ @SerializedName("relationship_types")
+ @Valid
+ private JpaToscaRelationshipTypes relationshipTypes;
+
+ @OneToOne(fetch = FetchType.EAGER, cascade = CascadeType.ALL, orphanRemoval = true)
+ @JoinColumn(name = "nodeTypesName", referencedColumnName = "name")
+ @JoinColumn(name = "nodeTypesVersion", referencedColumnName = "version")
+ @SerializedName("node_types")
+ @Valid
+ private JpaToscaNodeTypes nodeTypes;
+
+ @OneToOne(fetch = FetchType.EAGER, cascade = CascadeType.ALL, orphanRemoval = true)
+ @JoinColumn(name = "policyTypesName", referencedColumnName = "name")
+ @JoinColumn(name = "policyTypesVersion", referencedColumnName = "version")
@SerializedName("policy_types")
+ @Valid
private JpaToscaPolicyTypes policyTypes;
@OneToOne(fetch = FetchType.EAGER, cascade = CascadeType.ALL, orphanRemoval = true)
- @JoinColumns(
- {
- @JoinColumn(name = "topologyTemplateParentKeyName", referencedColumnName = "parentKeyName"),
- @JoinColumn(name = "topologyTemplateParentKeyVersion", referencedColumnName = "parentKeyVersion"),
- @JoinColumn(name = "topologyTemplateParentLocalName", referencedColumnName = "parentLocalName"),
- @JoinColumn(name = "topologyTemplateLocalName", referencedColumnName = "localName")
- }
- )
+ @JoinColumn(name = "topologyTemplateParentKeyName", referencedColumnName = "parentKeyName")
+ @JoinColumn(name = "topologyTemplateParentKeyVersion", referencedColumnName = "parentKeyVersion")
+ @JoinColumn(name = "topologyTemplateParentLocalName", referencedColumnName = "parentLocalName")
+ @JoinColumn(name = "topologyTemplateLocalName", referencedColumnName = "localName")
@SerializedName("topology_template")
+ @Valid
private JpaToscaTopologyTemplate topologyTemplate;
// @formatter:on
* @param key the key
*/
public JpaToscaServiceTemplate(@NonNull final PfConceptKey key) {
- this(key, DEFAULT_TOSCA_DEFINTIONS_VERISON);
+ this(key, DEFAULT_TOSCA_DEFINITIONS_VERSION);
}
/**
* The full constructor creates a {@link JpaToscaServiceTemplate} object with all mandatory parameters.
*
- * @param key the key
+ * @param key the key
* @param toscaDefinitionsVersion the TOSCA version string
*/
public JpaToscaServiceTemplate(@NonNull final PfConceptKey key, @NonNull final String toscaDefinitionsVersion) {
super(copyConcept);
this.toscaDefinitionsVersion = copyConcept.toscaDefinitionsVersion;
this.dataTypes = (copyConcept.dataTypes != null ? new JpaToscaDataTypes(copyConcept.dataTypes) : null);
+ this.capabilityTypes =
+ (copyConcept.capabilityTypes != null ? new JpaToscaCapabilityTypes(copyConcept.capabilityTypes) : null);
+ this.relationshipTypes =
+ (copyConcept.relationshipTypes != null ? new JpaToscaRelationshipTypes(copyConcept.relationshipTypes)
+ : null);
+ this.nodeTypes = (copyConcept.nodeTypes != null ? new JpaToscaNodeTypes(copyConcept.nodeTypes) : null);
this.policyTypes = (copyConcept.policyTypes != null ? new JpaToscaPolicyTypes(copyConcept.policyTypes) : null);
this.topologyTemplate =
- (copyConcept.topologyTemplate != null ? new JpaToscaTopologyTemplate(copyConcept.topologyTemplate)
- : null);
+ (copyConcept.topologyTemplate != null ? new JpaToscaTopologyTemplate(copyConcept.topologyTemplate)
+ : null);
}
/**
@Override
public ToscaServiceTemplate toAuthorative() {
- final ToscaServiceTemplate toscaServiceTemplate = new ToscaServiceTemplate();
+ final var toscaServiceTemplate = new ToscaServiceTemplate();
super.setToscaEntity(toscaServiceTemplate);
super.toAuthorative();
toscaServiceTemplate.setToscaDefinitionsVersion(toscaDefinitionsVersion);
if (dataTypes != null) {
- toscaServiceTemplate.setDataTypes(new LinkedHashMap<>());
- List<Map<String, ToscaDataType>> dataTypeMapList = dataTypes.toAuthorative();
- for (Map<String, ToscaDataType> dataTypeMap : dataTypeMapList) {
- toscaServiceTemplate.getDataTypes().putAll(dataTypeMap);
- }
+ toscaServiceTemplate.setDataTypes(flattenMap(dataTypes.toAuthorative()));
+ }
+
+ if (capabilityTypes != null) {
+ toscaServiceTemplate.setCapabilityTypes(flattenMap(capabilityTypes.toAuthorative()));
+ }
+
+ if (relationshipTypes != null) {
+ toscaServiceTemplate.setRelationshipTypes(flattenMap(relationshipTypes.toAuthorative()));
+ }
+
+ if (nodeTypes != null) {
+ toscaServiceTemplate.setNodeTypes(flattenMap(nodeTypes.toAuthorative()));
}
if (policyTypes != null) {
- toscaServiceTemplate.setPolicyTypes(new LinkedHashMap<>());
- List<Map<String, ToscaPolicyType>> policyTypeMapList = policyTypes.toAuthorative();
- for (Map<String, ToscaPolicyType> policyTypeMap : policyTypeMapList) {
- toscaServiceTemplate.getPolicyTypes().putAll(policyTypeMap);
- }
+ toscaServiceTemplate.setPolicyTypes(flattenMap(policyTypes.toAuthorative()));
}
if (topologyTemplate != null) {
return toscaServiceTemplate;
}
+ /**
+ * Takes a list of maps and flattens it into a single map.
+ *
+ * @param list list to be flattened
+ * @return a map containing all the elements from the list of maps
+ */
+ private <V> Map<String, V> flattenMap(List<Map<String, V>> list) {
+ Map<String, V> result = new LinkedHashMap<>();
+
+ for (Map<String, V> map : list) {
+ result.putAll(map);
+ }
+
+ return result;
+ }
+
@Override
public void fromAuthorative(ToscaServiceTemplate toscaServiceTemplate) {
super.fromAuthorative(toscaServiceTemplate);
- if (PfKey.NULL_KEY_NAME.equals(getKey().getName())) {
+ if (toscaServiceTemplate.getDefinedName() == null) {
getKey().setName(DEFAULT_NAME);
}
- if (PfKey.NULL_KEY_VERSION.equals(getKey().getVersion())) {
+ if (toscaServiceTemplate.getDefinedVersion() == null) {
getKey().setVersion(DEFAULT_VERSION);
}
dataTypes.fromAuthorative(Collections.singletonList(toscaServiceTemplate.getDataTypes()));
}
+ if (toscaServiceTemplate.getCapabilityTypes() != null) {
+ capabilityTypes = new JpaToscaCapabilityTypes();
+ capabilityTypes.fromAuthorative(Collections.singletonList(toscaServiceTemplate.getCapabilityTypes()));
+ }
+
+ if (toscaServiceTemplate.getRelationshipTypes() != null) {
+ relationshipTypes = new JpaToscaRelationshipTypes();
+ relationshipTypes.fromAuthorative(Collections.singletonList(toscaServiceTemplate.getRelationshipTypes()));
+ }
+
+ if (toscaServiceTemplate.getNodeTypes() != null) {
+ nodeTypes = new JpaToscaNodeTypes();
+ nodeTypes.fromAuthorative(Collections.singletonList(toscaServiceTemplate.getNodeTypes()));
+ }
+
if (toscaServiceTemplate.getPolicyTypes() != null) {
policyTypes = new JpaToscaPolicyTypes();
policyTypes.fromAuthorative(Collections.singletonList(toscaServiceTemplate.getPolicyTypes()));
keyList.addAll(dataTypes.getKeys());
}
+ if (capabilityTypes != null) {
+ keyList.addAll(capabilityTypes.getKeys());
+ }
+
+ if (relationshipTypes != null) {
+ keyList.addAll(relationshipTypes.getKeys());
+ }
+
+ if (nodeTypes != null) {
+ keyList.addAll(nodeTypes.getKeys());
+ }
+
if (policyTypes != null) {
keyList.addAll(policyTypes.getKeys());
}
dataTypes.clean();
}
- if (policyTypes != null) {
- policyTypes.clean();
+ if (capabilityTypes != null) {
+ capabilityTypes.clean();
}
- if (topologyTemplate != null) {
- topologyTemplate.clean();
+ if (relationshipTypes != null) {
+ relationshipTypes.clean();
}
- }
-
- @Override
- public PfValidationResult validate(final PfValidationResult resultIn) {
- PfValidationResult result = super.validate(resultIn);
- if (!ParameterValidationUtils.validateStringParameter(toscaDefinitionsVersion)) {
- result.addValidationMessage(new PfValidationMessage(getKey(), this.getClass(), ValidationResult.INVALID,
- "service template tosca definitions version may not be null"));
- }
-
- if (dataTypes != null) {
- result = dataTypes.validate(result);
+ if (nodeTypes != null) {
+ nodeTypes.clean();
}
if (policyTypes != null) {
- result = policyTypes.validate(result);
+ policyTypes.clean();
}
if (topologyTemplate != null) {
- result = topologyTemplate.validate(result);
+ topologyTemplate.clean();
}
+ }
- // No point in validating cross references if the structure of the individual parts are not valid
- if (!result.isOk()) {
+ @Override
+ public BeanValidationResult validate(String fieldName) {
+ BeanValidationResult result = super.validate(fieldName);
+
+ // No point in validating cross-references if the structure of the individual parts are not valid
+ if (!result.isValid()) {
return result;
}
validateReferencedDataTypes(result);
- return validatePolicyTypesInPolicies(result);
+ validatePolicyTypesInPolicies(result);
+
+ return result;
}
@Override
return result;
}
+ result = ObjectUtils.compare(capabilityTypes, other.capabilityTypes);
+ if (result != 0) {
+ return result;
+ }
+
+ result = ObjectUtils.compare(relationshipTypes, other.relationshipTypes);
+ if (result != 0) {
+ return result;
+ }
+
+ result = ObjectUtils.compare(nodeTypes, other.nodeTypes);
+ if (result != 0) {
+ return result;
+ }
+
result = ObjectUtils.compare(policyTypes, other.policyTypes);
if (result != 0) {
return result;
/**
* Validate that all data types referenced in policy types exist.
*
- * @param result the validation result object to use for the validation result
- * @return the validation result object
+ * @param result where the results are added
*/
- private PfValidationResult validateReferencedDataTypes(final PfValidationResult result) {
+ private void validateReferencedDataTypes(final BeanValidationResult result) {
if (policyTypes == null) {
- return result;
+ return;
}
if (dataTypes != null) {
for (JpaToscaDataType dataType : dataTypes.getAll(null)) {
- validateReferencedDataTypesExists(dataType.getKey(), dataType.getReferencedDataTypes(), result);
+ validateReferencedDataTypesExists(dataType.getReferencedDataTypes(), result);
}
}
for (JpaToscaPolicyType policyType : policyTypes.getAll(null)) {
- validateReferencedDataTypesExists(policyType.getKey(), policyType.getReferencedDataTypes(), result);
+ validateReferencedDataTypesExists(policyType.getReferencedDataTypes(), result);
}
-
- return result;
}
/**
* Validate that the referenced data types exist for a collection of data type keys.
*
- * @param referencingEntityKey the key of the referencing entity
* @param dataTypeKeyCollection the data type key collection
- * @param result the result of the validation
+ * @param result where the results are added
*/
- private void validateReferencedDataTypesExists(final PfConceptKey referencingEntityKey,
- final Collection<PfConceptKey> dataTypeKeyCollection, final PfValidationResult result) {
+ private void validateReferencedDataTypesExists(final Collection<PfConceptKey> dataTypeKeyCollection,
+ final BeanValidationResult result) {
for (PfConceptKey dataTypeKey : dataTypeKeyCollection) {
if (dataTypes == null || dataTypes.get(dataTypeKey) == null) {
- result.addValidationMessage(new PfValidationMessage(referencingEntityKey, this.getClass(),
- ValidationResult.INVALID, "referenced data type " + dataTypeKey.getId() + " not found"));
+ addResult(result, "data type", dataTypeKey.getId(), NOT_FOUND);
}
}
}
/**
* Validate that all policy types referenced in policies exist.
*
- * @param result the validation result object to use for the validation result
- * @return the validation result object
+ * @param result where the results are added
*/
- private PfValidationResult validatePolicyTypesInPolicies(PfValidationResult result) {
+ private void validatePolicyTypesInPolicies(BeanValidationResult result) {
if (topologyTemplate == null || topologyTemplate.getPolicies() == null
- || topologyTemplate.getPolicies().getConceptMap().isEmpty()) {
- return result;
+ || topologyTemplate.getPolicies().getConceptMap().isEmpty()) {
+ return;
}
if (policyTypes == null || policyTypes.getConceptMap().isEmpty()) {
- result.addValidationMessage(new PfValidationMessage(this.getKey(), this.getClass(),
- ValidationResult.INVALID,
- "no policy types are defined on the service template for the policies in the topology template"));
- return result;
+ addResult(result, "policyTypes", policyTypes,
+ "no policy types are defined on the service template for the policies in the topology template");
+ return;
}
for (JpaToscaPolicy policy : topologyTemplate.getPolicies().getAll(null)) {
if (policyTypes.get(policy.getType()) == null) {
- result.addValidationMessage(
- new PfValidationMessage(policy.getKey(), this.getClass(), ValidationResult.INVALID,
- "policy type " + policy.getType().getId() + " referenced in policy not found"));
+ addResult(result, "policy type", policy.getType().getId(), NOT_FOUND);
}
}
-
- return result;
}
}
Code Review / policy / models.git / blobdiff