model/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextSchema.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
  26 import javax.persistence.Column;
  27 import javax.persistence.Convert;
  28 import javax.persistence.EmbeddedId;
  29 import javax.persistence.Entity;
  30 import javax.persistence.Table;
  31 import javax.xml.bind.annotation.XmlAccessType;
  32 import javax.xml.bind.annotation.XmlAccessorType;
  33 import javax.xml.bind.annotation.XmlElement;
  34 import javax.xml.bind.annotation.XmlRootElement;
  35 import javax.xml.bind.annotation.XmlType;
  36 import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
  37
  38 import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
  39 import org.onap.policy.apex.model.basicmodel.concepts.AxConcept;
  40 import org.onap.policy.apex.model.basicmodel.concepts.AxKey;
  41 import org.onap.policy.apex.model.basicmodel.concepts.AxValidationMessage;
  42 import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult;
  43 import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult;
  44 import org.onap.policy.apex.model.basicmodel.dao.converters.CDataConditioner;
  45 import org.onap.policy.common.utils.validation.Assertions;
  46
  47 /**
  48  * This class holds a data schema definition in Apex. A data schema describes the structure of a single atom of data
  49  * handled by Apex. This atom of data can be a primitive type such as an integer or a string, or it can be a more
  50  * complex data type such as a Java object or an object described using a data definition language such as Avro. The
  51  * schema flavour defines the type of schema being defined and the schema itself defines the schema. The schema flavour
  52  * is used by Apex to look up and load a plugin class that understands and interprets the schema definition and can
  53  * create instances of classes for the schema.
  54  *
  55  * <p>An {@link AxContextSchema} is used to define each parameter in Apex events, the messages that enter, exit, and are
  56  * passed internally in Apex. In addition, an Apex {@link AxContextAlbum} instances hold a map of
  57  * {@link AxContextSchema} instances to represent the context being managed as an {@link AxContextAlbum}. For example,
  58  * the state of all cells in a mobile network might be represented as an {@link AxContextAlbum} with its
  59  * {@link AxContextSchema} being defined as @code cell} objects.
  60  *
  61  * <p>Validation checks that the schema key is not null. It also checks that the schema flavour is defined and matches
  62  * the regular expression SCHEMA_FLAVOUR_REGEXP. Finally, validation checks that the defined schema is not a blank or
  63  * empty string.
  64  */
  65 @Entity
  66 @Table(name = "AxContextSchema")
  67
  68 @XmlAccessorType(XmlAccessType.FIELD)
  69 @XmlRootElement(name = "apexContextSchema", namespace = "http://www.onap.org/policy/apex-pdp")
  70 @XmlType(name = "AxContextSchema", namespace = "http://www.onap.org/policy/apex-pdp", propOrder =
  71     { "key", "schemaFlavour", "schemaDefinition" })
  72
  73 public class AxContextSchema extends AxConcept {
  74     private static final String SCHEMA_FLAVOUR = "schemaFlavour";
  75     private static final String WHITESPACE_REGEXP = "\\s+$";
  76
  77     private static final long serialVersionUID = -6443016863162692288L;
  78
  79     /** Regular expression that constrains what values a schema flavour can have. */
  80     public static final String SCHEMA_FLAVOUR_REGEXP = "[A-Za-z0-9\\-_]+";
  81
  82     /** An undefined schema flavour has this value. */
  83     public static final String SCHEMA_FLAVOUR_UNDEFINED = "UNDEFINED";
  84
  85     /** The maximum permissible size of a schema definition. */
  86     public static final int MAX_SCHEMA_SIZE = 32672; // The maximum size supported by Apache Derby
  87
  88     @EmbeddedId
  89     @XmlElement(name = "key", required = true)
  90     private AxArtifactKey key;
  91
  92     @Column(name = SCHEMA_FLAVOUR)
  93     @XmlElement(required = true)
  94     private String schemaFlavour;
  95
  96     @Column(name = "schemaDefinition", length = MAX_SCHEMA_SIZE)
  97     @Convert(converter = CDataConditioner.class)
  98     @XmlJavaTypeAdapter(value = CDataConditioner.class)
  99     @XmlElement(name = "schemaDefinition", required = true)
 100     private String schemaDefinition;
 101
 102     /**
 103      * The default constructor creates a context schema with a null artifact key. The flavour of the context album is
 104      * set as SCHEMA_FLAVOUR_UNDEFINED and the schema itself is defined as an empty string.
 105      */
 106     public AxContextSchema() {
 107         this(new AxArtifactKey());
 108         schemaFlavour = SCHEMA_FLAVOUR_UNDEFINED;
 109     }
 110
 111     /**
 112      * Copy constructor.
 113      *
 114      * @param copyConcept the concept to copy from
 115      */
 116     public AxContextSchema(final AxContextSchema copyConcept) {
 117         super(copyConcept);
 118     }
 119
 120     /**
 121      * The key constructor creates a context schema with the given artifact key. The flavour of the context album is set
 122      * as SCHEMA_FLAVOUR_UNDEFINED and the schema itself is defined as an empty string.
 123      *
 124      * @param key the key
 125      */
 126     public AxContextSchema(final AxArtifactKey key) {
 127         this(key, SCHEMA_FLAVOUR_UNDEFINED, "");
 128     }
 129
 130     /**
 131      * This Constructor creates a context schema with all of its fields defined.
 132      *
 133      * @param key the key
 134      * @param schemaFlavour the schema flavour
 135      * @param schemaDefinition the schema definition
 136      */
 137     public AxContextSchema(final AxArtifactKey key, final String schemaFlavour, final String schemaDefinition) {
 138         super();
 139         Assertions.argumentNotNull(key, "key may not be null");
 140         Assertions.argumentNotNull(schemaFlavour, "schemaFlavour may not be null");
 141         Assertions.argumentNotNull(schemaDefinition, "schemaDefinition may not be null");
 142
 143         this.key = key;
 144         this.schemaFlavour = Assertions.validateStringParameter(SCHEMA_FLAVOUR, schemaFlavour, SCHEMA_FLAVOUR_REGEXP);
 145         this.schemaDefinition = schemaDefinition.replaceAll(WHITESPACE_REGEXP, "");
 146     }
 147
 148     /**
 149      * {@inheritDoc}.
 150      */
 151     @Override
 152     public AxArtifactKey getKey() {
 153         return key;
 154     }
 155
 156     /**
 157      * {@inheritDoc}.
 158      */
 159     @Override
 160     public List<AxKey> getKeys() {
 161         return key.getKeys();
 162     }
 163
 164     /**
 165      * Sets the key of the context schema.
 166      *
 167      * @param key the key of the context schema
 168      */
 169     public void setKey(final AxArtifactKey key) {
 170         Assertions.argumentNotNull(key, "key may not be null");
 171         this.key = key;
 172     }
 173
 174     /**
 175      * Gets the schema flavour, which defines the schema definition type being used.
 176      *
 177      * @return the schema flavour
 178      */
 179     public String getSchemaFlavour() {
 180         return schemaFlavour;
 181     }
 182
 183     /**
 184      * Sets the schema flavour, which defines the type of schema definition being used.
 185      *
 186      * @param schemaFlavour the schema flavour
 187      */
 188     public void setSchemaFlavour(final String schemaFlavour) {
 189         this.schemaFlavour = Assertions.validateStringParameter(SCHEMA_FLAVOUR, schemaFlavour, SCHEMA_FLAVOUR_REGEXP);
 190     }
 191
 192     /**
 193      * Gets the schema, which defines the structure of this data schema atom.
 194      *
 195      * @return the schema definition
 196      */
 197     public String getSchema() {
 198         return schemaDefinition;
 199     }
 200
 201     /**
 202      * Sets the schema, which defines the structure of this data schema atom.
 203      *
 204      * @param schema the schema definition
 205      */
 206     public void setSchema(final String schema) {
 207         Assertions.argumentNotNull(schema, "schema may not be null");
 208         this.schemaDefinition = schema.replaceAll(WHITESPACE_REGEXP, "");
 209     }
 210
 211     /**
 212      * {@inheritDoc}.
 213      */
 214     @Override
 215     public AxValidationResult validate(final AxValidationResult resultIn) {
 216         AxValidationResult result = resultIn;
 217
 218         if (key.equals(AxArtifactKey.getNullKey())) {
 219             result.addValidationMessage(new AxValidationMessage(key, this.getClass(), ValidationResult.INVALID,
 220                             "key is a null key"));
 221         }
 222
 223         result = key.validate(result);
 224
 225         if (schemaFlavour.replaceAll(WHITESPACE_REGEXP, "").length() == 0
 226                         || schemaFlavour.equals(SCHEMA_FLAVOUR_UNDEFINED)) {
 227             result.addValidationMessage(new AxValidationMessage(key, this.getClass(), ValidationResult.INVALID,
 228                             "schema flavour is not defined"));
 229         }
 230
 231         String flavourValidationResult = Assertions.getStringParameterValidationMessage(SCHEMA_FLAVOUR, schemaFlavour,
 232                         SCHEMA_FLAVOUR_REGEXP);
 233         if (flavourValidationResult != null) {
 234             result.addValidationMessage(new AxValidationMessage(key, this.getClass(), ValidationResult.INVALID,
 235                             "schema flavour invalid-" + flavourValidationResult));
 236         }
 237
 238         if (schemaDefinition.replaceAll(WHITESPACE_REGEXP, "").length() == 0) {
 239             result.addValidationMessage(new AxValidationMessage(key, this.getClass(), ValidationResult.INVALID,
 240                             "no schemaDefinition specified, schemaDefinition may not be blank"));
 241         }
 242
 243         return result;
 244     }
 245
 246     /**
 247      * {@inheritDoc}.
 248      */
 249     @Override
 250     public void clean() {
 251         key.clean();
 252         schemaFlavour = Assertions.validateStringParameter(SCHEMA_FLAVOUR, schemaFlavour, SCHEMA_FLAVOUR_REGEXP);
 253         schemaDefinition = schemaDefinition.replaceAll(WHITESPACE_REGEXP, "");
 254     }
 255
 256     /**
 257      * {@inheritDoc}.
 258      */
 259     @Override
 260     public String toString() {
 261         final StringBuilder builder = new StringBuilder();
 262         builder.append(this.getClass().getSimpleName());
 263         builder.append(":(");
 264         builder.append("key=");
 265         builder.append(key);
 266         builder.append(",schemaFlavour=");
 267         builder.append(schemaFlavour);
 268         builder.append(",schemaDefinition=");
 269         builder.append(schemaDefinition);
 270         builder.append(")");
 271         return builder.toString();
 272     }
 273
 274     /**
 275      * {@inheritDoc}.
 276      */
 277     @Override
 278     public AxConcept copyTo(final AxConcept target) {
 279         Assertions.argumentNotNull(target, "target may not be null");
 280
 281         final Object copyObject = target;
 282         Assertions.instanceOf(copyObject, AxContextSchema.class);
 283
 284         final AxContextSchema copy = ((AxContextSchema) copyObject);
 285         copy.setKey(new AxArtifactKey(key));
 286         copy.setSchemaFlavour(schemaFlavour);
 287         copy.setSchema(schemaDefinition);
 288
 289         return copy;
 290     }
 291
 292     /**
 293      * {@inheritDoc}.
 294      */
 295     @Override
 296     public int hashCode() {
 297         final int prime = 31;
 298         int result = 1;
 299         result = prime * result + key.hashCode();
 300         result = prime * result + schemaFlavour.hashCode();
 301         result = prime * result + schemaDefinition.hashCode();
 302         return result;
 303     }
 304
 305     /**
 306      * {@inheritDoc}.
 307      */
 308     @Override
 309     public boolean equals(final Object obj) {
 310         if (obj == null) {
 311             return false;
 312         }
 313         if (this == obj) {
 314             return true;
 315         }
 316
 317         if (getClass() != obj.getClass()) {
 318             return false;
 319         }
 320
 321         final AxContextSchema other = (AxContextSchema) obj;
 322
 323         if (!key.equals(other.key)) {
 324             return false;
 325         }
 326         if (!schemaFlavour.equals(other.schemaFlavour)) {
 327             return false;
 328         }
 329         final String thisSchema = CDataConditioner.clean(schemaDefinition).replaceAll("\n", "");
 330         final String otherSchema = CDataConditioner.clean(other.schemaDefinition).replaceAll("\n", "");
 331         return thisSchema.equals(otherSchema);
 332     }
 333
 334     /**
 335      * {@inheritDoc}.
 336      */
 337     @Override
 338     public int compareTo(final AxConcept otherObj) {
 339         if (otherObj == null) {
 340             return -1;
 341         }
 342         if (this == otherObj) {
 343             return 0;
 344         }
 345         if (getClass() != otherObj.getClass()) {
 346             return this.hashCode() - otherObj.hashCode();
 347         }
 348
 349         final AxContextSchema other = (AxContextSchema) otherObj;
 350         if (!key.equals(other.key)) {
 351             return key.compareTo(other.key);
 352         }
 353         if (!schemaFlavour.equals(other.schemaFlavour)) {
 354             return schemaFlavour.compareTo(other.schemaFlavour);
 355         }
 356         final String thisSchema = CDataConditioner.clean(schemaDefinition).replaceAll("\n", "");
 357         final String otherSchema = CDataConditioner.clean(other.schemaDefinition).replaceAll("\n", "");
 358         return thisSchema.compareTo(otherSchema);
 359     }
 360 }