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
|
/*-
* ============LICENSE_START=======================================================
* ONAP CLAMP
* ================================================================================
* Copyright (C) 2020-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.
* ============LICENSE_END============================================
* ===================================================================
*
*/
package org.onap.policy.clamp.clds.tosca.update;
import com.att.eelf.configuration.EELFLogger;
import com.att.eelf.configuration.EELFManager;
import com.google.gson.JsonObject;
import java.io.IOException;
import org.onap.policy.clamp.clds.config.ClampProperties;
import org.onap.policy.clamp.clds.tosca.update.parser.metadata.ToscaMetadataParser;
import org.onap.policy.clamp.clds.tosca.update.parser.metadata.ToscaMetadataParserWithDictionarySupport;
import org.onap.policy.clamp.clds.tosca.update.templates.JsonTemplateManager;
import org.onap.policy.clamp.clds.util.JsonUtils;
import org.onap.policy.clamp.loop.service.Service;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
/**
* This is the main class that must be used to convert a tosca to a json schema.
* This class adds feature to support the dictionary mechanism that enables json possible values extracted
* from the dictionary DB table.
*
* @see org.onap.policy.clamp.clds.tosca.update.ToscaConverterWithDictionarySupport#convertToscaToJsonSchemaObject
*/
@Component
public class ToscaConverterWithDictionarySupport {
private static final EELFLogger logger =
EELFManager.getInstance().getLogger(ToscaConverterWithDictionarySupport.class);
private ClampProperties clampProperties;
private ToscaMetadataParser metadataParser;
/**
* Constructor with Spring support.
*
* @param clampProperties Clamp Spring properties
* @param metadataParser Metadata parser
*/
@Autowired
public ToscaConverterWithDictionarySupport(ClampProperties clampProperties,
ToscaMetadataParserWithDictionarySupport metadataParser) {
this.clampProperties = clampProperties;
this.metadataParser = metadataParser;
}
/**
* This method converts a tosca file to a json schema.
* It uses some parameters specified in the application.properties.
*
* @param toscaFile The tosca file as String
* @param policyTypeToDecode The policy type to decode
* @param serviceModel The service model associated so that the clamp enrichment could be done if required by
* the tosca model
* @return A json object being a json schema
*/
public JsonObject convertToscaToJsonSchemaObject(String toscaFile, String policyTypeToDecode,
Service serviceModel) {
try {
return new JsonTemplateManager(toscaFile,
clampProperties.getFileContent("tosca.converter.default.datatypes"),
clampProperties.getFileContent("tosca.converter.json.schema.templates"))
.getJsonSchemaForPolicyType(policyTypeToDecode, Boolean.parseBoolean(clampProperties.getStringValue(
"tosca.converter.dictionary.support.enabled")) ? metadataParser : null, serviceModel);
} catch (IOException | UnknownComponentException e) {
logger.error("Unable to convert the tosca properly, exception caught during the decoding",
e);
return new JsonObject();
}
}
/**
* This method converts a tosca file to a json schema.
* It uses some parameters specified in the application.properties.
*
* @param toscaFile The tosca file as String
* @param policyTypeToDecode The policy type to decode
* @param serviceModel The service Model so that clamp enrichment could be done if required by tosca model
* @return A String containing the json schema
*/
public String convertToscaToJsonSchemaString(String toscaFile, String policyTypeToDecode, Service serviceModel) {
return JsonUtils.GSON.toJson(this.convertToscaToJsonSchemaObject(toscaFile, policyTypeToDecode, serviceModel));
}
}
|