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
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
* Modifications Copyright (C) 2020-2021 Nordix Foundation.
* 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.plugins.context.schema.avro;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonArray;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import java.util.Map.Entry;
import lombok.AccessLevel;
import lombok.NoArgsConstructor;
/**
* This static final class contains utility methods for Avro schemas.
*
* @author Liam Fallon (liam.fallon@ericsson.com)
*/
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public final class AvroSchemaKeyTranslationUtilities {
// Constants for key replacements
private static final String DOT_STRING = ".";
private static final String DOT_STRING_REPLACEMENT = "_DoT_";
private static final String DASH_STRING = "-";
private static final String DASH_STRING_REPLACEMENT = "_DasH_";
private static final String COLON_STRING = ":";
private static final String COLON_STRING_REPLACEMENT = "_ColoN_";
/**
* Translate characters in JSON keys to values that are legal in Avro. Avro names must start with [A-Za-z_] and
* subsequently contain only [A-Za-z0-9_]
*
* @param jsonString The JSON string to translate
* @param revert True if we want to revert the field names to their original values
* @return the translated JSON string
*/
public static String translateIllegalKeys(final String jsonString, final boolean revert) {
if (jsonString == null) {
return jsonString;
}
// Create a JSON element for the incoming JSON string
final var jsonElement = new GsonBuilder().serializeNulls().create().fromJson(jsonString,
JsonElement.class);
final var translatedJsonElement = translateIllegalKeys(jsonElement, revert);
return new GsonBuilder().serializeNulls().create().toJson(translatedJsonElement);
}
/**
* Translate characters in JSON keys to values that are legal in Avro. Avro names must start with [A-Za-z_] and
* subsequently contain only [A-Za-z0-9_]
*
* @param jsonElement The JSON element to translate
* @param revert True if we want to revert the field names to their original values
* @return the translated JSON element
*/
public static JsonElement translateIllegalKeys(final JsonElement jsonElement, final boolean revert) {
// We only act on JSON objects and arrays
if (jsonElement.isJsonObject()) {
return translateIllegalKeys(jsonElement.getAsJsonObject(), revert);
} else if (jsonElement.isJsonArray()) {
return translateIllegalKeys(jsonElement.getAsJsonArray(), revert);
} else {
return jsonElement;
}
}
/**
* Translate characters in JSON keys to values that are legal in Avro. Avro names must start with [A-Za-z_] and
* subsequently contain only [A-Za-z0-9_]
*
* @param jsonObject The JSON object to translate
* @param revert True if we want to revert the field names to their original values
* @return the translated JSON element
*/
public static JsonElement translateIllegalKeys(final JsonObject jsonObject, final boolean revert) {
final var newJsonObject = new JsonObject();
for (final Entry<String, JsonElement> jsonObjectEntry : jsonObject.entrySet()) {
newJsonObject.add(translateIllegalKey(jsonObjectEntry.getKey(), revert),
translateIllegalKeys(jsonObjectEntry.getValue(), revert));
}
return newJsonObject;
}
/**
* Translate characters in JSON keys to values that are legal in Avro. Avro names must start with [A-Za-z_] and
* subsequently contain only [A-Za-z0-9_]
*
* @param jsonArray The JSON array to translate
* @param revert True if we want to revert the field names to their original values
* @return the translated JSON element
*/
public static JsonElement translateIllegalKeys(final JsonArray jsonArray, final boolean revert) {
final var newJsonArray = new JsonArray();
for (var i = 0; i < jsonArray.size(); i++) {
newJsonArray.add(translateIllegalKeys(jsonArray.get(i), revert));
}
return newJsonArray;
}
/**
* Translate characters in a single JSON key to values that are legal in Avro. Avro names must start with [A-Za-z_]
* and subsequently contain only [A-Za-z0-9_]
*
* @param key The key to translate
* @param revert True if we want to revert the field names to their original values
* @return the translated key
*/
private static String translateIllegalKey(final String key, final boolean revert) {
if (revert) {
return key.replace(DOT_STRING_REPLACEMENT, DOT_STRING)
.replace(DASH_STRING_REPLACEMENT, DASH_STRING)
.replace(COLON_STRING_REPLACEMENT, COLON_STRING);
} else {
return key.replace(DOT_STRING, DOT_STRING_REPLACEMENT)
.replace(DASH_STRING, DASH_STRING_REPLACEMENT)
.replace(COLON_STRING, COLON_STRING_REPLACEMENT);
}
}
}
|
