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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
* Modifications Copyright (C) 2019-2020, 2023 Nordix Foundation.
* Modifications Copyright (C) 2021 Bell Canada. All rights reserved.
* 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.event.carrier.restrequestor;
import jakarta.ws.rs.client.Client;
import jakarta.ws.rs.client.ClientBuilder;
import jakarta.ws.rs.client.Entity;
import jakarta.ws.rs.client.Invocation.Builder;
import jakarta.ws.rs.core.Response;
import java.net.URL;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.BlockingQueue;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.TimeUnit;
import java.util.regex.Pattern;
import lombok.Getter;
import org.apache.commons.lang3.StringUtils;
import org.onap.policy.apex.core.infrastructure.threading.ThreadUtilities;
import org.onap.policy.apex.service.engine.event.ApexEventException;
import org.onap.policy.apex.service.engine.event.ApexEventReceiver;
import org.onap.policy.apex.service.engine.event.ApexEventRuntimeException;
import org.onap.policy.apex.service.engine.event.ApexPluginsEventConsumer;
import org.onap.policy.apex.service.parameters.carriertechnology.RestPluginCarrierTechnologyParameters.HttpMethod;
import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerParameters;
import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerPeeredMode;
import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
import org.onap.policy.common.endpoints.utils.NetLoggerUtil;
import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* This class implements an Apex event consumer that issues a REST request and returns the REST response to APEX as an
* event.
*
* @author Liam Fallon (liam.fallon@ericsson.com)
*/
public class ApexRestRequestorConsumer extends ApexPluginsEventConsumer {
// Get a reference to the logger
private static final Logger LOGGER = LoggerFactory.getLogger(ApexRestRequestorConsumer.class);
// The amount of time to wait in milliseconds between checks that the consumer thread has
// stopped
private static final long REST_REQUESTOR_WAIT_SLEEP_TIME = 50;
// The REST parameters read from the parameter service
private RestRequestorCarrierTechnologyParameters restConsumerProperties;
// The timeout for REST requests
private long restRequestTimeout = RestRequestorCarrierTechnologyParameters.DEFAULT_REST_REQUEST_TIMEOUT;
// The event receiver that will receive events from this consumer
private ApexEventReceiver eventReceiver;
// The HTTP client that makes a REST call to get an input event for Apex
private Client client;
// Temporary request holder for incoming REST requests
private final BlockingQueue<ApexRestRequest> incomingRestRequestQueue = new LinkedBlockingQueue<>();
// Map of ongoing REST request threads indexed by the time they started at
private final Map<ApexRestRequest, RestRequestRunner> ongoingRestRequestMap = new ConcurrentHashMap<>();
// The number of events received to date
private Object eventsReceivedLock = new Object();
@Getter
private int eventsReceived = 0;
// The number of the next request runner thread
private static long nextRequestRunnerThreadNo = 0;
// The pattern for filtering status code
private Pattern httpCodeFilterPattern = null;
@Override
public void init(final String consumerName, final EventHandlerParameters consumerParameters,
final ApexEventReceiver incomingEventReceiver) throws ApexEventException {
this.eventReceiver = incomingEventReceiver;
this.name = consumerName;
// Check and get the REST Properties
if (!(consumerParameters
.getCarrierTechnologyParameters() instanceof RestRequestorCarrierTechnologyParameters)) {
final String errorMessage =
"specified consumer properties are not applicable to REST Requestor consumer (" + this.name + ")";
throw new ApexEventException(errorMessage);
}
restConsumerProperties =
(RestRequestorCarrierTechnologyParameters) consumerParameters.getCarrierTechnologyParameters();
// Check if we are in peered mode
if (!consumerParameters.isPeeredMode(EventHandlerPeeredMode.REQUESTOR)) {
final String errorMessage = "REST Requestor consumer (" + this.name
+ ") must run in peered requestor mode with a REST Requestor producer";
throw new ApexEventException(errorMessage);
}
// Check if the HTTP method has been set
if (restConsumerProperties.getHttpMethod() == null) {
restConsumerProperties
.setHttpMethod(RestRequestorCarrierTechnologyParameters.DEFAULT_REQUESTOR_HTTP_METHOD);
}
// Check if the HTTP URL has been set
if (restConsumerProperties.getUrl() == null) {
final String errorMessage = "no URL has been specified on REST Requestor consumer (" + this.name + ")";
throw new ApexEventException(errorMessage);
}
// Check if the HTTP URL is valid
try {
new URL(restConsumerProperties.getUrl());
} catch (final Exception e) {
final String errorMessage = "invalid URL has been specified on REST Requestor consumer (" + this.name + ")";
throw new ApexEventException(errorMessage, e);
}
this.httpCodeFilterPattern = Pattern.compile(restConsumerProperties.getHttpCodeFilter());
// Set the requestor timeout
if (consumerParameters.getPeerTimeout(EventHandlerPeeredMode.REQUESTOR) != 0) {
restRequestTimeout = consumerParameters.getPeerTimeout(EventHandlerPeeredMode.REQUESTOR);
}
// Check if HTTP headers has been set
if (restConsumerProperties.checkHttpHeadersSet()) {
final var httpHeaderString = Arrays.deepToString(restConsumerProperties.getHttpHeaders());
LOGGER.debug("REST Requestor consumer has http headers ({}): {}", this.name, httpHeaderString);
}
// Initialize the HTTP client
client = ClientBuilder.newClient();
}
/**
* Receive an incoming REST request from the peered REST Requestor producer and queue it.
*
* @param restRequest the incoming rest request to queue
* @throws ApexEventRuntimeException on queueing errors
*/
public void processRestRequest(final ApexRestRequest restRequest) {
// Push the event onto the queue for handling
try {
incomingRestRequestQueue.add(restRequest);
} catch (final Exception requestException) {
final String errorMessage =
"could not queue request \"" + restRequest + "\" on REST Requestor consumer (" + this.name + ")";
throw new ApexEventRuntimeException(errorMessage);
}
}
/**
* {@inheritDoc}.
*/
@Override
public void run() {
// The endless loop that receives events using REST calls
while (consumerThread.isAlive() && !stopOrderedFlag) {
try {
// Take the next event from the queue
final ApexRestRequest restRequest =
incomingRestRequestQueue.poll(REST_REQUESTOR_WAIT_SLEEP_TIME, TimeUnit.MILLISECONDS);
if (restRequest == null) {
// Poll timed out, check for request timeouts
timeoutExpiredRequests();
continue;
}
// Set the time stamp of the REST request
restRequest.setTimestamp(System.currentTimeMillis());
// Create a thread to process the REST request and place it on the map of ongoing
// requests
final var restRequestRunner = new RestRequestRunner(restRequest);
ongoingRestRequestMap.put(restRequest, restRequestRunner);
// Start execution of the request
final var restRequestRunnerThread = new Thread(restRequestRunner);
restRequestRunnerThread.setName("RestRequestRunner_" + nextRequestRunnerThreadNo);
restRequestRunnerThread.start();
} catch (final InterruptedException e) {
LOGGER.debug("Thread interrupted, Reason {}", e.getMessage());
Thread.currentThread().interrupt();
}
}
client.close();
}
/**
* This method times out REST requests that have expired.
*/
private void timeoutExpiredRequests() {
// Hold a list of timed out requests
final List<ApexRestRequest> timedoutRequestList = new ArrayList<>();
// Check for timeouts
for (final Entry<ApexRestRequest, RestRequestRunner> requestEntry : ongoingRestRequestMap.entrySet()) {
if (System.currentTimeMillis() - requestEntry.getKey().getTimestamp() > restRequestTimeout) {
requestEntry.getValue().stop();
timedoutRequestList.add(requestEntry.getKey());
}
}
// Interrupt timed out requests and remove them from the ongoing map
for (final ApexRestRequest timedoutRequest : timedoutRequestList) {
final String errorMessage =
"REST Requestor consumer (" + this.name + "), REST request timed out: " + timedoutRequest;
LOGGER.warn(errorMessage);
ongoingRestRequestMap.remove(timedoutRequest);
}
}
/**
* {@inheritDoc}.
*/
@Override
public void stop() {
stopOrderedFlag = true;
while (consumerThread.isAlive()) {
ThreadUtilities.sleep(REST_REQUESTOR_WAIT_SLEEP_TIME);
}
}
/**
* This class is used to start a thread for each request issued.
*
* @author Liam Fallon (liam.fallon@ericsson.com)
*/
private class RestRequestRunner implements Runnable {
private static final String APPLICATION_JSON = "application/json";
// The REST request being processed by this thread
private final ApexRestRequest request;
// The thread executing the REST request
private Thread restRequestThread;
/**
* Constructor, initialise the request runner with the request.
*
* @param request the request this runner will issue
*/
private RestRequestRunner(final ApexRestRequest request) {
this.request = request;
}
/**
* {@inheritDoc}.
*/
@Override
public void run() {
// Get the thread for the request
restRequestThread = Thread.currentThread();
var inputExecutionProperties = request.getExecutionProperties();
String url = restConsumerProperties.getUrl();
Set<String> names = restConsumerProperties.getKeysFromUrl();
if (!names.isEmpty() && inputExecutionProperties != null) {
Set<String> inputProperty = inputExecutionProperties.stringPropertyNames();
names.stream().map(Optional::of)
.forEach(op -> op.filter(inputProperty::contains)
.orElseThrow(() -> new ApexEventRuntimeException(
"key\"" + op.get() + "\"specified on url \"" + restConsumerProperties.getUrl()
+ "\"not found in execution properties passed by the current policy")));
url = names.stream().reduce(url,
(acc, str) -> acc.replace("{" + str + "}", (String) inputExecutionProperties.get(str)));
}
try {
if (restConsumerProperties.getHttpMethod().equals(HttpMethod.PUT)
|| restConsumerProperties.getHttpMethod().equals(HttpMethod.POST)) {
NetLoggerUtil.log(EventType.OUT, CommInfrastructure.REST, url, request.getEvent().toString());
}
// Execute the REST request
final var response = sendEventAsRestRequest(url);
// Get the event we received
final var eventJsonString = response.readEntity(String.class);
NetLoggerUtil.log(EventType.IN, CommInfrastructure.REST, url, eventJsonString);
// Match the return code
var isPass = httpCodeFilterPattern.matcher(String.valueOf(response.getStatus()));
// Check that the request worked
if (!isPass.matches()) {
final String errorMessage = "reception of event from URL \"" + restConsumerProperties.getUrl()
+ "\" failed with status code " + response.getStatus();
throw new ApexEventRuntimeException(errorMessage);
}
// Check there is content
if (StringUtils.isBlank(eventJsonString)) {
final String errorMessage =
"received an empty response to \"" + request + "\" from URL \"" + url + "\"";
throw new ApexEventRuntimeException(errorMessage);
}
// Send the event into Apex
eventReceiver.receiveEvent(request.getExecutionId(), inputExecutionProperties, eventJsonString);
synchronized (eventsReceivedLock) {
eventsReceived++;
}
} catch (final Exception e) {
LOGGER.warn("error receiving events on thread {}", consumerThread.getName(), e);
} finally {
// Remove the request from the map of ongoing requests
ongoingRestRequestMap.remove(request);
}
}
/**
* Stop the REST request.
*/
private void stop() {
restRequestThread.interrupt();
}
/**
* Execute the REST request.
*
*
* @return the response to the REST request
*/
public Response sendEventAsRestRequest(String url) {
Builder headers = client.target(url).request(APPLICATION_JSON)
.headers(restConsumerProperties.getHttpHeadersAsMultivaluedMap());
switch (restConsumerProperties.getHttpMethod()) {
case GET:
return headers.get();
case PUT:
return headers.put(Entity.json(request.getEvent()));
case POST:
return headers.post(Entity.json(request.getEvent()));
case DELETE:
return headers.delete();
default:
break;
}
return null;
}
}
}
|