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
|
/*-
* ============LICENSE_START=======================================================
* ONAP PAP
* ================================================================================
* Copyright (C) 2019, 2021 AT&T Intellectual Property. All rights reserved.
* Modifications Copyright (C) 2021 Nordix Foundation.
* Modifications Copyright (C) 2021-2022 Bell Canada. 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 java.util.LinkedList;
import java.util.List;
import org.onap.policy.common.parameters.ParameterService;
import org.onap.policy.common.utils.services.Registry;
import org.onap.policy.models.base.PfModelException;
import org.onap.policy.models.pap.concepts.PolicyNotification;
import org.onap.policy.models.pdp.concepts.PdpStateChange;
import org.onap.policy.models.pdp.concepts.PdpSubGroup;
import org.onap.policy.models.pdp.concepts.PdpUpdate;
import org.onap.policy.models.pdp.enums.PdpState;
import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
import org.onap.policy.pap.main.PapConstants;
import org.onap.policy.pap.main.notification.DeploymentStatus;
import org.onap.policy.pap.main.notification.PolicyNotifier;
import org.onap.policy.pap.main.parameters.PapParameterGroup;
import org.onap.policy.pap.main.service.PolicyStatusService;
import org.onap.policy.pap.main.service.ToscaServiceTemplateService;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.context.event.ApplicationReadyEvent;
import org.springframework.context.event.EventListener;
/**
* PDP message generator used to generate PDP-UPDATE and PDP-STATE-CHANGE messages.
*/
public class PdpMessageGenerator {
private static final Logger LOGGER = LoggerFactory.getLogger(PdpMessageGenerator.class);
private static final String PAP_GROUP_PARAMS_NAME = "PapGroup";
private boolean includeHeartBeat;
/**
* Lock used when updating PDPs.
*/
protected Object updateLock;
/**
* Used to send UPDATE and STATE-CHANGE requests to the PDPs.
*/
protected PdpModifyRequestMap requestMap;
/**
* Heart beat interval, in milliseconds, to pass to PDPs, or {@code null}.
*/
private Long heartBeatMs;
@Autowired
private ToscaServiceTemplateService toscaService;
@Autowired
private PolicyStatusService policyStatusService;
@Autowired
private PolicyNotifier policyNotifier;
/**
* Constructs the object.
*
* @param includeHeartBeat if the heart beat interval is to be included in any
* PDP-UPDATE messages
*/
public PdpMessageGenerator(boolean includeHeartBeat) {
this.includeHeartBeat = includeHeartBeat;
}
/**
* Initialize the parameters.
*/
@EventListener(ApplicationReadyEvent.class)
public void initialize() {
updateLock = Registry.get(PapConstants.REG_PDP_MODIFY_LOCK, Object.class);
requestMap = Registry.get(PapConstants.REG_PDP_MODIFY_MAP, PdpModifyRequestMap.class);
if (includeHeartBeat) {
PapParameterGroup params = ParameterService.get(PAP_GROUP_PARAMS_NAME);
heartBeatMs = params.getPdpParameters().getHeartBeatMs();
} else {
heartBeatMs = null;
}
}
protected PdpUpdate createPdpUpdateMessage(final String pdpGroupName, final PdpSubGroup subGroup,
final String pdpInstanceId,
final List<ToscaPolicy> policiesToBeDeployed,
final List<ToscaConceptIdentifier> policiesToBeUndeployed) {
final var update = new PdpUpdate();
update.setSource(PapConstants.PAP_NAME);
update.setName(pdpInstanceId);
update.setPdpGroup(pdpGroupName);
update.setPdpSubgroup(subGroup.getPdpType());
update.setPoliciesToBeDeployed(policiesToBeDeployed);
update.setPoliciesToBeUndeployed(policiesToBeUndeployed);
update.setPdpHeartbeatIntervalMs(heartBeatMs);
LOGGER.debug("Created PdpUpdate message - {}", update);
return update;
}
/**
* Method to return a list of policies.
*
* @param subGroup PdpSubGroup to retrieve policies from
* @throws PfModelException the exception
* @returns a list of ToscaPolicy
**/
public List<ToscaPolicy> getToscaPolicies(final PdpSubGroup subGroup) throws PfModelException {
final List<ToscaPolicy> policies = new LinkedList<>();
for (final ToscaConceptIdentifier policyIdentifier : subGroup.getPolicies()) {
policies.addAll(toscaService.getPolicyList(policyIdentifier.getName(), policyIdentifier.getVersion()));
}
LOGGER.debug("Created ToscaPolicy list - {}", policies);
return policies;
}
protected PdpStateChange createPdpStateChangeMessage(final String pdpGroupName, final PdpSubGroup subGroup,
final String pdpInstanceId, final PdpState pdpState) {
final var stateChange = new PdpStateChange();
stateChange.setSource(PapConstants.PAP_NAME);
stateChange.setName(pdpInstanceId);
stateChange.setPdpGroup(pdpGroupName);
stateChange.setPdpSubgroup(subGroup.getPdpType());
stateChange.setState(pdpState == null ? PdpState.ACTIVE : pdpState);
LOGGER.debug("Created PdpStateChange message - {}", stateChange);
return stateChange;
}
/**
* If group state=ACTIVE AND updateMsg has policiesToDeploy, then make sure deployment status is updated
* If group state=PASSIVE, then delete any deployment information for a PDP.
*
* @param pdpGroupName the group name
* @param pdpType the pdp type
* @param pdpInstanceId the pdp instance
* @param pdpState the new state as per the PDP_STATE_CHANGE change message
* @param policies list of policies as per the PDP_UPDATE message
* @throws PfModelException the exception
*/
protected void updateDeploymentStatus(final String pdpGroupName, final String pdpType, final String pdpInstanceId,
PdpState pdpState, List<ToscaPolicy> policies) {
var deploymentStatus = new DeploymentStatus(policyStatusService);
deploymentStatus.loadByGroup(pdpGroupName);
if (pdpState.equals(PdpState.PASSIVE)) {
deploymentStatus.deleteDeployment(pdpInstanceId);
} else if (pdpState.equals(PdpState.ACTIVE)) {
for (ToscaPolicy toscaPolicy : policies) {
deploymentStatus.deploy(pdpInstanceId, toscaPolicy.getIdentifier(), toscaPolicy.getTypeIdentifier(),
pdpGroupName, pdpType, true);
}
}
var notification = new PolicyNotification();
deploymentStatus.flush(notification);
policyNotifier.publish(notification);
}
}
|
