dcae-analytics-model/src/main/java/org/openecomp/dcae/apod/analytics/model/domain/DynamicPropertiesProvider.java

   1 /*
   2  * ===============================LICENSE_START======================================
   3  *  dcae-analytics
   4  * ================================================================================
   5  *    Copyright © 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  *  Licensed under the Apache License, Version 2.0 (the "License");
   8  *  you may not use this file except in compliance with the License.
   9  *   You may obtain a copy of the License at
  10  *
  11  *          http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  *  Unless required by applicable law or agreed to in writing, software
  14  *  distributed under the License is distributed on an "AS IS" BASIS,
  15  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  *  See the License for the specific language governing permissions and
  17  *  limitations under the License.
  18  *  ============================LICENSE_END===========================================
  19  */
  20
  21 package org.openecomp.dcae.apod.analytics.model.domain;
  22
  23 import java.util.Map;
  24
  25 /**
  26  * <p>
  27  *      Problem: Many Entities have dynamic properties as well as known properties.
  28  *      Known properites can be binded explicitly with all dynamic properties need
  29  *      to be captured also ensuring that there must not be any loss in information
  30  *      during deserialization / serialization process.
  31  * </p>
  32  * <p>
  33  *     This contract allows the deserialization mechanism to catch those dynamic properties
  34  *     in a Map so that deserialization mechanism will not loose any information and
  35  *     can be serialized back with no loss in dynamic properties information
  36  * </p>
  37  * @author Rajiv Singla . Creation Date: 10/18/2016.
  38  */
  39 public interface DynamicPropertiesProvider extends DCAEAnalyticsModel {
  40
  41
  42     /**
  43      * Adds dynamic properties in a Map object
  44      *
  45      * @param propertyName property name
  46      * @param propertyValue property value
  47      */
  48     void addDynamicProperties(String propertyName, Object propertyValue);
  49
  50     /**
  51      * Provides dynamic properties map
  52      *
  53      * @return dynamic properties map object
  54      */
  55     Map<String, Object> getDynamicProperties();
  56 }