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
|
/*-
* ============LICENSE_START=======================================================
* ONAP
* ================================================================================
* Copyright (C) 2020-2021 AT&T Intellectual Property. All rights reserved.
* Modifications Copyright (C) 2023 Nordix Foundation.
* ================================================================================
* 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.appc;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import org.onap.aai.domain.yang.GenericVnf;
import org.onap.policy.appc.CommonHeader;
import org.onap.policy.appc.Request;
import org.onap.policy.appc.Response;
import org.onap.policy.appc.ResponseCode;
import org.onap.policy.common.utils.coder.Coder;
import org.onap.policy.common.utils.coder.CoderException;
import org.onap.policy.common.utils.coder.StandardCoder;
import org.onap.policy.common.utils.coder.StandardCoderInstantAsMillis;
import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
import org.onap.policy.controlloop.actorserviceprovider.OperationResult;
import org.onap.policy.controlloop.actorserviceprovider.impl.BidirectionalTopicOperation;
import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicConfig;
import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
import org.onap.policy.controlloop.actorserviceprovider.topic.SelectorKey;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Superclass for APPC Operations.
*/
public abstract class AppcOperation extends BidirectionalTopicOperation<Request, Response> {
private static final Logger logger = LoggerFactory.getLogger(AppcOperation.class);
private static final StandardCoder coder = new StandardCoderInstantAsMillis();
public static final String VNF_ID_KEY = "generic-vnf.vnf-id";
/**
* Keys used to match the response with the request listener. The sub request ID is a
* UUID, so it can be used to uniquely identify the response.
* <p/>
* Note: if these change, then {@link #getExpectedKeyValues(int, Request)} must be
* updated accordingly.
*/
public static final List<SelectorKey> SELECTOR_KEYS = List.of(new SelectorKey("CommonHeader", "SubRequestID"));
/**
* Constructs the object.
*
* @param params operation parameters
* @param config configuration for this operation
* @param propertyNames names of properties required by this operation
*/
protected AppcOperation(ControlLoopOperationParams params, BidirectionalTopicConfig config,
List<String> propertyNames) {
super(params, config, Response.class, propertyNames);
}
/**
* Makes a request, given the target VNF. This is a support function for
* {@link #makeRequest(int)}.
*
* @param targetVnf target VNF
* @return a new request
*/
protected Request makeRequest(GenericVnf targetVnf) {
var request = new Request();
request.setCommonHeader(new CommonHeader());
request.getCommonHeader().setRequestId(params.getRequestId());
request.getCommonHeader().setSubRequestId(getSubRequestId());
request.setAction(getName());
// convert payload strings to objects
if (params.getPayload() == null) {
logger.info("{}: no payload specified for {}", getFullName(), params.getRequestId());
} else {
convertPayload(params.getPayload(), request.getPayload());
}
// add/replace specific values
request.getPayload().put(VNF_ID_KEY, targetVnf.getVnfId());
return request;
}
/**
* Converts a payload. The original value is assumed to be a JSON string, which is
* decoded into an object.
*
* @param source source from which to get the values
* @param target where to place the decoded values
*/
private static void convertPayload(Map<String, Object> source, Map<String, Object> target) {
for (Entry<String, Object> ent : source.entrySet()) {
Object value = ent.getValue();
if (value == null) {
target.put(ent.getKey(), null);
continue;
}
try {
target.put(ent.getKey(), coder.decode(value.toString(), Object.class));
} catch (CoderException e) {
logger.warn("cannot decode JSON value {}: {}", ent.getKey(), ent.getValue(), e);
}
}
}
/**
* Note: these values must match {@link #SELECTOR_KEYS}.
*/
@Override
protected List<String> getExpectedKeyValues(int attempt, Request request) {
return List.of(getSubRequestId());
}
@Override
protected Status detmStatus(String rawResponse, Response response) {
if (response.getStatus() == null) {
// no status - this must be a request, not a response - just ignore it
logger.info("{}: ignoring request message for {}", getFullName(), params.getRequestId());
return Status.STILL_WAITING;
}
var code = ResponseCode.toResponseCode(response.getStatus().getCode());
if (code == null) {
throw new IllegalArgumentException(
"unknown APPC-C response status code: " + response.getStatus().getCode());
}
return switch (code) {
case SUCCESS -> Status.SUCCESS;
case FAILURE -> Status.FAILURE;
case ERROR, REJECT -> throw new IllegalArgumentException("APP-C request was not accepted, code=" + code);
// awaiting a "final" response
default -> Status.STILL_WAITING;
};
}
/**
* Sets the message to the status description, if available.
*/
@Override
public OperationOutcome setOutcome(OperationOutcome outcome, OperationResult result, Response response) {
outcome.setResponse(response);
if (response.getStatus() == null || response.getStatus().getDescription() == null) {
return setOutcome(outcome, result);
}
outcome.setResult(result);
outcome.setMessage(response.getStatus().getDescription());
return outcome;
}
@Override
protected Coder getCoder() {
return coder;
}
}
|
