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
|
/*-
* ============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.actorserviceprovider.impl;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.Executor;
import java.util.concurrent.Future;
import java.util.function.Function;
import javax.ws.rs.client.InvocationCallback;
import javax.ws.rs.core.Response;
import lombok.Getter;
import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
import org.onap.policy.common.endpoints.http.client.HttpClient;
import org.onap.policy.common.endpoints.utils.NetLoggerUtil;
import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
import org.onap.policy.common.utils.coder.CoderException;
import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig;
import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpParams;
import org.onap.policy.controlloop.actorserviceprovider.pipeline.PipelineControllerFuture;
import org.onap.policy.controlloop.policy.PolicyResult;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Operator that uses HTTP. The operator's parameters must be an {@link HttpParams}.
*
* @param <T> response type
*/
@Getter
public abstract class HttpOperation<T> extends OperationPartial {
private static final Logger logger = LoggerFactory.getLogger(HttpOperation.class);
/**
* Configuration for this operation.
*/
private final HttpConfig config;
/**
* Response class.
*/
private final Class<T> responseClass;
/**
* Constructs the object.
*
* @param params operation parameters
* @param config configuration for this operation
* @param clazz response class
*/
public HttpOperation(ControlLoopOperationParams params, HttpConfig config, Class<T> clazz) {
super(params, config);
this.config = config;
this.responseClass = clazz;
}
public HttpClient getClient() {
return config.getClient();
}
/**
* Gets the path to be used when performing the request; this is typically appended to
* the base URL. This method simply invokes {@link #getPath()}.
*
* @return the path URI suffix
*/
public String getPath() {
return config.getPath();
}
public long getTimeoutMs() {
return config.getTimeoutMs();
}
/**
* If no timeout is specified, then it returns the operator's configured timeout.
*/
@Override
protected long getTimeoutMs(Integer timeoutSec) {
return (timeoutSec == null || timeoutSec == 0 ? getTimeoutMs() : super.getTimeoutMs(timeoutSec));
}
/**
* Makes the request headers. This simply returns an empty map.
*
* @return request headers, a non-null, modifiable map
*/
protected Map<String, Object> makeHeaders() {
return new HashMap<>();
}
/**
* Makes the URL to which the HTTP request should be posted. This is primarily used
* for logging purposes. This particular method returns the base URL appended with the
* return value from {@link #getPath()}.
*
* @return the URL to which from which to get
*/
public String getUrl() {
return (getClient().getBaseUrl() + getPath());
}
/**
* Arranges to handle a response.
*
* @param outcome outcome to be populate
* @param url URL to which to request was sent
* @param requester function to initiate the request and invoke the given callback
* when it completes
* @return a future for the response
*/
protected CompletableFuture<OperationOutcome> handleResponse(OperationOutcome outcome, String url,
Function<InvocationCallback<Response>, Future<Response>> requester) {
final PipelineControllerFuture<OperationOutcome> controller = new PipelineControllerFuture<>();
final CompletableFuture<Response> future = new CompletableFuture<>();
final Executor executor = params.getExecutor();
// arrange for the callback to complete "future"
InvocationCallback<Response> callback = new InvocationCallback<>() {
@Override
public void completed(Response response) {
future.complete(response);
}
@Override
public void failed(Throwable throwable) {
logger.warn("{}.{}: response failure for {}", params.getActor(), params.getOperation(),
params.getRequestId());
future.completeExceptionally(throwable);
}
};
// start the request and arrange to cancel it if the controller is canceled
controller.add(requester.apply(callback));
// once "future" completes, process the response, and then complete the controller
future.thenComposeAsync(response -> processResponse(outcome, url, response), executor)
.whenCompleteAsync(controller.delayedComplete(), executor);
return controller;
}
/**
* Processes a response. This method decodes the response, sets the outcome based on
* the response, and then returns a completed future.
*
* @param outcome outcome to be populate
* @param url URL to which to request was sent
* @param response raw response to process
* @return a future to cancel or await the outcome
*/
protected CompletableFuture<OperationOutcome> processResponse(OperationOutcome outcome, String url,
Response rawResponse) {
logger.info("{}.{}: response received for {}", params.getActor(), params.getOperation(), params.getRequestId());
String strResponse = rawResponse.readEntity(String.class);
logMessage(EventType.IN, CommInfrastructure.REST, url, strResponse);
T response;
if (responseClass == String.class) {
response = responseClass.cast(strResponse);
} else {
try {
response = getCoder().decode(strResponse, responseClass);
} catch (CoderException e) {
logger.warn("{}.{} cannot decode response for {}", params.getActor(), params.getOperation(),
params.getRequestId(), e);
throw new IllegalArgumentException("cannot decode response");
}
}
if (!isSuccess(rawResponse, response)) {
logger.info("{}.{} request failed with http error code {} for {}", params.getActor(), params.getOperation(),
rawResponse.getStatus(), params.getRequestId());
return CompletableFuture.completedFuture(setOutcome(outcome, PolicyResult.FAILURE, rawResponse, response));
}
logger.info("{}.{} request succeeded for {}", params.getActor(), params.getOperation(), params.getRequestId());
setOutcome(outcome, PolicyResult.SUCCESS, rawResponse, response);
return postProcessResponse(outcome, url, rawResponse, response);
}
/**
* Sets an operation's outcome and default message based on the result.
*
* @param outcome operation to be updated
* @param result result of the operation
* @param rawResponse raw response
* @param response decoded response
* @return the updated operation
*/
public OperationOutcome setOutcome(OperationOutcome outcome, PolicyResult result, Response rawResponse,
T response) {
outcome.setResponse(response);
return setOutcome(outcome, result);
}
/**
* Processes a successful response. This method simply returns the outcome wrapped in
* a completed future.
*
* @param outcome outcome to be populate
* @param url URL to which to request was sent
* @param rawResponse raw response
* @param response decoded response
* @return a future to cancel or await the outcome
*/
protected CompletableFuture<OperationOutcome> postProcessResponse(OperationOutcome outcome, String url,
Response rawResponse, T response) {
return CompletableFuture.completedFuture(outcome);
}
/**
* Determines if the response indicates success. This method simply checks the HTTP
* status code.
*
* @param rawResponse raw response
* @param response decoded response
* @return {@code true} if the response indicates success, {@code false} otherwise
*/
protected boolean isSuccess(Response rawResponse, T response) {
return (rawResponse.getStatus() == 200);
}
@Override
public <Q> String logMessage(EventType direction, CommInfrastructure infra, String sink, Q request) {
String json = super.logMessage(direction, infra, sink, request);
NetLoggerUtil.log(direction, infra, sink, json);
return json;
}
}
|