model/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextSchemas.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
   4  *  Modifications Copyright (C) 2019 Nordix Foundation.
   5  * ================================================================================
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.apex.model.contextmodel.concepts;
  23
  24 import java.util.List;
  25 import java.util.Map;
  26 import java.util.Map.Entry;
  27 import java.util.NavigableMap;
  28 import java.util.Set;
  29 import java.util.TreeMap;
  30 import javax.persistence.CascadeType;
  31 import javax.persistence.EmbeddedId;
  32 import javax.persistence.Entity;
  33 import javax.persistence.JoinColumn;
  34 import javax.persistence.JoinTable;
  35 import javax.persistence.ManyToMany;
  36 import javax.persistence.Table;
  37 import javax.xml.bind.Unmarshaller;
  38 import javax.xml.bind.annotation.XmlAccessType;
  39 import javax.xml.bind.annotation.XmlAccessorType;
  40 import javax.xml.bind.annotation.XmlElement;
  41 import javax.xml.bind.annotation.XmlType;
  42 import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
  43 import org.onap.policy.apex.model.basicmodel.concepts.AxConcept;
  44 import org.onap.policy.apex.model.basicmodel.concepts.AxConceptGetter;
  45 import org.onap.policy.apex.model.basicmodel.concepts.AxConceptGetterImpl;
  46 import org.onap.policy.apex.model.basicmodel.concepts.AxKey;
  47 import org.onap.policy.apex.model.basicmodel.concepts.AxValidationMessage;
  48 import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult;
  49 import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult;
  50 import org.onap.policy.common.utils.validation.Assertions;
  51
  52 /**
  53  * This class is a context schema container and holds a map of the context schemas for an entire Apex model. All Apex
  54  * models that use context schemas must have an {@link AxContextSchemas} field. The {@link AxContextSchemas} class
  55  * implements the helper methods of the {@link AxConceptGetter} interface to allow {@link AxContextSchema} instances to
  56  * be retrieved by calling methods directly on this class without referencing the contained map.
  57  *
  58  * <p>Validation checks that the container key is not null. An error is issued if no context schemas are defined in the
  59  * container. Each context schema entry is checked to ensure that its key and value are not null and that the key
  60  * matches the key in the map value. Each context schema entry is then validated individually.
  61  */
  62 @Entity
  63 @Table(name = "AxContextSchemas")
  64
  65 @XmlAccessorType(XmlAccessType.FIELD)
  66 @XmlType(name = "AxContextSchemas", namespace = "http://www.onap.org/policy/apex-pdp", propOrder =
  67     { "key", "schemas" })
  68
  69 public class AxContextSchemas extends AxConcept implements AxConceptGetter<AxContextSchema> {
  70     private static final long serialVersionUID = -3203734282886453582L;
  71
  72     @EmbeddedId
  73     @XmlElement(name = "key", required = true)
  74     private AxArtifactKey key;
  75
  76     // @formatter:off
  77     @ManyToMany(cascade = CascadeType.ALL)
  78     @JoinTable(
  79             joinColumns = {@JoinColumn(name = "contextSchemasName", referencedColumnName = "name"),
  80                     @JoinColumn(name = "contextSchemasVersion", referencedColumnName = "version")},
  81             inverseJoinColumns = {@JoinColumn(name = "contextSchemaName", referencedColumnName = "name"),
  82                     @JoinColumn(name = "contextSchemaVersion", referencedColumnName = "version")})
  83     @XmlElement(name = "schemas", required = true)
  84     private Map<AxArtifactKey, AxContextSchema> schemas;
  85     // @formatter:on
  86
  87     /**
  88      * The Default Constructor creates a {@link AxContextSchemas} object with a null artifact key and creates an empty
  89      * context schemas map.
  90      */
  91     public AxContextSchemas() {
  92         this(new AxArtifactKey());
  93     }
  94
  95     /**
  96      * Copy constructor.
  97      *
  98      * @param copyConcept the concept to copy from
  99      */
 100     public AxContextSchemas(final AxContextSchemas copyConcept) {
 101         super(copyConcept);
 102     }
 103
 104     /**
 105      * The Key Constructor creates a {@link AxContextSchemas} object with the given artifact key and creates an empty
 106      * context schemas map.
 107      *
 108      * @param key the key of the context album container
 109      */
 110     public AxContextSchemas(final AxArtifactKey key) {
 111         this(key, new TreeMap<AxArtifactKey, AxContextSchema>());
 112     }
 113
 114     /**
 115      * This Constructor creates a {@link AxContextSchemas} object with all its fields defined.
 116      *
 117      * @param key the key of the context schema container
 118      * @param schemas a map of the schemas to insert in the context schema container
 119      */
 120     public AxContextSchemas(final AxArtifactKey key, final Map<AxArtifactKey, AxContextSchema> schemas) {
 121         super();
 122         Assertions.argumentNotNull(key, "key may not be null");
 123         Assertions.argumentNotNull(schemas, "schemas may not be null");
 124
 125         this.key = key;
 126         this.schemas = new TreeMap<>();
 127         this.schemas.putAll(schemas);
 128     }
 129
 130     /**
 131      * When a model is unmarshalled from disk or from the database, the context schema map is returned as a raw hash
 132      * map. This method is called by JAXB after unmarshaling and is used to convert the hash map to a
 133      * {@link NavigableMap} so that it will work with the {@link AxConceptGetter} interface.
 134      *
 135      * @param unmarshaller the unmarshaler that is unmarshaling the model
 136      * @param parent the parent object of this object in the unmarshaler
 137      */
 138     public void afterUnmarshal(final Unmarshaller unmarshaller, final Object parent) {
 139         // The map must be navigable to allow name and version searching, unmarshaling returns a
 140         // hash map
 141         final NavigableMap<AxArtifactKey, AxContextSchema> navigableContextSchemas = new TreeMap<>();
 142         navigableContextSchemas.putAll(schemas);
 143         schemas = navigableContextSchemas;
 144     }
 145
 146     /**
 147      * {@inheritDoc}.
 148      */
 149     @Override
 150     public AxArtifactKey getKey() {
 151         return key;
 152     }
 153
 154     /**
 155      * {@inheritDoc}.
 156      */
 157     @Override
 158     public List<AxKey> getKeys() {
 159         final List<AxKey> keyList = key.getKeys();
 160         keyList.addAll(schemas.keySet());
 161
 162         return keyList;
 163     }
 164
 165     /**
 166      * Sets the key of the context schema container.
 167      *
 168      * @param key the key of the container
 169      */
 170     public void setKey(final AxArtifactKey key) {
 171         Assertions.argumentNotNull(key, "key may not be null");
 172         this.key = key;
 173     }
 174
 175     /**
 176      * Gets the map of context schemas in this container.
 177      *
 178      * @return the map of schemas
 179      */
 180     public Map<AxArtifactKey, AxContextSchema> getSchemasMap() {
 181         return schemas;
 182     }
 183
 184     /**
 185      * Sets the map of context schemas in this container.
 186      *
 187      * @param schemasMap the map of schemas
 188      */
 189     public void setSchemasMap(final Map<AxArtifactKey, AxContextSchema> schemasMap) {
 190         Assertions.argumentNotNull(schemasMap, "schemasMap may not be null");
 191
 192         this.schemas = new TreeMap<>();
 193         this.schemas.putAll(schemasMap);
 194     }
 195
 196     /**
 197      * {@inheritDoc}.
 198      */
 199     @Override
 200     public AxValidationResult validate(final AxValidationResult resultIn) {
 201         AxValidationResult result = resultIn;
 202
 203         if (key.equals(AxArtifactKey.getNullKey())) {
 204             result.addValidationMessage(new AxValidationMessage(key, this.getClass(), ValidationResult.INVALID,
 205                             "key is a null key"));
 206         }
 207
 208         result = key.validate(result);
 209
 210         if (schemas.size() == 0) {
 211             result.addValidationMessage(new AxValidationMessage(key, this.getClass(), ValidationResult.INVALID,
 212                             "contextSchemas may not be empty"));
 213         } else {
 214             for (final Entry<AxArtifactKey, AxContextSchema> contextSchemaEntry : schemas.entrySet()) {
 215                 if (contextSchemaEntry.getKey().equals(AxArtifactKey.getNullKey())) {
 216                     result.addValidationMessage(new AxValidationMessage(key, this.getClass(), ValidationResult.INVALID,
 217                                     "key on schemas entry " + contextSchemaEntry.getKey()
 218                                                     + " may not be the null key"));
 219                 } else if (contextSchemaEntry.getValue() == null) {
 220                     result.addValidationMessage(new AxValidationMessage(key, this.getClass(), ValidationResult.INVALID,
 221                                     "value on schemas entry " + contextSchemaEntry.getKey() + " may not be null"));
 222                 } else {
 223                     if (!contextSchemaEntry.getKey().equals(contextSchemaEntry.getValue().getKey())) {
 224                         result.addValidationMessage(
 225                                         new AxValidationMessage(key, this.getClass(), ValidationResult.INVALID,
 226                                                         "key on schemas entry " + contextSchemaEntry.getKey()
 227                                                                         + " does not equal entry key "
 228                                                                         + contextSchemaEntry.getValue().getKey()));
 229                     }
 230
 231                     result = contextSchemaEntry.getValue().validate(result);
 232                 }
 233             }
 234         }
 235
 236         return result;
 237     }
 238
 239     /**
 240      * {@inheritDoc}.
 241      */
 242     @Override
 243     public void clean() {
 244         key.clean();
 245         for (final Entry<AxArtifactKey, AxContextSchema> contextSchemaEntry : schemas.entrySet()) {
 246             contextSchemaEntry.getKey().clean();
 247             contextSchemaEntry.getValue().clean();
 248         }
 249     }
 250
 251     /**
 252      * {@inheritDoc}.
 253      */
 254     @Override
 255     public String toString() {
 256         final StringBuilder builder = new StringBuilder();
 257         builder.append(this.getClass().getSimpleName());
 258         builder.append(":(");
 259         builder.append("key=");
 260         builder.append(key);
 261         builder.append(",schemas=");
 262         builder.append(schemas);
 263         builder.append(")");
 264         return builder.toString();
 265     }
 266
 267     /**
 268      * {@inheritDoc}.
 269      */
 270     @Override
 271     public AxConcept copyTo(final AxConcept target) {
 272         Assertions.argumentNotNull(target, "target may not be null");
 273
 274         final Object copyObject = target;
 275         Assertions.instanceOf(copyObject, AxContextSchemas.class);
 276
 277         final AxContextSchemas copy = ((AxContextSchemas) copyObject);
 278         copy.setKey(new AxArtifactKey(key));
 279
 280         final Map<AxArtifactKey, AxContextSchema> newcontextSchemas = new TreeMap<>();
 281         for (final Entry<AxArtifactKey, AxContextSchema> contextSchemasEntry : schemas.entrySet()) {
 282             newcontextSchemas.put(new AxArtifactKey(contextSchemasEntry.getKey()),
 283                             new AxContextSchema(contextSchemasEntry.getValue()));
 284         }
 285         copy.setSchemasMap(newcontextSchemas);
 286
 287         return copy;
 288     }
 289
 290     /**
 291      * {@inheritDoc}.
 292      */
 293     @Override
 294     public int hashCode() {
 295         final int prime = 31;
 296         int result = 1;
 297         result = prime * result + key.hashCode();
 298         result = prime * result + schemas.hashCode();
 299         return result;
 300     }
 301
 302     /**
 303      * {@inheritDoc}.
 304      */
 305     @Override
 306     public boolean equals(final Object obj) {
 307         if (obj == null) {
 308             return false;
 309         }
 310         if (this == obj) {
 311             return true;
 312         }
 313         if (getClass() != obj.getClass()) {
 314             return false;
 315         }
 316
 317         final AxContextSchemas other = (AxContextSchemas) obj;
 318         if (!key.equals(other.key)) {
 319             return false;
 320         }
 321         return schemas.equals(other.schemas);
 322     }
 323
 324     /**
 325      * {@inheritDoc}.
 326      */
 327     @Override
 328     public int compareTo(final AxConcept otherObj) {
 329         if (otherObj == null) {
 330             return -1;
 331         }
 332         if (this == otherObj) {
 333             return 0;
 334         }
 335         if (getClass() != otherObj.getClass()) {
 336             return this.hashCode() - otherObj.hashCode();
 337         }
 338
 339         final AxContextSchemas other = (AxContextSchemas) otherObj;
 340         if (!key.equals(other.key)) {
 341             return key.compareTo(other.key);
 342         }
 343         if (!schemas.equals(other.schemas)) {
 344             return (schemas.hashCode() - other.schemas.hashCode());
 345         }
 346
 347         return 0;
 348     }
 349
 350     /**
 351      * {@inheritDoc}.
 352      */
 353     @Override
 354     public AxContextSchema get(final AxArtifactKey conceptKey) {
 355         return new AxConceptGetterImpl<>((NavigableMap<AxArtifactKey, AxContextSchema>) schemas).get(conceptKey);
 356     }
 357
 358     /**
 359      * {@inheritDoc}.
 360      */
 361     @Override
 362     public AxContextSchema get(final String conceptKeyName) {
 363         return new AxConceptGetterImpl<>((NavigableMap<AxArtifactKey, AxContextSchema>) schemas).get(conceptKeyName);
 364     }
 365
 366     /**
 367      * {@inheritDoc}.
 368      */
 369     @Override
 370     public AxContextSchema get(final String conceptKeyName, final String conceptKeyVersion) {
 371         return new AxConceptGetterImpl<>((NavigableMap<AxArtifactKey, AxContextSchema>) schemas).get(conceptKeyName,
 372                         conceptKeyVersion);
 373     }
 374
 375     /**
 376      * {@inheritDoc}.
 377      */
 378     @Override
 379     public Set<AxContextSchema> getAll(final String conceptKeyName) {
 380         return new AxConceptGetterImpl<>((NavigableMap<AxArtifactKey, AxContextSchema>) schemas).getAll(conceptKeyName);
 381     }
 382
 383     /**
 384      * {@inheritDoc}.
 385      */
 386     @Override
 387     public Set<AxContextSchema> getAll(final String conceptKeyName, final String conceptKeyVersion) {
 388         return new AxConceptGetterImpl<>((NavigableMap<AxArtifactKey, AxContextSchema>) schemas).getAll(conceptKeyName,
 389                         conceptKeyVersion);
 390     }
 391 }