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
|
/*
* ============LICENSE_START=======================================================
* ONAP
* ================================================================================
* Copyright (C) 2018-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.drools.server.restful;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;
import java.net.URLEncoder;
import java.util.List;
import java.util.UUID;
import java.util.stream.Collectors;
import javax.ws.rs.Consumes;
import javax.ws.rs.GET;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.Status;
import org.onap.policy.aai.AaiManager;
import org.onap.policy.controlloop.ControlLoopException;
import org.onap.policy.controlloop.eventmanager.ControlLoopEventManager;
import org.onap.policy.controlloop.params.ControlLoopParams;
import org.onap.policy.controlloop.processor.ControlLoopProcessor;
import org.onap.policy.drools.apps.controlloop.feature.management.ControlLoopManagementFeature;
import org.onap.policy.drools.controller.DroolsController;
import org.onap.policy.drools.system.PolicyControllerConstants;
import org.onap.policy.drools.system.PolicyEngineConstants;
import org.onap.policy.rest.RestManager;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Telemetry Extensions for Control Loops in the PDP-D.
*/
@Path("/policy/pdp")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
@Api
public class RestControlLoopManager {
private static final Logger logger = LoggerFactory.getLogger(RestControlLoopManager.class);
/**
* GET control loops.
*
* @param controllerName controller name.
* @param sessionName session name.
* @return list of controller names.
*/
@GET
@Path("engine/controllers/{controller}/drools/facts/{session}/controlloops")
@ApiOperation(value = "Control Loops", notes = "Compact list", responseContainer = "List")
@ApiResponses(value = {@ApiResponse(code = 404, message = "Control Loops cannot be found")})
public Response controlLoops(
@ApiParam(value = "Policy Controller Name", required = true) @PathParam("controller") String controllerName,
@ApiParam(value = "Drools Session Name", required = true) @PathParam("session") String sessionName) {
try {
List<String> controlLoopNames =
ControlLoopManagementFeature.controlLoops(controllerName, sessionName)
.map(ControlLoopParams::getClosedLoopControlName)
.collect(Collectors.toList());
return Response.status(Response.Status.OK).entity(controlLoopNames).build();
} catch (IllegalArgumentException e) {
logger.error("{}", e);
return Response.status(Response.Status.NOT_FOUND).entity(e.getMessage()).build();
}
}
/**
* GET control loop.
*
* @param controllerName controller name.
* @param sessionName session name.
* @param controlLoopName control loop name.
* @return control loop.
*/
@GET
@Path("engine/controllers/{controller}/drools/facts/{session}/controlloops/{controlLoopName}")
@ApiOperation( value = "Control Loop", notes = "Control Loop Parameters", responseContainer = "List")
@ApiResponses(value = {@ApiResponse(code = 404, message = "The Control Loop cannot be found")})
public Response controlLoop(
@ApiParam(value = "Policy Controller Name", required = true) @PathParam("controller") String controllerName,
@ApiParam(value = "Drools Session Name", required = true) @PathParam("session") String sessionName,
@ApiParam(value = "Control Loop Name", required = true) @PathParam("controlLoopName") String controlLoopName) {
try {
List<ControlLoopParams> controlLoopParams =
ControlLoopManagementFeature.controlLoops(controllerName, sessionName)
.filter(c -> c.getClosedLoopControlName().equals(controlLoopName))
.collect(Collectors.toList());
return Response.status(Response.Status.OK).entity(controlLoopParams).build();
} catch (IllegalArgumentException e) {
logger.error("{}", e);
return Response.status(Response.Status.NOT_FOUND).entity(e.getMessage()).build();
}
}
/**
* GET operational policy.
*
* @param controllerName controller name.
* @param sessionName session name.
* @param controlLoopName control loop name.
* @return operational policy.
*/
@GET
@Path("engine/controllers/{controller}/drools/facts/{session}/controlloops/{controlLoopName}/policy")
@Produces(MediaType.TEXT_PLAIN)
@ApiOperation( value = "Operational Policy", notes = "The policy is in yaml format")
@ApiResponses(value = {@ApiResponse(code = 404, message = "The Control Loop cannot be found"),
@ApiResponse(code = 500, message = "The Control Loop has invalid data")})
public Response policy(
@ApiParam(value = "Policy Controller Name", required = true) @PathParam("controller") String controllerName,
@ApiParam(value = "Drools Session Name", required = true) @PathParam("session") String sessionName,
@ApiParam(value = "Control Loop Name", required = true) @PathParam("controlLoopName") String controlLoopName) {
try {
ControlLoopParams controlLoopParams =
ControlLoopManagementFeature.controlLoops(controllerName, sessionName)
.filter(c -> c.getClosedLoopControlName().equals(controlLoopName))
.findFirst()
.orElse(null);
if (controlLoopParams == null || controlLoopParams.getControlLoopYaml() == null) {
return Response.status(Response.Status.NOT_FOUND).entity("Policy not found").build();
}
return Response.status(Status.OK)
.entity(URLDecoder.decode(controlLoopParams.getControlLoopYaml(), "UTF-8")).build();
} catch (IllegalArgumentException e) {
logger.error("{}", e);
return Response.status(Response.Status.NOT_FOUND).entity(e.getMessage()).build();
} catch (UnsupportedEncodingException e) {
logger.error("{}", e);
return Response.status(Status.INTERNAL_SERVER_ERROR).entity("Unreadable Policy").build();
}
}
/**
* PUT an Operational Policy.
*
* @param controllerName controller name.
* @param sessionName session name.
* @param controlLoopName control loop name.
* @param policy operational policy.
*
* @return operational policy.
*/
@PUT
@Path("engine/controllers/{controller}/drools/facts/{session}/controlloops/{controlLoopName}/policy")
@Consumes(MediaType.TEXT_PLAIN)
@ApiOperation( value = "Add Operational Policy", notes = "The Operational Policy should be syntactically correct")
@ApiResponses(value = {@ApiResponse(code = 404, message = "The Control Loop cannot be found"),
@ApiResponse(code = 409, message = "The Control Loop exists"),
@ApiResponse(code = 412, message = "The Control Loop Name must be matched in the URL"),
@ApiResponse(code = 406, message = "The Operational Policy is invalid")})
public Response opOffer(
@ApiParam(value = "Policy Controller Name", required = true) @PathParam("controller") String controllerName,
@ApiParam(value = "Drools Session Name", required = true) @PathParam("session") String sessionName,
@ApiParam(value = "Control Loop Name", required = true) @PathParam("controlLoopName") String controlLoopName,
@ApiParam(value = "Operational Policy", required = true) String policy) {
try {
ControlLoopParams controlLoop =
ControlLoopManagementFeature.controlLoop(controllerName, sessionName, controlLoopName);
if (controlLoop != null) {
return Response.status(Status.CONFLICT).entity(controlLoop).build();
}
/* validation */
ControlLoopProcessor controlLoopProcessor = new ControlLoopProcessor(policy);
if (!controlLoopName.equals(controlLoopProcessor.getControlLoop().getControlLoopName())) {
return Response.status(Status.PRECONDITION_FAILED)
.entity("Control Loop Name in URL does not match the Operational Policy")
.build();
}
DroolsController controller = PolicyControllerConstants.getFactory().get(controllerName).getDrools();
controlLoop = new ControlLoopParams();
controlLoop.setPolicyScope(controller.getGroupId());
controlLoop.setPolicyName(controller.getArtifactId());
controlLoop.setPolicyVersion(controller.getVersion());
controlLoop.setClosedLoopControlName(controlLoopName);
controlLoop.setControlLoopYaml(URLEncoder.encode(policy, "UTF-8"));
controller.getContainer().insertAll(controlLoop);
return Response.status(Status.OK).entity(controlLoop).build();
} catch (IllegalArgumentException i) {
logger.error("{}", i);
return Response.status(Response.Status.NOT_FOUND).entity(i).build();
} catch (ControlLoopException | UnsupportedEncodingException e) {
logger.error("{}", e);
return Response.status(Status.NOT_ACCEPTABLE).entity(e).build();
}
}
/**
* AAI Custom Query.
*
* @param vserverId vServer identifier.
* @return query results.
*/
@GET
@Path("engine/tools/controlloops/aai/customQuery/{vserverId}")
@ApiOperation(value = "AAI Custom Query")
public Response aaiCustomQuery(@ApiParam(value = "vserver Identifier") String vserverId) {
return Response
.status(Status.OK)
.entity(new AaiManager(new RestManager())
.getCustomQueryResponse(
PolicyEngineConstants.getManager()
.getEnvironmentProperty(ControlLoopEventManager.AAI_URL),
PolicyEngineConstants.getManager().getEnvironmentProperty(
ControlLoopEventManager.AAI_USERNAME_PROPERTY),
PolicyEngineConstants.getManager().getEnvironmentProperty(
ControlLoopEventManager.AAI_PASS_PROPERTY),
UUID.randomUUID(),
vserverId))
.build();
}
}
|
