plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroStringObjectMapper.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.apex.plugins.context.schema.avro;
  22
  23 import org.apache.avro.Schema;
  24 import org.apache.avro.Schema.Type;
  25 import org.apache.avro.util.Utf8;
  26 import org.onap.policy.apex.context.ContextRuntimeException;
  27 import org.onap.policy.apex.model.basicmodel.concepts.AxKey;
  28 import org.slf4j.ext.XLogger;
  29 import org.slf4j.ext.XLoggerFactory;
  30
  31 /**
  32  * This class does string mapping from the Avro Utf8 class to the Java String class.
  33  *
  34  * @author Liam Fallon (liam.fallon@ericsson.com)
  35  */
  36 public class AvroStringObjectMapper implements AvroObjectMapper {
  37     // Get a reference to the logger
  38     private static final XLogger LOGGER = XLoggerFactory.getXLogger(AvroStringObjectMapper.class);
  39
  40     // The user keyAvro type for direct mapping
  41     private AxKey userKey;
  42     private Type avroType;
  43
  44     // The Apex compatible class
  45     private final Class<String> schemaClass = String.class;
  46
  47     /*
  48      * (non-Javadoc)
  49      *
  50      * @see org.onap.policy.apex.plugins.context.schema.avro.AvroObjectMapper#getJavaClass()
  51      */
  52     @Override
  53     public Class<?> getJavaClass() {
  54         return schemaClass;
  55     }
  56
  57     /*
  58      * (non-Javadoc)
  59      *
  60      * @see
  61      * org.onap.policy.apex.plugins.context.schema.avro.AvroObjectMapper#setAvroType(org.apache.
  62      * avro. Schema.Type)
  63      */
  64     @Override
  65     public void init(final AxKey initUserKey, final Type initAvroType) {
  66         this.userKey = initUserKey;
  67         this.avroType = initAvroType;
  68     }
  69
  70     /*
  71      * (non-Javadoc)
  72      *
  73      * @see org.onap.policy.apex.plugins.context.schema.avro.AvroObjectMapper#createNewinstance(org.
  74      * apache. avro.Schema)
  75      */
  76     @Override
  77     public Object createNewInstance(final Schema avroSchema) {
  78         // By default, we do not create an instance, normal Java object creation for strings is
  79         // sufficient
  80         return null;
  81     }
  82
  83     /*
  84      * (non-Javadoc)
  85      *
  86      * @see org.onap.policy.apex.plugins.context.schema.avro.AvroObjectMapper#getAvroType()
  87      */
  88     @Override
  89     public Type getAvroType() {
  90         return avroType;
  91     }
  92
  93     /*
  94      * (non-Javadoc)
  95      *
  96      * @see org.onap.policy.apex.plugins.context.schema.avro.AvroObjectMapper#mapFromAvro(java.lang.
  97      * Object)
  98      */
  99     @Override
 100     public Object mapFromAvro(final Object avroObject) {
 101         // The Avro object should be a Utf8 object
 102         if (!(avroObject instanceof Utf8)) {
 103             final String returnString =
 104                     userKey.getID() + ": object \"" + avroObject + "\" of class \"" + avroObject.getClass()
 105                             + "\" cannot be decoded to an object of class \"" + schemaClass.getCanonicalName() + "\"";
 106             LOGGER.warn(returnString);
 107             throw new ContextRuntimeException(returnString);
 108         }
 109
 110         return avroObject.toString();
 111     }
 112
 113     /*
 114      * (non-Javadoc)
 115      *
 116      * @see
 117      * org.onap.policy.apex.plugins.context.schema.avro.AvroObjectMapper#mapToAvro(java.lang.Object)
 118      */
 119     @Override
 120     public Object mapToAvro(final Object object) {
 121         if (object == null) {
 122             final String returnString = userKey.getID() + ": cannot encode a null object of class \""
 123                     + schemaClass.getCanonicalName() + "\"";
 124             LOGGER.warn(returnString);
 125             throw new ContextRuntimeException(returnString);
 126         }
 127
 128         return object;
 129     }
 130 }