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;
148 private static long fileSizeLimit;
150 private static boolean jUnit = false;
153 public static boolean isjUnit() {
157 public static void setjUnit(boolean jUnit) {
158 PolicyController.jUnit = jUnit;
162 private PolicyController(CommonClassDao commonClassDao){
163 PolicyController.commonClassDao = commonClassDao;
166 public PolicyController() {
171 Properties prop = new Properties();
172 InputStream input = null;
175 File file = new File(new File(".").getCanonicalPath() + File.separator + "src"+ File.separator + "test" + File.separator + "resources" + File.separator + "JSONConfig.json");
176 input = new FileInputStream(file);
178 input = new FileInputStream("xacml.admin.properties");
180 // load a properties file
182 //file upload size limit property
183 setFileSizeLimit(prop.getProperty("file.size.limit"));
185 setPapUrl(prop.getProperty("xacml.rest.pap.url"));
186 // get the property values
187 setSmtpHost(prop.getProperty("onap.smtp.host"));
188 setSmtpPort(prop.getProperty("onap.smtp.port"));
189 setSmtpUsername(prop.getProperty("onap.smtp.userName"));
190 setSmtpPassword(prop.getProperty("onap.smtp.password"));
191 setSmtpApplicationName(prop.getProperty("onap.application.name"));
192 setSmtpEmailExtension(prop.getProperty("onap.smtp.emailExtension"));
193 //Log Database Properties
194 setLogdbDriver(prop.getProperty("xacml.log.db.driver"));
195 setLogdbUrl(prop.getProperty("xacml.log.db.url"));
196 setLogdbUserName(prop.getProperty("xacml.log.db.user"));
197 setLogdbPassword(prop.getProperty("xacml.log.db.password"));
198 setLogdbDialect(prop.getProperty("onap.dialect"));
199 //Xacml Database Properties
200 setXacmldbUrl(prop.getProperty("javax.persistence.jdbc.url"));
201 setXacmldbUserName(prop.getProperty("javax.persistence.jdbc.user"));
202 setXacmldbPassword(prop.getProperty("javax.persistence.jdbc.password"));
204 setAutoPushAvailable(prop.getProperty("xacml.automatic.push"));
205 setAutoPushDSClosedLoop(prop.getProperty("xacml.autopush.closedloop"));
206 setAutoPushDSFirewall(prop.getProperty("xacml.autopush.firewall"));
207 setAutoPushDSMicroservice(prop.getProperty("xacml.autopush.microservice"));
208 setAutoPushPDPGroup(prop.getProperty("xacml.autopush.pdpGroup"));
209 //Micro Service Properties
210 setMsOnapName(prop.getProperty("xacml.policy.msOnapName"));
211 if(getMsOnapName() == null){
212 setMsOnapName(prop.getProperty("xacml.policy.msEcompName"));
214 policyLogger.info("getMsOnapName => " + getMsOnapName());
215 setMsPolicyName(prop.getProperty("xacml.policy.msPolicyName"));
216 policyLogger.info("setMsPolicyName => " + getMsPolicyName());
218 setConfigHome(prop.getProperty("xacml.rest.config.webapps") + "Config");
219 setActionHome(prop.getProperty("xacml.rest.config.webapps") + "Action");
220 //Get the Property Values for Dashboard tab Limit
222 setLogTableLimit(prop.getProperty("xacml.onap.dashboard.logTableLimit"));
223 setSystemAlertTableLimit(prop.getProperty("xacml.onap.dashboard.systemAlertTableLimit"));
225 policyLogger.error(XACMLErrorConstants.ERROR_DATA_ISSUE+"Dashboard tab Property fields are missing" +e);
226 setLogTableLimit("5000");
227 setSystemAlertTableLimit("2000");
229 System.setProperty(XACMLProperties.XACML_PROPERTIES_NAME, "xacml.admin.properties");
230 } catch (IOException ex) {
231 policyLogger.error(XACMLErrorConstants.ERROR_DATA_ISSUE+"Exception Occured while reading the Smtp properties from xacml.admin.properties file" +ex);
236 } catch (IOException e) {
237 policyLogger.error(XACMLErrorConstants.ERROR_DATA_ISSUE+"Exception Occured while Closing the xacml.admin.properties file" +e);
242 //Initialize the FunctionDefinition table at Server Start up
243 Map<Datatype, List<FunctionDefinition>> functionMap = getFunctionDatatypeMap();
244 for (Datatype id : functionMap.keySet()) {
245 List<FunctionDefinition> functionDefinations = functionMap.get(id);
246 for (FunctionDefinition functionDef : functionDefinations) {
247 dropDownMap.put(functionDef.getShortname(),functionDef.getXacmlid());
253 public static Map<Datatype, List<FunctionDefinition>> getFunctionDatatypeMap() {
254 synchronized(mapAccess) {
255 if (mapDatatype2Function == null) {
259 return mapDatatype2Function;
262 public static Map<String, FunctionDefinition> getFunctionIDMap() {
263 synchronized(mapAccess) {
264 if (mapID2Function == null) {
268 return mapID2Function;
271 private static void buildFunctionMaps() {
272 mapDatatype2Function = new HashMap<>();
273 mapID2Function = new HashMap<>();
274 List<Object> functiondefinitions = commonClassDao.getData(FunctionDefinition.class);
275 for (int i = 0; i < functiondefinitions.size(); i ++) {
276 FunctionDefinition value = (FunctionDefinition) functiondefinitions.get(i);
277 mapID2Function.put(value.getXacmlid(), value);
278 if (!mapDatatype2Function.containsKey(value.getDatatypeBean())) {
279 mapDatatype2Function.put(value.getDatatypeBean(), new ArrayList<FunctionDefinition>());
281 mapDatatype2Function.get(value.getDatatypeBean()).add(value);
285 @RequestMapping(value={"/get_FunctionDefinitionDataByName"}, method={org.springframework.web.bind.annotation.RequestMethod.GET} , produces=MediaType.APPLICATION_JSON_VALUE)
286 public void getFunctionDefinitionData(HttpServletRequest request, HttpServletResponse response){
288 Map<String, Object> model = new HashMap<>();
289 ObjectMapper mapper = new ObjectMapper();
290 model.put("functionDefinitionDatas", mapper.writeValueAsString(commonClassDao.getDataByColumn(FunctionDefinition.class, "shortname")));
291 JsonMessage msg = new JsonMessage(mapper.writeValueAsString(model));
292 JSONObject j = new JSONObject(msg);
293 response.getWriter().write(j.toString());
296 policyLogger.error(XACMLErrorConstants.ERROR_DATA_ISSUE +"Error while retriving the Function Definition data"+e);
300 public PolicyEntity getPolicyEntityData(String scope, String policyName){
301 String key = scope + ":" + policyName;
302 List<Object> data = commonClassDao.getDataById(PolicyEntity.class, "scope:policyName", key);
303 return (PolicyEntity) data.get(0);
306 public static Map<String, Roles> getUserRoles(String userId) {
307 Map<String, Roles> scopes = new HashMap<>();
308 List<Object> roles = commonClassDao.getDataById(Roles.class, "loginId", userId);
309 if (roles != null && !roles.isEmpty()) {
310 for (Object role : roles) {
311 scopes.put(((Roles) role).getScope(), (Roles) role);
317 public List<String> getRolesOfUser(String userId) {
318 List<String> rolesList = new ArrayList<>();
319 List<Object> roles = commonClassDao.getDataById(Roles.class, "loginId", userId);
320 for (Object role: roles) {
321 rolesList.add(((Roles) role).getRole());
326 public List<Object> getRoles(String userId) {
327 return commonClassDao.getDataById(Roles.class, "loginId", userId);
330 //Get List of User Roles
331 @RequestMapping(value={"/get_UserRolesData"}, method={org.springframework.web.bind.annotation.RequestMethod.GET} , produces=MediaType.APPLICATION_JSON_VALUE)
332 public void getUserRolesEntityData(HttpServletRequest request, HttpServletResponse response){
334 String userId = UserUtils.getUserSession(request).getOrgUserId();
335 Map<String, Object> model = new HashMap<>();
336 ObjectMapper mapper = new ObjectMapper();
337 model.put("userRolesDatas", mapper.writeValueAsString(getRolesOfUser(userId)));
338 JsonMessage msg = new JsonMessage(mapper.writeValueAsString(model));
339 JSONObject j = new JSONObject(msg);
340 response.getWriter().write(j.toString());
343 policyLogger.error("Exception Occured"+e);
347 //Policy tabs Model and View
348 @RequestMapping(value= {"/policy", "/policy/Editor" } , method = RequestMethod.GET)
349 public ModelAndView view(HttpServletRequest request){
350 String myRequestURL = request.getRequestURL().toString();
353 // Set the URL for the RESTful PAP Engine
355 setPapEngine((PAPPolicyEngine) new RESTfulPAPEngine(myRequestURL));
356 new PDPGroupContainer((PAPPolicyEngine) new RESTfulPAPEngine(myRequestURL));
357 } catch (Exception e) {
358 policyLogger.error(XACMLErrorConstants.ERROR_SYSTEM_ERROR+"Exception Occured while loading PAP"+e);
360 Map<String, Object> model = new HashMap<>();
361 return new ModelAndView("policy_Editor","model", model);
364 public PAPPolicyEngine getPapEngine() {
368 public static void setPapEngine(PAPPolicyEngine papEngine) {
369 PolicyController.papEngine = papEngine;
372 public String getUserName(String createdBy) {
373 String loginId = createdBy;
374 List<Object> data = commonClassDao.getDataById(UserInfo.class, "loginId", loginId);
375 return data.get(0).toString();
378 public static boolean getActivePolicy(String query) {
379 if(!commonClassDao.getDataByQuery(query, new SimpleBindings()).isEmpty()){
386 public void executeQuery(String query) {
387 commonClassDao.updateQuery(query);
390 public void saveData(Object cloneEntity) {
391 commonClassDao.save(cloneEntity);
394 public void updateData(Object entity) {
395 commonClassDao.update(entity);
398 public void deleteData(Object entity) {
399 commonClassDao.delete(entity);
402 public List<Object> getData(@SuppressWarnings("rawtypes") Class className){
403 return commonClassDao.getData(className);
406 public PolicyVersion getPolicyEntityFromPolicyVersion(String query){
407 return (PolicyVersion) commonClassDao.getEntityItem(PolicyVersion.class, "policyName", query);
410 public List<Object> getDataByQuery(String query, SimpleBindings params){
411 return commonClassDao.getDataByQuery(query, params);
415 @SuppressWarnings("rawtypes")
416 public Object getEntityItem(Class className, String columname, String key){
417 return commonClassDao.getEntityItem(className, columname, key);
421 public void watchPolicyFunction(PolicyVersion entity, String policyName, String mode){
422 PolicyNotificationMail email = new PolicyNotificationMail();
424 email.sendMail(entity, policyName, mode, commonClassDao);
425 } catch (MessagingException e) {
426 policyLogger.error(XACMLErrorConstants.ERROR_SYSTEM_ERROR + "Excepton Occured while Renaming/Deleting a Policy or Scope" + e);
431 public JSONObject switchVersionPolicyContent(String policyName) {
432 String dbCheckName = policyName.replace("/", ".");
433 if(dbCheckName.contains("Config_")){
434 dbCheckName = dbCheckName.replace(".Config_", ":Config_");
435 }else if(dbCheckName.contains("Action_")){
436 dbCheckName = dbCheckName.replace(".Action_", ":Action_");
437 }else if(dbCheckName.contains("Decision_")){
438 dbCheckName = dbCheckName.replace(".Decision_", ":Decision_");
440 String[] splitDBCheckName = dbCheckName.split(":");
441 String query = "FROM PolicyEntity where policyName like :splitDBCheckName1 and scope = :splitDBCheckName0";
442 SimpleBindings params = new SimpleBindings();
443 params.put("splitDBCheckName1", splitDBCheckName[1] + "%");
444 params.put("splitDBCheckName0", splitDBCheckName[0]);
445 List<Object> policyEntity = commonClassDao.getDataByQuery(query, params);
446 List<String> av = new ArrayList<>();
447 for(Object entity : policyEntity){
448 PolicyEntity pEntity = (PolicyEntity) entity;
449 String removeExtension = pEntity.getPolicyName().replace(".xml", "");
450 String version = removeExtension.substring(removeExtension.lastIndexOf(".")+1);
453 if(policyName.contains("/")){
454 policyName = policyName.replace("/", File.separator);
456 PolicyVersion entity = (PolicyVersion) commonClassDao.getEntityItem(PolicyVersion.class, "policyName", policyName);
457 JSONObject el = new JSONObject();
458 el.put("activeVersion", entity.getActiveVersion());
459 el.put("availableVersions", av);
460 el.put("highestVersion", entity.getHigherVersion());
464 public static String getLogTableLimit() {
465 return logTableLimit;
468 public static void setLogTableLimit(String logTableLimit) {
469 PolicyController.logTableLimit = logTableLimit;
472 public static String getSystemAlertTableLimit() {
473 return systemAlertTableLimit;
476 public static void setSystemAlertTableLimit(String systemAlertTableLimit) {
477 PolicyController.systemAlertTableLimit = systemAlertTableLimit;
480 public static CommonClassDao getCommonClassDao() {
481 return commonClassDao;
484 public static void setCommonClassDao(CommonClassDao commonClassDao) {
485 PolicyController.commonClassDao = commonClassDao;
488 public XacmlAdminAuthorization getAuthorizer() {
492 public void setAuthorizer(XacmlAdminAuthorization authorizer) {
493 this.authorizer = authorizer;
496 public static Map<Datatype, List<FunctionDefinition>> getMapDatatype2Function() {
497 return mapDatatype2Function;
500 public static void setMapDatatype2Function(Map<Datatype, List<FunctionDefinition>> mapDatatype2Function) {
501 PolicyController.mapDatatype2Function = mapDatatype2Function;
504 public static Map<String, FunctionDefinition> getMapID2Function() {
505 return mapID2Function;
508 public static void setMapID2Function(Map<String, FunctionDefinition> mapID2Function) {
509 PolicyController.mapID2Function = mapID2Function;
512 public static String getSmtpHost() {
516 public static void setSmtpHost(String smtpHost) {
517 PolicyController.smtpHost = smtpHost;
520 public static String getSmtpPort() {
524 public static void setSmtpPort(String smtpPort) {
525 PolicyController.smtpPort = smtpPort;
528 public static String getSmtpUsername() {
532 public static void setSmtpUsername(String smtpUsername) {
533 PolicyController.smtpUsername = smtpUsername;
536 public static String getSmtpPassword() {
540 public static void setSmtpPassword(String smtpPassword) {
541 PolicyController.smtpPassword = smtpPassword;
544 public static String getSmtpApplicationName() {
545 return smtpApplicationName;
548 public static void setSmtpApplicationName(String smtpApplicationName) {
549 PolicyController.smtpApplicationName = smtpApplicationName;
552 public static String getSmtpEmailExtension() {
553 return smtpEmailExtension;
556 public static void setSmtpEmailExtension(String smtpEmailExtension) {
557 PolicyController.smtpEmailExtension = smtpEmailExtension;
560 public static String getLogdbDriver() {
564 public static void setLogdbDriver(String logdbDriver) {
565 PolicyController.logdbDriver = logdbDriver;
568 public static String getLogdbUrl() {
572 public static void setLogdbUrl(String logdbUrl) {
573 PolicyController.logdbUrl = logdbUrl;
576 public static String getLogdbUserName() {
577 return logdbUserName;
580 public static void setLogdbUserName(String logdbUserName) {
581 PolicyController.logdbUserName = logdbUserName;
584 public static String getLogdbPassword() {
585 return logdbPassword;
588 public static void setLogdbPassword(String logdbPassword) {
589 PolicyController.logdbPassword = logdbPassword;
592 public static String getLogdbDialect() {
596 public static void setLogdbDialect(String logdbDialect) {
597 PolicyController.logdbDialect = logdbDialect;
600 public static String getXacmldbUrl() {
604 public static void setXacmldbUrl(String xacmldbUrl) {
605 PolicyController.xacmldbUrl = xacmldbUrl;
608 public static String getXacmldbUserName() {
609 return xacmldbUserName;
612 public static void setXacmldbUserName(String xacmldbUserName) {
613 PolicyController.xacmldbUserName = xacmldbUserName;
616 public static String getXacmldbPassword() {
617 return xacmldbPassword;
620 public static void setXacmldbPassword(String xacmldbPassword) {
621 PolicyController.xacmldbPassword = xacmldbPassword;
624 public static String getAutoPushAvailable() {
625 return autoPushAvailable;
628 public static void setAutoPushAvailable(String autoPushAvailable) {
629 PolicyController.autoPushAvailable = autoPushAvailable;
632 public static String getAutoPushDSClosedLoop() {
633 return autoPushDSClosedLoop;
636 public static void setAutoPushDSClosedLoop(String autoPushDSClosedLoop) {
637 PolicyController.autoPushDSClosedLoop = autoPushDSClosedLoop;
640 public static String getAutoPushDSFirewall() {
641 return autoPushDSFirewall;
644 public static void setAutoPushDSFirewall(String autoPushDSFirewall) {
645 PolicyController.autoPushDSFirewall = autoPushDSFirewall;
648 public static String getAutoPushDSMicroservice() {
649 return autoPushDSMicroservice;
652 public static void setAutoPushDSMicroservice(String autoPushDSMicroservice) {
653 PolicyController.autoPushDSMicroservice = autoPushDSMicroservice;
656 public static String getAutoPushPDPGroup() {
657 return autoPushPDPGroup;
660 public static void setAutoPushPDPGroup(String autoPushPDPGroup) {
661 PolicyController.autoPushPDPGroup = autoPushPDPGroup;
664 public static String getPapUrl() {
668 public static void setPapUrl(String papUrl) {
669 PolicyController.papUrl = papUrl;
672 public static String getMsOnapName() {
676 public static void setMsOnapName(String msOnapName) {
677 PolicyController.msOnapName = msOnapName;
680 public static String getMsPolicyName() {
684 public static void setMsPolicyName(String msPolicyName) {
685 PolicyController.msPolicyName = msPolicyName;
688 public static String getConfigHome() {
692 public static void setConfigHome(String configHome) {
693 PolicyController.configHome = configHome;
696 public static String getActionHome() {
700 public static void setActionHome(String actionHome) {
701 PolicyController.actionHome = actionHome;
704 public static Object getMapaccess() {
708 public static String getPolicydata() {
712 public static String getCharacterencoding() {
713 return characterEncoding;
716 public static String getContenttype() {
720 public static String getFile() {
724 public static void setFileSizeLimit(String uploadSize) {
725 //Default size limit is 30MB
726 if (uploadSize == null || uploadSize.isEmpty()) {
727 fileSizeLimit = 30000000;
730 fileSizeLimit = Long.parseLong(uploadSize);
734 public static long getFileSizeLimit() {
735 return fileSizeLimit;
737 public String convertDate(String dateTTL) {
738 String formateDate = null;
739 if(dateTTL.contains("-")){
740 formateDate = dateTTL.replace("-", "/");