2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017 AT&T Intellectual Property. All rights
7 * ================================================================================
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
19 * ============LICENSE_END============================================
20 * ===================================================================
21 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
24 package org.onap.clamp.clds.client;
26 import com.att.eelf.configuration.EELFLogger;
27 import com.att.eelf.configuration.EELFManager;
29 import java.io.IOException;
30 import java.util.ArrayList;
31 import java.util.Collection;
32 import java.util.Collections;
33 import java.util.Date;
34 import java.util.List;
36 import java.util.UUID;
38 import javax.ws.rs.BadRequestException;
40 import org.onap.clamp.clds.exception.policy.PolicyClientException;
41 import org.onap.clamp.clds.model.prop.ModelProperties;
42 import org.onap.clamp.clds.model.refprop.RefProp;
43 import org.onap.clamp.clds.util.LoggingUtils;
44 import org.onap.policy.api.AttributeType;
45 import org.onap.policy.api.ConfigRequestParameters;
46 import org.onap.policy.api.DeletePolicyCondition;
47 import org.onap.policy.api.DeletePolicyParameters;
48 import org.onap.policy.api.PolicyChangeResponse;
49 import org.onap.policy.api.PolicyConfig;
50 import org.onap.policy.api.PolicyConfigException;
51 import org.onap.policy.api.PolicyConfigType;
52 import org.onap.policy.api.PolicyEngine;
53 import org.onap.policy.api.PolicyEngineException;
54 import org.onap.policy.api.PolicyParameters;
55 import org.onap.policy.api.PolicyType;
56 import org.onap.policy.api.PushPolicyParameters;
57 import org.springframework.beans.factory.annotation.Autowired;
58 import org.springframework.beans.factory.annotation.Value;
59 import org.springframework.context.ApplicationContext;
62 * Policy utility methods - specifically, send the policy.
64 public class PolicyClient {
66 protected static final String POLICY_PREFIX_BASE = "Config_";
67 protected static final String POLICY_PREFIX_BRMS_PARAM = "Config_BRMS_Param_";
68 protected static final String POLICY_PREFIX_MICROSERVICE = "Config_MS_";
70 protected static final String LOG_POLICY_PREFIX = "Response is ";
72 protected static final EELFLogger logger = EELFManager.getInstance()
73 .getLogger(PolicyClient.class);
74 protected static final EELFLogger metricsLogger = EELFManager.getInstance().getMetricsLogger();
76 @Value("${org.onap.clamp.config.files.cldsPolicyConfig:'classpath:/clds/clds-policy-config.properties'}")
77 protected String cldsPolicyConfigFile;
80 protected ApplicationContext appContext;
83 protected RefProp refProp;
86 * Perform BRMS policy type.
92 * @param policyRequestUuid
94 * @return The response message of policy
97 public String sendBrmsPolicy(Map<AttributeType, Map<String, String>> attributes, ModelProperties prop,
98 String policyRequestUuid) {
100 PolicyParameters policyParameters = new PolicyParameters();
102 // Set Policy Type(Mandatory)
103 policyParameters.setPolicyConfigType(PolicyConfigType.BRMS_PARAM);
105 // Set Policy Name(Mandatory)
106 policyParameters.setPolicyName(prop.getPolicyScopeAndNameWithUniqueId());
108 // documentation says this is options, but when tested, got the
109 // following failure: java.lang.Exception: Policy send failed: PE300 -
110 // Data Issue: No policyDescription given.
111 policyParameters.setPolicyDescription(refProp.getStringValue("op.policyDescription"));
113 policyParameters.setAttributes(attributes);
115 // Set a random UUID(Mandatory)
116 policyParameters.setRequestID(UUID.fromString(policyRequestUuid));
117 String policyNamePrefix = refProp.getStringValue("policy.op.policyNamePrefix");
118 String rtnMsg = send(policyParameters, prop, policyNamePrefix);
120 String policyType = refProp.getStringValue("policy.op.type");
121 push(policyType, prop);
127 * Perform send of microservice policy in JSON.
132 * The ModelProperties
133 * @param policyRequestUuid
134 * The policy Request UUID
135 * @return The response message of policy
137 public String sendMicroServiceInJson(String policyJson, ModelProperties prop, String policyRequestUuid) {
139 PolicyParameters policyParameters = new PolicyParameters();
142 policyParameters.setPolicyConfigType(PolicyConfigType.MicroService);
143 policyParameters.setEcompName(refProp.getStringValue("policy.ecomp.name"));
144 policyParameters.setPolicyName(prop.getCurrentPolicyScopeAndPolicyName());
146 policyParameters.setConfigBody(policyJson);
147 policyParameters.setConfigBodyType(PolicyType.JSON);
149 policyParameters.setRequestID(UUID.fromString(policyRequestUuid));
150 String policyNamePrefix = refProp.getStringValue("policy.ms.policyNamePrefix");
152 // Adding this line to clear the policy id from policy name while
153 // pushing to policy engine
154 prop.setPolicyUniqueId("");
156 String rtnMsg = send(policyParameters, prop, policyNamePrefix);
157 String policyType = refProp.getStringValue("policy.ms.type");
158 push(policyType, prop);
164 * Perform send of base policy in OTHER type.
167 * The config policy string body
169 * The ModelProperties
170 * @param policyRequestUuid
171 * The policy request UUID
172 * @return The answer from policy call
174 public String sendBasePolicyInOther(String configBody, ModelProperties prop, String policyRequestUuid) {
176 PolicyParameters policyParameters = new PolicyParameters();
179 policyParameters.setPolicyConfigType(PolicyConfigType.Base);
180 policyParameters.setEcompName(refProp.getStringValue("policy.ecomp.name"));
181 policyParameters.setPolicyName(prop.getCurrentPolicyScopeAndPolicyName());
183 policyParameters.setConfigBody(configBody);
184 policyParameters.setConfigBodyType(PolicyType.OTHER);
185 policyParameters.setConfigName("HolmesPolicy");
187 policyParameters.setRequestID(UUID.fromString(policyRequestUuid));
189 // Adding this line to clear the policy id from policy name while
190 // pushing to policy engine
191 prop.setPolicyUniqueId("");
193 String rtnMsg = send(policyParameters, prop, POLICY_PREFIX_BASE);
194 push(PolicyConfigType.Base.toString(), prop);
200 * Perform send of policy.
202 * @param policyParameters
203 * The PolicyParameters
205 * The ModelProperties
206 * @return The response message of Policy
208 protected String send(PolicyParameters policyParameters, ModelProperties prop, String policyNamePrefix) {
209 // Verify whether it is triggered by Validation Test button from UI
211 return "send not executed for test action";
214 // API method to create or update Policy.
215 PolicyChangeResponse response = null;
216 String responseMessage = "";
217 Date startTime = new Date();
219 List<Integer> versions = getVersions(policyNamePrefix, prop);
220 if (versions.isEmpty()) {
221 LoggingUtils.setTargetContext("Policy", "createPolicy");
222 logger.info("Attempting to create policy for action=" + prop.getActionCd());
223 response = getPolicyEngine().createPolicy(policyParameters);
224 responseMessage = response.getResponseMessage();
226 LoggingUtils.setTargetContext("Policy", "updatePolicy");
227 logger.info("Attempting to update policy for action=" + prop.getActionCd());
228 response = getPolicyEngine().updatePolicy(policyParameters);
229 responseMessage = response.getResponseMessage();
231 } catch (Exception e) {
232 logger.error("Exception occurred during policy communication", e);
233 throw new PolicyClientException("Exception while communicating with Policy", e);
235 logger.info(LOG_POLICY_PREFIX + responseMessage);
237 LoggingUtils.setTimeContext(startTime, new Date());
239 if (response.getResponseCode() == 200) {
240 logger.info("Policy send successful");
241 metricsLogger.info("Policy send success");
243 logger.warn("Policy send failed: " + responseMessage);
244 metricsLogger.info("Policy send failure");
245 throw new BadRequestException("Policy send failed: " + responseMessage);
248 return responseMessage;
252 * Format and send push of policy.
257 * The ModelProperties
258 * @return The response message of policy
260 protected String push(String policyType, ModelProperties prop) {
261 // Verify whether it is triggered by Validation Test button from UI
263 return "push not executed for test action";
266 PushPolicyParameters pushPolicyParameters = new PushPolicyParameters();
268 // Parameter arguments
269 if (prop.getPolicyUniqueId() != null && !prop.getPolicyUniqueId().isEmpty()) {
270 pushPolicyParameters.setPolicyName(prop.getPolicyScopeAndNameWithUniqueId());
272 pushPolicyParameters.setPolicyName(prop.getCurrentPolicyScopeAndPolicyName());
274 logger.info("Policy Name in Push policy method - " + pushPolicyParameters.getPolicyName());
276 pushPolicyParameters.setPolicyType(policyType);
277 pushPolicyParameters.setPdpGroup(refProp.getStringValue("policy.pdp.group"));
278 pushPolicyParameters.setRequestID(null);
280 // API method to create or update Policy.
281 PolicyChangeResponse response = null;
282 String responseMessage = "";
284 logger.info("Attempting to push policy...");
285 response = getPolicyEngine().pushPolicy(pushPolicyParameters);
286 responseMessage = response.getResponseMessage();
287 } catch (Exception e) {
288 logger.error("Exception occurred during policy communication", e);
290 logger.info(LOG_POLICY_PREFIX + responseMessage);
292 if (response != null && (response.getResponseCode() == 200 || response.getResponseCode() == 204)) {
293 logger.info("Policy push successful");
295 logger.warn("Policy push failed: " + responseMessage);
296 throw new BadRequestException("Policy push failed: " + responseMessage);
299 return responseMessage;
303 * Use Get Config Policy API to retrieve the versions for a policy. Return
304 * versions in sorted order. Return empty list if none found.
306 * @param policyNamePrefix
307 * The Policy Name Prefix
309 * The ModelProperties
310 * @return The response message from policy
311 * @throws PolicyConfigException
312 * In case of issues with policy engine
314 protected List<Integer> getVersions(String policyNamePrefix, ModelProperties prop) throws PolicyConfigException {
316 ArrayList<Integer> versions = new ArrayList<>();
317 ConfigRequestParameters configRequestParameters = new ConfigRequestParameters();
318 String policyName = "";
320 if (prop.getPolicyUniqueId() != null && !prop.getPolicyUniqueId().isEmpty()) {
321 policyName = prop.getCurrentPolicyScopeAndFullPolicyName(policyNamePrefix) + "_" + prop.getPolicyUniqueId();
323 policyName = prop.getCurrentPolicyScopeAndFullPolicyName(policyNamePrefix);
326 logger.info("policyName=" + policyName);
327 configRequestParameters.setPolicyName(policyName);
329 Collection<PolicyConfig> response = getPolicyEngine().getConfig(configRequestParameters);
330 for (PolicyConfig policyConfig : response) {
331 Integer version = Integer.valueOf(policyConfig.getPolicyVersion());
332 versions.add(version);
334 Collections.sort(versions);
335 logger.info("Policy versions.size()=" + versions.size());
342 * This method create a new policy engine.
344 * @return A new policy engine
346 private PolicyEngine getPolicyEngine() {
347 PolicyEngine policyEngine;
349 policyEngine = new PolicyEngine(appContext.getResource(cldsPolicyConfigFile).getFile().getAbsolutePath());
350 } catch (IOException e1) {
351 throw new PolicyClientException("Exception when opening policy config file", e1);
352 } catch (PolicyEngineException e) {
353 throw new PolicyClientException("Exception when creating a new policy engine", e);
359 * Format and send delete Micro Service requests to Policy.
362 * The ModelProperties
363 * @return The response message from Policy
365 public String deleteMicrosService(ModelProperties prop) {
366 String policyType = refProp.getStringValue("policy.ms.type");
367 return deletePolicy(prop, policyType);
371 * This method delete the Base policy.
374 * The model Properties
375 * @return A string with the answer from policy
377 public String deleteBasePolicy(ModelProperties prop) {
378 return deletePolicy(prop, PolicyConfigType.Base.toString());
382 * Format and send delete BRMS requests to Policy.
385 * The ModelProperties
386 * @return The response message from policy
388 public String deleteBrms(ModelProperties prop) {
389 String policyType = refProp.getStringValue("policy.op.type");
390 return deletePolicy(prop, policyType);
394 * Format and send delete PAP and PDP requests to Policy.
397 * The ModelProperties
399 * @return The response message from policy
401 protected String deletePolicy(ModelProperties prop, String policyType) {
402 DeletePolicyParameters deletePolicyParameters = new DeletePolicyParameters();
404 if (prop.getPolicyUniqueId() != null && !prop.getPolicyUniqueId().isEmpty()) {
405 deletePolicyParameters.setPolicyName(prop.getPolicyScopeAndNameWithUniqueId());
407 deletePolicyParameters.setPolicyName(prop.getCurrentPolicyScopeAndPolicyName());
409 logger.info("Policy Name in delete policy method - " + deletePolicyParameters.getPolicyName());
410 deletePolicyParameters.setPolicyComponent("PDP");
411 deletePolicyParameters.setDeleteCondition(DeletePolicyCondition.ALL);
412 deletePolicyParameters.setPdpGroup(refProp.getStringValue("policy.pdp.group"));
413 deletePolicyParameters.setPolicyType(policyType);
414 // send delete request
415 StringBuilder responseMessage = new StringBuilder(sendDeletePolicy(deletePolicyParameters, prop));
417 logger.info("Deleting policy from PAP...");
418 deletePolicyParameters.setPolicyComponent("PAP");
419 deletePolicyParameters.setDeleteCondition(DeletePolicyCondition.ALL);
421 // send delete request
422 responseMessage.append(sendDeletePolicy(deletePolicyParameters, prop));
424 return responseMessage.toString();
428 * Send delete request to Policy.
430 * @param deletePolicyParameters
431 * The DeletePolicyParameters
433 * The ModelProperties
434 * @return The response message from policy
436 protected String sendDeletePolicy(DeletePolicyParameters deletePolicyParameters, ModelProperties prop) {
437 // Verify whether it is triggered by Validation Test button from UI
439 return "delete not executed for test action";
442 // API method to create or update Policy.
443 PolicyChangeResponse response = null;
444 String responseMessage = "";
446 logger.info("Attempting to delete policy...");
447 response = getPolicyEngine().deletePolicy(deletePolicyParameters);
448 responseMessage = response.getResponseMessage();
449 } catch (Exception e) {
450 logger.error("Exception occurred during policy communnication", e);
452 logger.info(LOG_POLICY_PREFIX + responseMessage);
454 if (response != null && response.getResponseCode() == 200) {
455 logger.info("Policy delete successful");
457 logger.warn("Policy delete failed: " + responseMessage);
458 throw new BadRequestException("Policy delete failed: " + responseMessage);
461 return responseMessage;