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
|
/*-
* ============LICENSE_START=======================================================
* ONAP
* ================================================================================
* 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.
* ============LICENSE_END=========================================================
*/
package org.onap.policy.controlloop.actor.aai;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.concurrent.CompletableFuture;
import javax.ws.rs.client.Entity;
import javax.ws.rs.client.Invocation.Builder;
import javax.ws.rs.client.WebTarget;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import org.apache.commons.lang3.StringUtils;
import org.onap.policy.aai.AaiConstants;
import org.onap.policy.aai.AaiCqResponse;
import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
import org.onap.policy.common.utils.coder.StandardCoderObject;
import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
import org.onap.policy.controlloop.actorserviceprovider.OperationProperties;
import org.onap.policy.controlloop.actorserviceprovider.OperationResult;
import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperation;
import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* A&AI Custom Query. Stores the {@link AaiCqResponse} in the context. In addition, if the
* context does not contain the "tenant" data for the vserver, then it will request that,
* as well. Note: this ignores the "target entity" in the parameters as this query always
* applies to the vserver, thus the target entity may be set to an empty string.
*/
public class AaiCustomQueryOperation extends HttpOperation<String> {
private static final Logger logger = LoggerFactory.getLogger(AaiCustomQueryOperation.class);
public static final String NAME = AaiCqResponse.OPERATION;
public static final String VSERVER_VSERVER_NAME = "vserver.vserver-name";
public static final String RESOURCE_LINK = "resource-link";
public static final String RESULT_DATA = "result-data";
private static final List<String> PROPERTY_NAMES = List.of(OperationProperties.AAI_VSERVER_LINK);
// TODO make this configurable
private static final String PREFIX = "/aai/v16";
/**
* Constructs the object.
*
* @param params operation parameters
* @param config configuration for this operation
*/
public AaiCustomQueryOperation(ControlLoopOperationParams params, HttpConfig config) {
super(params, config, String.class, PROPERTY_NAMES);
}
/**
* Gets the vserver name from the enrichment data.
*
* @return the vserver name
*/
protected String getVserver() {
String vserver = this.params.getContext().getEnrichment().get(VSERVER_VSERVER_NAME);
if (StringUtils.isBlank(vserver)) {
throw new IllegalArgumentException("missing " + VSERVER_VSERVER_NAME + " in enrichment data");
}
return vserver;
}
/**
* Queries the vserver, if necessary.
*/
@Override
protected CompletableFuture<OperationOutcome> startPreprocessorAsync() {
if (params.isPreprocessed()) {
return null;
}
String vserver = getVserver();
ControlLoopOperationParams tenantParams =
params.toBuilder().actor(AaiConstants.ACTOR_NAME).operation(AaiGetTenantOperation.NAME)
.targetEntity(vserver).payload(null).retry(null).timeoutSec(null).build();
return params.getContext().obtain(AaiGetTenantOperation.getKey(vserver), tenantParams);
}
@Override
public void generateSubRequestId(int attempt) {
setSubRequestId(String.valueOf(attempt));
}
@Override
protected CompletableFuture<OperationOutcome> startOperationAsync(int attempt, OperationOutcome outcome) {
outcome.setSubRequestId(String.valueOf(attempt));
final Map<String, String> request = makeRequest();
Map<String, Object> headers = makeHeaders();
StringBuilder str = new StringBuilder(getClient().getBaseUrl());
String path = getPath();
WebTarget web = getClient().getWebTarget().path(path);
str.append(path);
web = addQuery(web, str, "?", "format", "resource");
Builder webldr = web.request();
for (Entry<String, Object> header : headers.entrySet()) {
webldr.header(header.getKey(), header.getValue());
}
String url = str.toString();
String strRequest = prettyPrint(request);
logMessage(EventType.OUT, CommInfrastructure.REST, url, strRequest);
Entity<String> entity = Entity.entity(strRequest, MediaType.APPLICATION_JSON);
return handleResponse(outcome, url, callback -> webldr.async().put(entity, callback));
}
private WebTarget addQuery(WebTarget web, StringBuilder str, String separator, String name, String value) {
str.append(separator);
str.append(name);
str.append('=');
str.append(value);
return web.queryParam(name, value);
}
/**
* Constructs the custom query using the previously retrieved tenant data.
*/
private Map<String, String> makeRequest() {
return Map.of("start", getVserverLink(), "query", "query/closed-loop");
}
/**
* Gets the vserver link, first checking the properties, and then the tenant data.
*
* @return the vserver link
*/
protected String getVserverLink() {
String resourceLink = getProperty(OperationProperties.AAI_VSERVER_LINK);
if (resourceLink != null) {
return resourceLink;
}
String vserver = getVserver();
StandardCoderObject tenant = params.getContext().getProperty(AaiGetTenantOperation.getKey(vserver));
if (tenant == null) {
throw new IllegalStateException("cannot perform custom query - cannot determine resource-link");
}
resourceLink = tenant.getString(RESULT_DATA, 0, RESOURCE_LINK);
if (resourceLink == null) {
throw new IllegalArgumentException("cannot perform custom query - no resource-link");
}
resourceLink = resourceLink.replace(PREFIX, "");
return resourceLink;
}
@Override
protected Map<String, Object> makeHeaders() {
return AaiUtil.makeHeaders(params);
}
@Override
public OperationOutcome setOutcome(OperationOutcome outcome, OperationResult result, Response rawResponse,
String response) {
super.setOutcome(outcome, result, rawResponse, response);
if (response != null) {
outcome.setResponse(new AaiCqResponse(response));
}
return outcome;
}
/**
* Injects the response into the context.
*/
@Override
protected CompletableFuture<OperationOutcome> postProcessResponse(OperationOutcome outcome, String url,
Response rawResponse, String response) {
if (params.getContext() != null) {
logger.info("{}: caching response for {}", getFullName(), params.getRequestId());
params.getContext().setProperty(AaiCqResponse.CONTEXT_KEY, new AaiCqResponse(response));
}
return super.postProcessResponse(outcome, url, rawResponse, response);
}
}
|
