gerrit.onap Code Review - policy/apex-pdp.git/blob

   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 javax.persistence.AttributeOverride;
  26 import javax.persistence.AttributeOverrides;
  27 import javax.persistence.Column;
  28 import javax.persistence.Embedded;
  29 import javax.persistence.EmbeddedId;
  30 import javax.persistence.Entity;
  31 import javax.persistence.Table;
  32 import javax.xml.bind.annotation.XmlAccessType;
  33 import javax.xml.bind.annotation.XmlAccessorType;
  34 import javax.xml.bind.annotation.XmlElement;
  35 import javax.xml.bind.annotation.XmlRootElement;
  36 import javax.xml.bind.annotation.XmlType;
  37 import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
  38 import org.onap.policy.apex.model.basicmodel.concepts.AxConcept;
  39 import org.onap.policy.apex.model.basicmodel.concepts.AxKey;
  40 import org.onap.policy.apex.model.basicmodel.concepts.AxKeyUse;
  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.common.utils.validation.Assertions;
  45
  46 /**
  47  * This class is used to define an album of context.
  48  *
  49  * <p>A context album is a distributed map of context that will be distributed across all process instances that require
  50  * access to it. This class defines the schema (structure) of the items in the context album, whether the items on the
  51  * context album are writable or not, and what the scope of the context album is.
  52  *
  53  * <p>The structure of items (objects) the context album is defined as a schema, which is understood by whatever schema
  54  * implementation is being used for the context album.
  55  *
  56  * <p>The scope of a context album is a string field, understood by whatever distribution mechanism is being used for
  57  * the context album. The distribution mechanism uses the scope of the context album to decide to which executable
  58  * entities a given context album is distributed.
  59  *
  60  * <p>The writable flag on a context album defines whether users of a context album can write to the context album or
  61  * just read objects from the context album.
  62  *
  63  * <p>Validation checks that the album key and the context schema key are not null and that the scope field is not
  64  * undefined and matches the regular expression SCOPE_REGEXP.
  65  */
  66 @Entity
  67 @Table(name = "AxContextAlbum")
  68
  69 @XmlAccessorType(XmlAccessType.FIELD)
  70 @XmlRootElement(name = "apexContextAlbum", namespace = "http://www.onap.org/policy/apex-pdp")
  71 @XmlType(name = "AxContextAlbum", namespace = "http://www.onap.org/policy/apex-pdp", propOrder =
  72     { "key", "scope", "isWritable", "itemSchema" })
  73
  74 public class AxContextAlbum extends AxConcept {
  75     private static final String SCOPE_STRING = "scope";
  76
  77     private static final long serialVersionUID = 4290442590545820316L;
  78
  79     /**
  80      * The legal values for the scope of a context album is constrained by this regular expression.
  81      */
  82     public static final String SCOPE_REGEXP = "[A-Za-z0-9\\-_]+";
  83
  84     /** The value of scope for a context album for which a scope has not been specified. */
  85     public static final String SCOPE_UNDEFINED = "UNDEFINED";
  86
  87     private static final int HASH_PRIME_0 = 1231;
  88     private static final int HASH_PRIME_1 = 1237;
  89
  90     @EmbeddedId
  91     @XmlElement(name = "key", required = true)
  92     private AxArtifactKey key;
  93
  94     @Column(name = SCOPE_STRING)
  95     @XmlElement(name = SCOPE_STRING, required = true)
  96     private String scope;
  97
  98     @Column(name = "isWritable")
  99     @XmlElement(name = "isWritable", required = true)
 100     private boolean isWritable;
 101
 102     // @formatter:off
 103     @Embedded
 104     @AttributeOverrides({
 105         @AttributeOverride(name = "name", column = @Column(name = "itemSchemaName")),
 106         @AttributeOverride(name = "version", column = @Column(name = "itemSchemaVersion"))
 107         })
 108     @Column(name = "itemSchema")
 109     @XmlElement(name = "itemSchema", required = true)
 110     private AxArtifactKey itemSchema;
 111     // @formatter:on
 112
 113     /**
 114      * The default constructor creates a context album with a null artifact key. The scope of the context album is set
 115      * as SCOPE_UNDEFINED, the album is writable, and the artifact key of the context schema is set to the null artifact
 116      * key.
 117      */
 118     public AxContextAlbum() {
 119         this(new AxArtifactKey());
 120         scope = SCOPE_UNDEFINED;
 121         isWritable = true;
 122         itemSchema = AxArtifactKey.getNullKey();
 123     }
 124
 125     /**
 126      * Copy constructor.
 127      *
 128      * @param copyConcept the concept to copy from
 129      */
 130     public AxContextAlbum(final AxContextAlbum copyConcept) {
 131         super(copyConcept);
 132     }
 133
 134     /**
 135      * The keyed constructor creates a context album with the specified artifact key. The scope of the context album is
 136      * set as SCOPE_UNDEFINED, the album is writable, and the artifact key of the context schema is set to the null
 137      * artifact key.
 138      *
 139      * @param key the key of the context album
 140      */
 141     public AxContextAlbum(final AxArtifactKey key) {
 142         this(key, SCOPE_UNDEFINED, true, AxArtifactKey.getNullKey());
 143     }
 144
 145     /**
 146      * Constructor that sets all the fields of the context album.
 147      *
 148      * @param key the key of the context album
 149      * @param scope the scope field, must match the regular expression SCOPE_REGEXP
 150      * @param isWritable specifies whether the context album will be writable or not
 151      * @param itemSchema the artifact key of the context schema to use for this context album
 152      */
 153     public AxContextAlbum(final AxArtifactKey key, final String scope, final boolean isWritable,
 154                     final AxArtifactKey itemSchema) {
 155         super();
 156         Assertions.argumentNotNull(key, "key may not be null");
 157         Assertions.argumentNotNull(scope, "scope may not be null");
 158         Assertions.argumentNotNull(itemSchema, "itemSchema may not be null");
 159
 160         this.key = key;
 161         this.scope = Assertions.validateStringParameter(SCOPE_STRING, scope, SCOPE_REGEXP);
 162         this.isWritable = isWritable;
 163         this.itemSchema = itemSchema;
 164     }
 165
 166     /**
 167      * {@inheritDoc}.
 168      */
 169     @Override
 170     public AxArtifactKey getKey() {
 171         return key;
 172     }
 173
 174     /**
 175      * {@inheritDoc}.
 176      */
 177     @Override
 178     public List<AxKey> getKeys() {
 179         final List<AxKey> keyList = key.getKeys();
 180         keyList.add(new AxKeyUse(itemSchema.getKey()));
 181
 182         return keyList;
 183     }
 184
 185     /**
 186      * Sets the key of the context album.
 187      *
 188      * @param key the context album key
 189      */
 190     public void setKey(final AxArtifactKey key) {
 191         Assertions.argumentNotNull(key, "key may not be null");
 192         this.key = key;
 193     }
 194
 195     /**
 196      * Gets the scope of the context album.
 197      *
 198      * @return the context album scope
 199      */
 200     public String getScope() {
 201         return scope;
 202     }
 203
 204     /**
 205      * Sets the scope of the context album.
 206      *
 207      * @param scope the context album scope
 208      */
 209     public void setScope(final String scope) {
 210         Assertions.argumentNotNull(scope, "scope may not be null");
 211         this.scope = Assertions.validateStringParameter(SCOPE_STRING, scope, SCOPE_REGEXP);
 212     }
 213
 214     /**
 215      * Sets whether the album is writable or not.
 216      *
 217      * @param writable the writable flag value
 218      */
 219     public void setWritable(final boolean writable) {
 220         this.isWritable = writable;
 221     }
 222
 223     /**
 224      * Checks if the album is writable.
 225      *
 226      * @return true, if the album is writable
 227      */
 228     public boolean isWritable() {
 229         return isWritable;
 230     }
 231
 232     /**
 233      * Gets the artifact key of the item schema of this context album.
 234      *
 235      * @return the item schema key
 236      */
 237     public AxArtifactKey getItemSchema() {
 238         return itemSchema;
 239     }
 240
 241     /**
 242      * Sets the artifact key of the item schema of this context album.
 243      *
 244      * @param itemSchema the item schema key
 245      */
 246     public void setItemSchema(final AxArtifactKey itemSchema) {
 247         Assertions.argumentNotNull(itemSchema, "itemSchema key may not be null");
 248         this.itemSchema = itemSchema;
 249     }
 250
 251     /**
 252      * {@inheritDoc}.
 253      */
 254     @Override
 255     public AxValidationResult validate(final AxValidationResult resultIn) {
 256         AxValidationResult result = resultIn;
 257
 258         if (key.equals(AxArtifactKey.getNullKey())) {
 259             result.addValidationMessage(new AxValidationMessage(key, this.getClass(), ValidationResult.INVALID,
 260                             "key is a null key"));
 261         }
 262         result = key.validate(result);
 263
 264         if (scope.replaceAll("\\s+$", "").length() == 0 || scope.equals(SCOPE_UNDEFINED)) {
 265             result.addValidationMessage(new AxValidationMessage(key, this.getClass(), ValidationResult.INVALID,
 266                             "scope is not defined"));
 267         }
 268
 269         String stringCheckResult = Assertions.getStringParameterValidationMessage(SCOPE_STRING, scope, SCOPE_REGEXP);
 270         if (stringCheckResult != null) {
 271             result.addValidationMessage(new AxValidationMessage(key, this.getClass(), ValidationResult.INVALID,
 272                             "scope invalid-" + stringCheckResult));
 273         }
 274
 275         if (itemSchema.equals(AxArtifactKey.getNullKey())) {
 276             result.addValidationMessage(new AxValidationMessage(key, this.getClass(), ValidationResult.INVALID,
 277                             "itemSchema reference is a null key, an item schema must be specified"));
 278         }
 279         result = itemSchema.validate(result);
 280
 281         return result;
 282     }
 283
 284     /**
 285      * {@inheritDoc}.
 286      */
 287     @Override
 288     public void clean() {
 289         key.clean();
 290         scope = Assertions.validateStringParameter(SCOPE_STRING, scope, SCOPE_REGEXP);
 291         itemSchema.clean();
 292     }
 293
 294     /**
 295      * {@inheritDoc}.
 296      */
 297     @Override
 298     public String toString() {
 299         final StringBuilder builder = new StringBuilder();
 300         builder.append(this.getClass().getSimpleName());
 301         builder.append(":(");
 302         builder.append("key=");
 303         builder.append(key);
 304         builder.append(",scope=");
 305         builder.append(scope);
 306         builder.append(",isWritable=");
 307         builder.append(isWritable);
 308         builder.append(",itemSchema=");
 309         builder.append(itemSchema);
 310         builder.append(")");
 311         return builder.toString();
 312     }
 313
 314     /**
 315      * {@inheritDoc}.
 316      */
 317     @Override
 318     public AxConcept copyTo(final AxConcept target) {
 319         Assertions.argumentNotNull(target, "targetObject may not be null");
 320
 321         final Object copyObject = target;
 322         Assertions.instanceOf(copyObject, AxContextAlbum.class);
 323
 324         final AxContextAlbum copy = ((AxContextAlbum) copyObject);
 325         copy.setKey(new AxArtifactKey(key));
 326         copy.setScope(scope);
 327         copy.setWritable(isWritable);
 328         copy.setItemSchema(new AxArtifactKey(itemSchema));
 329
 330         return copy;
 331     }
 332
 333     /**
 334      * {@inheritDoc}.
 335      */
 336     @Override
 337     public int hashCode() {
 338         final int prime = 31;
 339         int result = 1;
 340         result = prime * result + key.hashCode();
 341         result = prime * result + scope.hashCode();
 342         result = prime * result + (isWritable ? HASH_PRIME_0 : HASH_PRIME_1);
 343         result = prime * result + itemSchema.hashCode();
 344         return result;
 345     }
 346
 347     /**
 348      * {@inheritDoc}.
 349      */
 350     @Override
 351     public boolean equals(final Object obj) {
 352         if (obj == null) {
 353             return false;
 354         }
 355         if (this == obj) {
 356             return true;
 357         }
 358
 359         if (getClass() != obj.getClass()) {
 360             return false;
 361         }
 362
 363         final AxContextAlbum other = (AxContextAlbum) obj;
 364         if (!key.equals(other.key)) {
 365             return false;
 366         }
 367         if (!scope.equals(other.scope)) {
 368             return false;
 369         }
 370         if (isWritable != other.isWritable) {
 371             return (false);
 372         }
 373         return itemSchema.equals(other.itemSchema);
 374     }
 375
 376     /**
 377      * {@inheritDoc}.
 378      */
 379     @Override
 380     public int compareTo(final AxConcept otherObj) {
 381         if (otherObj == null) {
 382             return -1;
 383         }
 384         if (this == otherObj) {
 385             return 0;
 386         }
 387         if (getClass() != otherObj.getClass()) {
 388             return this.hashCode() - otherObj.hashCode();
 389         }
 390
 391         final AxContextAlbum other = (AxContextAlbum) otherObj;
 392         if (!key.equals(other.key)) {
 393             return key.compareTo(other.key);
 394         }
 395         if (!scope.equals(other.scope)) {
 396             return scope.compareTo(other.scope);
 397         }
 398         if (isWritable != other.isWritable) {
 399             return (isWritable ? 1 : -1);
 400         }
 401         return itemSchema.compareTo(other.itemSchema);
 402     }
 403 }