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 static final Class<String> schemaClass = String.class;
  46
  47     /**
  48      * {@inheritDoc}.
  49      */
  50     @Override
  51     public Class<?> getJavaClass() {
  52         return schemaClass;
  53     }
  54
  55     /**
  56      * {@inheritDoc}.
  57      */
  58     @Override
  59     public void init(final AxKey initUserKey, final Type initAvroType) {
  60         this.userKey = initUserKey;
  61         this.avroType = initAvroType;
  62     }
  63
  64     /**
  65      * {@inheritDoc}.
  66      */
  67     @Override
  68     public Object createNewInstance(final Schema avroSchema) {
  69         // By default, we do not create an instance, normal Java object creation for strings is
  70         // sufficient
  71         return null;
  72     }
  73
  74     /**
  75      * {@inheritDoc}.
  76      */
  77     @Override
  78     public Type getAvroType() {
  79         return avroType;
  80     }
  81
  82     /**
  83      * {@inheritDoc}.
  84      */
  85     @Override
  86     public Object mapFromAvro(final Object avroObject) {
  87         // The Avro object should be a Utf8 object
  88         if (!(avroObject instanceof Utf8)) {
  89             final String returnString =
  90                     userKey.getId() + ": object \"" + avroObject + "\" of class \"" + avroObject.getClass()
  91                             + "\" cannot be decoded to an object of class \"" + schemaClass.getCanonicalName() + "\"";
  92             LOGGER.warn(returnString);
  93             throw new ContextRuntimeException(returnString);
  94         }
  95
  96         return avroObject.toString();
  97     }
  98
  99     /**
 100      * {@inheritDoc}.
 101      */
 102     @Override
 103     public Object mapToAvro(final Object object) {
 104         if (object == null) {
 105             final String returnString = userKey.getId() + ": cannot encode a null object of class \""
 106                     + schemaClass.getCanonicalName() + "\"";
 107             LOGGER.warn(returnString);
 108             throw new ContextRuntimeException(returnString);
 109         }
 110
 111         return object;
 112     }
 113 }