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
|
/*
* ============LICENSE_START=======================================================
* ONAP PAP
* ================================================================================
* Copyright (C) 2019 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.pap.main.comm;
import lombok.AccessLevel;
import lombok.Getter;
import lombok.NonNull;
import lombok.Setter;
import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
import org.onap.policy.common.utils.services.ServiceManager;
import org.onap.policy.models.pdp.concepts.PdpMessage;
import org.onap.policy.models.pdp.concepts.PdpStatus;
import org.onap.policy.pap.main.comm.msgdata.MessageData;
import org.onap.policy.pap.main.parameters.RequestDataParams;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Request data, the content of which may be changed at any point, possibly triggering a
* restart of the publishing.
*/
public abstract class RequestData {
private static final Logger logger = LoggerFactory.getLogger(RequestData.class);
/**
* Name with which this data is associated, used for logging purposes.
*/
@Getter
@Setter(AccessLevel.PROTECTED)
private String name;
/**
* The configuration parameters.
*/
private final RequestDataParams params;
/**
* Current retry count.
*/
private int retryCount = 0;
/**
* Used to register/unregister the listener and the timer.
*/
private ServiceManager svcmgr;
/**
* Wrapper for the message that is currently being published (i.e., {@link #update} or
* {@link #stateChange}.
*/
@Getter(AccessLevel.PROTECTED)
private MessageData wrapper;
/**
* Used to cancel a timer.
*/
private TimerManager.Timer timer;
/**
* Token that is placed on the queue.
*/
private QueueToken<PdpMessage> token = null;
/**
* Constructs the object, and validates the parameters.
*
* @param params configuration parameters
*
* @throws IllegalArgumentException if a required parameter is not set
*/
public RequestData(@NonNull RequestDataParams params) {
params.validate();
this.params = params;
}
/**
* Starts the publishing process, registering any listeners or timeout handlers, and
* adding the request to the publisher queue. This should not be invoked until after
* {@link #configure(MessageData)} is invoked.
*/
public void startPublishing() {
synchronized (params.getModifyLock()) {
if (!svcmgr.isAlive()) {
svcmgr.start();
}
}
}
/**
* Unregisters the listener and cancels the timer.
*/
protected void stopPublishing() {
if (svcmgr.isAlive()) {
svcmgr.stop();
}
}
/**
* Configures the fields based on the {@link #message} type.
*
* @param newWrapper the new message wrapper
*/
protected void configure(MessageData newWrapper) {
wrapper = newWrapper;
resetRetryCount();
TimerManager timerManager = wrapper.getTimers();
String msgType = wrapper.getType();
String reqid = wrapper.getMessage().getRequestId();
/*
* We have to configure the service manager HERE, because it's name changes if the
* message class changes.
*/
// @formatter:off
this.svcmgr = new ServiceManager(name + " " + msgType)
.addAction("listener",
() -> params.getResponseDispatcher().register(reqid, this::processResponse),
() -> params.getResponseDispatcher().unregister(reqid))
.addAction("timer",
() -> timer = timerManager.register(name, this::handleTimeout),
() -> timer.cancel())
.addAction("enqueue",
() -> enqueue(),
() -> {
// nothing to "stop"
});
// @formatter:on
}
/**
* Enqueues the current message with the publisher, putting it into the queue token,
* if possible. Otherwise, it adds a new token to the queue.
*/
private void enqueue() {
PdpMessage message = wrapper.getMessage();
if (token != null && token.replaceItem(message) != null) {
// took the other's place in the queue - continue using the token
return;
}
// couldn't take the other's place - add our own token to the queue
token = new QueueToken<>(message);
params.getPublisher().enqueue(token);
}
/**
* Resets the retry count.
*/
protected void resetRetryCount() {
retryCount = 0;
}
/**
* Bumps the retry count.
*
* @return {@code true} if successful, {@code false} if the limit has been reached
*/
protected boolean bumpRetryCount() {
if (retryCount >= wrapper.getMaxRetryCount()) {
return false;
}
retryCount++;
return true;
}
/**
* Indicates that the retry count was exhausted. The default method simply invokes
* {@link #allCompleted()}.
*/
protected void retryCountExhausted() {
// remove this request data from the PDP request map
allCompleted();
}
/**
* Processes a response received from the PDP.
*
* @param infra infrastructure on which the response was received
* @param topic topic on which the response was received
* @param response the response
*/
private void processResponse(CommInfrastructure infra, String topic, PdpStatus response) {
synchronized (params.getModifyLock()) {
if (!svcmgr.isAlive()) {
// this particular request must have been discarded
return;
}
stopPublishing();
if (!isActive()) {
return;
}
String reason = wrapper.checkResponse(response);
if (reason != null) {
logger.info("{} PDP data mismatch: {}", getName(), reason);
wrapper.mismatch(reason);
} else {
logger.info("{} {} successful", getName(), wrapper.getType());
wrapper.completed();
}
}
}
/**
* Handles a timeout.
*
* @param timerName the timer timer
*/
private void handleTimeout(String timerName) {
synchronized (params.getModifyLock()) {
if (!svcmgr.isAlive()) {
// this particular request must have been discarded
return;
}
stopPublishing();
if (!isActive()) {
return;
}
if (isInQueue()) {
// haven't published yet - just leave it in the queue and reset counts
logger.info("{} timeout - request still in the queue", getName());
resetRetryCount();
startPublishing();
return;
}
if (!bumpRetryCount()) {
logger.info("{} timeout - retry count exhausted", getName());
retryCountExhausted();
return;
}
// re-publish
logger.info("{} timeout - re-publish", getName());
startPublishing();
}
}
/**
* Determines if the current message is still in the queue. Assumes that
* {@link #startPublishing()} has been invoked and thus {@link #token} has been
* initialized.
*
* @return {@code true} if the current message is in the queue, {@code false}
* otherwise
*/
private boolean isInQueue() {
return (token.get() == wrapper.getMessage());
}
/**
* Determines if this request data is still active.
*
* @return {@code true} if this request is active, {@code false} otherwise
*/
protected abstract boolean isActive();
/**
* Indicates that this entire request has completed.
*/
protected abstract void allCompleted();
}
|