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

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