2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ============LICENSE_END=========================================================
21 package org.onap.policy.controller;
25 import java.io.FileInputStream;
26 import java.io.IOException;
27 import java.io.InputStream;
28 import java.util.ArrayList;
29 import java.util.HashMap;
30 import java.util.List;
32 import java.util.Properties;
34 import javax.annotation.PostConstruct;
35 import javax.mail.MessagingException;
36 import javax.script.SimpleBindings;
37 import javax.servlet.http.HttpServletRequest;
38 import javax.servlet.http.HttpServletResponse;
40 import org.json.JSONObject;
41 import org.onap.policy.admin.PolicyNotificationMail;
42 import org.onap.policy.admin.RESTfulPAPEngine;
43 import org.onap.policy.common.logging.flexlogger.FlexLogger;
44 import org.onap.policy.common.logging.flexlogger.Logger;
45 import org.onap.policy.model.PDPGroupContainer;
46 import org.onap.policy.model.Roles;
47 import org.onap.policy.rest.XACMLRestProperties;
48 import org.onap.policy.rest.XacmlAdminAuthorization;
49 import org.onap.policy.rest.dao.CommonClassDao;
50 import org.onap.policy.rest.jpa.Datatype;
51 import org.onap.policy.rest.jpa.FunctionDefinition;
52 import org.onap.policy.rest.jpa.PolicyEntity;
53 import org.onap.policy.rest.jpa.PolicyVersion;
54 import org.onap.policy.rest.jpa.UserInfo;
55 import org.onap.policy.xacml.api.XACMLErrorConstants;
56 import org.onap.policy.xacml.api.pap.PAPPolicyEngine;
57 import org.onap.portalsdk.core.controller.RestrictedBaseController;
58 import org.onap.portalsdk.core.web.support.JsonMessage;
59 import org.onap.portalsdk.core.web.support.UserUtils;
60 import org.springframework.beans.factory.annotation.Autowired;
61 import org.springframework.http.MediaType;
62 import org.springframework.stereotype.Controller;
63 import org.springframework.web.bind.annotation.RequestMapping;
64 import org.springframework.web.bind.annotation.RequestMethod;
65 import org.springframework.web.servlet.ModelAndView;
67 import com.att.research.xacml.util.XACMLProperties;
68 import com.fasterxml.jackson.databind.ObjectMapper;
73 public class PolicyController extends RestrictedBaseController {
74 private static final Logger policyLogger = FlexLogger.getLogger(PolicyController.class);
76 private static CommonClassDao commonClassDao;
78 // Our authorization object
80 XacmlAdminAuthorization authorizer = new XacmlAdminAuthorization();
84 private static PAPPolicyEngine papEngine;
86 private static String logTableLimit;
87 private static String systemAlertTableLimit;
88 protected static Map<String, String> dropDownMap = new HashMap<>();
89 public static Map<String, String> getDropDownMap() {
93 public static void setDropDownMap(Map<String, String> dropDownMap) {
94 PolicyController.dropDownMap = dropDownMap;
97 public static String getDomain() {
98 return XACMLProperties.getProperty(XACMLRestProperties.PROP_ADMIN_DOMAIN, "urn");
101 private static final Object mapAccess = new Object();
102 private static Map<Datatype, List<FunctionDefinition>> mapDatatype2Function = null;
103 private static Map<String, FunctionDefinition> mapID2Function = null;
105 //Constant variables used across Policy-sdk
106 private static final String policyData = "policyData";
107 private static final String characterEncoding = "UTF-8";
108 private static final String contentType = "application/json";
109 private static final String file = "file";
111 //Smtp Java Mail Properties
112 private static String smtpHost = null;
113 private static String smtpPort = null;
114 private static String smtpUsername = null;
115 private static String smtpPassword = null;
116 private static String smtpApplicationName = null;
117 private static String smtpEmailExtension = null;
119 private static String logdbDriver = null;
120 private static String logdbUrl = null;
121 private static String logdbUserName = null;
122 private static String logdbPassword = null;
123 private static String logdbDialect = null;
124 //Xacml db properties
125 private static String xacmldbUrl = null;
126 private static String xacmldbUserName = null;
127 private static String xacmldbPassword = null;
130 private static String autoPushAvailable;
131 private static String autoPushDSClosedLoop;
132 private static String autoPushDSFirewall;
133 private static String autoPushDSMicroservice;
134 private static String autoPushPDPGroup;
137 private static String papUrl;
139 //MicroService Model Properties
140 private static String msOnapName;
141 private static String msPolicyName;
144 private static String configHome;
145 private static String actionHome;
147 private static boolean jUnit = false;
150 public static boolean isjUnit() {
154 public static void setjUnit(boolean jUnit) {
155 PolicyController.jUnit = jUnit;
159 private PolicyController(CommonClassDao commonClassDao){
160 PolicyController.commonClassDao = commonClassDao;
163 public PolicyController() {
168 Properties prop = new Properties();
169 InputStream input = null;
172 File file = new File(new File(".").getCanonicalPath() + File.separator + "src"+ File.separator + "test" + File.separator + "resources" + File.separator + "JSONConfig.json");
173 input = new FileInputStream(file);
175 input = new FileInputStream("xacml.admin.properties");
177 // load a properties file
180 setPapUrl(prop.getProperty("xacml.rest.pap.url"));
181 // get the property values
182 setSmtpHost(prop.getProperty("onap.smtp.host"));
183 setSmtpPort(prop.getProperty("onap.smtp.port"));
184 setSmtpUsername(prop.getProperty("onap.smtp.userName"));
185 setSmtpPassword(prop.getProperty("onap.smtp.password"));
186 setSmtpApplicationName(prop.getProperty("onap.application.name"));
187 setSmtpEmailExtension(prop.getProperty("onap.smtp.emailExtension"));
188 //Log Database Properties
189 setLogdbDriver(prop.getProperty("xacml.log.db.driver"));
190 setLogdbUrl(prop.getProperty("xacml.log.db.url"));
191 setLogdbUserName(prop.getProperty("xacml.log.db.user"));
192 setLogdbPassword(prop.getProperty("xacml.log.db.password"));
193 setLogdbDialect(prop.getProperty("onap.dialect"));
194 //Xacml Database Properties
195 setXacmldbUrl(prop.getProperty("javax.persistence.jdbc.url"));
196 setXacmldbUserName(prop.getProperty("javax.persistence.jdbc.user"));
197 setXacmldbPassword(prop.getProperty("javax.persistence.jdbc.password"));
199 setAutoPushAvailable(prop.getProperty("xacml.automatic.push"));
200 setAutoPushDSClosedLoop(prop.getProperty("xacml.autopush.closedloop"));
201 setAutoPushDSFirewall(prop.getProperty("xacml.autopush.firewall"));
202 setAutoPushDSMicroservice(prop.getProperty("xacml.autopush.microservice"));
203 setAutoPushPDPGroup(prop.getProperty("xacml.autopush.pdpGroup"));
204 //Micro Service Properties
205 setMsOnapName(prop.getProperty("xacml.policy.msOnapName"));
206 if(getMsOnapName() == null){
207 setMsOnapName(prop.getProperty("xacml.policy.msEcompName"));
209 policyLogger.info("getMsOnapName => " + getMsOnapName());
210 setMsPolicyName(prop.getProperty("xacml.policy.msPolicyName"));
211 policyLogger.info("setMsPolicyName => " + getMsPolicyName());
213 setConfigHome(prop.getProperty("xacml.rest.config.webapps") + "Config");
214 setActionHome(prop.getProperty("xacml.rest.config.webapps") + "Action");
215 //Get the Property Values for Dashboard tab Limit
217 setLogTableLimit(prop.getProperty("xacml.onap.dashboard.logTableLimit"));
218 setSystemAlertTableLimit(prop.getProperty("xacml.onap.dashboard.systemAlertTableLimit"));
220 policyLogger.error(XACMLErrorConstants.ERROR_DATA_ISSUE+"Dashboard tab Property fields are missing" +e);
221 setLogTableLimit("5000");
222 setSystemAlertTableLimit("2000");
224 System.setProperty(XACMLProperties.XACML_PROPERTIES_NAME, "xacml.admin.properties");
225 } catch (IOException ex) {
226 policyLogger.error(XACMLErrorConstants.ERROR_DATA_ISSUE+"Exception Occured while reading the Smtp properties from xacml.admin.properties file" +ex);
231 } catch (IOException e) {
232 policyLogger.error(XACMLErrorConstants.ERROR_DATA_ISSUE+"Exception Occured while Closing the xacml.admin.properties file" +e);
237 //Initialize the FunctionDefinition table at Server Start up
238 Map<Datatype, List<FunctionDefinition>> functionMap = getFunctionDatatypeMap();
239 for (Datatype id : functionMap.keySet()) {
240 List<FunctionDefinition> functionDefinations = functionMap.get(id);
241 for (FunctionDefinition functionDef : functionDefinations) {
242 dropDownMap.put(functionDef.getShortname(),functionDef.getXacmlid());
248 public static Map<Datatype, List<FunctionDefinition>> getFunctionDatatypeMap() {
249 synchronized(mapAccess) {
250 if (mapDatatype2Function == null) {
254 return mapDatatype2Function;
257 public static Map<String, FunctionDefinition> getFunctionIDMap() {
258 synchronized(mapAccess) {
259 if (mapID2Function == null) {
263 return mapID2Function;
266 private static void buildFunctionMaps() {
267 mapDatatype2Function = new HashMap<>();
268 mapID2Function = new HashMap<>();
269 List<Object> functiondefinitions = commonClassDao.getData(FunctionDefinition.class);
270 for (int i = 0; i < functiondefinitions.size(); i ++) {
271 FunctionDefinition value = (FunctionDefinition) functiondefinitions.get(i);
272 mapID2Function.put(value.getXacmlid(), value);
273 if (!mapDatatype2Function.containsKey(value.getDatatypeBean())) {
274 mapDatatype2Function.put(value.getDatatypeBean(), new ArrayList<FunctionDefinition>());
276 mapDatatype2Function.get(value.getDatatypeBean()).add(value);
280 @RequestMapping(value={"/get_FunctionDefinitionDataByName"}, method={org.springframework.web.bind.annotation.RequestMethod.GET} , produces=MediaType.APPLICATION_JSON_VALUE)
281 public void getFunctionDefinitionData(HttpServletRequest request, HttpServletResponse response){
283 Map<String, Object> model = new HashMap<>();
284 ObjectMapper mapper = new ObjectMapper();
285 model.put("functionDefinitionDatas", mapper.writeValueAsString(commonClassDao.getDataByColumn(FunctionDefinition.class, "shortname")));
286 JsonMessage msg = new JsonMessage(mapper.writeValueAsString(model));
287 JSONObject j = new JSONObject(msg);
288 response.getWriter().write(j.toString());
291 policyLogger.error(XACMLErrorConstants.ERROR_DATA_ISSUE +"Error while retriving the Function Definition data"+e);
295 public PolicyEntity getPolicyEntityData(String scope, String policyName){
296 String key = scope + ":" + policyName;
297 List<Object> data = commonClassDao.getDataById(PolicyEntity.class, "scope:policyName", key);
298 return (PolicyEntity) data.get(0);
301 public static Map<String, Roles> getUserRoles(String userId) {
302 Map<String, Roles> scopes = new HashMap<>();
303 List<Object> roles = commonClassDao.getDataById(Roles.class, "loginId", userId);
304 if (roles != null && !roles.isEmpty()) {
305 for (Object role : roles) {
306 scopes.put(((Roles) role).getScope(), (Roles) role);
312 public List<String> getRolesOfUser(String userId) {
313 List<String> rolesList = new ArrayList<>();
314 List<Object> roles = commonClassDao.getDataById(Roles.class, "loginId", userId);
315 for (Object role: roles) {
316 rolesList.add(((Roles) role).getRole());
321 public List<Object> getRoles(String userId) {
322 return commonClassDao.getDataById(Roles.class, "loginId", userId);
325 //Get List of User Roles
326 @RequestMapping(value={"/get_UserRolesData"}, method={org.springframework.web.bind.annotation.RequestMethod.GET} , produces=MediaType.APPLICATION_JSON_VALUE)
327 public void getUserRolesEntityData(HttpServletRequest request, HttpServletResponse response){
329 String userId = UserUtils.getUserSession(request).getOrgUserId();
330 Map<String, Object> model = new HashMap<>();
331 ObjectMapper mapper = new ObjectMapper();
332 model.put("userRolesDatas", mapper.writeValueAsString(getRolesOfUser(userId)));
333 JsonMessage msg = new JsonMessage(mapper.writeValueAsString(model));
334 JSONObject j = new JSONObject(msg);
335 response.getWriter().write(j.toString());
338 policyLogger.error("Exception Occured"+e);
342 //Policy tabs Model and View
343 @RequestMapping(value= {"/policy", "/policy/Editor" } , method = RequestMethod.GET)
344 public ModelAndView view(HttpServletRequest request){
345 String myRequestURL = request.getRequestURL().toString();
348 // Set the URL for the RESTful PAP Engine
350 setPapEngine((PAPPolicyEngine) new RESTfulPAPEngine(myRequestURL));
351 new PDPGroupContainer((PAPPolicyEngine) new RESTfulPAPEngine(myRequestURL));
352 } catch (Exception e) {
353 policyLogger.error(XACMLErrorConstants.ERROR_SYSTEM_ERROR+"Exception Occured while loading PAP"+e);
355 Map<String, Object> model = new HashMap<>();
356 return new ModelAndView("policy_Editor","model", model);
359 public PAPPolicyEngine getPapEngine() {
363 public static void setPapEngine(PAPPolicyEngine papEngine) {
364 PolicyController.papEngine = papEngine;
367 public String getUserName(String createdBy) {
368 String loginId = createdBy;
369 List<Object> data = commonClassDao.getDataById(UserInfo.class, "loginId", loginId);
370 return data.get(0).toString();
373 public static boolean getActivePolicy(String query) {
374 if(!commonClassDao.getDataByQuery(query, new SimpleBindings()).isEmpty()){
381 public void executeQuery(String query) {
382 commonClassDao.updateQuery(query);
385 public void saveData(Object cloneEntity) {
386 commonClassDao.save(cloneEntity);
389 public void updateData(Object entity) {
390 commonClassDao.update(entity);
393 public void deleteData(Object entity) {
394 commonClassDao.delete(entity);
397 public List<Object> getData(@SuppressWarnings("rawtypes") Class className){
398 return commonClassDao.getData(className);
401 public PolicyVersion getPolicyEntityFromPolicyVersion(String query){
402 return (PolicyVersion) commonClassDao.getEntityItem(PolicyVersion.class, "policyName", query);
405 public List<Object> getDataByQuery(String query, SimpleBindings params){
406 return commonClassDao.getDataByQuery(query, params);
410 @SuppressWarnings("rawtypes")
411 public Object getEntityItem(Class className, String columname, String key){
412 return commonClassDao.getEntityItem(className, columname, key);
416 public void watchPolicyFunction(PolicyVersion entity, String policyName, String mode){
417 PolicyNotificationMail email = new PolicyNotificationMail();
419 email.sendMail(entity, policyName, mode, commonClassDao);
420 } catch (MessagingException e) {
421 policyLogger.error(XACMLErrorConstants.ERROR_SYSTEM_ERROR + "Excepton Occured while Renaming/Deleting a Policy or Scope" + e);
426 public JSONObject switchVersionPolicyContent(String policyName) {
427 String dbCheckName = policyName.replace("/", ".");
428 if(dbCheckName.contains("Config_")){
429 dbCheckName = dbCheckName.replace(".Config_", ":Config_");
430 }else if(dbCheckName.contains("Action_")){
431 dbCheckName = dbCheckName.replace(".Action_", ":Action_");
432 }else if(dbCheckName.contains("Decision_")){
433 dbCheckName = dbCheckName.replace(".Decision_", ":Decision_");
435 String[] splitDBCheckName = dbCheckName.split(":");
436 String query = "FROM PolicyEntity where policyName like :splitDBCheckName1 and scope = :splitDBCheckName0";
437 SimpleBindings params = new SimpleBindings();
438 params.put("splitDBCheckName1", splitDBCheckName[1] + "%");
439 params.put("splitDBCheckName0", splitDBCheckName[0]);
440 List<Object> policyEntity = commonClassDao.getDataByQuery(query, params);
441 List<String> av = new ArrayList<>();
442 for(Object entity : policyEntity){
443 PolicyEntity pEntity = (PolicyEntity) entity;
444 String removeExtension = pEntity.getPolicyName().replace(".xml", "");
445 String version = removeExtension.substring(removeExtension.lastIndexOf(".")+1);
448 if(policyName.contains("/")){
449 policyName = policyName.replace("/", File.separator);
451 PolicyVersion entity = (PolicyVersion) commonClassDao.getEntityItem(PolicyVersion.class, "policyName", policyName);
452 JSONObject el = new JSONObject();
453 el.put("activeVersion", entity.getActiveVersion());
454 el.put("availableVersions", av);
455 el.put("highestVersion", entity.getHigherVersion());
459 public static String getLogTableLimit() {
460 return logTableLimit;
463 public static void setLogTableLimit(String logTableLimit) {
464 PolicyController.logTableLimit = logTableLimit;
467 public static String getSystemAlertTableLimit() {
468 return systemAlertTableLimit;
471 public static void setSystemAlertTableLimit(String systemAlertTableLimit) {
472 PolicyController.systemAlertTableLimit = systemAlertTableLimit;
475 public static CommonClassDao getCommonClassDao() {
476 return commonClassDao;
479 public static void setCommonClassDao(CommonClassDao commonClassDao) {
480 PolicyController.commonClassDao = commonClassDao;
483 public XacmlAdminAuthorization getAuthorizer() {
487 public void setAuthorizer(XacmlAdminAuthorization authorizer) {
488 this.authorizer = authorizer;
491 public static Map<Datatype, List<FunctionDefinition>> getMapDatatype2Function() {
492 return mapDatatype2Function;
495 public static void setMapDatatype2Function(Map<Datatype, List<FunctionDefinition>> mapDatatype2Function) {
496 PolicyController.mapDatatype2Function = mapDatatype2Function;
499 public static Map<String, FunctionDefinition> getMapID2Function() {
500 return mapID2Function;
503 public static void setMapID2Function(Map<String, FunctionDefinition> mapID2Function) {
504 PolicyController.mapID2Function = mapID2Function;
507 public static String getSmtpHost() {
511 public static void setSmtpHost(String smtpHost) {
512 PolicyController.smtpHost = smtpHost;
515 public static String getSmtpPort() {
519 public static void setSmtpPort(String smtpPort) {
520 PolicyController.smtpPort = smtpPort;
523 public static String getSmtpUsername() {
527 public static void setSmtpUsername(String smtpUsername) {
528 PolicyController.smtpUsername = smtpUsername;
531 public static String getSmtpPassword() {
535 public static void setSmtpPassword(String smtpPassword) {
536 PolicyController.smtpPassword = smtpPassword;
539 public static String getSmtpApplicationName() {
540 return smtpApplicationName;
543 public static void setSmtpApplicationName(String smtpApplicationName) {
544 PolicyController.smtpApplicationName = smtpApplicationName;
547 public static String getSmtpEmailExtension() {
548 return smtpEmailExtension;
551 public static void setSmtpEmailExtension(String smtpEmailExtension) {
552 PolicyController.smtpEmailExtension = smtpEmailExtension;
555 public static String getLogdbDriver() {
559 public static void setLogdbDriver(String logdbDriver) {
560 PolicyController.logdbDriver = logdbDriver;
563 public static String getLogdbUrl() {
567 public static void setLogdbUrl(String logdbUrl) {
568 PolicyController.logdbUrl = logdbUrl;
571 public static String getLogdbUserName() {
572 return logdbUserName;
575 public static void setLogdbUserName(String logdbUserName) {
576 PolicyController.logdbUserName = logdbUserName;
579 public static String getLogdbPassword() {
580 return logdbPassword;
583 public static void setLogdbPassword(String logdbPassword) {
584 PolicyController.logdbPassword = logdbPassword;
587 public static String getLogdbDialect() {
591 public static void setLogdbDialect(String logdbDialect) {
592 PolicyController.logdbDialect = logdbDialect;
595 public static String getXacmldbUrl() {
599 public static void setXacmldbUrl(String xacmldbUrl) {
600 PolicyController.xacmldbUrl = xacmldbUrl;
603 public static String getXacmldbUserName() {
604 return xacmldbUserName;
607 public static void setXacmldbUserName(String xacmldbUserName) {
608 PolicyController.xacmldbUserName = xacmldbUserName;
611 public static String getXacmldbPassword() {
612 return xacmldbPassword;
615 public static void setXacmldbPassword(String xacmldbPassword) {
616 PolicyController.xacmldbPassword = xacmldbPassword;
619 public static String getAutoPushAvailable() {
620 return autoPushAvailable;
623 public static void setAutoPushAvailable(String autoPushAvailable) {
624 PolicyController.autoPushAvailable = autoPushAvailable;
627 public static String getAutoPushDSClosedLoop() {
628 return autoPushDSClosedLoop;
631 public static void setAutoPushDSClosedLoop(String autoPushDSClosedLoop) {
632 PolicyController.autoPushDSClosedLoop = autoPushDSClosedLoop;
635 public static String getAutoPushDSFirewall() {
636 return autoPushDSFirewall;
639 public static void setAutoPushDSFirewall(String autoPushDSFirewall) {
640 PolicyController.autoPushDSFirewall = autoPushDSFirewall;
643 public static String getAutoPushDSMicroservice() {
644 return autoPushDSMicroservice;
647 public static void setAutoPushDSMicroservice(String autoPushDSMicroservice) {
648 PolicyController.autoPushDSMicroservice = autoPushDSMicroservice;
651 public static String getAutoPushPDPGroup() {
652 return autoPushPDPGroup;
655 public static void setAutoPushPDPGroup(String autoPushPDPGroup) {
656 PolicyController.autoPushPDPGroup = autoPushPDPGroup;
659 public static String getPapUrl() {
663 public static void setPapUrl(String papUrl) {
664 PolicyController.papUrl = papUrl;
667 public static String getMsOnapName() {
671 public static void setMsOnapName(String msOnapName) {
672 PolicyController.msOnapName = msOnapName;
675 public static String getMsPolicyName() {
679 public static void setMsPolicyName(String msPolicyName) {
680 PolicyController.msPolicyName = msPolicyName;
683 public static String getConfigHome() {
687 public static void setConfigHome(String configHome) {
688 PolicyController.configHome = configHome;
691 public static String getActionHome() {
695 public static void setActionHome(String actionHome) {
696 PolicyController.actionHome = actionHome;
699 public static Object getMapaccess() {
703 public static String getPolicydata() {
707 public static String getCharacterencoding() {
708 return characterEncoding;
711 public static String getContenttype() {
715 public static String getFile() {
719 public String convertDate(String dateTTL) {
720 String formateDate = null;
721 if(dateTTL.contains("-")){
722 formateDate = dateTTL.replace("-", "/");