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
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
* Modifications Copyright (C) 2021 AT&T Intellectual Property. 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.tools.model.generator;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import lombok.AccessLevel;
import lombok.NoArgsConstructor;
import org.apache.avro.AvroRuntimeException;
import org.apache.avro.Schema;
import org.apache.avro.Schema.Field;
import org.apache.avro.reflect.ReflectData;
import org.onap.policy.apex.context.SchemaHelper;
import org.onap.policy.apex.context.impl.schema.SchemaHelperFactory;
import org.onap.policy.apex.model.eventmodel.concepts.AxEvent;
import org.onap.policy.apex.model.eventmodel.concepts.AxField;
import org.onap.policy.apex.plugins.context.schema.avro.AvroSchemaHelper;
import org.onap.policy.apex.service.engine.event.ApexEventException;
/**
* Utility methods for schema handling.
*
* @author John Keeney (john.keeney@ericsson.com)
*/
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public final class SchemaUtils {
/**
* Returns the schema for an event.
*
* @param event the event to process
* @return the schema of the event
* @throws ApexEventException in any error case
*/
public static Schema getEventSchema(final AxEvent event) throws ApexEventException {
final Schema skeletonSchema = Schema.createRecord(event.getKey().getName(), event.getNameSpace(),
"org.onap.policy.apex.model.eventmodel.events", false);
// Get the schema field for each parameter
final List<Field> fields = new ArrayList<>(getSkeletonEventSchemaFields());
final Map<String, Schema> preExistingParamSchemas = new LinkedHashMap<>();
for (final AxField parameter : event.getParameterMap().values()) {
final Schema fieldSchema = getEventParameterSchema(parameter, preExistingParamSchemas);
final Field f = new Field(parameter.getKey().getLocalName(), fieldSchema, (String) null, (Object) null);
fields.add(f);
}
skeletonSchema.setFields(fields);
return skeletonSchema;
}
/**
* Returns the schema fields as an array.
*
* @return an array with schema fields in the following order: nameSpace, name, version, source, target
*/
public static List<Field> getSkeletonEventSchemaFields() {
// Fixed fields
final Field f1 = new Field("nameSpace", Schema.create(Schema.Type.STRING), (String) null, (Object) null);
final Field f2 = new Field("name", Schema.create(Schema.Type.STRING), (String) null, (Object) null);
final Field f3 = new Field("version", Schema.create(Schema.Type.STRING), (String) null, (Object) null);
final Field f4 = new Field("source", Schema.create(Schema.Type.STRING), (String) null, (Object) null);
final Field f5 = new Field("target", Schema.create(Schema.Type.STRING), (String) null, (Object) null);
return Arrays.asList(f1, f2, f3, f4, f5);
}
/**
* Returns the schema for an event parameter.
*
* @param parameter the parameter to process
* @param preexistingParamSchemas map of pre-existing schemas
* @return the schema for the event parameter
* @throws ApexEventException in case of any error
*/
public static Schema getEventParameterSchema(final AxField parameter,
final Map<String, Schema> preexistingParamSchemas) throws ApexEventException {
final SchemaHelper schemaHelper =
new SchemaHelperFactory().createSchemaHelper(parameter.getKey(), parameter.getSchema().getKey());
Schema parameterSchema = null;
try {
if (schemaHelper instanceof AvroSchemaHelper) {
parameterSchema = ((AvroSchemaHelper) schemaHelper).getAvroSchema();
} else {
parameterSchema = ReflectData.get().getSchema(schemaHelper.getSchemaClass());
}
} catch (final AvroRuntimeException e) {
throw new ApexEventException("failed to decode a schema for parameter " + parameter.getKey().getLocalName()
+ " of type " + parameter.getSchema().getId() + " with Java type " + schemaHelper.getSchemaClass(),
e);
}
final String schemaname = parameterSchema.getFullName();
// Get the Avro schema for this parameter, we need to keep track of sub-schemas for records because Avro does
// not
// allow re-declaration of sub-schema records of the same type. You simply reference the first sub-schema.
final Schema alreadyseen = preexistingParamSchemas.get(schemaname);
try {
processSubSchemas(parameterSchema, preexistingParamSchemas);
} catch (AvroRuntimeException | ApexEventException e) {
throw new ApexEventException("failed to decode a schema for parameter " + parameter.getKey().getLocalName()
+ " of type " + parameter.getSchema().getId() + " using Schema type " + schemaname, e);
}
if (alreadyseen != null) {
parameterSchema = alreadyseen;
}
return parameterSchema;
}
/**
* Processes a sub-schema.
*
* @param avroParameterSchema an AVRO schema to process
* @param map mapping of strings to schemas
* @throws ApexEventException in case of any error
*/
public static void processSubSchemas(final Schema avroParameterSchema, final Map<String, Schema> map)
throws ApexEventException {
if (avroParameterSchema.getType() == Schema.Type.RECORD) {
final String schematypename = avroParameterSchema.getFullName();
final Schema alreadyregistered = map.get(schematypename);
if (alreadyregistered != null && !avroParameterSchema.equals(alreadyregistered)) {
throw new ApexEventException(
"Parameter attempts to redefine type " + schematypename + " when it has already been defined");
}
map.put(schematypename, avroParameterSchema);
for (final Schema.Field f : avroParameterSchema.getFields()) {
final Schema fieldschema = f.schema();
processSubSchemas(fieldschema, map);
}
} else if (avroParameterSchema.getType() == Schema.Type.ARRAY) {
processSubSchemas(avroParameterSchema.getElementType(), map);
} else if (avroParameterSchema.getType() == Schema.Type.MAP) {
processSubSchemas(avroParameterSchema.getValueType(), map);
} else if (avroParameterSchema.getType() == Schema.Type.UNION) {
for (final Schema s : avroParameterSchema.getTypes()) {
processSubSchemas(s, map);
}
}
}
}
|
