aboutsummaryrefslogtreecommitdiffstats
path: root/UniversalVesAdapter/src/main/java/org/onap/universalvesadapter/utils/MapperConfigUtils.java
blob: 3d1907a8dc94b252e41b873df71421625dd1950e (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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
/*
* ============LICENSE_START=======================================================
* ONAP : DCAE
* ================================================================================
* Copyright 2018 TechMahindra
*=================================================================================
* 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.
* ============LICENSE_END=========================================================
*/
package org.onap.universalvesadapter.utils;

import java.io.IOException;
import java.util.Set;
import java.util.TreeSet;

import org.onap.universalvesadapter.exception.MapperConfigException;
import org.onap.universalvesadapter.mappingconfig.Entry;
import org.onap.universalvesadapter.mappingconfig.Evaluation;
import org.onap.universalvesadapter.mappingconfig.MapperConfig;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;

/**
 * This class will be used in Future for different telemetry data:
 * This class will be utility class to read the mapper config file and parse the
 * config to prepare the grammar to detect the incoming json's event type.
 * 
 * @author kmalbari
 *
 */
public class MapperConfigUtils {

	private final Logger LOGGER = LoggerFactory.getLogger(MapperConfigUtils.class);
    private static Set<Entry> entries = new TreeSet<>((o1, o2) -> o1.getPriority().compareTo(o2.getPriority()));

    private enum JoinOperator {
        AND("AND"), OR("OR");

        private final String value;

        private JoinOperator(final String value) {
            this.value = value;
        }

        public String getValue() {
            return value;
        }
    }

    private enum ExpressionOperator {
        EQUALS("EQUALS"), STARTSWITH("STARTSWITH"), ENDSWITH("ENDSWITH"), CONTAINS("CONTAINS");

        private final String value;

        private ExpressionOperator(final String value) {
            this.value = value;
        }

        public String getValue() {
            return value;
        }
    }

    private enum DataType {
        STRING("STRING"), DOUBLE("DOUBLE");

        private final String value;

        private DataType(final String value) {
            this.value = value;
        }

        public String getValue() {
            return value;
        }
    }

    /**
     * main method.
     * 
     * @param args
     *            arguments
     */
    public static void main(String[] args) {

        String mappingFile = " { " + " \"entries\": [{ " + "     \"priority\": 4, " + "     \"evaluation\": { "
                + "         \"operand\": \"AND\", " + "         \"field\": null, " + "         \"value\": null, "
                + "         \"datatype\": null, " + "         \"lhs\": { " + "             \"operand\": \"OR\", "
                + "             \"field\": null, " + "             \"value\": null, "
                + "             \"datatype\": null, " + "             \"lhs\": { "
                + "                 \"operand\": \"EQUALS\", " + "                 \"field\": \"domain\", "
                + "                 \"value\": \"snmp-heartbeat\", " + "                 \"datatype\": \"string\", "
                + "                 \"lhs\": null, " + "                 \"rhs\": null " + "             }, "
                + "             \"rhs\": { " + "                 \"operand\": \"EQUALS\", "
                + "                 \"field\": \"domain\", " + "                 \"value\": \"snmp-fault\", "
                + "                 \"datatype\": \"string\", " + "                 \"lhs\": null, "
                + "                 \"rhs\": null " + "             } " + "         }, " + "         \"rhs\": { "
                + "             \"operand\": \"EQUALS\", " + "             \"field\": \"trap version\", "
                + "             \"value\": \"1.2\", " + "             \"datatype\": \"float\", "
                + "             \"lhs\": null, " + "             \"rhs\": null " + "         } " + "     }, "
                + "     \"result\": \"smooks.config\" " + " }, { " + "     \"priority\": 1, "
                + "     \"evaluation\": { " + "         \"operand\": \"AND\", " + "         \"field\": null, "
                + "         \"value\": null, " + "         \"datatype\": null, " + "         \"lhs\": { "
                + "             \"operand\": \"OR\", " + "             \"field\": null, "
                + "             \"value\": null, " + "             \"datatype\": null, " + "             \"lhs\": { "
                + "                 \"operand\": \"EQUALS\", " + "                 \"field\": \"domain\", "
                + "                 \"value\": \"snmp-heartbeat\", " + "                 \"datatype\": \"string\", "
                + "                 \"lhs\": null, " + "                 \"rhs\": null " + "             }, "
                + "             \"rhs\": { " + "                 \"operand\": \"EQUALS\", "
                + "                 \"field\": \"domain\", " + "                 \"value\": \"snmp-fault\", "
                + "                 \"datatype\": \"string\", " + "                 \"lhs\": null, "
                + "                 \"rhs\": null " + "             } " + "         }, " + "         \"rhs\": { "
                + "             \"operand\": \"EQUALS\", " + "             \"field\": \"trap version\", "
                + "             \"value\": \"1.2\", " + "             \"datatype\": \"float\", "
                + "             \"lhs\": null, " + "             \"rhs\": null " + "         } " + "     }, "
                + "     \"result\": \"smooks.config\" " + " }, { " + "     \"priority\": 3, "
                + "     \"evaluation\": { " + "         \"operand\": \"AND\", " + "         \"field\": null, "
                + "         \"value\": null, " + "         \"datatype\": null, " + "         \"lhs\": { "
                + "             \"operand\": \"OR\", " + "             \"field\": null, "
                + "             \"value\": null, " + "             \"datatype\": null, " + "             \"lhs\": { "
                + "                 \"operand\": \"EQUALS\", " + "                 \"field\": \"domain\", "
                + "                 \"value\": \"snmp-heartbeat\", " + "                 \"datatype\": \"string\", "
                + "                 \"lhs\": null, " + "                 \"rhs\": null " + "             }, "
                + "             \"rhs\": { " + "                 \"operand\": \"EQUALS\", "
                + "                 \"field\": \"domain\", " + "                 \"value\": \"snmp-fault\", "
                + "                 \"datatype\": \"string\", " + "                 \"lhs\": null, "
                + "                 \"rhs\": null " + "             } " + "         }, " + "         \"rhs\": { "
                + "             \"operand\": \"EQUALS\", " + "             \"field\": \"trap version\", "
                + "             \"value\": \"1.2\", " + "             \"datatype\": \"float\", "
                + "             \"lhs\": null, " + "             \"rhs\": null " + "         } " + "     }, "
                + "     \"result\": \"smooks.config\" " + " }, { " + "     \"priority\": 2, "
                + "     \"evaluation\": { " + "         \"operand\": \"AND\", " + "         \"field\": null, "
                + "         \"value\": null, " + "         \"datatype\": null, " + "         \"lhs\": { "
                + "             \"operand\": \"OR\", " + "             \"field\": null, "
                + "             \"value\": null, " + "             \"datatype\": null, " + "             \"lhs\": { "
                + "                 \"operand\": \"EQUALS\", " + "                 \"field\": \"domain\", "
                + "                 \"value\": \"snmp-heartbeat\", " + "                 \"datatype\": \"string\", "
                + "                 \"lhs\": null, " + "                 \"rhs\": null " + "             }, "
                + "             \"rhs\": { " + "                 \"operand\": \"EQUALS\", "
                + "                 \"field\": \"domain\", " + "                 \"value\": \"snmp-fault\", "
                + "                 \"datatype\": \"string\", " + "                 \"lhs\": null, "
                + "                 \"rhs\": null " + "             } " + "         }, " + "         \"rhs\": { "
                + "             \"operand\": \"EQUALS\", " + "             \"field\": \"trap version\", "
                + "             \"value\": \"1.2\", " + "             \"datatype\": \"float\", "
                + "             \"lhs\": null, " + "             \"rhs\": null " + "         } " + "     }, "
                + "     \"result\": \"smooks.config\" " + " }] " + "}";
        String incomingJsonString = "{\"domain\":\"snmp-heartbeat\",\"trap version\":1.2}";

        try {
            readMapperConfigFile(mappingFile);
            checkIncomingJsonForMatchingDomain(incomingJsonString);
        } catch (MapperConfigException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }

    }

    /**
     * Checks incoming json to see which of the domain it mathces as per mapper
     * config entries. If nothing matches, a default mapping will be used.
     * 
     * @param incomingJsonString
     *            incoming json
     * @throws MapperConfigException
     *             if error occurs in operation
     */
    public static String checkIncomingJsonForMatchingDomain(String incomingJsonString) throws MapperConfigException {
        ObjectMapper mapper = new ObjectMapper();
        JsonNode actualObj = null;
        try {
            actualObj = mapper.readTree(incomingJsonString);
        } catch (IOException exception) {
            throw new MapperConfigException("Unable to read incoming json in a tree " + exception.getMessage(),
                    exception);
        }
        for (Entry entry : entries) {

            boolean result = false;
            result = evaluateEntryMatch(entry.getEvaluation(), actualObj);
            if (result) {
                return entry.getResult();
            }
        }
        return "default";
    }

    /**
     * Reads the mapper config file.
     * 
     * @param mappingFileData
     *            string json for mapper config
     * @throws MapperConfigException
     *             if error in mapper config
     */
    public static void readMapperConfigFile(String mappingFileData) throws MapperConfigException {

        ObjectMapper name = new ObjectMapper();
        MapperConfig config = null;
        try {
            config = name.readValue(mappingFileData, MapperConfig.class);
        } catch (IOException exception) {
            throw new MapperConfigException("Unable to read config file for reason...\n " + exception.getMessage(),
                    exception);
        }
        System.out.println("Read config file content into :" + config);
        
        if (null != config) {
            entries.addAll(config.getEntries());
        } else {
            throw new MapperConfigException("Unable to generate configuration for different domains.");
        }
    }

    /**
     * Evaluates the passed in {@code Evaluation} instance and return boolean
     * result.
     * 
     * @param evaluation
     *            evaluation instance
     * @param actualObj
     *            Json node with values to compare with
     * @return true if matches evaluation else false
     * @throws MapperConfigException
     *             error in evaluation
     */
    public static boolean evaluateEntryMatch(Evaluation evaluation, JsonNode actualObj) throws MapperConfigException {
        if (null == evaluation) {
            throw new MapperConfigException("Cannot have null evaluation");
        }
        if (null != evaluation.getOperand()) {

            if (MapperConfigUtils.isValidEnum(JoinOperator.class, evaluation.getOperand())) {
                // if(JOIN_OPERATOR.contains(evaluation.getOperand())){
                switch (JoinOperator.valueOf(evaluation.getOperand())) {
                    case AND:
                        return evaluateEntryMatch(evaluation.getLhs(), actualObj)
                                && evaluateEntryMatch(evaluation.getRhs(), actualObj);
                    case OR:
                        return evaluateEntryMatch(evaluation.getLhs(), actualObj)
                                || evaluateEntryMatch(evaluation.getRhs(), actualObj);
                    default:
                        break;
                }
            }

            if (MapperConfigUtils.isValidEnum(ExpressionOperator.class, evaluation.getOperand())) {
                // if(EXPR_OPERATOR.contains(evaluation.getOperand())){

                // currently it is assumed field being compared is first level
                // child of incoming JSON structure.
                // If needed, can write a JsonPath implementation later
                String field = evaluation.getField();
                if (null != field && null != evaluation.getDatatype() && actualObj.has(field)) {
                    switch (ExpressionOperator.valueOf(evaluation.getOperand())) {
                        case EQUALS:
                            if (MapperConfigUtils.isValidEnum(DataType.class, evaluation.getDatatype())) {
                                switch (DataType.valueOf(evaluation.getDatatype())) {
                                    case STRING:
                                        if (null != actualObj.get(field))
                                            return actualObj.get(field).asText().equals(evaluation.getValue());
                                    case DOUBLE:
                                        if (null != actualObj.get(field))
                                            return actualObj.get(field).asDouble() == Double
                                                    .valueOf(evaluation.getValue());
                                    default:
                                        return false;
                                }
                            } else
                                return false;
                        case STARTSWITH:
                            if (MapperConfigUtils.isValidEnum(DataType.class, evaluation.getDatatype())) {
                                switch (DataType.valueOf(evaluation.getDatatype())) {
                                    case STRING:
                                        if (null != actualObj.get(field))
                                            return actualObj.get(field).asText().startsWith(evaluation.getValue());
                                    default:
                                        return false;
                                }
                            } else
                                return false;
                        case ENDSWITH:
                            if (MapperConfigUtils.isValidEnum(DataType.class, evaluation.getDatatype())) {
                                switch (DataType.valueOf(evaluation.getDatatype())) {
                                    case STRING:
                                        if (null != actualObj.get(field))
                                            return actualObj.get(field).asText().endsWith(evaluation.getValue());
                                    default:
                                        return false;
                                }
                            } else
                                return false;
                        case CONTAINS:
                            if (MapperConfigUtils.isValidEnum(DataType.class, evaluation.getDatatype())) {
                                switch (DataType.valueOf(evaluation.getDatatype())) {
                                    case STRING:
                                        if (null != actualObj.get(field))
                                            return actualObj.get(field).asText().contains(evaluation.getValue());
                                    default:
                                        return false;
                                }
                            } else
                                return false;
                        default:
                            return false;
                    }
                }
            }
        } else
            throw new MapperConfigException("Not an expected operand as per config for " + evaluation.getField());

        return false;
    }
    /**
     * <p>Checks if the specified name is a valid enum for the class.</p>
     *
     * <p>This method differs from {@link Enum#valueOf} in that checks if the name is
     * a valid enum without needing to catch the exception.</p>
     *
     * @param <E> the type of the enumeration
     * @param enumClass  the class of the enum to query, not null
     * @param enumName   the enum name, null returns false
     * @return true if the enum name is valid, otherwise false
     */

    public static <E extends Enum<E>> boolean isValidEnum(final Class<E> enumClass, final String enumName) {
        if (enumName == null) {
            return false;
        }
        try {
            Enum.valueOf(enumClass, enumName);
            return true;
        } catch (final IllegalArgumentException ex) {
            return false;
        }
    }


}