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
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2019, 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.
*
* SPDX-License-Identifier: Apache-2.0
* ============LICENSE_END=========================================================
*/
package org.onap.policy.pdpx.main.startstop;
import java.util.List;
import lombok.Getter;
import lombok.Setter;
import org.onap.policy.common.endpoints.event.comm.TopicEndpointManager;
import org.onap.policy.common.endpoints.event.comm.client.BidirectionalTopicClient;
import org.onap.policy.common.endpoints.event.comm.client.BidirectionalTopicClientException;
import org.onap.policy.common.endpoints.event.comm.client.TopicSinkClient;
import org.onap.policy.common.endpoints.http.client.HttpClient;
import org.onap.policy.common.endpoints.http.client.HttpClientConfigException;
import org.onap.policy.common.endpoints.http.client.HttpClientFactoryInstance;
import org.onap.policy.common.endpoints.listeners.MessageTypeDispatcher;
import org.onap.policy.common.endpoints.parameters.RestClientParameters;
import org.onap.policy.common.parameters.ParameterService;
import org.onap.policy.common.utils.services.ServiceManagerContainer;
import org.onap.policy.models.pdp.concepts.PdpStatus;
import org.onap.policy.models.pdp.enums.PdpMessageType;
import org.onap.policy.pdpx.main.PolicyXacmlPdpRuntimeException;
import org.onap.policy.pdpx.main.XacmlState;
import org.onap.policy.pdpx.main.comm.XacmlPdpHearbeatPublisher;
import org.onap.policy.pdpx.main.comm.listeners.XacmlPdpStateChangeListener;
import org.onap.policy.pdpx.main.comm.listeners.XacmlPdpUpdateListener;
import org.onap.policy.pdpx.main.parameters.XacmlPdpParameterGroup;
import org.onap.policy.pdpx.main.rest.XacmlPdpApplicationManager;
import org.onap.policy.pdpx.main.rest.XacmlPdpRestController;
import org.onap.policy.pdpx.main.rest.XacmlPdpServiceFilter;
import org.onap.policy.pdpx.main.rest.XacmlPdpStatisticsManager;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* This class wraps a distributor so that it can be activated as a complete service together with
* all its xacml pdp and forwarding handlers.
*/
public class XacmlPdpActivator extends ServiceManagerContainer {
// The logger for this class
private static final Logger LOGGER = LoggerFactory.getLogger(XacmlPdpActivator.class);
private static final String[] MSG_TYPE_NAMES = {"messageName"};
private static final String TOPIC = "POLICY-PDP-PAP";
@Getter
@Setter
private static XacmlPdpActivator current = null;
private final XacmlPdpRestServer restServer;
// The parameters of this policy xacml pdp activator
private final XacmlPdpParameterGroup xacmlPdpParameterGroup;
/**
* POLICY-PDP-PAP client.
*/
private BidirectionalTopicClient topicClient;
/**
* Listens for messages on the topic, decodes them into a {@link PdpStatus} message, and then
* dispatches them to appropriate listener.
*/
private final MessageTypeDispatcher msgDispatcher;
/**
* Instantiate the activator for policy xacml pdp as a complete service.
*
* @param xacmlPdpParameterGroup the parameters for the xacml pdp service
*/
public XacmlPdpActivator(final XacmlPdpParameterGroup xacmlPdpParameterGroup) {
LOGGER.info("Activator initializing using {}", xacmlPdpParameterGroup);
RestClientParameters apiClientParams = xacmlPdpParameterGroup.getPolicyApiParameters();
TopicEndpointManager.getManager().addTopics(xacmlPdpParameterGroup.getTopicParameterGroup());
final XacmlPdpHearbeatPublisher heartbeat;
final TopicSinkClient sinkClient;
final XacmlState state;
try {
HttpClient apiClient = HttpClientFactoryInstance.getClientFactory().build(apiClientParams);
var appmgr = new XacmlPdpApplicationManager(xacmlPdpParameterGroup.getApplicationParameters(),
apiClient);
XacmlPdpApplicationManager.setCurrent(appmgr);
var stats = new XacmlPdpStatisticsManager();
XacmlPdpStatisticsManager.setCurrent(stats);
stats.setTotalPolicyTypesCount(appmgr.getPolicyTypeCount());
stats.setTotalPolicyCount(appmgr.getPolicyCount());
state = new XacmlState(appmgr, xacmlPdpParameterGroup.getPdpGroup(), xacmlPdpParameterGroup.getPdpType());
this.xacmlPdpParameterGroup = xacmlPdpParameterGroup;
this.msgDispatcher = new MessageTypeDispatcher(MSG_TYPE_NAMES);
topicClient = new BidirectionalTopicClient(TOPIC, TOPIC);
sinkClient = new TopicSinkClient(topicClient.getSink());
heartbeat = new XacmlPdpHearbeatPublisher(topicClient,
xacmlPdpParameterGroup.getProbeHeartbeatTopicSec() * 1000, state);
/*
* since the dispatcher isn't registered with the topic yet, we can go ahead
* and register the listeners with it.
*/
msgDispatcher.register(PdpMessageType.PDP_STATE_CHANGE.name(),
new XacmlPdpStateChangeListener(sinkClient, state));
msgDispatcher.register(PdpMessageType.PDP_UPDATE.name(),
new XacmlPdpUpdateListener(sinkClient, state, heartbeat, appmgr));
XacmlPdpServiceFilter.disableApi();
restServer = new XacmlPdpRestServer(xacmlPdpParameterGroup.getRestServerParameters(),
List.of(XacmlPdpServiceFilter.class), List.of(XacmlPdpRestController.class));
} catch (RuntimeException | HttpClientConfigException | BidirectionalTopicClientException e) {
throw new PolicyXacmlPdpRuntimeException(e.getMessage(), e);
}
xacmlPdpParameterGroup.getRestServerParameters().setName(xacmlPdpParameterGroup.getName());
// @formatter:off
addAction("XACML PDP parameters",
() -> ParameterService.register(xacmlPdpParameterGroup),
() -> ParameterService.deregister(xacmlPdpParameterGroup.getName()));
addAction("Message Dispatcher",
this::registerMsgDispatcher,
this::unregisterMsgDispatcher);
addAction("topics",
TopicEndpointManager.getManager()::start,
TopicEndpointManager.getManager()::shutdown);
addAction("Terminate PDP",
() -> { },
() -> sendTerminateMessage(sinkClient, state));
// initial heart beats act as registration messages
addAction("Heartbeat Publisher",
heartbeat::start,
heartbeat::terminate);
// @formatter:on
addAction("REST Server",
restServer::start,
restServer::stop);
}
/*
* Method used to send a terminate message to the PAP.
*/
private void sendTerminateMessage(TopicSinkClient sinkClient, XacmlState state) {
PdpStatus terminateStatus = state.terminatePdpMessage();
sinkClient.send(terminateStatus);
}
/**
* Get the parameters used by the activator.
*
* @return the parameters of the activator
*/
public XacmlPdpParameterGroup getParameterGroup() {
return xacmlPdpParameterGroup;
}
/**
* Method to register the parameters to Common Parameter Service.
*
* @param xacmlPdpParameterGroup the xacml pdp parameter group
*/
public void registerToParameterService(final XacmlPdpParameterGroup xacmlPdpParameterGroup) {
ParameterService.register(xacmlPdpParameterGroup);
}
/**
* Method to deregister the parameters from Common Parameter Service.
*
* @param xacmlPdpParameterGroup the xacml pdp parameter group
*/
public void deregisterToParameterService(final XacmlPdpParameterGroup xacmlPdpParameterGroup) {
ParameterService.deregister(xacmlPdpParameterGroup.getName());
}
/**
* Registers the dispatcher with the topic source(s).
*/
private void registerMsgDispatcher() {
topicClient.getSource().register(msgDispatcher);
}
/**
* Unregisters the dispatcher from the topic source(s).
*/
private void unregisterMsgDispatcher() {
topicClient.getSource().unregister(msgDispatcher);
}
/**
* Start the xacmlpdp rest controller.
*/
public void enableApi() {
XacmlPdpServiceFilter.enableApi();
}
/**
* Stop the xacmlpdp rest controller.
*/
public void disableApi() {
XacmlPdpServiceFilter.disableApi();
}
public boolean isApiEnabled() {
return XacmlPdpServiceFilter.isApiEnabled();
}
}
|
