* ============LICENSE_START=======================================================
* ONAP Policy Model
* ================================================================================
- * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
- * Modifications Copyright (C) 2019-2020 Nordix Foundation.
+ * Copyright (C) 2019-2021 AT&T Intellectual Property. All rights reserved.
+ * Modifications Copyright (C) 2019-2020, 2023 Nordix Foundation.
+ * Modifications Copyright (C) 2022 Bell Canada. 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 java.util.Collection;
-import java.util.LinkedHashMap;
-import java.util.LinkedHashSet;
+import jakarta.persistence.CollectionTable;
+import jakarta.persistence.ElementCollection;
+import jakarta.persistence.Entity;
+import jakarta.persistence.Inheritance;
+import jakarta.persistence.InheritanceType;
+import jakarta.persistence.JoinColumn;
+import jakarta.persistence.Lob;
+import jakarta.persistence.Table;
+import java.io.Serial;
import java.util.List;
-import java.util.Map;
-import java.util.Map.Entry;
-import java.util.Set;
-import javax.persistence.ElementCollection;
-import javax.persistence.Entity;
-import javax.persistence.Inheritance;
-import javax.persistence.InheritanceType;
-import javax.persistence.Lob;
-import javax.persistence.Table;
import lombok.Data;
import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
import lombok.NonNull;
-import org.apache.commons.collections4.CollectionUtils;
-import org.onap.policy.models.base.PfAuthorative;
+import org.onap.policy.common.parameters.BeanValidationResult;
+import org.onap.policy.common.parameters.annotations.NotNull;
+import org.onap.policy.common.parameters.annotations.Valid;
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.PfReferenceKey;
import org.onap.policy.models.base.PfUtils;
-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.ToscaPolicyType;
-import org.onap.policy.models.tosca.authorative.concepts.ToscaProperty;
-import org.onap.policy.models.tosca.utils.ToscaUtils;
/**
* Class to represent the policy type in TOSCA definition.
@Inheritance(strategy = InheritanceType.TABLE_PER_CLASS)
@Data
@EqualsAndHashCode(callSuper = true)
-public class JpaToscaPolicyType extends JpaToscaEntityType<ToscaPolicyType> implements PfAuthorative<ToscaPolicyType> {
+@NoArgsConstructor
+public class JpaToscaPolicyType extends JpaToscaWithToscaProperties<ToscaPolicyType> {
+ @Serial
private static final long serialVersionUID = -563659852901842616L;
@ElementCollection
- @Lob
- private Map<String, JpaToscaProperty> properties;
-
- @ElementCollection
- private List<PfConceptKey> targets;
+ @CollectionTable(joinColumns = {
+ @JoinColumn(name = "toscaPolicyTypeName", referencedColumnName = "name"),
+ @JoinColumn(name = "toscaPolicyTypeVersion", referencedColumnName = "version")
+ })
+ private List<@NotNull @Valid PfConceptKey> targets;
@ElementCollection
- private List<JpaToscaTrigger> triggers;
-
- /**
- * The Default Constructor creates a {@link JpaToscaPolicyType} object with a null key.
- */
- public JpaToscaPolicyType() {
- this(new PfConceptKey());
- }
+ @Lob
+ private List<@NotNull @Valid JpaToscaTrigger> triggers;
/**
* The Key Constructor creates a {@link JpaToscaPolicyType} object with the given concept key.
*/
public JpaToscaPolicyType(final JpaToscaPolicyType copyConcept) {
super(copyConcept);
- this.properties = PfUtils.mapMap(copyConcept.properties, JpaToscaProperty::new);
this.targets = PfUtils.mapList(copyConcept.targets, PfConceptKey::new);
this.triggers = PfUtils.mapList(copyConcept.triggers, JpaToscaTrigger::new);
}
* @param authorativeConcept the authorative concept to copy from
*/
public JpaToscaPolicyType(final ToscaPolicyType authorativeConcept) {
- this.fromAuthorative(authorativeConcept);
+ super(authorativeConcept);
}
@Override
public ToscaPolicyType toAuthorative() {
- ToscaPolicyType toscaPolicyType = new ToscaPolicyType();
+ var toscaPolicyType = new ToscaPolicyType();
super.setToscaEntity(toscaPolicyType);
super.toAuthorative();
- toscaPolicyType.setProperties(PfUtils.mapMap(properties, JpaToscaProperty::toAuthorative));
+ // TODO need to copy targets & triggers?
return toscaPolicyType;
}
public void fromAuthorative(final ToscaPolicyType toscaPolicyType) {
super.fromAuthorative(toscaPolicyType);
- // Set properties
- if (toscaPolicyType.getProperties() != null) {
- properties = new LinkedHashMap<>();
- for (Entry<String, ToscaProperty> toscaPropertyEntry : toscaPolicyType.getProperties().entrySet()) {
- JpaToscaProperty jpaProperty = new JpaToscaProperty(toscaPropertyEntry.getValue());
- jpaProperty.setKey(new PfReferenceKey(getKey(), toscaPropertyEntry.getKey()));
- properties.put(toscaPropertyEntry.getKey(), jpaProperty);
- }
- }
+ // TODO need to copy targets & triggers?
}
@Override
public List<PfKey> getKeys() {
final List<PfKey> keyList = super.getKeys();
- if (properties != null) {
- for (JpaToscaProperty property : properties.values()) {
- keyList.addAll(property.getKeys());
- }
- }
-
if (targets != null) {
keyList.addAll(targets);
}
public void clean() {
super.clean();
- if (properties != null) {
- for (JpaToscaProperty property : properties.values()) {
- property.clean();
- }
- }
-
if (targets != null) {
for (PfConceptKey target : targets) {
target.clean();
}
@Override
- public PfValidationResult validate(@NonNull final PfValidationResult resultIn) {
- PfValidationResult result = super.validate(resultIn);
-
- if (PfKey.NULL_KEY_VERSION.equals(getKey().getVersion())) {
- result.addValidationMessage(new PfValidationMessage(getKey(), this.getClass(), ValidationResult.INVALID,
- "key version is a null version"));
- }
-
- if (properties != null) {
- result = validateProperties(result);
- }
-
- if (targets != null) {
- result = validateTargets(result);
- }
-
- if (triggers != null) {
- result = validateTriggers(result);
- }
-
- return result;
- }
-
- /**
- * Validate the policy properties.
- *
- * @param result The result of validations up to now
- * @return the validation result
- */
- private PfValidationResult validateProperties(final PfValidationResult resultIn) {
- PfValidationResult result = resultIn;
-
- for (JpaToscaProperty property : properties.values()) {
- if (property == null) {
- result.addValidationMessage(new PfValidationMessage(getKey(), this.getClass(), ValidationResult.INVALID,
- "policy property may not be null "));
- } else {
- result = property.validate(result);
- }
- }
- return result;
- }
-
- /**
- * Validate the policy targets.
- *
- * @param result The result of validations up to now
- * @return the validation result
- */
- private PfValidationResult validateTargets(final PfValidationResult resultIn) {
- PfValidationResult result = resultIn;
-
- for (PfConceptKey target : targets) {
- if (target == null) {
- result.addValidationMessage(new PfValidationMessage(getKey(), this.getClass(), ValidationResult.INVALID,
- "policy target may not be null "));
- } else {
- result = target.validate(result);
- }
- }
- return result;
- }
-
- /**
- * Validate the policy triggers.
- *
- * @param result The result of validations up to now
- * @return the validation result
- */
- private PfValidationResult validateTriggers(final PfValidationResult resultIn) {
- PfValidationResult result = resultIn;
-
- for (JpaToscaTrigger trigger : triggers) {
- if (trigger == null) {
- result.addValidationMessage(new PfValidationMessage(getKey(), this.getClass(), ValidationResult.INVALID,
- "policy trigger may not be null "));
- } else {
- result = trigger.validate(result);
- }
- }
- return result;
+ public BeanValidationResult validate(@NonNull String fieldName) {
+ return validateWithKey(fieldName);
}
@Override
public int compareTo(final PfConcept otherConcept) {
- if (otherConcept == null) {
- return -1;
- }
if (this == otherConcept) {
return 0;
}
- if (getClass() != otherConcept.getClass()) {
- return getClass().getName().compareTo(otherConcept.getClass().getName());
- }
- final JpaToscaPolicyType other = (JpaToscaPolicyType) otherConcept;
- int result = super.compareTo(other);
+ int result = super.compareTo(otherConcept);
if (result != 0) {
return result;
}
- result = PfUtils.compareMaps(properties, other.properties);
- if (result != 0) {
- return result;
- }
+ final JpaToscaPolicyType other = (JpaToscaPolicyType) otherConcept;
result = PfUtils.compareCollections(targets, other.targets);
if (result != 0) {
return PfUtils.compareCollections(triggers, other.triggers);
}
-
- /**
- * Get the data types referenced in a policy type.
- *
- * @return the data types referenced in a policy type
- */
- public Collection<PfConceptKey> getReferencedDataTypes() {
- if (properties == null) {
- return CollectionUtils.emptyCollection();
- }
-
- Set<PfConceptKey> referencedDataTypes = new LinkedHashSet<>();
-
- for (JpaToscaProperty property : properties.values()) {
- referencedDataTypes.add(property.getType());
-
- if (property.getEntrySchema() != null) {
- referencedDataTypes.add(property.getEntrySchema().getType());
- }
- }
-
- referencedDataTypes.removeAll(ToscaUtils.getPredefinedDataTypes());
-
- return referencedDataTypes;
- }
}