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
|
/*-
* ============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.Collections;
import java.util.Map;
import java.util.Map.Entry;
import java.util.concurrent.CompletableFuture;
import javax.ws.rs.client.Invocation.Builder;
import javax.ws.rs.client.WebTarget;
import javax.ws.rs.core.Response;
import org.onap.policy.common.utils.coder.StandardCoderObject;
import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
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;
/**
* Superclass of A&AI operators that use "get" to perform their request and store their
* response within the context as a {@link StandardCoderObject}. The property name under
* which they are stored is ${actor}.${operation}.${targetEntity}.
*/
public class AaiGetOperation extends HttpOperation<StandardCoderObject> {
private static final Logger logger = LoggerFactory.getLogger(AaiGetOperation.class);
public static final int DEFAULT_RETRY = 3;
/**
* Responses that are retrieved from A&AI are placed in the operation context under
* the name "${propertyPrefix}.${targetEntity}".
*/
private final String propertyPrefix;
/**
* Constructs the object.
*
* @param params operation parameters
* @param config configuration for this operation
*/
public AaiGetOperation(ControlLoopOperationParams params, HttpConfig config) {
super(params, config, StandardCoderObject.class, Collections.emptyList());
this.propertyPrefix = getFullName() + ".";
}
@Override
public void generateSubRequestId(int attempt) {
setSubRequestId(String.valueOf(attempt));
}
/**
* Adds a query parameter to a web target.
*
* @param web target to which the parameter should be added
* @param str the separator and parameter are appended here, for logging purposes
* @param separator separator to be added to "str"; that's its only use
* @param name parameter name
* @param value parameter value
* @return "web"
*/
protected 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);
}
/**
* Adds headers to the web builder.
*
* @param webldr builder to which the headers should be added
* @param headers headers to be added
*/
protected void addHeaders(Builder webldr, Map<String, Object> headers) {
for (Entry<String, Object> header : headers.entrySet()) {
webldr.header(header.getKey(), header.getValue());
}
}
@Override
protected Map<String, Object> makeHeaders() {
return AaiUtil.makeHeaders(params);
}
/**
* Injects the response into the context.
*/
@Override
protected CompletableFuture<OperationOutcome> postProcessResponse(OperationOutcome outcome, String url,
Response rawResponse, StandardCoderObject response) {
String entity = params.getTargetEntity();
logger.info("{}: caching response of {} for {}", getFullName(), entity, params.getRequestId());
params.getContext().setProperty(propertyPrefix + entity, response);
return super.postProcessResponse(outcome, url, rawResponse, response);
}
/**
* Provides a default retry value, if none specified.
*/
@Override
protected int getRetry(Integer retry) {
return (retry == null ? DEFAULT_RETRY : retry);
}
}
|