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
|
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2020 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.drools.policies;
import com.worldturner.medeia.api.ValidationFailedException;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import lombok.NoArgsConstructor;
import lombok.NonNull;
import org.apache.commons.lang3.StringUtils;
import org.onap.policy.common.utils.coder.CoderException;
import org.onap.policy.common.utils.coder.StandardCoder;
import org.onap.policy.common.utils.coder.StandardValCoder;
import org.onap.policy.common.utils.resources.ResourceUtils;
import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyType;
import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeIdentifier;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Converts Tosca Policies into Domain policies.
*
* <p>
* A Domain Policy is a specialized version of the Tosca Policy that
* conform with a particular domain specification in json schema format.
* A ToscaPolicy is a generic data structure where domain data is contained
* in a Map[String, Object]. This class contains that generic information
* into a concrete domain specific data model for the ToscaPolicy.
* </p>
*/
@NoArgsConstructor
public class DomainMaker {
private static final Logger logger = LoggerFactory.getLogger(DomainMaker.class);
/**
* policy-type -> schema validator map.
*/
private final Map<ToscaPolicyTypeIdentifier, StandardValCoder> validators = new ConcurrentHashMap<>();
/**
* non-validation serialization coder.
*/
private final StandardCoder nonValCoder = new StandardCoder();
/**
* Does this json conform to a registered policy type schema?.
*/
public boolean isConformant(@NonNull ToscaPolicyTypeIdentifier policyType, @NonNull String json) {
if (!isRegistered(policyType)) {
return false;
}
return validators.get(policyType).isConformant(json);
}
/**
* Does this policy conform to its domain specification?.
*/
public boolean isConformant(@NonNull ToscaPolicy policy) {
String rawPolicy = serialize(policy);
if (StringUtils.isBlank(rawPolicy)) {
return false;
}
return isConformant(policy.getTypeIdentifier(), rawPolicy);
}
/**
* Does this domain policy conforms to its schema definition?.
*/
public <T> boolean isDomainConformant(@NonNull ToscaPolicyTypeIdentifier policyType, @NonNull T domainPolicy) {
if (!isRegistered(policyType)) {
return false;
}
try {
return validators.get(policyType).encode(domainPolicy) != null;
} catch (CoderException e) {
logger.info("policy {}:{} is not conformant", policyType, domainPolicy.getClass().getName(), e);
return false;
}
}
/**
* Check policy conformance to its specification providing a list of errors
* in a ValidationFailedException.
*/
public boolean conformance(@NonNull ToscaPolicy policy) throws ValidationFailedException {
if (!isRegistered(policy.getTypeIdentifier())) {
return false;
}
String rawPolicy = serialize(policy);
if (StringUtils.isBlank(rawPolicy)) {
return false;
}
try {
validators.get(policy.getTypeIdentifier()).conformance(rawPolicy);
} catch (CoderException e) {
logger.info("policy {}:{}:{} is not conformant",
policy.getTypeIdentifier(), policy.getName(), policy.getVersion(), e);
if (e.getCause() instanceof ValidationFailedException) {
throw (ValidationFailedException) e.getCause();
}
return false;
}
return true;
}
/**
* Checks a domain policy conformance to its specification providing a list of errors
* in a ValidationFailedException.
*/
public <T> boolean conformance(@NonNull ToscaPolicyTypeIdentifier policyType, T domainPolicy)
throws ValidationFailedException {
if (!isRegistered(policyType)) {
return false;
}
try {
validators.get(policyType).encode(domainPolicy);
} catch (CoderException e) {
logger.info("policy {}:{}:{} is not conformant", policyType, domainPolicy.getClass().getName(), e);
if (e.getCause() instanceof ValidationFailedException) {
throw (ValidationFailedException) e.getCause();
}
return false;
}
return true;
}
/**
* Registers a known schema resource for validation.
*/
public boolean registerValidator(@NonNull ToscaPolicyTypeIdentifier policyType) {
//
// A known schema is one that embedded in a .jar in the classpath as a resource
// matching the following syntax: <policy-type-name>-<policy-type-version>.schema.json.
//
String schema =
ResourceUtils
.getResourceAsString("schemas/"
+ policyType.getName() + "-" + policyType.getVersion() + ".schema.json");
if (schema == null) {
return false;
}
return registerValidator(policyType, schema);
}
/**
* Registers/Overrides a new/known schema for a policy type.
*/
public boolean registerValidator(@NonNull ToscaPolicyTypeIdentifier policyType, @NonNull String schema) {
try {
validators.put(policyType, new StandardValCoder(schema, policyType.toString()));
} catch (RuntimeException r) {
logger.info("schema for {} is not valid", policyType, r);
return false;
}
return true;
}
/**
* Converts a ToscaPolicy into a Domain Policy.
*/
public <T> T convertTo(@NonNull ToscaPolicy toscaPolicy, @NonNull Class<T> clazz) throws CoderException {
return convertTo(toscaPolicy.getTypeIdentifier(), nonValCoder.encode(toscaPolicy), clazz);
}
/**
* Converts a JSON policy into a Domain Policy.
*/
public <T> T convertTo(@NonNull ToscaPolicyTypeIdentifier policyType, @NonNull String json, @NonNull Class<T> clazz)
throws CoderException {
if (isRegistered(policyType)) {
return validators.get(policyType).decode(json, clazz);
} else {
return nonValCoder.decode(json, clazz);
}
}
/**
* Converts a Tosca Policy Type specification to a domain-specific json specification.
*/
public String convertToSchema(@NonNull ToscaPolicyType policyType) {
//
// TODO:
// 1. Convert Tosca Policy Type definition schema to suitable json schema.
// 2. Call registerValidator to register
throw new UnsupportedOperationException("schema generation from policy type is not supported");
}
public boolean isRegistered(@NonNull ToscaPolicyTypeIdentifier policyType) {
return validators.containsKey(policyType) || registerValidator(policyType);
}
private String serialize(@NonNull ToscaPolicy policy) {
String rawPolicy = null;
try {
rawPolicy = nonValCoder.encode(policy);
} catch (CoderException e) {
logger.debug("policy {}:{} is invalid json", policy.getTypeIdentifier(), policy.getIdentifier(), e);
}
return rawPolicy;
}
}
|
