aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroDirectObjectMapper.java
blob: 2c24833847e3eac01ea680cdfddd9cab1a0a8609 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
 *  Modifications Copyright (C) 2019-2021 Nordix Foundation.
 * ================================================================================
 * 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.HashMap;
import java.util.Map;
import java.util.TreeMap;
import org.apache.avro.Schema;
import org.apache.avro.Schema.Type;
import org.apache.avro.generic.GenericData;
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 does direct mapping from Avro classes to Java classes, used for Avro primitive types that directly produce
 * Java objects.
 *
 * @author Liam Fallon (liam.fallon@ericsson.com)
 */
public class AvroDirectObjectMapper implements AvroObjectMapper {
    // Get a reference to the logger
    private static final XLogger LOGGER = XLoggerFactory.getXLogger(AvroDirectObjectMapper.class);

    // Map for Avro primitive types to Java primitive types
    private static final Map<Schema.Type, Class<?>> AVRO_JAVA_TYPE_MAP = new TreeMap<>();

    // @formatter:off
    // Initialize the mapping
    static {
        AVRO_JAVA_TYPE_MAP.put(Schema.Type.ARRAY,   GenericData.Array.class);
        AVRO_JAVA_TYPE_MAP.put(Schema.Type.BOOLEAN, Boolean.class);
        AVRO_JAVA_TYPE_MAP.put(Schema.Type.DOUBLE,  Double.class);
        AVRO_JAVA_TYPE_MAP.put(Schema.Type.ENUM,    GenericData.EnumSymbol.class);
        AVRO_JAVA_TYPE_MAP.put(Schema.Type.FIXED,   GenericData.Fixed.class);
        AVRO_JAVA_TYPE_MAP.put(Schema.Type.FLOAT,   Float.class);
        AVRO_JAVA_TYPE_MAP.put(Schema.Type.INT,     Integer.class);
        AVRO_JAVA_TYPE_MAP.put(Schema.Type.LONG,    Long.class);
        AVRO_JAVA_TYPE_MAP.put(Schema.Type.MAP,     HashMap.class);
        AVRO_JAVA_TYPE_MAP.put(Schema.Type.NULL,    null);
        AVRO_JAVA_TYPE_MAP.put(Schema.Type.RECORD,  GenericData.Record.class);
    }
    // @formatter:on

    // The user keyAvro type for direct mapping
    private AxKey userKey;
    private Type avroType;

    // The Apex compatible class
    private Class<?> schemaClass;

    /**
     * {@inheritDoc}.
     */
    @Override
    public Class<?> getJavaClass() {
        return schemaClass;
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public void init(final AxKey initUserKey, final Type initAvroType) {
        this.userKey = initUserKey;
        this.avroType = initAvroType;
        schemaClass = AVRO_JAVA_TYPE_MAP.get(avroType);
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public Object createNewInstance(final Schema avroSchema) {
        // By default, we do not create an instance, normal Java object creation is sufficient
        return null;
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public Type getAvroType() {
        return avroType;
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public Object mapFromAvro(final Object avroObject) {
        // Always return null if the schema is a null schema
        if (schemaClass == null) {
            return null;
        }

        // It is legal for the schema class to be null, if the Avro schema has a "null" type then
        // the decoded object is always returned as a null
        if (!schemaClass.isAssignableFrom(avroObject.getClass())) {
            final var returnString = userKey.getId() + ": object \"" + avroObject + "\" of class \""
                            + avroObject.getClass() + "\" cannot be decoded to an object of class \""
                            + schemaClass.getName() + "\"";
            LOGGER.warn(returnString);
            throw new ContextRuntimeException(returnString);
        }

        return avroObject;
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public Object mapToAvro(final Object object) {
        // Null values are only allowed if the schema class is null
        if (object == null && schemaClass != null) {
            final var returnString = userKey.getId() + ": cannot encode a null object of class \""
                            + schemaClass.getName() + "\"";
            LOGGER.warn(returnString);
            throw new ContextRuntimeException(returnString);
        }

        // For direct mappings, just work directly with the Java objects
        return object;
    }
}