restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/dfserializer/DataFormatSerializer.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP - CCSDK
   4  * ================================================================================
   5  * Copyright (C) 2018 Huawei Technologies Co., Ltd. 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.onap.ccsdk.sli.plugins.yangserializers.dfserializer;
  22
  23 import org.onap.ccsdk.sli.core.sli.SvcLogicException;
  24
  25 import java.util.List;
  26 import java.util.Map;
  27
  28 /**
  29  * Abstraction of serializer to encode/decode context memory parameters
  30  * to/from specified data format.
  31  */
  32 public abstract class DataFormatSerializer {
  33
  34     /**
  35      * Data format type of the serializer.
  36      */
  37     private DataFormat dataFormat;
  38
  39     /**
  40      * Data format serializer context.
  41      */
  42     private DataFormatSerializerContext serializerContext;
  43
  44     /**
  45      * Creates an instance of data format serializer.
  46      *
  47      * @param d type of data format
  48      * @param s data format serializer context
  49      */
  50     protected DataFormatSerializer(DataFormat d,
  51                                    DataFormatSerializerContext s) {
  52         this.dataFormat = d;
  53         this.serializerContext = s;
  54     }
  55
  56     /**
  57      * Encodes context memory parameters to data format.
  58      *
  59      * @param param context memory parameter
  60      * @param annotations annotations
  61      * @return data format body
  62      * @throws SvcLogicException when serialization fails
  63      */
  64     public abstract String encode(Map<String, String> param,
  65         Map<String, List<Annotation>> annotations) throws SvcLogicException;
  66
  67     /**
  68      * Decodes data format body to context memory parameters.
  69      *
  70      * @param dataFormatBody abstract node
  71      * @return context memory parameters
  72      * @throws SvcLogicException when serialization fails
  73      */
  74     public abstract Map<String, String> decode(String dataFormatBody)
  75             throws SvcLogicException;
  76
  77     /**
  78      * Returns data format serializer context.
  79      *
  80      * @return data format serializer context
  81      */
  82     public DataFormatSerializerContext serializerContext() {
  83         return serializerContext;
  84     }
  85
  86     /**
  87      * Returns supported data format.
  88      *
  89      * @return supported data format
  90      */
  91     public DataFormat dataFormat() {
  92         return dataFormat;
  93     }
  94 }