Fix incorrect naming on context plugins
[policy/apex-pdp.git] / plugins / plugins-context / plugins-context-schema / plugins-context-schema-avro / src / main / java / org / onap / policy / apex / plugins / context / schema / avro / AvroObjectMapperFactory.java
diff --git a/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroObjectMapperFactory.java b/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroObjectMapperFactory.java
new file mode 100644 (file)
index 0000000..22152a8
--- /dev/null
@@ -0,0 +1,131 @@
+/*-
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * 
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.apex.plugins.context.schema.avro;
+
+import java.util.List;
+import java.util.Map;
+import java.util.TreeMap;
+
+import org.apache.avro.Schema;
+import org.onap.policy.apex.context.ContextRuntimeException;
+import org.onap.policy.apex.model.basicmodel.concepts.AxKey;
+import org.slf4j.ext.XLogger;
+import org.slf4j.ext.XLoggerFactory;
+
+/**
+ * This class maps between Avro types to Java types. This class is thread safe.
+ *
+ * @author Liam Fallon (liam.fallon@ericsson.com)
+ */
+public class AvroObjectMapperFactory {
+    // Get a reference to the logger
+    private static final XLogger LOGGER = XLoggerFactory.getXLogger(AvroObjectMapperFactory.class);
+
+    // Map for Avro primitive types to Java primitive types
+    private static final Map<Schema.Type, Class<? extends AvroObjectMapper>> AVRO_OBJECT_MAPPER_MAP = new TreeMap<>();
+
+    // @formatter:off
+    // Initialize the mapping
+    static {
+        AVRO_OBJECT_MAPPER_MAP.put(Schema.Type.ARRAY, AvroArrayObjectMapper.class);
+        AVRO_OBJECT_MAPPER_MAP.put(Schema.Type.BOOLEAN, AvroDirectObjectMapper.class);
+        AVRO_OBJECT_MAPPER_MAP.put(Schema.Type.BYTES, AvroBytesObjectMapper.class);
+        AVRO_OBJECT_MAPPER_MAP.put(Schema.Type.DOUBLE, AvroDirectObjectMapper.class);
+        AVRO_OBJECT_MAPPER_MAP.put(Schema.Type.ENUM, AvroEnumObjectMapper.class);
+        AVRO_OBJECT_MAPPER_MAP.put(Schema.Type.FIXED, AvroDirectObjectMapper.class);
+        AVRO_OBJECT_MAPPER_MAP.put(Schema.Type.FLOAT, AvroDirectObjectMapper.class);
+        AVRO_OBJECT_MAPPER_MAP.put(Schema.Type.INT, AvroDirectObjectMapper.class);
+        AVRO_OBJECT_MAPPER_MAP.put(Schema.Type.LONG, AvroDirectObjectMapper.class);
+        AVRO_OBJECT_MAPPER_MAP.put(Schema.Type.MAP, AvroDirectObjectMapper.class);
+        AVRO_OBJECT_MAPPER_MAP.put(Schema.Type.NULL, AvroDirectObjectMapper.class);
+        AVRO_OBJECT_MAPPER_MAP.put(Schema.Type.RECORD, AvroRecordObjectMapper.class);
+        AVRO_OBJECT_MAPPER_MAP.put(Schema.Type.STRING, AvroStringObjectMapper.class);
+        AVRO_OBJECT_MAPPER_MAP.put(Schema.Type.UNION, null);
+    }
+    // @formatter:on
+
+    /**
+     * Gets the Avro object mapper to use for an artifact with the given key and schema.
+     *
+     * @param userKey the key of the artifact
+     * @param incomingSchema the incoming schema
+     * @return the avro object mapper
+     */
+    public AvroObjectMapper get(final AxKey userKey, final Schema incomingSchema) {
+        Schema schema = incomingSchema;
+        boolean isnullable = false;
+        if (Schema.Type.UNION.equals(schema.getType())) {
+
+            final List<Schema> types = schema.getTypes();
+            // TODO: properly support UNIONS
+            // currently only support unions with 2 types, one of which is NULL
+            final Schema nullschema = Schema.create(Schema.Type.NULL);
+            if (types.size() != 2 || !types.contains(nullschema)) {
+                final String resultSting = userKey.getID()
+                        + ": Apex currently only supports UNION schemas with 2 options, one must be NULL";
+                LOGGER.warn(resultSting);
+                throw new ContextRuntimeException(resultSting);
+            }
+            isnullable = true;
+            // get the non-null schema given for the union so it can be wrapped
+            schema = types.get(0);
+            if (Schema.Type.NULL.equals(schema.getType())) {
+                schema = types.get(1);
+            }
+            if (Schema.Type.NULL.equals(schema.getType())) {
+                final String resultSting = userKey.getID()
+                        + ": Apex currently only supports UNION schema2 with 2 options, only one can be NULL, and the other cannot be another UNION";
+                LOGGER.warn(resultSting);
+                throw new ContextRuntimeException(resultSting);
+            }
+        }
+
+        final Schema.Type avroType = schema.getType();
+
+        // Check that there is a definition for the mapper for this type
+        if (!AVRO_OBJECT_MAPPER_MAP.containsKey(avroType) || AVRO_OBJECT_MAPPER_MAP.get(avroType) == null) {
+            final String resultSting =
+                    userKey.getID() + ": no Avro object mapper defined for Avro type \"" + avroType + "\"";
+            LOGGER.warn(resultSting);
+            throw new ContextRuntimeException(resultSting);
+        }
+
+        // Create a mapper
+        AvroObjectMapper avroObjectMapper;
+        try {
+            avroObjectMapper = AVRO_OBJECT_MAPPER_MAP.get(avroType).newInstance();
+            if (isnullable) {
+                avroObjectMapper = new AvroNullableMapper(avroObjectMapper);
+            }
+
+        } catch (final Exception e) {
+            final String resultSting = userKey.getID() + ": could not create an Avro object mapper of type \""
+                    + AVRO_OBJECT_MAPPER_MAP.get(avroType) + "\" for Avro type \"" + avroType + "\" : " + e;
+            LOGGER.warn(resultSting, e);
+            throw new ContextRuntimeException(resultSting, e);
+        }
+
+        // Set the type and return
+        avroObjectMapper.init(userKey, avroType);
+
+        return avroObjectMapper;
+    }
+}