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
|
/*
* ============LICENSE_START===================================================
* Copyright (c) 2018 Amdocs
* ============================================================================
* 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.aai.validation.ruledriven.rule.builtin;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.annotations.Expose;
import com.google.gson.annotations.SerializedName;
import com.sun.jersey.core.util.MultivaluedMapImpl;
import groovy.lang.GString;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import org.onap.aai.cl.api.Logger;
import org.onap.aai.restclient.client.OperationResult;
import org.onap.aai.validation.exception.ValidationServiceError;
import org.onap.aai.validation.logging.ApplicationMsgs;
import org.onap.aai.validation.logging.LogHelper;
public class DataDictionary {
private static final Logger logger = LogHelper.INSTANCE;
private static String credentials;
private static String urlTemplate;
private static org.onap.aai.restclient.client.RestClient restClient;
private DataDictionary() {
// intentionally empty
}
/**
* Initializes this class' static variables using MethodInvokingFactoryBean
* @param props
*/
public static void setProperties(Properties props) {
String hostport = props.getProperty("rule.datadictionary.hostport");
String connectTimeout = props.getProperty("rule.datadictionary.connect.timeout");
String readTimeout = props.getProperty("rule.datadictionary.read.timeout");
String uriTemplate = props.getProperty("rule.datadictionary.uri");
credentials = "Basic " + props.getProperty("rule.datadictionary.credentials");
urlTemplate = hostport + uriTemplate;
restClient = new org.onap.aai.restclient.client.RestClient()
.validateServerHostname(false)
.connectTimeoutMs(Integer.parseInt(connectTimeout))
.readTimeoutMs(Integer.parseInt(readTimeout));
}
/**
* Generates a REST request to data-dictionary to validate the given entities.
* URI: /commonModelElements/[entityType]~[entityName]~1.0/validateInstance
* Currently only "instance" is supported for entityType.
*
* @param entityType
* @param entityName
* @param entities
* @return
*/
public static String validate(String entityType, String entityName, List<Map<GString, GString>> entities) {
logger.debug("Executing built-in rule with...");
for(Map<GString, GString> attributes : entities) {
logger.debug(" " + attributes.toString());
}
if(entities == null || entities.isEmpty()) {
final String error = "list of instances missing";
logger.error(ApplicationMsgs.CANNOT_VALIDATE_ERROR, error);
return error;
}
String url = MessageFormat.format(urlTemplate, entityType, entityName);
Gson gson = new GsonBuilder().create();
String payload = gson.toJson(new Request(entities));
OperationResult result = post(url, payload);
if(result.getResultCode() != 200 && result.getResultCode() != 204) {
String error = ValidationServiceError.REST_CLIENT_RESPONSE_ERROR.getMessage(result.getResultCode(), result.getFailureCause());
logger.error(ApplicationMsgs.CANNOT_VALIDATE_ERROR, error);
return result.getFailureCause();
}
return "";
}
/**
* Posts the payload to the URL
* @param url
* @param payload
* @return
*/
private static OperationResult post(String url, String payload) {
MultivaluedMap<String, String> headers = new MultivaluedMapImpl();
headers.put("x-authorization", Arrays.asList(credentials));
return restClient.post(url, payload, headers, MediaType.APPLICATION_JSON_TYPE, MediaType.APPLICATION_JSON_TYPE);
}
/**
* JSON serializable class representing an instance sent to data-dictionary.
*/
public static class Request {
@Expose
@SerializedName("instance")
private List<Object> instances;
public Request(List<Map<GString, GString>> groovyInstances) {
instances = new ArrayList<>();
for(Map<GString, GString> groovyEntry : groovyInstances) {
instances.add(createInstance(groovyEntry));
}
}
public List<Object> getInstance() {
return instances;
}
/**
* Creates an instance entry; converts Groovy's GString into a java String
* @param groovyMap
* @return
*/
private Map<String, String> createInstance(Map<GString, GString> groovyMap) {
Map<String, String> newMap = new HashMap<>();
for(Map.Entry<GString, GString> groovyEntry : groovyMap.entrySet()) {
newMap.put(groovyEntry.getKey().toString(), groovyEntry.getValue().toString());
}
return newMap;
}
}
}
|
