ONAP-PAP-REST/src/main/java/org/onap/policy/pap/xacml/rest/XACMLPapServlet.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP-PAP-REST
   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
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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=========================================================
  19  */
  20
  21 package org.onap.policy.pap.xacml.rest;
  22
  23 import java.io.File;
  24 import java.io.FileInputStream;
  25 import java.io.IOException;
  26 import java.io.InputStream;
  27 import java.io.OutputStream;
  28 import java.io.UnsupportedEncodingException;
  29 import java.net.ConnectException;
  30 import java.net.HttpURLConnection;
  31 import java.net.InetAddress;
  32 import java.net.MalformedURLException;
  33 import java.net.SocketTimeoutException;
  34 import java.net.URL;
  35 import java.net.URLDecoder;
  36 import java.net.UnknownHostException;
  37 import java.nio.file.Files;
  38 import java.nio.file.Path;
  39 import java.nio.file.Paths;
  40 import java.util.ArrayList;
  41 import java.util.HashMap;
  42 import java.util.HashSet;
  43 import java.util.Iterator;
  44 import java.util.List;
  45 import java.util.Properties;
  46 import java.util.Scanner;
  47 import java.util.Set;
  48 import java.util.UUID;
  49 import java.util.concurrent.CopyOnWriteArrayList;
  50
  51 import javax.persistence.EntityManagerFactory;
  52 import javax.persistence.Persistence;
  53 import javax.persistence.PersistenceException;
  54 import javax.servlet.Servlet;
  55 import javax.servlet.ServletConfig;
  56 import javax.servlet.ServletException;
  57 import javax.servlet.annotation.WebInitParam;
  58 import javax.servlet.annotation.WebServlet;
  59 import javax.servlet.http.HttpServlet;
  60 import javax.servlet.http.HttpServletRequest;
  61 import javax.servlet.http.HttpServletResponse;
  62
  63 import org.apache.commons.io.IOUtils;
  64 import org.onap.policy.common.ia.IntegrityAudit;
  65 import org.onap.policy.common.im.AdministrativeStateException;
  66 import org.onap.policy.common.im.ForwardProgressException;
  67 import org.onap.policy.common.im.IntegrityMonitor;
  68 import org.onap.policy.common.im.IntegrityMonitorProperties;
  69 import org.onap.policy.common.im.StandbyStatusException;
  70 import org.onap.policy.common.logging.ONAPLoggingContext;
  71 import org.onap.policy.common.logging.ONAPLoggingUtils;
  72 import org.onap.policy.common.logging.eelf.MessageCodes;
  73 import org.onap.policy.common.logging.eelf.PolicyLogger;
  74 import org.onap.policy.common.logging.flexlogger.FlexLogger;
  75 import org.onap.policy.common.logging.flexlogger.Logger;
  76 import org.onap.policy.pap.xacml.rest.components.PolicyDBDao;
  77 import org.onap.policy.pap.xacml.rest.components.PolicyDBDaoTransaction;
  78 import org.onap.policy.pap.xacml.rest.handler.APIRequestHandler;
  79 import org.onap.policy.pap.xacml.rest.handler.PushPolicyHandler;
  80 import org.onap.policy.pap.xacml.rest.handler.SavePolicyHandler;
  81 import org.onap.policy.pap.xacml.restAuth.CheckPDP;
  82 import org.onap.policy.rest.XACMLRest;
  83 import org.onap.policy.rest.XACMLRestProperties;
  84 import org.onap.policy.rest.dao.PolicyDBException;
  85 import org.onap.policy.utils.PolicyUtils;
  86 import org.onap.policy.xacml.api.XACMLErrorConstants;
  87 import org.onap.policy.xacml.api.pap.ONAPPapEngineFactory;
  88 import org.onap.policy.xacml.api.pap.OnapPDP;
  89 import org.onap.policy.xacml.api.pap.OnapPDPGroup;
  90 import org.onap.policy.xacml.api.pap.PAPPolicyEngine;
  91 import org.onap.policy.xacml.std.pap.StdPAPPolicy;
  92 import org.onap.policy.xacml.std.pap.StdPDP;
  93 import org.onap.policy.xacml.std.pap.StdPDPGroup;
  94 import org.onap.policy.xacml.std.pap.StdPDPItemSetChangeNotifier.StdItemSetChangeListener;
  95 import org.onap.policy.xacml.std.pap.StdPDPPolicy;
  96 import org.onap.policy.xacml.std.pap.StdPDPStatus;
  97
  98 import com.att.research.xacml.api.pap.PAPException;
  99 import com.att.research.xacml.api.pap.PDPPolicy;
 100 import com.att.research.xacml.api.pap.PDPStatus;
 101 import com.att.research.xacml.util.FactoryException;
 102 import com.att.research.xacml.util.XACMLProperties;
 103 import com.fasterxml.jackson.databind.ObjectMapper;
 104 import com.google.common.base.Splitter;
 105
 106 /**
 107  * Servlet implementation class XacmlPapServlet
 108  */
 109 @WebServlet(
 110                 description = "Implements the XACML PAP RESTful API.",
 111                 urlPatterns = { "/" },
 112                 loadOnStartup=1,
 113                 initParams = {
 114                         @WebInitParam(name = "XACML_PROPERTIES_NAME", value = "xacml.pap.properties", description = "The location of the properties file holding configuration information.")
 115                 })
 116 public class XACMLPapServlet extends HttpServlet implements StdItemSetChangeListener, Runnable {
 117         private static final long serialVersionUID = 1L;
 118         private static final Logger LOGGER      = FlexLogger.getLogger(XACMLPapServlet.class);
 119         // audit (transaction) LOGGER
 120         private static final Logger auditLogger = FlexLogger.getLogger("auditLogger");
 121         //Persistence Unit for JPA
 122         private static final String PERSISTENCE_UNIT = "XACML-PAP-REST";
 123         private static final String AUDIT_PAP_PERSISTENCE_UNIT = "auditPapPU";
 124         // Client Headers.
 125         private static final String ENVIRONMENT_HEADER = "Environment";
 126         /*
 127          * List of Admin Console URLs.
 128          * Used to send notifications when configuration changes.
 129          *
 130          * The CopyOnWriteArrayList *should* protect from concurrency errors.
 131          * This list is seldom changed but often read, so the costs of this approach make sense.
 132          */
 133         private static final CopyOnWriteArrayList<String> adminConsoleURLStringList = new CopyOnWriteArrayList<>();
 134
 135         private static String configHome;
 136         private static String actionHome;
 137         /*
 138          * This PAP instance's own URL.
 139          * Need this when creating URLs to send to the PDPs so they can GET the Policy files from this process.
 140          */
 141         private static String papURL = null;
 142         // The heartbeat thread.
 143         private static Heartbeat heartbeat = null;
 144         private static Thread heartbeatThread = null;
 145         //The entity manager factory for JPA access
 146         private static EntityManagerFactory emf;
 147         private static PolicyDBDao policyDBDao;
 148         /*
 149          * papEngine - This is our engine workhorse that manages the PDP Groups and Nodes.
 150          */
 151         private static PAPPolicyEngine papEngine = null;
 152         /*
 153          * These are the parameters needed for DB access from the PAP
 154          */
 155         private static int papIntegrityAuditPeriodSeconds = -1;
 156         private static String papDbDriver = null;
 157         private static String papDbUrl = null;
 158         private static String papDbUser = null;
 159         private static String papDbPassword = null;
 160         private static String papResourceName = null;
 161         private static String[] papDependencyGroupsFlatArray = null;
 162         private static String environment = null;
 163         private static String pdpFile = null;
 164
 165         private transient IntegrityMonitor im;
 166         private transient IntegrityAudit ia;
 167
 168         //MicroService Model Properties
 169         private static String msOnapName;
 170         private static String msPolicyName;
 171         /*
 172          * This thread may be invoked upon startup to initiate sending PDP policy/pip configuration when
 173          * this servlet starts. Its configurable by the admin.
 174          */
 175         private static transient Thread initiateThread = null;
 176         private transient ONAPLoggingContext baseLoggingContext = null;
 177
 178         /**
 179          * @see HttpServlet#HttpServlet()
 180          */
 181         public XACMLPapServlet() {
 182                 super();
 183         }
 184
 185         /**
 186          * @see Servlet#init(ServletConfig)
 187          */
 188         public void init(ServletConfig config) throws ServletException {
 189                 try {
 190                         // Logging
 191                         baseLoggingContext = new ONAPLoggingContext();
 192                         // fixed data that will be the same in all logging output goes here
 193                         try {
 194                                 String hostname = InetAddress.getLocalHost().getCanonicalHostName();
 195                                 baseLoggingContext.setServer(hostname);
 196                         } catch (UnknownHostException e) {
 197                                 LOGGER.warn(XACMLErrorConstants.ERROR_SYSTEM_ERROR + "Unable to get hostname for logging", e);
 198                         }
 199                         // Initialize
 200                         XACMLRest.xacmlInit(config);
 201                         // Load the properties
 202                         XACMLRest.loadXacmlProperties(null, null);
 203                         /*
 204                          * Retrieve the property values
 205                          */
 206                         setCommonProperties();
 207                         String papSiteName = XACMLProperties.getProperty(XACMLRestProperties.PAP_SITE_NAME);
 208                         if(papSiteName == null){
 209                                 PolicyLogger.error(MessageCodes.ERROR_DATA_ISSUE,"XACMLPapServlet", " ERROR: Bad papSiteName property entry");
 210                                 throw new PAPException("papSiteName is null");
 211                         }
 212                         String papNodeType = XACMLProperties.getProperty(XACMLRestProperties.PAP_NODE_TYPE);
 213                         if(papNodeType == null){
 214                                 PolicyLogger.error(MessageCodes.ERROR_DATA_ISSUE,"XACMLPapServlet", " ERROR: Bad papNodeType property entry");
 215                                 throw new PAPException("papNodeType is null");
 216                         }
 217                         //Integer will throw an exception of anything is missing or unrecognized
 218                         int papTransWait = Integer.parseInt(XACMLProperties.getProperty(XACMLRestProperties.PROP_PAP_TRANS_WAIT));
 219                         int papTransTimeout = Integer.parseInt(XACMLProperties.getProperty(XACMLRestProperties.PROP_PAP_TRANS_TIMEOUT));
 220                         int papAuditTimeout = Integer.parseInt(XACMLProperties.getProperty(XACMLRestProperties.PROP_PAP_AUDIT_TIMEOUT));
 221                         //Boolean will default to false if anything is missing or unrecognized
 222                         boolean papAuditFlag = Boolean.parseBoolean(XACMLProperties.getProperty(XACMLRestProperties.PROP_PAP_RUN_AUDIT_FLAG));
 223                         boolean papFileSystemAudit = Boolean.parseBoolean(XACMLProperties.getProperty(XACMLRestProperties.PROP_PAP_AUDIT_FLAG));
 224                         String papDependencyGroups = XACMLProperties.getProperty(XACMLRestProperties.PAP_DEPENDENCY_GROUPS);
 225                         if(papDependencyGroups == null){
 226                                 throw new PAPException("papDependencyGroups is null");
 227                         }
 228                         setPAPDependencyGroups(papDependencyGroups);
 229                         //Integer will throw an exception of anything is missing or unrecognized
 230                         int fpMonitorInterval = Integer.parseInt(XACMLProperties.getProperty(IntegrityMonitorProperties.FP_MONITOR_INTERVAL));
 231                         int failedCounterThreshold = Integer.parseInt(XACMLProperties.getProperty(IntegrityMonitorProperties.FAILED_COUNTER_THRESHOLD));
 232                         int testTransInterval = Integer.parseInt(XACMLProperties.getProperty(IntegrityMonitorProperties.TEST_TRANS_INTERVAL));
 233                         int writeFpcInterval = Integer.parseInt(XACMLProperties.getProperty(IntegrityMonitorProperties.WRITE_FPC_INTERVAL));
 234                         LOGGER.debug("\n\n\n**************************************"
 235                                         + "\n*************************************"
 236                                         + "\n"
 237                                         + "\n   papDbDriver = " + papDbDriver
 238                                         + "\n   papDbUrl = " + papDbUrl
 239                                         + "\n   papDbUser = " + papDbUser
 240                                         + "\n   papDbPassword = " + papDbPassword
 241                                         + "\n   papTransWait = " + papTransWait
 242                                         + "\n   papTransTimeout = " + papTransTimeout
 243                                         + "\n   papAuditTimeout = " + papAuditTimeout
 244                                         + "\n   papAuditFlag = " + papAuditFlag
 245                                         + "\n   papFileSystemAudit = " + papFileSystemAudit
 246                                         + "\n   papResourceName = " + papResourceName
 247                                         + "\n   fpMonitorInterval = " + fpMonitorInterval
 248                                         + "\n   failedCounterThreshold = " + failedCounterThreshold
 249                                         + "\n   testTransInterval = " + testTransInterval
 250                                         + "\n   writeFpcInterval = " + writeFpcInterval
 251                                         + "\n   papSiteName = " + papSiteName
 252                                         + "\n   papNodeType = " + papNodeType
 253                                         + "\n   papDependencyGroupsList = " + papDependencyGroups
 254                                         + "\n   papIntegrityAuditPeriodSeconds = " + papIntegrityAuditPeriodSeconds
 255                                         + "\n\n*************************************"
 256                                         + "\n**************************************");
 257                         // Pull custom persistence settings
 258                         Properties properties;
 259                         try {
 260                                 properties = XACMLProperties.getProperties();
 261                                 LOGGER.debug("\n\n\n**************************************"
 262                                                 + "\n**************************************"
 263                                                 + "\n\n"
 264                                                 + "properties = " + properties
 265                                                 + "\n\n**************************************");
 266                         } catch (IOException e) {
 267                                 PolicyLogger.error(MessageCodes.ERROR_DATA_ISSUE, e, "XACMLPapServlet", " Error loading properties with: "
 268                                                 + "XACMLProperties.getProperties()");
 269                                 throw new ServletException(e.getMessage(), e.getCause());
 270                         }
 271                         // Create an IntegrityMonitor
 272                         im = IntegrityMonitor.getInstance(papResourceName,properties);
 273                         // Create an IntegrityAudit
 274                         ia = new IntegrityAudit(papResourceName, AUDIT_PAP_PERSISTENCE_UNIT, properties);
 275                         ia.startAuditThread();
 276                         // Create the entity manager factory
 277                         setEMF(properties);
 278                         // we are about to call the PDPs and give them their configuration.
 279                         // To do that we need to have the URL of this PAP so we can construct the Policy file URLs
 280                         setPAPURL(XACMLProperties.getProperty(XACMLRestProperties.PROP_PAP_URL));
 281                         //Create the policyDBDao
 282                         setPolicyDBDao();
 283                         // Load our PAP engine, first create a factory
 284                         ONAPPapEngineFactory factory = ONAPPapEngineFactory.newInstance(XACMLProperties.getProperty(XACMLProperties.PROP_PAP_PAPENGINEFACTORY));
 285                         // The factory knows how to go about creating a PAP Engine
 286                         setPAPEngine((PAPPolicyEngine) factory.newEngine());
 287                         PolicyDBDaoTransaction addNewGroup = null;
 288             if (((org.onap.policy.xacml.std.pap.StdEngine) papEngine).wasDefaultGroupJustAdded) {
 289                 try {
 290                     addNewGroup = policyDBDao.getNewTransaction();
 291                     OnapPDPGroup group = papEngine.getDefaultGroup();
 292                     addNewGroup.createGroup(group.getId(), group.getName(), group.getDescription(),
 293                             "automaticallyAdded");
 294                     addNewGroup.commitTransaction();
 295                     addNewGroup = policyDBDao.getNewTransaction();
 296                     addNewGroup.changeDefaultGroup(group, "automaticallyAdded");
 297                     addNewGroup.commitTransaction();
 298                 } catch (Exception e) {
 299                     PolicyLogger.error(MessageCodes.EXCEPTION_ERROR, e, "XACMLPapServlet",
 300                             " Error creating new default group in the database");
 301                     if (addNewGroup != null) {
 302                         addNewGroup.rollbackTransaction();
 303                     }
 304                 }
 305             }
 306                         policyDBDao.setPapEngine((PAPPolicyEngine) XACMLPapServlet.papEngine);
 307                 if (Boolean.parseBoolean(XACMLProperties.getProperty(XACMLRestProperties.PROP_PAP_RUN_AUDIT_FLAG))){
 308                         /*
 309                          * Auditing the local File System groups to be in sync with the Database
 310                          */
 311
 312                         //get an AuditTransaction to lock out all other transactions
 313                         PolicyDBDaoTransaction auditTrans = policyDBDao.getNewAuditTransaction();
 314
 315                         LOGGER.info("PapServlet: calling auditLocalFileSystem for PDP group audit");
 316                 LOGGER.info("PapServlet: old group is " + papEngine.getDefaultGroup().toString());
 317                         //get the current filesystem group and update from the database if needed
 318                 StdPDPGroup group = (StdPDPGroup) papEngine.getDefaultGroup();
 319                 StdPDPGroup updatedGroup = policyDBDao.auditLocalFileSystem(group);
 320                 if(updatedGroup!=null) {
 321                         papEngine.updateGroup(updatedGroup);
 322                 }
 323                 LOGGER.info("PapServlet:  updated group is " + papEngine.getDefaultGroup().toString());
 324
 325                         //release the transaction lock
 326                         auditTrans.close();
 327                 }
 328
 329                         // Sanity check for URL.
 330                         if (XACMLPapServlet.papURL == null) {
 331                                 throw new PAPException("The property " + XACMLRestProperties.PROP_PAP_URL + " is not valid: " + XACMLPapServlet.papURL);
 332                         }
 333                         // Configurable - have the PAP servlet initiate sending the latest PDP policy/pip configuration
 334                         // to all its known PDP nodes.
 335                         if (Boolean.parseBoolean(XACMLProperties.getProperty(XACMLRestProperties.PROP_PAP_INITIATE_PDP_CONFIG))) {
 336                             startInitiateThreadService(new Thread(this));
 337                         }
 338                         // After startup, the PAP does Heartbeat's to each of the PDPs periodically
 339                         startHeartBeatService(new Heartbeat((PAPPolicyEngine) XACMLPapServlet.papEngine));
 340
 341                 } catch (FactoryException | PAPException e) {
 342                         PolicyLogger.error(MessageCodes.ERROR_SYSTEM_ERROR, e, "XACMLPapServlet", " Failed to create engine");
 343                         throw new ServletException (XACMLErrorConstants.ERROR_SYSTEM_ERROR + "PAP not initialized; error: "+e);
 344                 } catch (Exception e) {
 345                         PolicyLogger.error(MessageCodes.ERROR_SYSTEM_ERROR, e, "XACMLPapServlet", " Failed to create engine - unexpected error");
 346                         throw new ServletException (XACMLErrorConstants.ERROR_SYSTEM_ERROR + "PAP not initialized; unexpected error: "+e);
 347                 }
 348         }
 349
 350         private static void startInitiateThreadService(Thread thread) {
 351             initiateThread = thread;
 352         initiateThread.start();
 353     }
 354
 355     private static void mapperWriteValue(ObjectMapper mapper,  HttpServletResponse response, Object value) {
 356         try {
 357             mapper.writeValue(response.getOutputStream(), value);
 358         } catch (Exception e) {
 359             LOGGER.error(e);
 360         }
 361     }
 362
 363     private static void startHeartBeatService(Heartbeat heartbeat) {
 364             XACMLPapServlet.heartbeat = heartbeat;
 365         XACMLPapServlet.heartbeatThread = new Thread(XACMLPapServlet.heartbeat);
 366         XACMLPapServlet.heartbeatThread.start();
 367     }
 368
 369     private static void setPolicyDBDao() throws ServletException {
 370             try {
 371             policyDBDao = PolicyDBDao.getPolicyDBDaoInstance(getEmf());
 372         } catch (Exception e) {
 373             throw new ServletException("Unable to Create Policy DBDao Instance",e);
 374         }
 375     }
 376
 377     private static void setEMF(Properties properties) throws ServletException {
 378             emf = Persistence.createEntityManagerFactory(PERSISTENCE_UNIT, properties);
 379         if (emf == null) {
 380             PolicyLogger.error(MessageCodes.ERROR_DATA_ISSUE + " Error creating entity manager factory with persistence unit: "
 381                     + PERSISTENCE_UNIT);
 382             throw new ServletException("Unable to create Entity Manager Factory");
 383         }
 384     }
 385
 386     private static void setPAPURL(String papURL) {
 387             XACMLPapServlet.papURL = papURL;
 388     }
 389
 390     private static void setPAPEngine(PAPPolicyEngine newEngine) {
 391             XACMLPapServlet.papEngine = newEngine;
 392     }
 393
 394     private static void setPAPDependencyGroups(String papDependencyGroups) throws PAPException {
 395             try{
 396             //Now we have flattened the array into a simple comma-separated list
 397             papDependencyGroupsFlatArray = papDependencyGroups.split("[;,]");
 398             //clean up the entries
 399             for (int i = 0 ; i < papDependencyGroupsFlatArray.length ; i ++){
 400                 papDependencyGroupsFlatArray[i] = papDependencyGroupsFlatArray[i].trim();
 401             }
 402             try{
 403                 if(XACMLProperties.getProperty(XACMLRestProperties.PAP_INTEGRITY_AUDIT_PERIOD_SECONDS) != null){
 404                     papIntegrityAuditPeriodSeconds = Integer.parseInt(XACMLProperties.getProperty(XACMLRestProperties.PAP_INTEGRITY_AUDIT_PERIOD_SECONDS).trim());
 405                 }
 406             }catch(Exception e){
 407                 String msg = "integrity_audit_period_seconds ";
 408                 LOGGER.error("\n\nERROR: " + msg + "Bad property entry: " + e.getMessage() + "\n");
 409                 PolicyLogger.error(MessageCodes.EXCEPTION_ERROR, e, "XACMLPapServlet", " ERROR: " + msg +"Bad property entry");
 410                 throw e;
 411             }
 412         }catch(Exception e){
 413             PolicyLogger.error(MessageCodes.EXCEPTION_ERROR, e, "XACMLPapServlet", " ERROR: Bad property entry");
 414             throw new PAPException(e);
 415         }
 416     }
 417
 418     private static void setCommonProperties() throws PAPException {
 419             setConfigHome();
 420         setActionHome();
 421         papDbDriver = XACMLProperties.getProperty(XACMLRestProperties.PROP_PAP_DB_DRIVER);
 422         if(papDbDriver == null){
 423             PolicyLogger.error(MessageCodes.ERROR_DATA_ISSUE,"XACMLPapServlet", " ERROR: Bad papDbDriver property entry");
 424             throw new PAPException("papDbDriver is null");
 425         }
 426         setPapDbDriver(papDbDriver);
 427         papDbUrl = XACMLProperties.getProperty(XACMLRestProperties.PROP_PAP_DB_URL);
 428         if(papDbUrl == null){
 429             PolicyLogger.error(MessageCodes.ERROR_DATA_ISSUE,"XACMLPapServlet", " ERROR: Bad papDbUrl property entry");
 430             throw new PAPException("papDbUrl is null");
 431         }
 432         setPapDbUrl(papDbUrl);
 433         papDbUser = XACMLProperties.getProperty(XACMLRestProperties.PROP_PAP_DB_USER);
 434         if(papDbUser == null){
 435             PolicyLogger.error(MessageCodes.ERROR_DATA_ISSUE,"XACMLPapServlet", " ERROR: Bad papDbUser property entry");
 436             throw new PAPException("papDbUser is null");
 437         }
 438         setPapDbUser(papDbUser);
 439         papDbPassword = XACMLProperties.getProperty(XACMLRestProperties.PROP_PAP_DB_PASSWORD);
 440         if(papDbPassword == null){
 441             PolicyLogger.error(MessageCodes.ERROR_DATA_ISSUE,"XACMLPapServlet", " ERROR: Bad papDbPassword property entry");
 442             throw new PAPException("papDbPassword is null");
 443         }
 444         setPapDbPassword(papDbPassword);
 445         papResourceName = XACMLProperties.getProperty(XACMLRestProperties.PAP_RESOURCE_NAME);
 446         if(papResourceName == null){
 447             PolicyLogger.error(MessageCodes.ERROR_DATA_ISSUE,"XACMLPapServlet", " ERROR: Bad papResourceName property entry");
 448             throw new PAPException("papResourceName is null");
 449         }
 450         environment = XACMLProperties.getProperty("ENVIRONMENT", "DEVL");
 451         //Micro Service Properties
 452         msOnapName=XACMLProperties.getProperty("xacml.policy.msOnapName");
 453         setMsOnapName(msOnapName);
 454         msPolicyName=XACMLProperties.getProperty("xacml.policy.msPolicyName");
 455         setMsPolicyName(msPolicyName);
 456         // PDPId File location
 457         XACMLPapServlet.pdpFile = XACMLProperties.getProperty(XACMLRestProperties.PROP_PDP_IDFILE);
 458         if (XACMLPapServlet.pdpFile == null) {
 459             PolicyLogger.error(MessageCodes.ERROR_DATA_ISSUE + " The PDP Id Authentication File Property is not valid: "
 460                 + XACMLRestProperties.PROP_PDP_IDFILE);
 461             throw new PAPException("The PDP Id Authentication File Property :"+ XACMLRestProperties.PROP_PDP_IDFILE+ " is not Valid. ");
 462         }
 463     }
 464
 465     /**
 466          * Thread used only during PAP startup to initiate change messages to all known PDPs.
 467          * This must be on a separate thread so that any GET requests from the PDPs during this update can be serviced.
 468          */
 469         @Override
 470         public void run() {
 471                 // send the current configuration to all the PDPs that we know about
 472                 changed();
 473         }
 474
 475         /**
 476          * @see Servlet#destroy()
 477          *
 478          * Depending on how this servlet is run, we may or may not care about cleaning up the resources.
 479          * For now we assume that we do care.
 480          */
 481         @Override
 482         public void destroy() {
 483                 // Make sure our threads are destroyed
 484                 if (XACMLPapServlet.heartbeatThread != null) {
 485                         // stop the heartbeat
 486                         try {
 487                                 if (XACMLPapServlet.heartbeat != null) {
 488                                         XACMLPapServlet.heartbeat.terminate();
 489                                 }
 490                                 XACMLPapServlet.heartbeatThread.interrupt();
 491                                 XACMLPapServlet.heartbeatThread.join();
 492                         } catch (InterruptedException e) {
 493                             XACMLPapServlet.heartbeatThread.interrupt();
 494                                 PolicyLogger.error(MessageCodes.ERROR_SYSTEM_ERROR, e, "XACMLPapServlet", " Error stopping heartbeat");
 495                         }
 496                 }
 497                 if (initiateThread != null) {
 498                         try {
 499                                 initiateThread.interrupt();
 500                                 initiateThread.join();
 501                         } catch (InterruptedException e) {
 502                             initiateThread.interrupt();
 503                                 PolicyLogger.error(MessageCodes.ERROR_SYSTEM_ERROR, e, "XACMLPapServlet", " Error stopping thread");
 504                         }
 505                 }
 506         }
 507
 508         /**
 509          * Called by:
 510          *      - PDP nodes to register themselves with the PAP, and
 511          *      - Admin Console to make changes in the PDP Groups.
 512          *
 513          * @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse response)
 514          */
 515         protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
 516                 ONAPLoggingContext loggingContext = ONAPLoggingUtils.getLoggingContextForRequest(request, baseLoggingContext);
 517                 loggingContext.transactionStarted();
 518                 loggingContext.setServiceName("PAP.post");
 519                 if ((loggingContext.getRequestID() == null) || (loggingContext.getRequestID() == "")){
 520                         UUID requestID = UUID.randomUUID();
 521                         loggingContext.setRequestID(requestID.toString());
 522                         PolicyLogger.info("requestID not provided in call to XACMLPapSrvlet (doPost) so we generated one");
 523                 } else {
 524                         PolicyLogger.info("requestID was provided in call to XACMLPapSrvlet (doPost)");
 525                 }
 526                 PolicyDBDaoTransaction pdpTransaction = null;
 527                 loggingContext.metricStarted();
 528                 try {
 529                         im.startTransaction();
 530                         loggingContext.metricEnded();
 531                         PolicyLogger.metrics("XACMLPapServlet doPost im startTransaction");
 532                 } catch (AdministrativeStateException ae){
 533                         String message = "POST interface called for PAP " + papResourceName + " but it has an Administrative"
 534                                         + " state of " + im.getStateManager().getAdminState()
 535                                         + "\n Exception Message: " + ae.getMessage();
 536                         LOGGER.error(MessageCodes.ERROR_SYSTEM_ERROR + " " + message, ae);
 537                         loggingContext.metricEnded();
 538                         PolicyLogger.metrics("XACMLPapServlet doPost im startTransaction");
 539                         loggingContext.transactionEnded();
 540                         PolicyLogger.audit("Transaction Failed - See Error.log");
 541                         setResponseError(response,HttpServletResponse.SC_INTERNAL_SERVER_ERROR, message);
 542                         return;
 543                 }catch (StandbyStatusException se) {
 544                         String message = "POST interface called for PAP " + papResourceName + " but it has a Standby Status"
 545                                         + " of " + im.getStateManager().getStandbyStatus()
 546                                         + "\n Exception Message: " + se.getMessage();
 547                         LOGGER.error(MessageCodes.ERROR_SYSTEM_ERROR + " " + message, se);
 548                         loggingContext.metricEnded();
 549                         PolicyLogger.metrics("XACMLPapServlet doPost im startTransaction");
 550                         loggingContext.transactionEnded();
 551                         PolicyLogger.audit("Transaction Failed - See Error.log");
 552                         setResponseError(response,HttpServletResponse.SC_INTERNAL_SERVER_ERROR, message);
 553                         return;
 554                 }
 555                 try {
 556                         loggingContext.metricStarted();
 557                         XACMLRest.dumpRequest(request);
 558                         loggingContext.metricEnded();
 559                         PolicyLogger.metrics("XACMLPapServlet doPost dumpRequest");
 560                         // since getParameter reads the content string, explicitly get the content before doing that.
 561                         // Simply getting the inputStream seems to protect it against being consumed by getParameter.
 562                         request.getInputStream();
 563                         String groupId = request.getParameter("groupId");
 564                         String apiflag = request.getParameter("apiflag");
 565                         if(groupId != null) {
 566                                 // Is this from the Admin Console or API?
 567                                 if(apiflag!=null && apiflag.equalsIgnoreCase("api")) {
 568                                         // this is from the API so we need to check the client credentials before processing the request
 569                                         if(!authorizeRequest(request)){
 570                                                 String message = "PEP not Authorized for making this Request!!";
 571                                                 PolicyLogger.error(MessageCodes.ERROR_PERMISSIONS + " " + message);
 572                                                 loggingContext.transactionEnded();
 573                                                 PolicyLogger.audit("Transaction Failed - See Error.log");
 574                                                 setResponseError(response,HttpServletResponse.SC_FORBIDDEN, message);
 575                                                 im.endTransaction();
 576                                                 return;
 577                                         }
 578                                 }
 579                                 loggingContext.metricStarted();
 580                                 doACPost(request, response, groupId, loggingContext);
 581                                 loggingContext.metricEnded();
 582                                 PolicyLogger.metrics("XACMLPapServlet doPost doACPost");
 583                                 loggingContext.transactionEnded();
 584                                 PolicyLogger.audit("Transaction Ended Successfully");
 585                                 im.endTransaction();
 586                                 return;
 587                         }
 588                         // Request is from a PDP asking for its config.
 589                         loggingContext.setServiceName("PDP:PAP.register");
 590                         // Get the PDP's ID
 591                         String id = this.getPDPID(request);
 592                         String jmxport = this.getPDPJMX(request);
 593                         LOGGER.info("Request(doPost) from PDP coming up: " + id);
 594                         // Get the PDP Object
 595                         OnapPDP pdp = XACMLPapServlet.papEngine.getPDP(id);
 596                         // Is it known?
 597                         if (pdp == null) {
 598                                 LOGGER.info("Unknown PDP: " + id);
 599                                 // Check PDP ID
 600                                 if(CheckPDP.validateID(id)){
 601                                         pdpTransaction = policyDBDao.getNewTransaction();
 602                                         try {
 603                                                 pdpTransaction.addPdpToGroup(id, XACMLPapServlet.papEngine.getDefaultGroup().getId(), id, "Registered on first startup", Integer.parseInt(jmxport), "PDP autoregister");
 604                                                 XACMLPapServlet.papEngine.newPDP(id, XACMLPapServlet.papEngine.getDefaultGroup(), id, "Registered on first startup", Integer.parseInt(jmxport));
 605                                         } catch (NullPointerException | PAPException | IllegalArgumentException | IllegalStateException | PersistenceException | PolicyDBException e) {
 606                                                 pdpTransaction.rollbackTransaction();
 607                                                 String message = "Failed to create new PDP for id: " + id;
 608                                                 PolicyLogger.error(MessageCodes.ERROR_PROCESS_FLOW, e, "XACMLPapServlet", " " + message);
 609                                                 loggingContext.transactionEnded();
 610                                                 PolicyLogger.audit("Transaction Failed - See Error.log");
 611                                                 setResponseError(response, HttpServletResponse.SC_INTERNAL_SERVER_ERROR, e.getMessage());
 612                                                 im.endTransaction();
 613                                                 return;
 614                                         }
 615                                         // get the PDP we just created
 616                             try{
 617                                 pdp = XACMLPapServlet.papEngine.getPDP(id);
 618                             }catch(PAPException e){
 619                                 LOGGER.error(e);
 620                             }
 621                                         if (pdp == null) {
 622                                                 if(pdpTransaction != null){
 623                                                         pdpTransaction.rollbackTransaction();
 624                                                 }
 625                                                 String message = "Failed to create new PDP for id: " + id;
 626                                                 PolicyLogger.error(MessageCodes.ERROR_PROCESS_FLOW + " " + message);
 627                                                 loggingContext.transactionEnded();
 628                                                 PolicyLogger.audit("Transaction Failed - See Error.log");
 629                                                 setResponseError(response, HttpServletResponse.SC_INTERNAL_SERVER_ERROR, message);
 630                                                 im.endTransaction();
 631                                                 return;
 632                                         }
 633                                 } else {
 634                                         String message = "PDP is Unauthorized to Connect to PAP: "+ id;
 635                                         loggingContext.transactionEnded();
 636                                         PolicyLogger.error(MessageCodes.ERROR_PERMISSIONS + " " + message);
 637                                         setResponseError(response, HttpServletResponse.SC_UNAUTHORIZED, "PDP not Authorized to connect to this PAP. Please contact the PAP Admin for registration.");
 638                                         PolicyLogger.audit("Transaction Failed - See Error.log");
 639                                         im.endTransaction();
 640                                         return;
 641                                 }
 642                                 try{
 643                                         loggingContext.metricStarted();
 644                                         pdpTransaction.commitTransaction();
 645                                         loggingContext.metricEnded();
 646                                         PolicyLogger.metrics("XACMLPapServlet doPost commitTransaction");
 647                                 } catch(Exception e){
 648                                         PolicyLogger.error(MessageCodes.ERROR_PROCESS_FLOW, e, "XACMLPapServlet", "Could not commit transaction to put pdp in the database");
 649                                 }
 650                         }
 651                         if (jmxport != null && jmxport != ""){
 652                             try{
 653                         ((StdPDP) pdp).setJmxPort(Integer.valueOf(jmxport));
 654                             }catch(NumberFormatException e){
 655                                 LOGGER.error(e);
 656                             }
 657                         }
 658                         // Get the PDP's Group
 659                         OnapPDPGroup group =null;
 660                         try{
 661                     group= XACMLPapServlet.papEngine.getPDPGroup((OnapPDP) pdp);
 662                         }catch(PAPException e){
 663                             LOGGER.error(e);
 664                         }
 665                         if (group == null) {
 666                                 PolicyLogger.error(MessageCodes.ERROR_PROCESS_FLOW + " PDP not associated with any group, even the default");
 667                                 loggingContext.transactionEnded();
 668                                 PolicyLogger.audit("Transaction Failed - See Error.log");
 669                                 setResponseError(response, HttpServletResponse.SC_UNAUTHORIZED, "PDP not associated with any group, even the default");
 670                                 im.endTransaction();
 671                                 return;
 672                         }
 673                         // Determine what group the PDP node is in and get
 674                         // its policy/pip properties.
 675                         Properties policies = group.getPolicyProperties();
 676                         Properties pipconfig = group.getPipConfigProperties();
 677                         // Get the current policy/pip configuration that the PDP has
 678                         Properties pdpProperties = new Properties();
 679                         try{
 680                     pdpProperties.load(request.getInputStream());
 681                         }catch(IOException e){
 682                             LOGGER.error(e);
 683                         }
 684                         LOGGER.info("PDP Current Properties: " + pdpProperties.toString());
 685                         LOGGER.info("Policies: " + (policies != null ? policies.toString() : "null"));
 686                         LOGGER.info("Pip config: " + (pipconfig != null ? pipconfig.toString() : "null"));
 687                         // Validate the node's properties
 688                         boolean isCurrent = this.isPDPCurrent(policies, pipconfig, pdpProperties);
 689                         // Send back current configuration
 690                         if (isCurrent == false) {
 691                                 // Tell the PDP we are sending back the current policies/pip config
 692                                 LOGGER.info("PDP configuration NOT current.");
 693                                 if (policies != null) {
 694                                         // Put URL's into the properties in case the PDP needs to
 695                                         // retrieve them.
 696                                         this.populatePolicyURL(request.getRequestURL(), policies);
 697                                         // Copy the properties to the output stream
 698                                         try{
 699                                             policies.store(response.getOutputStream(), "");
 700                                         }catch(IOException e){
 701                                 LOGGER.error(e);
 702                             }
 703                                 }
 704                                 if (pipconfig != null) {
 705                                         // Copy the properties to the output stream
 706                                         try{
 707                                             pipconfig.store(response.getOutputStream(), "");
 708                                         }catch(IOException e){
 709                                 LOGGER.error(e);
 710                             }
 711                                 }
 712                                 // We are good - and we are sending them information
 713                                 response.setStatus(HttpServletResponse.SC_OK);
 714                                 try{
 715                                     setPDPSummaryStatus(pdp, PDPStatus.Status.OUT_OF_SYNCH);
 716                                 }catch(PAPException e){
 717                         LOGGER.error(e);
 718                     }
 719                         } else {
 720                                 // Tell them they are good
 721                                 response.setStatus(HttpServletResponse.SC_NO_CONTENT);
 722                                 try{
 723                                     setPDPSummaryStatus(pdp, PDPStatus.Status.UP_TO_DATE);
 724                                 }catch(PAPException e){
 725                         LOGGER.error(e);
 726                     }
 727                         }
 728                         // tell the AC that something changed
 729                         loggingContext.metricStarted();
 730                         notifyAC();
 731                         loggingContext.metricEnded();
 732                         PolicyLogger.metrics("XACMLPapServlet doPost notifyAC");
 733                         loggingContext.transactionEnded();
 734                         auditLogger.info("Success");
 735                         PolicyLogger.audit("Transaction Ended Successfully");
 736                 } catch (PAPException | IOException | NumberFormatException e) {
 737                         if(pdpTransaction != null){
 738                                 pdpTransaction.rollbackTransaction();
 739                         }
 740                         LOGGER.debug(XACMLErrorConstants.ERROR_PROCESS_FLOW + "POST exception: " + e, e);
 741                         loggingContext.transactionEnded();
 742                         PolicyLogger.audit("Transaction Failed - See Error.log");
 743                         setResponseError(response, HttpServletResponse.SC_INTERNAL_SERVER_ERROR, e.getMessage());
 744                         im.endTransaction();
 745                         return;
 746                 }
 747                 //Catch anything that fell through
 748                 loggingContext.transactionEnded();
 749                 PolicyLogger.audit("Transaction Ended");
 750                 im.endTransaction();
 751         }
 752
 753         private void setResponseError(HttpServletResponse response,int responseCode, String message) {
 754             try {
 755             response.sendError(responseCode, message);
 756         } catch (IOException e) {
 757             LOGGER.error("Error setting Error response Header ", e);
 758         }
 759             return;
 760     }
 761
 762     /**
 763          * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response)
 764          */
 765         protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
 766                 ONAPLoggingContext loggingContext = ONAPLoggingUtils.getLoggingContextForRequest(request, baseLoggingContext);
 767                 loggingContext.transactionStarted();
 768                 loggingContext.setServiceName("PAP.get");
 769                 if ((loggingContext.getRequestID() == null) || (loggingContext.getRequestID() == "")){
 770                         UUID requestID = UUID.randomUUID();
 771                         loggingContext.setRequestID(requestID.toString());
 772                         PolicyLogger.info("requestID not provided in call to XACMLPapSrvlet (doGet) so we generated one");
 773                 } else {
 774                         PolicyLogger.info("requestID was provided in call to XACMLPapSrvlet (doGet)");
 775                 }
 776                 try {
 777                         loggingContext.metricStarted();
 778                         XACMLRest.dumpRequest(request);
 779                         loggingContext.metricEnded();
 780                         PolicyLogger.metrics("XACMLPapServlet doGet dumpRequest");
 781                         String pathInfo = request.getRequestURI();
 782                         LOGGER.info("path info: " + pathInfo);
 783                         if (pathInfo != null){
 784                                 //DO NOT do a im.startTransaction for the test request
 785                                 if (pathInfo.equals("/pap/test")) {
 786                                         try {
 787                                                 testService(loggingContext, response);
 788                                         } catch (IOException e) {
 789                                                 LOGGER.debug(e);
 790                                         }
 791                                         return;
 792                                 }
 793                         }
 794                         //This im.startTransaction() covers all other Get transactions
 795                         try {
 796                                 loggingContext.metricStarted();
 797                                 im.startTransaction();
 798                                 loggingContext.metricEnded();
 799                                 PolicyLogger.metrics("XACMLPapServlet doGet im startTransaction");
 800                         } catch (AdministrativeStateException ae){
 801                                 String message = "GET interface called for PAP " + papResourceName + " but it has an Administrative"
 802                                                 + " state of " + im.getStateManager().getAdminState()
 803                                                 + "\n Exception Message: " + ae.getMessage();
 804                                 LOGGER.info(message, ae);
 805                                 PolicyLogger.error(MessageCodes.ERROR_SYSTEM_ERROR + " " + message);
 806                                 loggingContext.transactionEnded();
 807                                 PolicyLogger.audit("Transaction Failed - See Error.log");
 808                                 setResponseError(response, HttpServletResponse.SC_INTERNAL_SERVER_ERROR, message);
 809                                 return;
 810                         }catch (StandbyStatusException se) {
 811                                 String message = "GET interface called for PAP " + papResourceName + " but it has a Standby Status"
 812                                                 + " of " + im.getStateManager().getStandbyStatus()
 813                                                 + "\n Exception Message: " + se.getMessage();
 814                                 LOGGER.info(message, se);
 815                                 PolicyLogger.error(MessageCodes.ERROR_SYSTEM_ERROR + " " + message);
 816                                 loggingContext.transactionEnded();
 817                                 PolicyLogger.audit("Transaction Failed - See Error.log");
 818                                 setResponseError(response, HttpServletResponse.SC_INTERNAL_SERVER_ERROR, message);
 819                                 return;
 820                         }
 821                         // Request from the API to get the gitPath
 822                         String apiflag = request.getParameter("apiflag");
 823                         if (apiflag!=null) {
 824                                 if(authorizeRequest(request)){
 825                                         APIRequestHandler apiRequestHandler = new APIRequestHandler();
 826                                         try{
 827                                                 loggingContext.metricStarted();
 828                                             apiRequestHandler.doGet(request,response, apiflag);
 829                                                 loggingContext.metricEnded();
 830                                                 PolicyLogger.metrics("XACMLPapServlet doGet apiRequestHandler doGet");
 831                                         }catch(IOException e){
 832                                             LOGGER.error(e);
 833                                         }
 834                                         loggingContext.transactionEnded();
 835                                         PolicyLogger.audit("Transaction Ended Successfully");
 836                                         im.endTransaction();
 837                                         return;
 838                                 } else {
 839                                         String message = "PEP not Authorized for making this Request!! \n Contact Administrator for this Scope. ";
 840                                         PolicyLogger.error(MessageCodes.ERROR_PERMISSIONS + " " + message);
 841                                         loggingContext.transactionEnded();
 842                                         PolicyLogger.audit("Transaction Failed - See Error.log");
 843                                         setResponseError(response, HttpServletResponse.SC_FORBIDDEN, message);
 844                                         im.endTransaction();
 845                                         return;
 846                                 }
 847                         }
 848                         // Is this from the Admin Console?
 849                         String groupId = request.getParameter("groupId");
 850                         if (groupId != null) {
 851                                 // this is from the Admin Console, so handle separately
 852                                 try{
 853                                         loggingContext.metricStarted();
 854                                     doACGet(request, response, groupId, loggingContext);
 855                                         loggingContext.metricEnded();
 856                                         PolicyLogger.metrics("XACMLPapServlet doGet doACGet");
 857                                 } catch(IOException e){
 858                     LOGGER.error(e);
 859                 }
 860                                 loggingContext.transactionEnded();
 861                                 PolicyLogger.audit("Transaction Ended Successfully");
 862                                 im.endTransaction();
 863                                 return;
 864                         }
 865                         // Get the PDP's ID
 866                         String id = this.getPDPID(request);
 867                         LOGGER.info("doGet from: " + id);
 868                         // Get the PDP Object
 869                         OnapPDP pdp = null;
 870                         try{
 871                             pdp = XACMLPapServlet.papEngine.getPDP(id);
 872                         }catch(PAPException e){
 873                             LOGGER.error(e);
 874                         }
 875                         // Is it known?
 876                         if (pdp == null) {
 877                                 // Check if request came from localhost
 878                                 if (request.getRemoteHost().equals("localhost") ||
 879                                                 request.getRemoteHost().equals(request.getLocalAddr())) {
 880                                         // Return status information - basically all the groups
 881                                         loggingContext.setServiceName("PAP.getGroups");
 882                                         Set<OnapPDPGroup> groups = papEngine.getOnapPDPGroups();
 883                                         // convert response object to JSON and include in the response
 884                                         mapperWriteValue(new ObjectMapper(), response,  groups);
 885                                         response.setHeader("content-type", "application/json");
 886                                         response.setStatus(HttpServletResponse.SC_OK);
 887                                         loggingContext.transactionEnded();
 888                                         PolicyLogger.audit("Transaction Ended Successfully");
 889                                         im.endTransaction();
 890                                         return;
 891                                 }
 892                                 String message = "Unknown PDP: " + id + " from " + request.getRemoteHost() + " us: " + request.getLocalAddr();
 893                                 PolicyLogger.error(MessageCodes.ERROR_PERMISSIONS + " " + message);
 894                                 loggingContext.transactionEnded();
 895                                 PolicyLogger.audit("Transaction Failed - See Error.log");
 896                                 setResponseError(response, HttpServletResponse.SC_UNAUTHORIZED, message);
 897                                 im.endTransaction();
 898                                 return;
 899                         }
 900                         loggingContext.setServiceName("PAP.getPolicy");
 901                         // Get the PDP's Group
 902                         OnapPDPGroup group = null;
 903                         try {
 904                             group = XACMLPapServlet.papEngine.getPDPGroup((OnapPDP) pdp);
 905                         } catch (PAPException e) {
 906                             LOGGER.error(e);
 907                         }
 908                         if (group == null) {
 909                                 String message = "No group associated with pdp " + pdp.getId();
 910                                 LOGGER.warn(XACMLErrorConstants.ERROR_PERMISSIONS + message);
 911                                 loggingContext.transactionEnded();
 912                                 PolicyLogger.audit("Transaction Failed - See Error.log");
 913                                 setResponseError(response, HttpServletResponse.SC_UNAUTHORIZED, message);
 914                                 im.endTransaction();
 915                                 return;
 916                         }
 917                         // Which policy do they want?
 918                         String policyId = request.getParameter("id");
 919                         if (policyId == null) {
 920                                 String message = "Did not specify an id for the policy";
 921                                 LOGGER.warn(XACMLErrorConstants.ERROR_DATA_ISSUE + message);
 922                                 loggingContext.transactionEnded();
 923                                 PolicyLogger.audit("Transaction Failed - See Error.log");
 924                                 setResponseError(response,HttpServletResponse.SC_NOT_FOUND, message);
 925                                 im.endTransaction();
 926                                 return;
 927                         }
 928                         PDPPolicy policy = group.getPolicy(policyId);
 929                         if (policy == null) {
 930                                 String message = "Unknown policy: " + policyId;
 931                                 LOGGER.warn(XACMLErrorConstants.ERROR_DATA_ISSUE + message);
 932                                 loggingContext.transactionEnded();
 933                                 PolicyLogger.audit("Transaction Failed - See Error.log");
 934                                 setResponseError(response,HttpServletResponse.SC_NOT_FOUND, message);
 935                                 im.endTransaction();
 936                                 return;
 937                         }
 938                         try{
 939                     LOGGER.warn("PolicyDebugging: Policy Validity: " + policy.isValid() + "\n "
 940                             + "Policy Name : " + policy.getName() + "\n Policy URI: " + policy.getLocation().toString());
 941                         } catch (PAPException| IOException e){
 942                             LOGGER.error(e);
 943                         }
 944                         try (InputStream is = new FileInputStream(((StdPDPGroup)group).getDirectory().toString()+File.separator+policyId); OutputStream os = response.getOutputStream()) {
 945                                 // Send the policy back
 946                                 IOUtils.copy(is, os);
 947                                 response.setStatus(HttpServletResponse.SC_OK);
 948                                 loggingContext.transactionEnded();
 949                                 auditLogger.info("Success");
 950                                 PolicyLogger.audit("Transaction Ended Successfully");
 951                         } catch (IOException e) {
 952                                 String message = "Failed to open policy id " + policyId;
 953                                 LOGGER.debug(e);
 954                                 PolicyLogger.error(MessageCodes.ERROR_DATA_ISSUE + " " + message);
 955                                 loggingContext.transactionEnded();
 956                                 PolicyLogger.audit("Transaction Failed - See Error.log");
 957                                 setResponseError(response,HttpServletResponse.SC_NOT_FOUND, message);
 958                         }
 959                 }  catch (PAPException e) {
 960                         LOGGER.debug(e);
 961                         PolicyLogger.error(MessageCodes.ERROR_UNKNOWN, e, "XACMLPapServlet", " GET exception");
 962                         loggingContext.transactionEnded();
 963                         PolicyLogger.audit("Transaction Failed - See Error.log");
 964                         setResponseError(response,HttpServletResponse.SC_INTERNAL_SERVER_ERROR, e.getMessage());
 965                         im.endTransaction();
 966                         return;
 967                 }
 968                 loggingContext.transactionEnded();
 969                 PolicyLogger.audit("Transaction Ended");
 970                 im.endTransaction();
 971         }
 972
 973         /**
 974          * @see HttpServlet#doPut(HttpServletRequest request, HttpServletResponse response)
 975          */
 976         protected void doPut(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
 977                 ONAPLoggingContext loggingContext = ONAPLoggingUtils.getLoggingContextForRequest(request, baseLoggingContext);
 978                 loggingContext.transactionStarted();
 979                 loggingContext.setServiceName("PAP.put");
 980                 if ((loggingContext.getRequestID() == null) || (loggingContext.getRequestID() == "")){
 981                         UUID requestID = UUID.randomUUID();
 982                         loggingContext.setRequestID(requestID.toString());
 983                         PolicyLogger.info("requestID not provided in call to XACMLPapSrvlet (doPut) so we generated one");
 984                 } else {
 985                         PolicyLogger.info("requestID was provided in call to XACMLPapSrvlet (doPut)");
 986                 }
 987                 try {
 988                         loggingContext.metricStarted();
 989                         im.startTransaction();
 990                         loggingContext.metricEnded();
 991                         PolicyLogger.metrics("XACMLPapServlet doPut im startTransaction");
 992                 } catch (AdministrativeStateException | StandbyStatusException e) {
 993                         String message = "PUT interface called for PAP " + papResourceName;
 994                         if (e instanceof AdministrativeStateException) {
 995                                 message += " but it has an Administrative state of "
 996                                         + im.getStateManager().getAdminState();
 997                         } else if (e instanceof StandbyStatusException) {
 998                                 message += " but it has a Standby Status of "
 999                                         + im.getStateManager().getStandbyStatus();
1000
1001                         }
1002                         message += "\n Exception Message: " + e.getMessage();
1003
1004                         LOGGER.info(message, e);
1005                         PolicyLogger.error(MessageCodes.ERROR_SYSTEM_ERROR + " " + message);
1006                         loggingContext.transactionEnded();
1007                         PolicyLogger.audit("Transaction Failed - See Error.log");
1008                         setResponseError(response,HttpServletResponse.SC_INTERNAL_SERVER_ERROR, message);
1009                         return;
1010                 }
1011
1012                 loggingContext.metricStarted();
1013                 XACMLRest.dumpRequest(request);
1014                 loggingContext.metricEnded();
1015                 PolicyLogger.metrics("XACMLPapServlet doPut dumpRequest");
1016                 //need to check if request is from the API or Admin console
1017                 String apiflag = request.getParameter("apiflag");
1018                 //This would occur if a PolicyDBDao notification was received
1019                 String policyDBDaoRequestUrl = request.getParameter("policydbdaourl");
1020                 if(policyDBDaoRequestUrl != null){
1021                         String policyDBDaoRequestEntityId = request.getParameter("entityid");
1022                         String policyDBDaoRequestEntityType = request.getParameter("entitytype");
1023                         String policyDBDaoRequestExtraData = request.getParameter("extradata");
1024                         if(policyDBDaoRequestEntityId == null || policyDBDaoRequestEntityType == null){
1025                                 setResponseError(response,400, "entityid or entitytype not supplied");
1026                                 loggingContext.transactionEnded();
1027                                 PolicyLogger.audit("Transaction Ended Successfully");
1028                                 im.endTransaction();
1029                                 return;
1030                         }
1031                         loggingContext.metricStarted();
1032                         policyDBDao.handleIncomingHttpNotification(policyDBDaoRequestUrl,policyDBDaoRequestEntityId,policyDBDaoRequestEntityType,policyDBDaoRequestExtraData,this);
1033                         loggingContext.metricEnded();
1034                         PolicyLogger.metrics("XACMLPapServlet doPut handle incoming http notification");
1035                         response.setStatus(200);
1036                         loggingContext.transactionEnded();
1037                         PolicyLogger.audit("Transaction Ended Successfully");
1038                         im.endTransaction();
1039                         return;
1040                 }
1041                 /*
1042                  * Request for ImportService
1043                  */
1044                 String importService = request.getParameter("importService");
1045                 if (importService != null) {
1046                         if(authorizeRequest(request)){
1047                                 APIRequestHandler apiRequestHandler = new APIRequestHandler();
1048                                 try{
1049                                         loggingContext.metricStarted();
1050                                     apiRequestHandler.doPut(request, response, importService);
1051                                         loggingContext.metricEnded();
1052                                         PolicyLogger.metrics("XACMLPapServlet doPut apiRequestHandler doPut");
1053                                 }catch(IOException e){
1054                                     LOGGER.error(e);
1055                                 }
1056                                 im.endTransaction();
1057                                 return;
1058                         } else {
1059                                 String message = "PEP not Authorized for making this Request!! \n Contact Administrator for this Scope. ";
1060                                 LOGGER.error(XACMLErrorConstants.ERROR_PERMISSIONS + message );
1061                                 loggingContext.transactionEnded();
1062                                 PolicyLogger.audit("Transaction Failed - See Error.log");
1063                                 setResponseError(response,HttpServletResponse.SC_FORBIDDEN, message);
1064                                 return;
1065                         }
1066                 }
1067                 //This would occur if we received a notification of a policy rename from AC
1068                 String oldPolicyName = request.getParameter("oldPolicyName");
1069                 String newPolicyName = request.getParameter("newPolicyName");
1070                 if(oldPolicyName != null && newPolicyName != null){
1071                         if(LOGGER.isDebugEnabled()){
1072                                 LOGGER.debug("\nXACMLPapServlet.doPut() - before decoding"
1073                                                 + "\npolicyToCreateUpdate = " + " ");
1074                         }
1075                         //decode it
1076                         try{
1077                                 oldPolicyName = URLDecoder.decode(oldPolicyName, "UTF-8");
1078                                 newPolicyName = URLDecoder.decode(newPolicyName, "UTF-8");
1079                                 if(LOGGER.isDebugEnabled()){
1080                                         LOGGER.debug("\nXACMLPapServlet.doPut() - after decoding"
1081                                                         + "\npolicyToCreateUpdate = " + " ");
1082                                 }
1083                         } catch(UnsupportedEncodingException e){
1084                                 PolicyLogger.error("\nXACMLPapServlet.doPut() - Unsupported URL encoding of policyToCreateUpdate (UTF-8)"
1085                                                 + "\npolicyToCreateUpdate = " + " ");
1086                                 setResponseError(response,HttpServletResponse.SC_INTERNAL_SERVER_ERROR,"policyToCreateUpdate encoding not supported"
1087                                                 + "\nfailure with the following exception: " + e);
1088                                 loggingContext.transactionEnded();
1089                                 PolicyLogger.audit("Transaction Failed - See error.log");
1090                                 im.endTransaction();
1091                                 return;
1092                         }
1093                         //send it to PolicyDBDao
1094                         PolicyDBDaoTransaction renameTransaction = policyDBDao.getNewTransaction();
1095                         try{
1096                                 renameTransaction.renamePolicy(oldPolicyName,newPolicyName, "XACMLPapServlet.doPut");
1097                         }catch(Exception e){
1098                                 renameTransaction.rollbackTransaction();
1099                                 setResponseError(response,HttpServletResponse.SC_INTERNAL_SERVER_ERROR,"createUpdateTransaction.createPolicy(policyToCreateUpdate, XACMLPapServlet.doPut) "
1100                                                 + "\nfailure with the following exception: " + e);
1101                                 loggingContext.transactionEnded();
1102                                 PolicyLogger.audit("Transaction Failed - See error.log");
1103                                 im.endTransaction();
1104                                 return;
1105                         }
1106                         loggingContext.metricStarted();
1107                         renameTransaction.commitTransaction();
1108                         loggingContext.metricEnded();
1109                         PolicyLogger.metrics("XACMLPapServlet goPut commitTransaction");
1110                         response.setStatus(HttpServletResponse.SC_OK);
1111                         loggingContext.transactionEnded();
1112                         PolicyLogger.audit("Transaction Ended Successfully");
1113                         im.endTransaction();
1114                         return;
1115                 }
1116                 //
1117                 // See if this is Admin Console registering itself with us
1118                 //
1119                 String acURLString = request.getParameter("adminConsoleURL");
1120                 if (acURLString != null) {
1121                         loggingContext.setServiceName("AC:PAP.register");
1122                         // remember this Admin Console for future updates
1123                         if ( ! adminConsoleURLStringList.contains(acURLString)) {
1124                                 adminConsoleURLStringList.add(acURLString);
1125                         }
1126                         if (LOGGER.isDebugEnabled()) {
1127                                 LOGGER.debug("Admin Console registering with URL: " + acURLString);
1128                         }
1129                         response.setStatus(HttpServletResponse.SC_NO_CONTENT);
1130                         loggingContext.transactionEnded();
1131                         auditLogger.info("Success");
1132                         PolicyLogger.audit("Transaction Ended Successfully");
1133                         im.endTransaction();
1134                         return;
1135                 }
1136                 /*
1137                  * This is to update the PDP Group with the policy/policies being pushed
1138                  * Part of a 2 step process to push policies to the PDP that can now be done
1139                  * From both the Admin Console and the PolicyEngine API
1140                  */
1141                 String groupId = request.getParameter("groupId");
1142                 if (groupId != null) {
1143                         if(apiflag!=null){
1144                                 if(!authorizeRequest(request)){
1145                                         String message = "PEP not Authorized for making this Request!! \n Contact Administrator for this Scope. ";
1146                                         PolicyLogger.error(MessageCodes.ERROR_PERMISSIONS + " " + message);
1147                                         loggingContext.transactionEnded();
1148                                         PolicyLogger.audit("Transaction Failed - See Error.log");
1149                                         setResponseError(response,HttpServletResponse.SC_FORBIDDEN, message);
1150                                         return;
1151                                 }
1152                                 if(apiflag.equalsIgnoreCase("addPolicyToGroup")){
1153                                     try{
1154                                         updateGroupsFromAPI(request, response, groupId, loggingContext);
1155                                     }catch(IOException e){
1156                                         LOGGER.error(e);
1157                                     }
1158                                         loggingContext.transactionEnded();
1159                                         PolicyLogger.audit("Transaction Ended Successfully");
1160                                         im.endTransaction();
1161                                         return;
1162                                 }
1163                         }
1164                         // this is from the Admin Console, so handle separately
1165                         try {
1166                                 loggingContext.metricEnded();
1167                             doACPut(request, response, groupId, loggingContext);
1168                                 loggingContext.metricEnded();
1169                                 PolicyLogger.metrics("XACMLPapServlet goPut doACPut");
1170                         } catch (IOException e) {
1171                 LOGGER.error(e);
1172             }
1173                         loggingContext.transactionEnded();
1174                         PolicyLogger.audit("Transaction Ended Successfully");
1175                         im.endTransaction();
1176                         return;
1177                 }
1178                 //
1179                 // Request is for policy validation and creation
1180                 //
1181                 if (apiflag != null && apiflag.equalsIgnoreCase("admin")){
1182                         // this request is from the Admin Console
1183                         SavePolicyHandler savePolicyHandler = SavePolicyHandler.getInstance();
1184                         try{
1185                                 loggingContext.metricStarted();
1186                             savePolicyHandler.doPolicyAPIPut(request, response);
1187                                 loggingContext.metricEnded();
1188                                 PolicyLogger.metrics("XACMLPapServlet goPut savePolicyHandler");
1189                         } catch (IOException e) {
1190                 LOGGER.error(e);
1191             }
1192                         loggingContext.transactionEnded();
1193                         PolicyLogger.audit("Transaction Ended Successfully");
1194                         im.endTransaction();
1195                         return;
1196                 } else if (apiflag != null && apiflag.equalsIgnoreCase("api")) {
1197                         // this request is from the Policy Creation API
1198                         if(authorizeRequest(request)){
1199                                 APIRequestHandler apiRequestHandler = new APIRequestHandler();
1200                                 try{
1201                                         loggingContext.metricStarted();
1202                                     apiRequestHandler.doPut(request, response, request.getHeader("ClientScope"));
1203                                         loggingContext.metricEnded();
1204                                         PolicyLogger.metrics("XACMLPapServlet goPut apiRequestHandler doPut");
1205                     } catch (IOException e) {
1206                         LOGGER.error(e);
1207                     }
1208                                 loggingContext.transactionEnded();
1209                                 PolicyLogger.audit("Transaction Ended Successfully");
1210                                 im.endTransaction();
1211                                 return;
1212                         } else {
1213                                 String message = "PEP not Authorized for making this Request!!";
1214                                 PolicyLogger.error(MessageCodes.ERROR_PERMISSIONS + " " + message);
1215                                 loggingContext.transactionEnded();
1216                                 PolicyLogger.audit("Transaction Failed - See Error.log");
1217                                 setResponseError(response,HttpServletResponse.SC_FORBIDDEN, message);
1218                                 im.endTransaction();
1219                                 return;
1220                         }
1221                 }
1222                 // We do not expect anything from anywhere else.
1223                 // This method is here in case we ever need to support other operations.
1224                 LOGGER.error(XACMLErrorConstants.ERROR_DATA_ISSUE + "Request does not have groupId or apiflag");
1225                 loggingContext.transactionEnded();
1226                 PolicyLogger.audit("Transaction Failed - See Error.log");
1227                 setResponseError(response,HttpServletResponse.SC_BAD_REQUEST, "Request does not have groupId or apiflag");
1228                 loggingContext.transactionEnded();
1229                 PolicyLogger.audit("Transaction Failed - See error.log");
1230                 im.endTransaction();
1231         }
1232
1233         /**
1234          * @see HttpServlet#doDelete(HttpServletRequest request, HttpServletResponse response)
1235          */
1236         protected void doDelete(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
1237                 ONAPLoggingContext loggingContext = ONAPLoggingUtils.getLoggingContextForRequest(request, baseLoggingContext);
1238                 loggingContext.transactionStarted();
1239                 loggingContext.setServiceName("PAP.delete");
1240                 if ((loggingContext.getRequestID() == null) || (loggingContext.getRequestID() == "")){
1241                         UUID requestID = UUID.randomUUID();
1242                         loggingContext.setRequestID(requestID.toString());
1243                         PolicyLogger.info("requestID not provided in call to XACMLPapSrvlet (doDelete) so we generated one");
1244                 } else {
1245                         PolicyLogger.info("requestID was provided in call to XACMLPapSrvlet (doDelete)");
1246                 }
1247                 try {
1248                         loggingContext.metricStarted();
1249                         im.startTransaction();
1250                         loggingContext.metricEnded();
1251                         PolicyLogger.metrics("XACMLPapServlet doDelete im startTransaction");
1252                 } catch (AdministrativeStateException ae){
1253                         String message = "DELETE interface called for PAP " + papResourceName + " but it has an Administrative"
1254                                         + " state of " + im.getStateManager().getAdminState()
1255                                         + "\n Exception Message: " + ae.getMessage();
1256                         LOGGER.info(message, ae);
1257                         PolicyLogger.error(MessageCodes.ERROR_SYSTEM_ERROR + " " + message);
1258                         loggingContext.transactionEnded();
1259                         PolicyLogger.audit("Transaction Failed - See Error.log");
1260                         setResponseError(response,HttpServletResponse.SC_INTERNAL_SERVER_ERROR, message);
1261                         return;
1262                 }catch (StandbyStatusException se) {
1263                         String message = "PUT interface called for PAP " + papResourceName + " but it has a Standby Status"
1264                                         + " of " + im.getStateManager().getStandbyStatus()
1265                                         + "\n Exception Message: " + se.getMessage();
1266                         LOGGER.info(message, se);
1267                         PolicyLogger.error(MessageCodes.ERROR_SYSTEM_ERROR + " " + message);
1268                         loggingContext.transactionEnded();
1269                         PolicyLogger.audit("Transaction Failed - See Error.log");
1270                         setResponseError(response,HttpServletResponse.SC_INTERNAL_SERVER_ERROR, message);
1271                         return;
1272                 }
1273                 loggingContext.metricStarted();
1274                 XACMLRest.dumpRequest(request);
1275                 loggingContext.metricEnded();
1276                 PolicyLogger.metrics("XACMLPapServlet doDelete dumpRequest");
1277                 String groupId = request.getParameter("groupId");
1278                 String apiflag = request.getParameter("apiflag");
1279                 if (groupId != null) {
1280                         // Is this from the Admin Console or API?
1281                         if(apiflag!=null) {
1282                                 if(!authorizeRequest(request)){
1283                                         String message = "PEP not Authorized for making this Request!! \n Contact Administrator for this Scope. ";
1284                                         PolicyLogger.error(MessageCodes.ERROR_PERMISSIONS + " " + message);
1285                                         loggingContext.transactionEnded();
1286                                         PolicyLogger.audit("Transaction Failed - See Error.log");
1287                                         setResponseError(response,HttpServletResponse.SC_FORBIDDEN, message);
1288                                         return;
1289                                 }
1290                                 APIRequestHandler apiRequestHandler = new APIRequestHandler();
1291                                 try {
1292                                         loggingContext.metricStarted();
1293                                         apiRequestHandler.doDelete(request, response, loggingContext, apiflag);
1294                                         loggingContext.metricEnded();
1295                                         PolicyLogger.metrics("XACMLPapServlet doDelete apiRequestHandler doDelete");
1296                                 } catch (Exception e) {
1297                                         LOGGER.error("Exception Occured"+e);
1298                                 }
1299                                 if(apiRequestHandler.getNewGroup()!=null){
1300                                         groupChanged(apiRequestHandler.getNewGroup(), loggingContext);
1301                                 }
1302                                 return;
1303                         }
1304                         // this is from the Admin Console, so handle separately
1305                         try{
1306                                 loggingContext.metricStarted();
1307                             doACDelete(request, response, groupId, loggingContext);
1308                                 loggingContext.metricEnded();
1309                                 PolicyLogger.metrics("XACMLPapServlet doDelete doACDelete");
1310                         } catch (IOException e) {
1311                 LOGGER.error(e);
1312             }
1313                         loggingContext.transactionEnded();
1314                         PolicyLogger.audit("Transaction Ended Successfully");
1315                         im.endTransaction();
1316                         return;
1317                 }
1318                 //Catch anything that fell through
1319                 PolicyLogger.error(MessageCodes.ERROR_DATA_ISSUE + " Request does not have groupId");
1320                 loggingContext.transactionEnded();
1321                 PolicyLogger.audit("Transaction Failed - See Error.log");
1322                 setResponseError(response,HttpServletResponse.SC_BAD_REQUEST, "Request does not have groupId");
1323                 im.endTransaction();
1324         }
1325
1326         private boolean isPDPCurrent(Properties policies, Properties pipconfig, Properties pdpProperties) {
1327                 String localRootPolicies = policies.getProperty(XACMLProperties.PROP_ROOTPOLICIES);
1328                 String localReferencedPolicies = policies.getProperty(XACMLProperties.PROP_REFERENCEDPOLICIES);
1329                 if (localRootPolicies == null || localReferencedPolicies == null) {
1330                         LOGGER.warn(XACMLErrorConstants.ERROR_DATA_ISSUE + "Missing property on PAP server: RootPolicies="+localRootPolicies+"  ReferencedPolicies="+localReferencedPolicies);
1331                         return false;
1332                 }
1333                 // Compare the policies and pipconfig properties to the pdpProperties
1334                 try {
1335                         // the policy properties includes only xacml.rootPolicies and
1336                         // xacml.referencedPolicies without any .url entries
1337                         Properties pdpPolicies = XACMLProperties.getPolicyProperties(pdpProperties, false);
1338                         Properties pdpPipConfig = XACMLProperties.getPipProperties(pdpProperties);
1339                         if (localRootPolicies.equals(pdpPolicies.getProperty(XACMLProperties.PROP_ROOTPOLICIES)) &&
1340                                         localReferencedPolicies.equals(pdpPolicies.getProperty(XACMLProperties.PROP_REFERENCEDPOLICIES)) &&
1341                                         pdpPipConfig.equals(pipconfig)) {
1342                                 // The PDP is current
1343                                 return true;
1344                         }
1345                 } catch (Exception e) {
1346                         // we get here if the PDP did not include either xacml.rootPolicies or xacml.pip.engines,
1347                         // or if there are policies that do not have a corresponding ".url" property.
1348                         // Either of these cases means that the PDP is not up-to-date, so just drop-through to return false.
1349                         PolicyLogger.error(MessageCodes.ERROR_SCHEMA_INVALID, e, "XACMLPapServlet", " PDP Error");
1350                 }
1351                 return false;
1352         }
1353
1354         private void populatePolicyURL(StringBuffer urlPath, Properties policies) {
1355                 String lists[] = new String[2];
1356                 lists[0] = policies.getProperty(XACMLProperties.PROP_ROOTPOLICIES);
1357                 lists[1] = policies.getProperty(XACMLProperties.PROP_REFERENCEDPOLICIES);
1358                 for (String list : lists) {
1359                         if (list != null && list.isEmpty() == false) {
1360                                 for (String id : Splitter.on(',').trimResults().omitEmptyStrings().split(list)) {
1361                                         String url = urlPath + "?id=" + id;
1362                                         LOGGER.info("Policy URL for " + id + ": " + url);
1363                                         policies.setProperty(id + ".url", url);
1364                                 }
1365                         }
1366                 }
1367         }
1368
1369         protected String getPDPID(HttpServletRequest request) {
1370                 String pdpURL = request.getHeader(XACMLRestProperties.PROP_PDP_HTTP_HEADER_ID);
1371                 if (pdpURL == null || pdpURL.isEmpty()) {
1372                         // Should send back its port for identification
1373                         LOGGER.warn(XACMLErrorConstants.ERROR_DATA_ISSUE + "PDP did not send custom header");
1374                         pdpURL = "";
1375                 }
1376                 return pdpURL;
1377         }
1378
1379         protected String getPDPJMX(HttpServletRequest request) {
1380                 String pdpJMMX = request.getHeader(XACMLRestProperties.PROP_PDP_HTTP_HEADER_JMX_PORT);
1381                 if (pdpJMMX == null || pdpJMMX.isEmpty()) {
1382                         // Should send back its port for identification
1383                         LOGGER.warn(XACMLErrorConstants.ERROR_DATA_ISSUE + "PDP did not send custom header for JMX Port so the value of 0 is assigned");
1384                         return null;
1385                 }
1386                 return pdpJMMX;
1387         }
1388
1389         /**
1390          * Requests from the PolicyEngine API to update the PDP Group with pushed policy
1391          *
1392          * @param request
1393          * @param response
1394          * @param groupId
1395          * @param loggingContext
1396          * @throws ServletException
1397          * @throws IOException
1398          */
1399         public void updateGroupsFromAPI(HttpServletRequest request, HttpServletResponse response, String groupId, ONAPLoggingContext loggingContext) throws IOException {
1400                 PolicyDBDaoTransaction acPutTransaction = policyDBDao.getNewTransaction();
1401                 PolicyLogger.audit("PolicyDBDaoTransaction started for updateGroupsFromAPI");
1402                 try {
1403                         // for PUT operations the group may or may not need to exist before the operation can be done
1404                         StdPDPGroup group = (StdPDPGroup) papEngine.getGroup(groupId);
1405
1406                         // get the request input stream content into a String
1407                         String json = null;
1408                         java.util.Scanner scanner = new java.util.Scanner(request.getInputStream());
1409                         scanner.useDelimiter("\\A");
1410                         json =  scanner.hasNext() ? scanner.next() : "";
1411                         scanner.close();
1412
1413                         PolicyLogger.info("pushPolicy request from API: " + json);
1414
1415                         // convert Object sent as JSON into local object
1416                         StdPDPPolicy policy = PolicyUtils.jsonStringToObject(json, StdPDPPolicy.class);
1417
1418                         //Get the current policies from the Group and Add the new one
1419                         Set<PDPPolicy> currentPoliciesInGroup = new HashSet<>();
1420                         currentPoliciesInGroup = group.getPolicies();
1421                         //If the selected policy is in the group we must remove the old version of it
1422                         LOGGER.info("Removing old version of the policy");
1423                         for(PDPPolicy existingPolicy : currentPoliciesInGroup) {
1424                                 if (existingPolicy.getName().equals(policy.getName())){
1425                                         if (!existingPolicy.getId().equals(policy.getId())) {
1426                                                 group.removePolicy(existingPolicy);
1427                                                 LOGGER.info("Removing policy: " + existingPolicy);
1428                                                 break;
1429                                         }
1430                                 }
1431                         }
1432
1433                         // Assume that this is an update of an existing PDP Group
1434                         loggingContext.setServiceName("PolicyEngineAPI:PAP.updateGroup");
1435                         try{
1436                                 acPutTransaction.updateGroup(group, "XACMLPapServlet.doACPut");
1437                         } catch(Exception e){
1438                                 PolicyLogger.error(MessageCodes.ERROR_PROCESS_FLOW, e, "XACMLPapServlet", " Error while updating group in the database: "
1439                                                 +"group="+group.getId());
1440                                 throw new PAPException(e.getMessage());
1441                         }
1442
1443                         LOGGER.info("Calling updatGroup() with new group");
1444                         papEngine.updateGroup(group);
1445
1446                         String policyId = "empty";
1447                         if(policy!=null){
1448                                 policyId = policy.getId();
1449                         }
1450                         response.setStatus(HttpServletResponse.SC_NO_CONTENT);
1451                         response.addHeader("operation", "push");
1452                         response.addHeader("policyId", policyId);
1453                         response.addHeader("groupId", groupId);
1454
1455                         LOGGER.info("Group '" + group.getId() + "' updated");
1456
1457                         loggingContext.metricStarted();
1458                         acPutTransaction.commitTransaction();
1459                         loggingContext.metricEnded();
1460                         PolicyLogger.metrics("XACMLPapServlet updateGroupsFromAPI commitTransaction");
1461                         loggingContext.metricStarted();
1462                         notifyAC();
1463                         loggingContext.metricEnded();
1464                         PolicyLogger.metrics("XACMLPapServlet updateGroupsFromAPI notifyAC");
1465
1466                         // Group changed, which might include changing the policies
1467                         groupChanged(group, loggingContext);
1468                         loggingContext.transactionEnded();
1469                         LOGGER.info("Success");
1470
1471                         if (policy != null && ((policy.getId().contains("Config_MS_")) || (policy.getId().contains("BRMS_Param")))) {
1472                                 PushPolicyHandler pushPolicyHandler = PushPolicyHandler.getInstance();
1473                                 if (pushPolicyHandler.preSafetyCheck(policy, configHome)) {
1474                                         LOGGER.debug("Precheck Successful.");
1475                                 }
1476                         }
1477
1478                         PolicyLogger.audit("Transaction Ended Successfully");
1479                         return;
1480                 } catch (PAPException e) {
1481                         acPutTransaction.rollbackTransaction();
1482                         PolicyLogger.error(MessageCodes.ERROR_PROCESS_FLOW, e, "XACMLPapServlet", " API PUT exception");
1483                         loggingContext.transactionEnded();
1484                         PolicyLogger.audit("Transaction Failed - See Error.log");
1485                         String message = XACMLErrorConstants.ERROR_PROCESS_FLOW + "Exception in request to update group from API - See Error.log on on the PAP.";
1486                         setResponseError(response, HttpServletResponse.SC_INTERNAL_SERVER_ERROR, e.getMessage());
1487                         response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
1488                         response.addHeader("error","addGroupError");
1489                         response.addHeader("message", message);
1490                         return;
1491                 }
1492         }
1493
1494         /**
1495          * Requests from the Admin Console for operations not on single specific objects
1496          *
1497          * @param request
1498          * @param response
1499          * @param groupId
1500          * @param loggingContext
1501          * @throws ServletException
1502          * @throws IOException
1503          */
1504         private void doACPost(HttpServletRequest request, HttpServletResponse response, String groupId, ONAPLoggingContext loggingContext) throws ServletException, IOException {
1505                 PolicyDBDaoTransaction doACPostTransaction = null;
1506                 try {
1507                         String groupName = request.getParameter("groupName");
1508                         String groupDescription = request.getParameter("groupDescription");
1509                         String apiflag = request.getParameter("apiflag");
1510                         if (groupName != null && groupDescription != null) {
1511                                 // Args:              group=<groupId> groupName=<name> groupDescription=<description>            <= create a new group
1512                                 loggingContext.setServiceName("AC:PAP.createGroup");
1513                                 String unescapedName = null;
1514                                 String unescapedDescription = null;
1515                                 try{
1516                                     unescapedName = URLDecoder.decode(groupName, "UTF-8");
1517                                     unescapedDescription = URLDecoder.decode(groupDescription, "UTF-8");
1518                                 } catch (UnsupportedEncodingException e) {
1519                                     LOGGER.error(e);
1520                                 }
1521                                 PolicyDBDaoTransaction newGroupTransaction = policyDBDao.getNewTransaction();
1522                                 try {
1523                                         newGroupTransaction.createGroup(PolicyDBDao.createNewPDPGroupId(unescapedName), unescapedName, unescapedDescription,"XACMLPapServlet.doACPost");
1524                                         papEngine.newGroup(unescapedName, unescapedDescription);
1525                                         loggingContext.metricStarted();
1526                                         newGroupTransaction.commitTransaction();
1527                                         loggingContext.metricEnded();
1528                                         PolicyLogger.metrics("XACMLPapServlet doACPost commitTransaction");
1529                                 } catch (Exception e) {
1530                                         newGroupTransaction.rollbackTransaction();
1531                                         PolicyLogger.error(MessageCodes.ERROR_PROCESS_FLOW, e, "XACMLPapServlet", " Unable to create new group");
1532                                         loggingContext.transactionEnded();
1533                                         PolicyLogger.audit("Transaction Failed - See Error.log");
1534                                         setResponseError(response,HttpServletResponse.SC_INTERNAL_SERVER_ERROR, "Unable to create new group '" + groupId + "'");
1535                                         return;
1536                                 }
1537                                 response.setStatus(HttpServletResponse.SC_NO_CONTENT);
1538                                 if (LOGGER.isDebugEnabled()) {
1539                                         LOGGER.debug("New Group '" + groupId + "' created");
1540                                 }
1541                                 // tell the Admin Consoles there is a change
1542                                 loggingContext.metricStarted();
1543                                 notifyAC();
1544                                 loggingContext.metricEnded();
1545                                 PolicyLogger.metrics("XACMLPapServlet doACPost notifyAC");
1546                                 // new group by definition has no PDPs, so no need to notify them of changes
1547                                 loggingContext.transactionEnded();
1548                                 PolicyLogger.audit("Transaction Failed - See Error.log");
1549                                 auditLogger.info("Success");
1550                                 PolicyLogger.audit("Transaction Ended Successfully");
1551                                 return;
1552                         }
1553                         // for all remaining POST operations the group must exist before the operation can be done
1554                         OnapPDPGroup group = null;
1555                         try{
1556                             group = papEngine.getGroup(groupId);
1557                         } catch (PAPException e){
1558                             LOGGER.error(e);
1559                         }
1560                         if (group == null) {
1561                                 String message = "Unknown groupId '" + groupId + "'";
1562                                 PolicyLogger.error(MessageCodes.ERROR_DATA_ISSUE + " " + message);
1563                                 loggingContext.transactionEnded();
1564                                 PolicyLogger.audit("Transaction Failed - See Error.log");
1565                                 if (apiflag!=null){
1566                                         response.addHeader("error", "unknownGroupId");
1567                                         response.addHeader("operation", "push");
1568                                         response.addHeader("message", message);
1569                                         response.setStatus(HttpServletResponse.SC_NOT_FOUND);
1570                                 } else {
1571                                         setResponseError(response,HttpServletResponse.SC_NOT_FOUND, message);
1572                                 }
1573                                 return;
1574                         }
1575
1576                         // If the request contains a policyId then we know we are pushing the policy to PDP
1577                         if (request.getParameter("policyId") != null) {
1578
1579                                 if(apiflag!=null){
1580                                         loggingContext.setServiceName("PolicyEngineAPI:PAP.postPolicy");
1581                                 } else {
1582                                         loggingContext.setServiceName("AC:PAP.postPolicy");
1583                                 }
1584
1585                                 String policyId = request.getParameter("policyId");
1586                                 PolicyDBDaoTransaction addPolicyToGroupTransaction = policyDBDao.getNewTransaction();
1587                                 StdPDPGroup updatedGroup = null;
1588                                 try {
1589                                         //Copying the policy to the file system and updating groups in database
1590                                         LOGGER.info("PapServlet: calling PolicyDBDao.addPolicyToGroup()");
1591                                         updatedGroup = addPolicyToGroupTransaction.addPolicyToGroup(group.getId(), policyId,"XACMLPapServlet.doACPost");
1592                                         loggingContext.metricStarted();
1593                                         addPolicyToGroupTransaction.commitTransaction();
1594                                         loggingContext.metricEnded();
1595                                         PolicyLogger.metrics("XACMLPapServlet doACPost commitTransaction");
1596                                         LOGGER.info("PapServlet: addPolicyToGroup() succeeded, transaction was committed");
1597
1598                                 } catch (Exception e) {
1599                                         addPolicyToGroupTransaction.rollbackTransaction();
1600                                         String message = "Policy '" + policyId + "' not copied to group '" + groupId +"': " + e;
1601                                         PolicyLogger.error(MessageCodes.ERROR_PROCESS_FLOW + " " + message);
1602                                         loggingContext.transactionEnded();
1603                                         PolicyLogger.audit("Transaction Failed - See Error.log");
1604                                         if (apiflag!=null){
1605                                                 response.addHeader("error", "policyCopyError");
1606                                                 response.addHeader("message", message);
1607                                                 response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
1608                                         } else {
1609                                                 setResponseError(response,HttpServletResponse.SC_INTERNAL_SERVER_ERROR, message);
1610                                         }
1611                                         return;
1612                                 }
1613
1614                                 // Get new transaction to perform updateGroup()
1615                                 PolicyDBDaoTransaction acPutTransaction = policyDBDao.getNewTransaction();
1616                                 try {
1617                                         /*
1618                                          * If request comes from the API we need to run the PolicyDBDao updateGroup() to notify other paps of the change.
1619                                          * The GUI does this from the POLICY-SDK-APP code.
1620                                          */
1621                                         if(apiflag != null){
1622
1623                                                 // get the request content into a String
1624                                                 String json = null;
1625                                                 // read the inputStream into a buffer
1626                                                 java.util.Scanner scanner = new java.util.Scanner(request.getInputStream());
1627                                                 scanner.useDelimiter("\\A");
1628                                                 json =  scanner.hasNext() ? scanner.next() : "";
1629                                                 scanner.close();
1630                                                 LOGGER.info("PushPolicy API request: " + json);
1631
1632                                                 // convert Object sent as JSON into local object
1633                                                 ObjectMapper mapper = new ObjectMapper();
1634                                                 Object objectFromJSON = mapper.readValue(json, StdPDPPolicy.class);
1635                                                 StdPDPPolicy policy = (StdPDPPolicy) objectFromJSON;
1636
1637                                                 // Assume that this is an update of an existing PDP Group
1638                                                 loggingContext.setServiceName("PolicyEngineAPI:PAP.updateGroup");
1639                                                 try{
1640                                                         acPutTransaction.updateGroup(updatedGroup, "XACMLPapServlet.doACPut");
1641                                                 } catch(Exception e){
1642                                                         PolicyLogger.error(MessageCodes.ERROR_PROCESS_FLOW, e, "XACMLPapServlet", " Error occurred when notifying PAPs of a group change: "
1643                                                                         + e);
1644                                                         throw new PAPException(e.getMessage());
1645                                                 }
1646
1647                                                 LOGGER.info("Calling updatGroup() with new group");
1648                                                 papEngine.updateGroup(updatedGroup);
1649
1650                                                 LOGGER.info("Group '" + updatedGroup.getId() + "' updated");
1651
1652                                                 // Commit transaction to send notification to other PAPs
1653                                                 loggingContext.metricStarted();
1654                                                 acPutTransaction.commitTransaction();
1655                                                 loggingContext.metricEnded();
1656                                                 PolicyLogger.metrics("XACMLPapServlet updateGroupsFromAPI commitTransaction");
1657                                                 loggingContext.metricStarted();
1658
1659                                                 notifyAC();
1660                                                 loggingContext.metricEnded();
1661                                                 PolicyLogger.metrics("XACMLPapServlet updateGroupsFromAPI notifyAC");
1662
1663                                                 // Group changed to send notification to PDPs, which might include changing the policies
1664                                                 groupChanged(updatedGroup,loggingContext);
1665                                                 loggingContext.transactionEnded();
1666                                                 LOGGER.info("Success");
1667
1668                                                 if (policy != null && ((policy.getName().contains("Config_MS_")) || (policy.getId().contains("BRMS_Param")))) {
1669                                                         PushPolicyHandler pushPolicyHandler = PushPolicyHandler.getInstance();
1670                                                         if (pushPolicyHandler.preSafetyCheck(policy, configHome)) {
1671                                                                 LOGGER.debug("Precheck Successful.");
1672                                                         }
1673                                                 }
1674
1675                                                 //delete temporary policy file from the bin directory
1676                                                 Files.deleteIfExists(Paths.get(policy.getId()));
1677
1678                                         }
1679                                 } catch (Exception e) {
1680                                         acPutTransaction.rollbackTransaction();
1681                                         PolicyLogger.error(MessageCodes.ERROR_PROCESS_FLOW, e, "XACMLPapServlet", " API PUT exception");
1682                                         loggingContext.transactionEnded();
1683                                         PolicyLogger.audit("Transaction Failed - See Error.log");
1684                                         String message = XACMLErrorConstants.ERROR_PROCESS_FLOW + "Exception occurred when updating the group from API.";
1685                                         LOGGER.error(message);
1686                                         setResponseError(response, HttpServletResponse.SC_INTERNAL_SERVER_ERROR, e.getMessage());
1687                                         response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
1688                                         response.addHeader("error","addGroupError");
1689                                         response.addHeader("message", message);
1690                                         return;
1691                                 }
1692
1693
1694
1695                                 // policy file copied ok and the Group was updated on the PDP
1696                                 response.setStatus(HttpServletResponse.SC_NO_CONTENT);
1697                                 response.addHeader("operation", "push");
1698                                 response.addHeader("policyId", policyId);
1699                                 response.addHeader("groupId", groupId);
1700
1701                                 LOGGER.info("policy '" + policyId + "' copied to directory for group '" + groupId + "'");
1702                                 loggingContext.transactionEnded();
1703                                 auditLogger.info("Success");
1704                                 LOGGER.info("Transaction Ended Successfully");
1705
1706                                 return;
1707                         } else if (request.getParameter("default") != null) {
1708                                 // Args:       group=<groupId> default=true               <= make default
1709                                 // change the current default group to be the one identified in the request.
1710                                 loggingContext.setServiceName("AC:PAP.setDefaultGroup");
1711                                 // This is a POST operation rather than a PUT "update group" because of the side-effect that the current default group is also changed.
1712                                 // It should never be the case that multiple groups are currently marked as the default, but protect against that anyway.
1713                                 PolicyDBDaoTransaction setDefaultGroupTransaction = policyDBDao.getNewTransaction();
1714                                 try {
1715                                         setDefaultGroupTransaction.changeDefaultGroup(group, "XACMLPapServlet.doACPost");
1716                                         papEngine.setDefaultGroup(group);
1717                                         loggingContext.metricStarted();
1718                                         setDefaultGroupTransaction.commitTransaction();
1719                                         loggingContext.metricEnded();
1720                                         PolicyLogger.metrics("XACMLPapServlet doACPost commitTransaction");
1721                                 } catch (Exception e) {
1722                                         setDefaultGroupTransaction.rollbackTransaction();
1723                                         PolicyLogger.error(MessageCodes.ERROR_PROCESS_FLOW, e, "XACMLPapServlet", " Unable to set group");
1724                                         loggingContext.transactionEnded();
1725                                         PolicyLogger.audit("Transaction Failed - See Error.log");
1726                                         setResponseError(response,HttpServletResponse.SC_INTERNAL_SERVER_ERROR, "Unable to set group '" + groupId + "' to default");
1727                                         return;
1728                                 }
1729                                 response.setStatus(HttpServletResponse.SC_NO_CONTENT);
1730                                 if (LOGGER.isDebugEnabled()) {
1731                                         LOGGER.debug("Group '" + groupId + "' set to be default");
1732                                 }
1733                                 // Notify the Admin Consoles that something changed
1734                                 // For now the AC cannot handle anything more detailed than the whole set of PDPGroups, so just notify on that
1735                                 //TODO - Future: FIGURE OUT WHAT LEVEL TO NOTIFY: 2 groups or entire set - currently notify AC to update whole configuration of all groups
1736                                 loggingContext.metricStarted();
1737                                 notifyAC();
1738                                 // This does not affect any PDPs in the existing groups, so no need to notify them of this change
1739                                 loggingContext.metricEnded();
1740                                 PolicyLogger.metrics("XACMLPapServlet doACPost notifyAC");
1741                                 loggingContext.transactionEnded();
1742                                 auditLogger.info("Success");
1743                                 LOGGER.info("Transaction Ended Successfully");
1744                                 return;
1745                         } else if (request.getParameter("pdpId") != null) {
1746                                 doACPostTransaction = policyDBDao.getNewTransaction();
1747                                 // Args:       group=<groupId> pdpId=<pdpId>               <= move PDP to group
1748                                 loggingContext.setServiceName("AC:PAP.movePDP");
1749                                 String pdpId = request.getParameter("pdpId");
1750                                 OnapPDP pdp = papEngine.getPDP(pdpId);
1751                                 OnapPDPGroup originalGroup = papEngine.getPDPGroup((OnapPDP) pdp);
1752                                 try{
1753                                         doACPostTransaction.movePdp(pdp, group, "XACMLPapServlet.doACPost");
1754                                 }catch(Exception e){
1755                                         doACPostTransaction.rollbackTransaction();
1756                                         PolicyLogger.error(MessageCodes.ERROR_PROCESS_FLOW, e, "XACMLPapServlet",
1757                                                         " Error while moving pdp in the database: "
1758                                                                         +"pdp="+pdp.getId()+",to group="+group.getId());
1759                                         throw new PAPException(e.getMessage());
1760                                 }
1761                                 papEngine.movePDP((OnapPDP) pdp, group);
1762                                 response.setStatus(HttpServletResponse.SC_NO_CONTENT);
1763                                 if (LOGGER.isDebugEnabled()) {
1764                                         LOGGER.debug("PDP '" + pdp.getId() +"' moved to group '" + group.getId() + "' set to be default");
1765                                 }
1766                                 // update the status of both the original group and the new one
1767                                 ((StdPDPGroup)originalGroup).resetStatus();
1768                                 ((StdPDPGroup)group).resetStatus();
1769                                 // Notify the Admin Consoles that something changed
1770                                 // For now the AC cannot handle anything more detailed than the whole set of PDPGroups, so just notify on that
1771                                 loggingContext.metricStarted();
1772                                 notifyAC();
1773                                 loggingContext.metricEnded();
1774                                 PolicyLogger.metrics("XACMLPapServlet doACPost notifyAC");
1775                                 // Need to notify the PDP that it's config may have changed
1776                                 pdpChanged(pdp, loggingContext);
1777                                 loggingContext.metricStarted();
1778                                 doACPostTransaction.commitTransaction();
1779                                 loggingContext.metricEnded();
1780                                 PolicyLogger.metrics("XACMLPapServlet doACPost commitTransaction");
1781                                 loggingContext.transactionEnded();
1782                                 auditLogger.info("Success");
1783                                 PolicyLogger.audit("Transaction Ended Successfully");
1784                                 return;
1785                         }
1786                 } catch (PAPException e) {
1787                         PolicyLogger.error(MessageCodes.ERROR_PROCESS_FLOW, e, "XACMLPapServlet", " AC POST exception");
1788                         loggingContext.transactionEnded();
1789                         PolicyLogger.audit("Transaction Failed - See Error.log");
1790                         setResponseError(response,HttpServletResponse.SC_INTERNAL_SERVER_ERROR, e.getMessage());
1791                         return;
1792                 }
1793         }
1794
1795         /**
1796          * Requests from the Admin Console to GET info about the Groups and PDPs
1797          *
1798          * @param request
1799          * @param response
1800          * @param groupId
1801          * @param loggingContext
1802          * @throws ServletException
1803          * @throws IOException
1804          */
1805         private void doACGet(HttpServletRequest request, HttpServletResponse response, String groupId, ONAPLoggingContext loggingContext) throws IOException {
1806                 try {
1807                         String parameterDefault = request.getParameter("default");
1808                         String pdpId = request.getParameter("pdpId");
1809                         String pdpGroup = request.getParameter("getPDPGroup");
1810                         if ("".equals(groupId)) {
1811                                 // request IS from AC but does not identify a group by name
1812                                 if (parameterDefault != null) {
1813                                         // Request is for the Default group (whatever its id)
1814                                         loggingContext.setServiceName("AC:PAP.getDefaultGroup");
1815                                         OnapPDPGroup group = papEngine.getDefaultGroup();
1816                                         // convert response object to JSON and include in the response
1817                                         mapperWriteValue(new ObjectMapper(), response,  group);
1818                                         if (LOGGER.isDebugEnabled()) {
1819                                                 LOGGER.debug("GET Default group req from '" + request.getRequestURL() + "'");
1820                                         }
1821                                         response.setStatus(HttpServletResponse.SC_OK);
1822                                         response.setHeader("content-type", "application/json");
1823                                         try{
1824                         response.getOutputStream().close();
1825                     } catch (IOException e){
1826                         LOGGER.error(e);
1827                     }
1828                                         loggingContext.transactionEnded();
1829                                         auditLogger.info("Success");
1830                                         PolicyLogger.audit("Transaction Ended Successfully");
1831                                         return;
1832                                 } else if (pdpId != null) {
1833                                         // Request is related to a PDP
1834                                         if (pdpGroup == null) {
1835                                                 // Request is for the (unspecified) group containing a given PDP
1836                                                 loggingContext.setServiceName("AC:PAP.getPDP");
1837                                                 OnapPDP pdp = null;
1838                                                 try{
1839                                                     pdp = papEngine.getPDP(pdpId);
1840                                                 }catch(PAPException e){
1841                                                     LOGGER.error(e);
1842                                                 }
1843                                                 // convert response object to JSON and include in the response
1844                                                 mapperWriteValue(new ObjectMapper(), response,  pdp);
1845                                                 if (LOGGER.isDebugEnabled()) {
1846                                                         LOGGER.debug("GET pdp '" + pdpId + "' req from '" + request.getRequestURL() + "'");
1847                                                 }
1848                                                 response.setStatus(HttpServletResponse.SC_OK);
1849                                                 response.setHeader("content-type", "application/json");
1850                                                 try{
1851                             response.getOutputStream().close();
1852                         } catch (IOException e){
1853                             LOGGER.error(e);
1854                         }
1855                                                 loggingContext.transactionEnded();
1856                                                 auditLogger.info("Success");
1857                                                 PolicyLogger.audit("Transaction Ended Successfully");
1858                                                 return;
1859                                         } else {
1860                                                 // Request is for the group containing a given PDP
1861                                                 loggingContext.setServiceName("AC:PAP.getGroupForPDP");
1862                                                 OnapPDPGroup group =null;
1863                                                 try{
1864                                                     OnapPDP pdp = papEngine.getPDP(pdpId);
1865                                 group = papEngine.getPDPGroup((OnapPDP) pdp);
1866                                                 }catch(PAPException e){
1867                                                     LOGGER.error(e);
1868                                                 }
1869                                                 // convert response object to JSON and include in the response
1870                                                 mapperWriteValue(new ObjectMapper(), response,  group);
1871                                                 if (LOGGER.isDebugEnabled()) {
1872                                                         LOGGER.debug("GET PDP '" + pdpId + "' Group req from '" + request.getRequestURL() + "'");
1873                                                 }
1874                                                 response.setStatus(HttpServletResponse.SC_OK);
1875                                                 response.setHeader("content-type", "application/json");
1876                                                 try{
1877                                 response.getOutputStream().close();
1878                             } catch (IOException e){
1879                                 LOGGER.error(e);
1880                             }
1881                                                 loggingContext.transactionEnded();
1882                                                 auditLogger.info("Success");
1883                                                 PolicyLogger.audit("Transaction Ended Successfully");
1884                                                 return;
1885                                         }
1886                                 } else {
1887                                         // request is for top-level properties about all groups
1888                                         loggingContext.setServiceName("AC:PAP.getAllGroups");
1889                                         Set<OnapPDPGroup> groups = papEngine.getOnapPDPGroups();
1890                                         // convert response object to JSON and include in the response
1891                                         mapperWriteValue(new ObjectMapper(), response,  groups);
1892                                         if (LOGGER.isDebugEnabled()) {
1893                                                 LOGGER.debug("GET All groups req");
1894                                         }
1895                                         response.setStatus(HttpServletResponse.SC_OK);
1896                                         response.setHeader("content-type", "application/json");
1897                                         try{
1898                             response.getOutputStream().close();
1899                         } catch (IOException e){
1900                             LOGGER.error(e);
1901                         }
1902                                         loggingContext.transactionEnded();
1903                                         auditLogger.info("Success");
1904                                         PolicyLogger.audit("Transaction Ended Successfully");
1905                                         return;
1906                                 }
1907                         }
1908                         // for all other GET operations the group must exist before the operation can be done
1909                         OnapPDPGroup group = null;
1910                         try{
1911                             group = papEngine.getGroup(groupId);
1912                         } catch(PAPException e){
1913                             LOGGER.error(e);
1914                         }
1915                         if (group == null) {
1916                                 String message = "Unknown groupId '" + groupId + "'";
1917                                 PolicyLogger.error(MessageCodes.ERROR_DATA_ISSUE + " " + message);
1918                                 loggingContext.transactionEnded();
1919                                 PolicyLogger.audit("Transaction Failed - See Error.log");
1920                                 setResponseError(response,HttpServletResponse.SC_NOT_FOUND, message);
1921                                 return;
1922                         }
1923                         // Figure out which request this is based on the parameters
1924                         String policyId = request.getParameter("policyId");
1925                         if (policyId != null) {
1926                                 // retrieve a policy
1927                                 loggingContext.setServiceName("AC:PAP.getPolicy");
1928                                 // convert response object to JSON and include in the response
1929                                 PolicyLogger.error(MessageCodes.ERROR_DATA_ISSUE + " GET Policy not implemented");
1930                                 loggingContext.transactionEnded();
1931                                 PolicyLogger.audit("Transaction Failed - See Error.log");
1932                                 setResponseError(response,HttpServletResponse.SC_BAD_REQUEST, "GET Policy not implemented");
1933                         } else {
1934                                 // No other parameters, so return the identified Group
1935                                 loggingContext.setServiceName("AC:PAP.getGroup");
1936                                 // convert response object to JSON and include in the response
1937                                 mapperWriteValue(new ObjectMapper(), response,  group);
1938                                 if (LOGGER.isDebugEnabled()) {
1939                                         LOGGER.debug("GET group '" + group.getId() + "' req from '" + request.getRequestURL() + "'");
1940                                 }
1941                                 response.setStatus(HttpServletResponse.SC_OK);
1942                                 response.setHeader("content-type", "application/json");
1943                                 try{
1944                                     response.getOutputStream().close();
1945                                 } catch (IOException e){
1946                                     LOGGER.error(e);
1947                                 }
1948                                 loggingContext.transactionEnded();
1949                                 auditLogger.info("Success");
1950                                 PolicyLogger.audit("Transaction Ended Successfully");
1951                                 return;
1952                         }
1953                         // Currently there are no other GET calls from the AC.
1954                         // The AC uses the "GET All Groups" operation to fill its local cache and uses that cache for all other GETs without calling the PAP.
1955                         // Other GETs that could be called:
1956                         //                              Specific Group  (groupId=<groupId>)
1957                         //                              A Policy                (groupId=<groupId> policyId=<policyId>)
1958                         //                              A PDP                   (groupId=<groupId> pdpId=<pdpId>)
1959                         PolicyLogger.error(MessageCodes.ERROR_DATA_ISSUE + " UNIMPLEMENTED ");
1960                         loggingContext.transactionEnded();
1961                         PolicyLogger.audit("Transaction Failed - See Error.log");
1962                         setResponseError(response,HttpServletResponse.SC_BAD_REQUEST, "UNIMPLEMENTED");
1963                 } catch (PAPException e) {
1964                         PolicyLogger.error(MessageCodes.ERROR_PROCESS_FLOW, e, "XACMLPapServlet", " AC Get exception");
1965                         loggingContext.transactionEnded();
1966                         PolicyLogger.audit("Transaction Failed - See Error.log");
1967                         setResponseError(response,HttpServletResponse.SC_INTERNAL_SERVER_ERROR, e.getMessage());
1968                         return;
1969                 }
1970         }
1971
1972         /**
1973          * Requests from the Admin Console to create new items or update existing ones
1974          *
1975          * @param request
1976          * @param response
1977          * @param groupId
1978          * @param loggingContext
1979          * @throws ServletException
1980          * @throws IOException
1981          */
1982         private void doACPut(HttpServletRequest request, HttpServletResponse response, String groupId, ONAPLoggingContext loggingContext) throws IOException {
1983                 PolicyDBDaoTransaction acPutTransaction = policyDBDao.getNewTransaction();
1984                 try {
1985                         // for PUT operations the group may or may not need to exist before the operation can be done
1986                         OnapPDPGroup group = papEngine.getGroup(groupId);
1987                         // determine the operation needed based on the parameters in the request
1988                         // for remaining operations the group must exist before the operation can be done
1989                         if (group == null) {
1990                                 String message = "Unknown groupId '" + groupId + "'";
1991                                 PolicyLogger.error(MessageCodes.ERROR_DATA_ISSUE + " " + message);
1992                                 loggingContext.transactionEnded();
1993                                 PolicyLogger.audit("Transaction Failed - See Error.log");
1994                                 setResponseError(response,HttpServletResponse.SC_NOT_FOUND, message);
1995                                 return;
1996                         }
1997                         if (request.getParameter("policy") != null) {
1998                                 //        group=<groupId> policy=<policyId> contents=policy file               <= Create new policy file in group dir, or replace it if it already exists (do not touch properties)
1999                                 loggingContext.setServiceName("AC:PAP.putPolicy");
2000                                 PolicyLogger.error(MessageCodes.ERROR_DATA_ISSUE + " PARTIALLY IMPLEMENTED!!!  ACTUAL CHANGES SHOULD BE MADE BY PAP SERVLET!!! ");
2001                                 response.setStatus(HttpServletResponse.SC_NO_CONTENT);
2002                                 loggingContext.transactionEnded();
2003                                 PolicyLogger.audit("Transaction Failed - See Error.log");
2004                                 auditLogger.info("Success");
2005                                 PolicyLogger.audit("Transaction Ended Successfully");
2006                                 return;
2007                         } else if (request.getParameter("pdpId") != null) {
2008                                 // ARGS:        group=<groupId> pdpId=<pdpId/URL>          <= create a new PDP or Update an Existing one
2009                                 String pdpId = request.getParameter("pdpId");
2010                                 if (papEngine.getPDP(pdpId) == null) {
2011                                         loggingContext.setServiceName("AC:PAP.createPDP");
2012                                 } else {
2013                                         loggingContext.setServiceName("AC:PAP.updatePDP");
2014                                 }
2015                                 // get the request content into a String
2016                                 String json = null;
2017                                 // read the inputStream into a buffer (trick found online scans entire input looking for end-of-file)
2018                                 try{
2019                                     Scanner scanner = new Scanner(request.getInputStream());
2020                                     scanner.useDelimiter("\\A");
2021                         json =  scanner.hasNext() ? scanner.next() : "";
2022                         scanner.close();
2023                                 }catch(IOException e){
2024                                     LOGGER.error(e);
2025                                 }
2026                                 LOGGER.info("JSON request from AC: " + json);
2027                                 // convert Object sent as JSON into local object
2028                                 ObjectMapper mapper = new ObjectMapper();
2029                                 Object objectFromJSON = mapper.readValue(json, StdPDP.class);
2030                                 if (pdpId == null ||
2031                                                 objectFromJSON == null ||
2032                                                 ! (objectFromJSON instanceof StdPDP) ||
2033                                                 ((StdPDP)objectFromJSON).getId() == null ||
2034                                                 ! ((StdPDP)objectFromJSON).getId().equals(pdpId)) {
2035                                         PolicyLogger.error(MessageCodes.ERROR_DATA_ISSUE + " PDP new/update had bad input. pdpId=" + pdpId + " objectFromJSON="+objectFromJSON);
2036                                         loggingContext.transactionEnded();
2037                                         PolicyLogger.audit("Transaction Failed - See Error.log");
2038                                         setResponseError(response,HttpServletResponse.SC_INTERNAL_SERVER_ERROR, "Bad input, pdpid="+pdpId+" object="+objectFromJSON);
2039                                 }
2040                                 StdPDP pdp = (StdPDP) objectFromJSON;
2041                                 if(pdp != null){
2042                                     OnapPDP oPDP = null;
2043                                     try{
2044                                         oPDP = papEngine.getPDP(pdpId);
2045                                     }catch (PAPException e){
2046                                         LOGGER.error(e);
2047                                     }
2048                                         if (oPDP == null) {
2049                                                 // this is a request to create a new PDP object
2050                                                 try{
2051                                                         acPutTransaction.addPdpToGroup(pdp.getId(), group.getId(), pdp.getName(),
2052                                                                         pdp.getDescription(), pdp.getJmxPort(),"XACMLPapServlet.doACPut");
2053                                                 } catch(Exception e){
2054                                                         PolicyLogger.error(MessageCodes.ERROR_PROCESS_FLOW, e, "XACMLPapServlet", " Error while adding pdp to group in the database: "
2055                                                                         +"pdp="+ (pdp.getId()) +",to group="+group.getId());
2056                                                         throw new PAPException(e.getMessage());
2057                                                 }
2058                                                 try{
2059                                                     papEngine.newPDP(pdp.getId(), group, pdp.getName(), pdp.getDescription(), pdp.getJmxPort());
2060                                                 }catch(PAPException e){
2061                                                     LOGGER.error(e);
2062                                                 }
2063                                         } else {
2064                                                 try{
2065                                                         acPutTransaction.updatePdp(pdp, "XACMLPapServlet.doACPut");
2066                                                 } catch(Exception e){
2067                                                         PolicyLogger.error(MessageCodes.ERROR_PROCESS_FLOW, e, "XACMLPapServlet", " Error while updating pdp in the database: "
2068                                                                         +"pdp="+ pdp.getId());
2069                                                         throw new PAPException(e.getMessage());
2070                                                 }
2071                                                 // this is a request to update the pdp
2072                                                 try{
2073                                                     papEngine.updatePDP(pdp);
2074                                                 }catch(PAPException e){
2075                             LOGGER.error(e);
2076                         }
2077                                         }
2078                                         response.setStatus(HttpServletResponse.SC_NO_CONTENT);
2079                                         if (LOGGER.isDebugEnabled()) {
2080                                                 LOGGER.debug("PDP '" + pdpId + "' created/updated");
2081                                         }
2082                                         // adjust the group's state including the new PDP
2083                                         ((StdPDPGroup)group).resetStatus();
2084                                         // tell the Admin Consoles there is a change
2085                                         loggingContext.metricStarted();
2086                                         notifyAC();
2087                                         loggingContext.metricEnded();
2088                                         PolicyLogger.metrics("XACMLPapServlet doACPut notifyAC");
2089                                         // this might affect the PDP, so notify it of the change
2090                                         pdpChanged(pdp, loggingContext);
2091                                         loggingContext.metricStarted();
2092                                         acPutTransaction.commitTransaction();
2093                                         loggingContext.metricEnded();
2094                                         PolicyLogger.metrics("XACMLPapServlet doACPut commitTransaction");
2095                                         loggingContext.transactionEnded();
2096                                         auditLogger.info("Success");
2097                                         PolicyLogger.audit("Transaction Ended Successfully");
2098                                         return;
2099                                 }else{
2100                                         try{
2101                                                 PolicyLogger.error(MessageCodes.ERROR_PROCESS_FLOW, "XACMLPapServlet", " Error while adding pdp to group in the database: "
2102                                                                 +"pdp=null" + ",to group="+group.getId());
2103                                                 throw new PAPException("PDP is null");
2104                                         } catch(Exception e){
2105                                                 throw new PAPException("PDP is null" + e.getMessage() +e);
2106                                         }
2107                                 }
2108                         } else if (request.getParameter("pipId") != null) {
2109                                 //                group=<groupId> pipId=<pipEngineId> contents=pip properties              <= add a PIP to pip config, or replace it if it already exists (lenient operation)
2110                                 loggingContext.setServiceName("AC:PAP.putPIP");
2111                                 PolicyLogger.error(MessageCodes.ERROR_SYSTEM_ERROR + " UNIMPLEMENTED");
2112                                 loggingContext.transactionEnded();
2113                                 PolicyLogger.audit("Transaction Failed - See Error.log");
2114                                 setResponseError(response,HttpServletResponse.SC_BAD_REQUEST, "UNIMPLEMENTED");
2115                                 return;
2116                         } else {
2117                                 // Assume that this is an update of an existing PDP Group
2118                                 // ARGS:        group=<groupId>         <= Update an Existing Group
2119                                 loggingContext.setServiceName("AC:PAP.updateGroup");
2120                                 // get the request content into a String
2121                                 String json = null;
2122                                 // read the inputStream into a buffer (trick found online scans entire input looking for end-of-file)
2123                 try{
2124                     Scanner scanner = new Scanner(request.getInputStream());
2125                     scanner.useDelimiter("\\A");
2126                     json =  scanner.hasNext() ? scanner.next() : "";
2127                     scanner.close();
2128                 }catch(IOException e){
2129                     LOGGER.error(e);
2130                 }
2131                                 LOGGER.info("JSON request from AC: " + json);
2132                                 // convert Object sent as JSON into local object
2133                                 ObjectMapper mapper = new ObjectMapper();
2134                                 Object objectFromJSON  = mapper.readValue(json, StdPDPGroup.class);
2135                                 if (objectFromJSON == null || ! (objectFromJSON instanceof StdPDPGroup) ||
2136                                                 ! ((StdPDPGroup)objectFromJSON).getId().equals(group.getId())) {
2137                                         PolicyLogger.error(MessageCodes.ERROR_DATA_ISSUE + " Group update had bad input. id=" + group.getId() + " objectFromJSON="+objectFromJSON);
2138                                         loggingContext.transactionEnded();
2139                                         PolicyLogger.audit("Transaction Failed - See Error.log");
2140                                         setResponseError(response,HttpServletResponse.SC_INTERNAL_SERVER_ERROR, "Bad input, id="+group.getId() +" object="+objectFromJSON);
2141                                 }
2142                                 // The Path on the PAP side is not carried on the RESTful interface with the AC
2143                                 // (because it is local to the PAP)
2144                                 // so we need to fill that in before submitting the group for update
2145                                 if(objectFromJSON != null){
2146                                         ((StdPDPGroup)objectFromJSON).setDirectory(((StdPDPGroup)group).getDirectory());
2147                                 }
2148                                 try{
2149                                         acPutTransaction.updateGroup((StdPDPGroup)objectFromJSON, "XACMLPapServlet.doACPut");
2150                                 } catch(Exception e){
2151                                         PolicyLogger.error(MessageCodes.ERROR_PROCESS_FLOW + " Error while updating group in the database: "
2152                                                         +"group="+group.getId());
2153                                         LOGGER.error(e);
2154                                         throw new PAPException(e.getMessage());
2155                                 }
2156
2157                                 PushPolicyHandler pushPolicyHandler = PushPolicyHandler.getInstance();
2158                                 OnapPDPGroup updatedGroup = (StdPDPGroup)objectFromJSON;
2159                                 if (pushPolicyHandler.preSafetyCheck(updatedGroup, configHome)) {
2160                                         LOGGER.debug("Precheck Successful.");
2161                                 }
2162                                 try{
2163                                     papEngine.updateGroup((StdPDPGroup)objectFromJSON);
2164                                 }catch(PAPException e){
2165                                     LOGGER.error(e);
2166                                 }
2167                                 response.setStatus(HttpServletResponse.SC_NO_CONTENT);
2168                                 if (LOGGER.isDebugEnabled()) {
2169                                         LOGGER.debug("Group '" + group.getId() + "' updated");
2170                                 }
2171                                 loggingContext.metricStarted();
2172                                 acPutTransaction.commitTransaction();
2173                                 loggingContext.metricEnded();
2174                                 PolicyLogger.metrics("XACMLPapServlet doACPut commitTransaction");
2175                                 // tell the Admin Consoles there is a change
2176                                 loggingContext.metricStarted();
2177                                 notifyAC();
2178                                 loggingContext.metricEnded();
2179                                 PolicyLogger.metrics("XACMLPapServlet doACPut notifyAC");
2180                                 // Group changed, which might include changing the policies
2181                                 groupChanged(group, loggingContext);
2182                                 loggingContext.transactionEnded();
2183                                 auditLogger.info("Success");
2184                                 PolicyLogger.audit("Transaction Ended Successfully");
2185                                 return;
2186                         }
2187                 } catch (PAPException e) {
2188                         LOGGER.debug(e);
2189                         acPutTransaction.rollbackTransaction();
2190                         PolicyLogger.error(MessageCodes.ERROR_PROCESS_FLOW, e, "XACMLPapServlet", " AC PUT exception");
2191                         loggingContext.transactionEnded();
2192                         PolicyLogger.audit("Transaction Failed - See Error.log");
2193                         setResponseError(response,HttpServletResponse.SC_INTERNAL_SERVER_ERROR, e.getMessage());
2194                         return;
2195                 }
2196         }
2197
2198         /**
2199          * Requests from the Admin Console to delete/remove items
2200          *
2201          * @param request
2202          * @param response
2203          * @param groupId
2204          * @param loggingContext
2205          * @throws ServletException
2206          * @throws IOException
2207          */
2208         private void doACDelete(HttpServletRequest request, HttpServletResponse response, String groupId, ONAPLoggingContext loggingContext) throws IOException {
2209                 //This code is to allow deletes to propagate to the database since delete is not implemented
2210                 String isDeleteNotify = request.getParameter("isDeleteNotify");
2211                 if(isDeleteNotify != null){
2212                         String policyToDelete = request.getParameter("policyToDelete");
2213                         try{
2214                                 policyToDelete = URLDecoder.decode(policyToDelete,"UTF-8");
2215                         } catch(UnsupportedEncodingException e){
2216                                 LOGGER.error("Unsupported URL encoding of policyToDelete (UTF-8", e);
2217                                 setResponseError(response,HttpServletResponse.SC_INTERNAL_SERVER_ERROR,"policyToDelete encoding not supported");
2218                                 return;
2219                         }
2220                         PolicyDBDaoTransaction deleteTransaction = policyDBDao.getNewTransaction();
2221                         try{
2222                                 deleteTransaction.deletePolicy(policyToDelete);
2223                         } catch(Exception e){
2224                                 deleteTransaction.rollbackTransaction();
2225                                 setResponseError(response,HttpServletResponse.SC_INTERNAL_SERVER_ERROR,"deleteTransaction.deleteTransaction(policyToDelete) "
2226                                                 + "\nfailure with the following exception: " + e);
2227                                 return;
2228                         }
2229                         loggingContext.metricStarted();
2230                         deleteTransaction.commitTransaction();
2231                         loggingContext.metricEnded();
2232                         PolicyLogger.metrics("XACMLPapServlet doACPut commitTransaction");
2233                         response.setStatus(HttpServletResponse.SC_OK);
2234                         return;
2235                 }
2236                 PolicyDBDaoTransaction removePdpOrGroupTransaction = policyDBDao.getNewTransaction();
2237                 try {
2238                         // for all DELETE operations the group must exist before the operation can be done
2239                         loggingContext.setServiceName("AC:PAP.delete");
2240                         OnapPDPGroup group = papEngine.getGroup(groupId);
2241                         if (group == null) {
2242                                 String message = "Unknown groupId '" + groupId + "'";
2243                                 PolicyLogger.error(MessageCodes.ERROR_DATA_ISSUE + " " + message);
2244                                 loggingContext.transactionEnded();
2245                                 PolicyLogger.audit("Transaction Failed - See Error.log");
2246                                 setResponseError(response,HttpServletResponse.SC_NOT_FOUND, "Unknown groupId '" + groupId +"'");
2247                                 return;
2248                         }
2249                         // determine the operation needed based on the parameters in the request
2250                         if (request.getParameter("policy") != null) {
2251                                 //        group=<groupId> policy=<policyId>  [delete=<true|false>]       <= delete policy file from group
2252                                 loggingContext.setServiceName("AC:PAP.deletePolicy");
2253                                 PolicyLogger.error(MessageCodes.ERROR_SYSTEM_ERROR + " UNIMPLEMENTED");
2254                                 loggingContext.transactionEnded();
2255                                 PolicyLogger.audit("Transaction Failed - See Error.log");
2256                                 setResponseError(response,HttpServletResponse.SC_BAD_REQUEST, "UNIMPLEMENTED");
2257                                 return;
2258                         } else if (request.getParameter("pdpId") != null) {
2259                                 // ARGS:        group=<groupId> pdpId=<pdpId>                  <= delete PDP
2260                                 String pdpId = request.getParameter("pdpId");
2261                                 OnapPDP pdp = papEngine.getPDP(pdpId);
2262                                 try{
2263                                         removePdpOrGroupTransaction.removePdpFromGroup(pdp.getId(),"XACMLPapServlet.doACDelete");
2264                                 } catch(Exception e){
2265                                         throw new PAPException(e);
2266                                 }
2267                                 try{
2268                         papEngine.removePDP((OnapPDP) pdp);
2269                                 }catch(PAPException e){
2270                     LOGGER.error(e);
2271                 }
2272                                 // adjust the status of the group, which may have changed when we removed this PDP
2273                                 ((StdPDPGroup)group).resetStatus();
2274                                 response.setStatus(HttpServletResponse.SC_NO_CONTENT);
2275                                 loggingContext.metricStarted();
2276                                 notifyAC();
2277                                 loggingContext.metricEnded();
2278                                 PolicyLogger.metrics("XACMLPapServlet doACPut notifyAC");
2279                                 // update the PDP and tell it that it has NO Policies (which prevents it from serving PEP Requests)
2280                                 pdpChanged(pdp, loggingContext);
2281                                 loggingContext.metricStarted();
2282                                 removePdpOrGroupTransaction.commitTransaction();
2283                                 loggingContext.metricEnded();
2284                                 PolicyLogger.metrics("XACMLPapServlet doACPut commitTransaction");
2285                                 loggingContext.transactionEnded();
2286                                 auditLogger.info("Success");
2287                                 PolicyLogger.audit("Transaction Ended Successfully");
2288                                 return;
2289                         } else if (request.getParameter("pipId") != null) {
2290                                 //        group=<groupId> pipId=<pipEngineId> <= delete PIP config for given engine
2291                                 loggingContext.setServiceName("AC:PAP.deletePIPConfig");
2292                                 PolicyLogger.error(MessageCodes.ERROR_SYSTEM_ERROR + " UNIMPLEMENTED");
2293                                 loggingContext.transactionEnded();
2294                                 PolicyLogger.audit("Transaction Failed - See Error.log");
2295                                 setResponseError(response,HttpServletResponse.SC_BAD_REQUEST, "UNIMPLEMENTED");
2296                                 return;
2297                         } else {
2298                                 // ARGS:      group=<groupId> movePDPsToGroupId=<movePDPsToGroupId>            <= delete a group and move all its PDPs to the given group
2299                                 String moveToGroupId = request.getParameter("movePDPsToGroupId");
2300                                 OnapPDPGroup moveToGroup = null;
2301                                 if (moveToGroupId != null) {
2302                                     try{
2303                                         moveToGroup = papEngine.getGroup(moveToGroupId);
2304                                     }catch(PAPException e){
2305                             LOGGER.error(e);
2306                         }
2307                                 }
2308                                 // get list of PDPs in the group being deleted so we can notify them that they got changed
2309                                 Set<OnapPDP> movedPDPs = new HashSet<>();
2310                                 movedPDPs.addAll(group.getOnapPdps());
2311                                 // do the move/remove
2312                                 try{
2313                                         removePdpOrGroupTransaction.deleteGroup(group, moveToGroup,"XACMLPapServlet.doACDelete");
2314                                 } catch(Exception e){
2315                                         PolicyLogger.error(MessageCodes.ERROR_UNKNOWN, e, "XACMLPapServlet", " Failed to delete PDP Group. Exception");
2316                                         throw new PAPException(e.getMessage());
2317                                 }
2318                                 try{
2319                                     papEngine.removeGroup(group, moveToGroup);
2320                                 }catch(PAPException e){
2321                     LOGGER.error(e);
2322                 }
2323                                 response.setStatus(HttpServletResponse.SC_NO_CONTENT);
2324                                 loggingContext.metricStarted();
2325                                 notifyAC();
2326                                 loggingContext.metricEnded();
2327                                 PolicyLogger.metrics("XACMLPapServlet doACPut notifyAC");
2328                                 // notify any PDPs in the removed set that their config may have changed
2329                                 for (OnapPDP pdp : movedPDPs) {
2330                                         pdpChanged(pdp, loggingContext);
2331                                 }
2332                                 loggingContext.metricStarted();
2333                                 removePdpOrGroupTransaction.commitTransaction();
2334                                 loggingContext.metricEnded();
2335                                 PolicyLogger.metrics("XACMLPapServlet doACPut commitTransaction");
2336                                 loggingContext.transactionEnded();
2337                                 auditLogger.info("Success");
2338                                 PolicyLogger.audit("Transaction Ended Successfully");
2339                                 return;
2340                         }
2341                 } catch (PAPException e) {
2342                         removePdpOrGroupTransaction.rollbackTransaction();
2343                         PolicyLogger.error(MessageCodes.ERROR_PROCESS_FLOW, e, "XACMLPapServlet", " AC DELETE exception");
2344                         loggingContext.transactionEnded();
2345                         PolicyLogger.audit("Transaction Failed - See Error.log");
2346                         setResponseError(response,HttpServletResponse.SC_INTERNAL_SERVER_ERROR, e.getMessage());
2347                         return;
2348                 }
2349         }
2350
2351         /**
2352          * Heartbeat thread - periodically check on PDPs' status
2353          *
2354          * Heartbeat with all known PDPs.
2355          *
2356          * Implementation note:
2357          *
2358          * The PDPs are contacted Sequentially, not in Parallel.
2359          *
2360          * If we did this in parallel using multiple threads we would simultaneously use
2361          *              - 1 thread and
2362          *              - 1 connection
2363          * for EACH PDP.
2364          * This could become a resource problem since we already use multiple threads and connections for updating the PDPs
2365          * when user changes occur.
2366          * Using separate threads can also make it tricky dealing with timeouts on PDPs that are non-responsive.
2367          *
2368          * The Sequential operation does a heartbeat request to each PDP one at a time.
2369          * This has the flaw that any PDPs that do not respond will hold up the entire heartbeat sequence until they timeout.
2370          * If there are a lot of non-responsive PDPs and the timeout is large-ish (the default is 20 seconds)
2371          * it could take a long time to cycle through all of the PDPs.
2372          * That means that this may not notice a PDP being down in a predictable time.
2373          */
2374         private class Heartbeat implements Runnable {
2375                 private PAPPolicyEngine papEngine;
2376                 private Set<OnapPDP> pdps = new HashSet<>();
2377                 private int heartbeatInterval;
2378                 private int heartbeatTimeout;
2379
2380                 public volatile boolean isRunning = false;
2381
2382                 public synchronized boolean isRunning() {
2383                         return this.isRunning;
2384                 }
2385
2386                 public synchronized void terminate() {
2387                         this.isRunning = false;
2388                 }
2389
2390                 public Heartbeat(PAPPolicyEngine papEngine2) {
2391                         papEngine = papEngine2;
2392                         this.heartbeatInterval = Integer.parseInt(XACMLProperties.getProperty(XACMLRestProperties.PROP_PAP_HEARTBEAT_INTERVAL, "10000"));
2393                         this.heartbeatTimeout = Integer.parseInt(XACMLProperties.getProperty(XACMLRestProperties.PROP_PAP_HEARTBEAT_TIMEOUT, "10000"));
2394                 }
2395
2396                 @Override
2397                 public void run() {
2398                         // Set ourselves as running
2399                         synchronized(this) {
2400                                 this.isRunning = true;
2401                         }
2402                         HashMap<String, URL> idToURLMap = new HashMap<>();
2403                         try {
2404                                 while (this.isRunning()) {
2405                                         // Wait the given time
2406                                         Thread.sleep(heartbeatInterval);
2407                                         // get the list of PDPs (may have changed since last time)
2408                                         pdps.clear();
2409                                         synchronized(papEngine) {
2410                                                 try {
2411                                                         for (OnapPDPGroup g : papEngine.getOnapPDPGroups()) {
2412                                                                 for (OnapPDP p : g.getOnapPdps()) {
2413                                                                         pdps.add(p);
2414                                                                 }
2415                                                         }
2416                                                 } catch (PAPException e) {
2417                                                         PolicyLogger.error(MessageCodes.ERROR_SYSTEM_ERROR, e, "XACMLPapServlet", "Heartbeat unable to read PDPs from PAPEngine");
2418                                                 }
2419                                         }
2420                                         // Check for shutdown
2421                                         if (this.isRunning() == false) {
2422                                                 LOGGER.info("isRunning is false, getting out of loop.");
2423                                                 break;
2424                                         }
2425                                         // try to get the summary status from each PDP
2426                                         boolean changeSeen = false;
2427                                         for (OnapPDP pdp : pdps) {
2428                                                 // Check for shutdown
2429                                                 if (this.isRunning() == false) {
2430                                                         LOGGER.info("isRunning is false, getting out of loop.");
2431                                                         break;
2432                                                 }
2433                                                 // the id of the PDP is its url (though we add a query parameter)
2434                                                 URL pdpURL = idToURLMap.get(pdp.getId());
2435                                                 if (pdpURL == null) {
2436                                                         // haven't seen this PDP before
2437                                                         String fullURLString = null;
2438                                                         try {
2439                                                                 // Check PDP ID
2440                                                                 if(CheckPDP.validateID(pdp.getId())){
2441                                                                         fullURLString = pdp.getId() + "?type=hb";
2442                                                                         pdpURL = new URL(fullURLString);
2443                                                                         idToURLMap.put(pdp.getId(), pdpURL);
2444                                                                 }
2445                                                         } catch (MalformedURLException e) {
2446                                                                 PolicyLogger.error(MessageCodes.ERROR_DATA_ISSUE, e, "XACMLPapServlet", " PDP id '" + fullURLString + "' is not a valid URL");
2447                                                                 continue;
2448                                                         }
2449                                                 }
2450                                                 // Do a GET with type HeartBeat
2451                                                 String newStatus = "";
2452                                                 HttpURLConnection connection = null;
2453                                                 try {
2454                                                         // Open up the connection
2455                                                         if(pdpURL != null){
2456                                                                 connection = (HttpURLConnection)pdpURL.openConnection();
2457                                                                 // Setup our method and headers
2458                                                                 connection.setRequestMethod("GET");
2459                                                                 connection.setConnectTimeout(heartbeatTimeout);
2460                                                                 // Authentication
2461                                                                 String encoding = CheckPDP.getEncoding(pdp.getId());
2462                                                                 if(encoding !=null){
2463                                                                         connection.setRequestProperty("Authorization", "Basic " + encoding);
2464                                                                 }
2465                                                                 // Do the connect
2466                                                                 connection.connect();
2467                                                                 if (connection.getResponseCode() == 204) {
2468                                                                         newStatus = connection.getHeaderField(XACMLRestProperties.PROP_PDP_HTTP_HEADER_HB);
2469                                                                         if (LOGGER.isDebugEnabled()) {
2470                                                                                 LOGGER.debug("Heartbeat '" + pdp.getId() + "' status='" + newStatus + "'");
2471                                                                         }
2472                                                                 } else {
2473                                                                         // anything else is an unexpected result
2474                                                                         newStatus = PDPStatus.Status.UNKNOWN.toString();
2475                                                                         PolicyLogger.error(MessageCodes.ERROR_SYSTEM_ERROR + " Heartbeat connect response code " + connection.getResponseCode() + ": " + pdp.getId());
2476                                                                 }
2477                                                         }
2478                                                 } catch (UnknownHostException e) {
2479                                                         newStatus = PDPStatus.Status.NO_SUCH_HOST.toString();
2480                                                         PolicyLogger.error(MessageCodes.ERROR_SYSTEM_ERROR, e, "XACMLPapServlet", " Heartbeat '" + pdp.getId() + "' NO_SUCH_HOST");
2481                                                 } catch (SocketTimeoutException e) {
2482                                                         newStatus = PDPStatus.Status.CANNOT_CONNECT.toString();
2483                                                         PolicyLogger.error(MessageCodes.ERROR_SYSTEM_ERROR, e, "XACMLPapServlet", " Heartbeat '" + pdp.getId() + "' connection timeout");
2484                                                 } catch (ConnectException e) {
2485                                                         newStatus = PDPStatus.Status.CANNOT_CONNECT.toString();
2486                                                         PolicyLogger.error(MessageCodes.ERROR_SYSTEM_ERROR, e, "XACMLPapServlet", " Heartbeat '" + pdp.getId() + "' cannot connect");
2487                                                 } catch (Exception e) {
2488                                                         newStatus = PDPStatus.Status.UNKNOWN.toString();
2489                                                         PolicyLogger.error(MessageCodes.ERROR_SYSTEM_ERROR, e, "XACMLPapServlet", "Heartbeat '" + pdp.getId() + "' connect exception");
2490                                                 } finally {
2491                                                         // cleanup the connection
2492                                                         if(connection != null)
2493                                                                 connection.disconnect();
2494                                                 }
2495                                                 if ( ! pdp.getStatus().getStatus().toString().equals(newStatus)) {
2496                                                         if (LOGGER.isDebugEnabled()) {
2497                                                                 LOGGER.debug("previous status='" + pdp.getStatus().getStatus()+"'  new Status='" + newStatus + "'");
2498                                                         }
2499                                                         try {
2500                                                                 setPDPSummaryStatus(pdp, newStatus);
2501                                                         } catch (PAPException e) {
2502                                                                 PolicyLogger.error(MessageCodes.ERROR_PROCESS_FLOW, e, "XACMLPapServlet", "Unable to set state for PDP '" + pdp.getId());
2503                                                         }
2504                                                         changeSeen = true;
2505                                                 }
2506                                         }
2507                                         // Check for shutdown
2508                                         if (this.isRunning() == false) {
2509                                                 LOGGER.info("isRunning is false, getting out of loop.");
2510                                                 break;
2511                                         }
2512                                         // if any of the PDPs changed state, tell the ACs to update
2513                                         if (changeSeen) {
2514                                                 notifyAC();
2515                                         }
2516                                 }
2517                         } catch (InterruptedException e) {
2518                                 PolicyLogger.error(MessageCodes.ERROR_SYSTEM_ERROR + " Heartbeat interrupted.  Shutting down");
2519                                 this.terminate();
2520                                 Thread.currentThread().interrupt();
2521                         }
2522                 }
2523         }
2524
2525         /*
2526          * HELPER to change Group status when PDP status is changed
2527          * (Must NOT be called from a method that is synchronized on the papEngine or it may deadlock)
2528          */
2529         private void setPDPSummaryStatus(OnapPDP pdp, PDPStatus.Status newStatus) throws PAPException {
2530                 setPDPSummaryStatus(pdp, newStatus.toString());
2531         }
2532
2533         private void setPDPSummaryStatus(OnapPDP pdp, String newStatus) throws PAPException {
2534                 synchronized(papEngine) {
2535                         StdPDPStatus status = new StdPDPStatus();
2536                         status.setStatus(PDPStatus.Status.valueOf(newStatus));
2537                         ((StdPDP)pdp).setStatus(status);
2538                         // now adjust the group
2539                         StdPDPGroup group = (StdPDPGroup)papEngine.getPDPGroup((OnapPDP) pdp);
2540                         // if the PDP was just deleted it may transiently exist but not be in a group
2541                         if (group != null) {
2542                                 group.resetStatus();
2543                         }
2544                 }
2545         }
2546
2547         /*
2548          * Callback methods telling this servlet to notify PDPs of changes made by the PAP StdEngine
2549          * in the PDP group directories
2550          */
2551         @Override
2552         public void changed() {
2553                 // all PDPs in all groups need to be updated/sync'd
2554                 Set<OnapPDPGroup> groups;
2555                 try {
2556                         groups = papEngine.getOnapPDPGroups();
2557                 } catch (PAPException e) {
2558                         PolicyLogger.error(MessageCodes.ERROR_SYSTEM_ERROR, e, "XACMLPapServlet", " getPDPGroups failed");
2559                         throw new IllegalAccessError(XACMLErrorConstants.ERROR_SYSTEM_ERROR + "Unable to get Groups: " + e);
2560                 }
2561                 for (OnapPDPGroup group : groups) {
2562                         groupChanged(group);
2563                 }
2564         }
2565
2566         public void changed(ONAPLoggingContext loggingContext) {
2567                 // all PDPs in all groups need to be updated/sync'd
2568                 Set<OnapPDPGroup> groups;
2569                 try {
2570                         groups = papEngine.getOnapPDPGroups();
2571                 } catch (PAPException e) {
2572                         PolicyLogger.error(MessageCodes.ERROR_SYSTEM_ERROR, e, "XACMLPapServlet", " getPDPGroups failed");
2573                         throw new IllegalAccessError(XACMLErrorConstants.ERROR_SYSTEM_ERROR + "Unable to get Groups: " + e);
2574                 }
2575                 for (OnapPDPGroup group : groups) {
2576                         groupChanged(group, loggingContext);
2577                 }
2578         }
2579
2580         @Override
2581         public void groupChanged(OnapPDPGroup group) {
2582                 // all PDPs within one group need to be updated/sync'd
2583                 for (OnapPDP pdp : group.getOnapPdps()) {
2584                         pdpChanged(pdp);
2585                 }
2586         }
2587
2588         public void groupChanged(OnapPDPGroup group, ONAPLoggingContext loggingContext) {
2589                 // all PDPs within one group need to be updated/sync'd
2590                 for (OnapPDP pdp : group.getOnapPdps()) {
2591                         pdpChanged(pdp, loggingContext);
2592                 }
2593         }
2594
2595         @Override
2596          public void pdpChanged(OnapPDP pdp) {
2597                 // kick off a thread to do an event notification for each PDP.
2598                 // This needs to be on a separate thread so that PDPs that do not respond (down, non-existent, etc)
2599                 // do not block the PSP response to the AC, which would freeze the GUI until all PDPs sequentially respond or time-out.
2600                 Thread t = new Thread(new UpdatePDPThread(pdp));
2601                 if(CheckPDP.validateID(pdp.getId())){
2602                         t.start();
2603                 }
2604         }
2605
2606          public void pdpChanged(OnapPDP pdp, ONAPLoggingContext loggingContext) {
2607                 // kick off a thread to do an event notification for each PDP.
2608                 // This needs to be on a separate thread so that PDPs that do not respond (down, non-existent, etc)
2609                 // do not block the PSP response to the AC, which would freeze the GUI until all PDPs sequentially respond or time-out.
2610                 Thread t = new Thread(new UpdatePDPThread(pdp, loggingContext));
2611                 if(CheckPDP.validateID(pdp.getId())){
2612                         t.start();
2613                 }
2614         }
2615
2616         private class UpdatePDPThread implements Runnable {
2617                 private OnapPDP pdp;
2618                 private String requestId;
2619                 private ONAPLoggingContext loggingContext;
2620
2621                 public UpdatePDPThread(OnapPDP pdp) {
2622                         this.pdp = pdp;
2623                 }
2624
2625                 public UpdatePDPThread(OnapPDP pdp, ONAPLoggingContext loggingContext) {
2626                         this.pdp = pdp;
2627                         if (!(loggingContext == null)) {
2628                                 if (!(loggingContext.getRequestID() == null) || (loggingContext.getRequestID() == "")) {
2629                                         this.requestId = loggingContext.getRequestID();
2630                                 }
2631                         }
2632                         this.loggingContext = loggingContext;
2633                 }
2634
2635                 public void run() {
2636                         // send the current configuration to one PDP
2637                         HttpURLConnection connection = null;
2638                         // get a new logging context for the thread
2639                         try {
2640                                 if (this.loggingContext.equals(null)) {
2641                                      loggingContext = new ONAPLoggingContext(baseLoggingContext);
2642                                 }
2643                         } catch (Exception e) {
2644                             PolicyLogger.error(MessageCodes.ERROR_SYSTEM_ERROR, e, "XACMLPapServlet", " Failed to send property file to " + pdp.getId());
2645                             // Since this is a server-side error, it probably does not reflect a problem on the client,
2646                             // so do not change the PDP status.
2647                             return;
2648                 }
2649                         try {
2650                                 loggingContext.setServiceName("PAP:PDP.putConfig");
2651                                 // If a requestId was provided, use it, otherwise generate one; post to loggingContext to be used later when calling PDP
2652                                 if ((requestId == null) || (requestId == "")) {
2653                                         UUID requestID = UUID.randomUUID();
2654                                         loggingContext.setRequestID(requestID.toString());
2655                                         PolicyLogger.info("requestID not provided in call to XACMLPapSrvlet (UpdatePDPThread) so we generated one:  " + loggingContext.getRequestID());
2656                                 } else {
2657                                         loggingContext.setRequestID(requestId);
2658                                         PolicyLogger.info("requestID was provided in call to XACMLPapSrvlet (UpdatePDPThread):  " + loggingContext.getRequestID());
2659                                 }
2660                                 loggingContext.transactionStarted();
2661                                 // the Id of the PDP is its URL
2662                                 if (LOGGER.isDebugEnabled()) {
2663                                         LOGGER.debug("creating url for id '" + pdp.getId() + "'");
2664                                 }
2665                                 //TODO - currently always send both policies and pips.  Do we care enough to add code to allow sending just one or the other?
2666                                 //TODO          (need to change "cache=", implying getting some input saying which to change)
2667                                 URL url = new URL(pdp.getId() + "?cache=all");
2668                                 // Open up the connection
2669                                 connection = (HttpURLConnection)url.openConnection();
2670                                 // Setup our method and headers
2671                                 connection.setRequestMethod("PUT");
2672                                 // Authentication
2673                                 String encoding = CheckPDP.getEncoding(pdp.getId());
2674                                 if(encoding !=null){
2675                                         connection.setRequestProperty("Authorization", "Basic " + encoding);
2676                                 }
2677                                 connection.setRequestProperty("Content-Type", "text/x-java-properties");
2678                                 connection.setRequestProperty("X-ECOMP-RequestID", loggingContext.getRequestID());
2679                                 connection.setInstanceFollowRedirects(true);
2680                                 connection.setDoOutput(true);
2681                                 try (OutputStream os = connection.getOutputStream()) {
2682                                         OnapPDPGroup group = papEngine.getPDPGroup((OnapPDP) pdp);
2683                                         // if the PDP was just deleted, there is no group, but we want to send an update anyway
2684                                         if (group == null) {
2685                                                 // create blank properties files
2686                                                 Properties policyProperties = new Properties();
2687                                                 policyProperties.put(XACMLProperties.PROP_ROOTPOLICIES, "");
2688                                                 policyProperties.put(XACMLProperties.PROP_REFERENCEDPOLICIES, "");
2689                                                 policyProperties.store(os, "");
2690                                                 Properties pipProps = new Properties();
2691                                                 pipProps.setProperty(XACMLProperties.PROP_PIP_ENGINES, "");
2692                                                 pipProps.store(os, "");
2693                                         } else {
2694                                                 // send properties from the current group
2695                                                 group.getPolicyProperties().store(os, "");
2696                                                 Properties policyLocations = new Properties();
2697                                                 for (PDPPolicy policy : group.getPolicies()) {
2698                                                         policyLocations.put(policy.getId() + ".url", XACMLPapServlet.papURL + "?id=" + policy.getId());
2699                                                 }
2700                                                 policyLocations.store(os, "");
2701                                                 group.getPipConfigProperties().store(os, "");
2702                                         }
2703                                 } catch (Exception e) {
2704                                         PolicyLogger.error(MessageCodes.ERROR_SYSTEM_ERROR, e, "XACMLPapServlet", " Failed to send property file to " + pdp.getId());
2705                                         // Since this is a server-side error, it probably does not reflect a problem on the client,
2706                                         // so do not change the PDP status.
2707                                         return;
2708                                 }
2709                                 // Do the connect
2710                                 loggingContext.metricStarted();
2711                                 connection.connect();
2712                                 loggingContext.metricEnded();
2713                                 PolicyLogger.metrics("XACMLPapServlet UpdatePDPThread connection connect");
2714                                 if (connection.getResponseCode() == 204) {
2715                                         LOGGER.info("Success. We are configured correctly.");
2716                                         loggingContext.transactionEnded();
2717                                         auditLogger.info("Success. PDP is configured correctly.");
2718                                         PolicyLogger.audit("Transaction Success. PDP is configured correctly.");
2719                                         setPDPSummaryStatus(pdp, PDPStatus.Status.UP_TO_DATE);
2720                                 } else if (connection.getResponseCode() == 200) {
2721                                         LOGGER.info("Success. PDP needs to update its configuration.");
2722                                         loggingContext.transactionEnded();
2723                                         auditLogger.info("Success. PDP needs to update its configuration.");
2724                                         PolicyLogger.audit("Transaction Success. PDP is configured correctly.");
2725                                         setPDPSummaryStatus(pdp, PDPStatus.Status.OUT_OF_SYNCH);
2726                                 } else {
2727                                         LOGGER.warn("Failed: " + connection.getResponseCode() + "  message: " + connection.getResponseMessage());
2728                                         loggingContext.transactionEnded();
2729                                         auditLogger.warn("Failed: " + connection.getResponseCode() + "  message: " + connection.getResponseMessage());
2730                                         PolicyLogger.audit("Transaction Failed: " + connection.getResponseCode() + "  message: " + connection.getResponseMessage());
2731                                         setPDPSummaryStatus(pdp, PDPStatus.Status.UNKNOWN);
2732                                 }
2733                         } catch (Exception e) {
2734                                 LOGGER.debug(e);
2735                                 PolicyLogger.error(MessageCodes.ERROR_SYSTEM_ERROR, e, "XACMLPapServlet", " Unable to sync config with PDP '" + pdp.getId() + "'");
2736                                 loggingContext.transactionEnded();
2737                                 PolicyLogger.audit("Transaction Failed: Unable to sync config with PDP '" + pdp.getId() + "': " + e);
2738                                 try {
2739                                         setPDPSummaryStatus(pdp, PDPStatus.Status.UNKNOWN);
2740                                 } catch (PAPException e1) {
2741                                         LOGGER.debug(e1);
2742                                         PolicyLogger.audit("Transaction Failed: Unable to set status of PDP " + pdp.getId() + " to UNKNOWN: " + e);
2743                                         PolicyLogger.error(MessageCodes.ERROR_SYSTEM_ERROR, e, "XACMLPapServlet", " Unable to set status of PDP '" + pdp.getId() + "' to UNKNOWN");
2744                                 }
2745                         } finally {
2746                                 // cleanup the connection
2747                                 if(connection != null){
2748                                         connection.disconnect();
2749                                 }
2750                                 // tell the AC to update it's status info
2751                                 notifyAC();
2752                         }
2753                 }
2754         }
2755
2756         /*
2757          * RESTful Interface from PAP to ACs notifying them of changes
2758          */
2759         private void notifyAC() {
2760                 // kick off a thread to do one event notification for all registered ACs
2761                 // This needs to be on a separate thread so that ACs can make calls back to PAP to get the updated Group data
2762                 // as part of processing this message on their end.
2763                 Thread t = new Thread(new NotifyACThread());
2764                 t.start();
2765         }
2766
2767         private class NotifyACThread implements Runnable {
2768                 public void run() {
2769                         List<String> disconnectedACs = new ArrayList<>();
2770                         // There should be no Concurrent exception here because the list is a CopyOnWriteArrayList.
2771                         // The "for each" loop uses the collection's iterator under the covers, so it should be correct.
2772                         for (String acURL : adminConsoleURLStringList) {
2773                                 HttpURLConnection connection = null;
2774                                 try {
2775                                         acURL += "?PAPNotification=true";
2776                                         //TODO - Currently we just tell AC that "Something changed" without being specific.  Do we want to tell it which group/pdp changed?
2777                                         //TODO - If so, put correct parameters into the Query string here
2778                                         acURL += "&objectType=all" + "&action=update";
2779                                         if (LOGGER.isDebugEnabled()) {
2780                                                 LOGGER.debug("creating url for id '" + acURL + "'");
2781                                         }
2782                                         //TODO - currently always send both policies and pips.  Do we care enough to add code to allow sending just one or the other?
2783                                         //TODO          (need to change "cache=", implying getting some input saying which to change)
2784                                         URL url = new URL(acURL );
2785                                         // Open up the connection
2786                                         connection = (HttpURLConnection)url.openConnection();
2787                                         // Setup our method and headers
2788                                         connection.setRequestMethod("PUT");
2789                                         connection.setRequestProperty("Content-Type", "text/x-java-properties");
2790                                         // Adding this in. It seems the HttpUrlConnection class does NOT
2791                                         // properly forward our headers for POST re-direction. It does so
2792                                         // for a GET re-direction.
2793                                         // So we need to handle this ourselves.
2794                                         //TODO - is this needed for a PUT?  seems better to leave in for now?
2795                                         connection.setInstanceFollowRedirects(false);
2796                                         // Do not include any data in the PUT because this is just a
2797                                         // notification to the AC.
2798                                         // The AC will use GETs back to the PAP to get what it needs
2799                                         // to fill in the screens.
2800                                         // Do the connect
2801                                         connection.connect();
2802                                         if (connection.getResponseCode() == 204) {
2803                                                 LOGGER.info("Success. We updated correctly.");
2804                                         } else {
2805                                                 LOGGER.warn(XACMLErrorConstants.ERROR_SYSTEM_ERROR + "Failed: " + connection.getResponseCode() + "  message: " + connection.getResponseMessage());
2806                                         }
2807
2808                                 } catch (Exception e) {
2809                                         PolicyLogger.error(MessageCodes.ERROR_SYSTEM_ERROR, e, "XACMLPapServlet", " Unable to sync config AC '" + acURL + "'");
2810                                         disconnectedACs.add(acURL);
2811                                 } finally {
2812                                         // cleanup the connection
2813                                         if(connection != null)
2814                                                 connection.disconnect();
2815                                 }
2816                         }
2817                         // remove any ACs that are no longer connected
2818                         if (disconnectedACs.size() > 0) {
2819                                 adminConsoleURLStringList.removeAll(disconnectedACs);
2820                         }
2821                 }
2822         }
2823
2824         private void testService(ONAPLoggingContext loggingContext, HttpServletResponse response) throws IOException{
2825                 LOGGER.info("Test request received");
2826                 try {
2827                         im.evaluateSanity();
2828                         //If we make it this far, all is well
2829                         String message = "GET:/pap/test called and PAP " + papResourceName + " is OK";
2830                         LOGGER.info(message);
2831                         loggingContext.transactionEnded();
2832                         PolicyLogger.audit("Transaction Failed - See Error.log");
2833                         response.setStatus(HttpServletResponse.SC_OK);
2834                         return;
2835                 }catch (ForwardProgressException | AdministrativeStateException | StandbyStatusException e){
2836                         String submsg;
2837                         if (e instanceof ForwardProgressException) {
2838                                 submsg = " is not making forward progress.";
2839                         } else if (e instanceof AdministrativeStateException) {
2840                                 submsg = " Administrative State is LOCKED.";
2841                         } else {
2842                                 submsg = " Standby Status is NOT PROVIDING SERVICE.";
2843                         }
2844
2845                         String message = "GET:/pap/test called and PAP " + papResourceName + submsg
2846                                         + " Exception Message: " + e.getMessage();
2847                         LOGGER.info(message, e);
2848                         PolicyLogger.error(MessageCodes.ERROR_SYSTEM_ERROR + " " + message);
2849                         loggingContext.transactionEnded();
2850                         PolicyLogger.audit("Transaction Failed - See Error.log");
2851                         setResponseError(response,HttpServletResponse.SC_INTERNAL_SERVER_ERROR, message);
2852                         return;
2853                 }catch (Exception e) {
2854                         //A subsystem is not making progress, is locked, standby or is not responding
2855                         String eMsg = e.getMessage();
2856                         if(eMsg == null){
2857                                 eMsg = "No Exception Message";
2858                         }
2859                         String message = "GET:/pap/test called and PAP " + papResourceName + " has had a subsystem failure."
2860                                         + " Exception Message: " + eMsg;
2861                         LOGGER.info(message, e);
2862                         PolicyLogger.error(MessageCodes.ERROR_SYSTEM_ERROR + " " + message);
2863                         loggingContext.transactionEnded();
2864                         PolicyLogger.audit("Transaction Failed - See Error.log");
2865                         //Get the specific list of subsystems that failed
2866                         String ssFailureList = null;
2867                         for(String failedSS : papDependencyGroupsFlatArray){
2868                                 if(eMsg.contains(failedSS)){
2869                                         if(ssFailureList == null){
2870                                                 ssFailureList = failedSS;
2871                                         }else{
2872                                                 ssFailureList = ssFailureList.concat(","+failedSS);
2873                                         }
2874                                 }
2875                         }
2876                         if(ssFailureList == null){
2877                                 ssFailureList = "UnknownSubSystem";
2878                         }
2879                         response.addHeader("X-ONAP-SubsystemFailure", ssFailureList);
2880                         setResponseError(response, HttpServletResponse.SC_INTERNAL_SERVER_ERROR, message);
2881                         return;
2882                 }
2883         }
2884
2885         /*
2886          * Authorizing the PEP Requests.
2887          */
2888         private boolean authorizeRequest(HttpServletRequest request) {
2889                 String clientCredentials = request.getHeader(ENVIRONMENT_HEADER);
2890                 // Check if the Client is Authorized.
2891                 if(clientCredentials!=null && clientCredentials.equalsIgnoreCase(environment)){
2892                         return true;
2893                 }else{
2894                         return false;
2895                 }
2896         }
2897
2898         private static void loadWebapps() throws PAPException{
2899                 if(actionHome == null || configHome == null){
2900                         Path webappsPath = Paths.get(XACMLProperties.getProperty(XACMLRestProperties.PROP_PAP_WEBAPPS));
2901                         //Sanity Check
2902                         if (webappsPath == null) {
2903                                 PolicyLogger.error("Invalid Webapps Path Location property : " + XACMLRestProperties.PROP_PAP_WEBAPPS);
2904                                 throw new PAPException("Invalid Webapps Path Location property : " + XACMLRestProperties.PROP_PAP_WEBAPPS);
2905                         }
2906                         Path webappsPathConfig = Paths.get(webappsPath.toString()+File.separator+"Config");
2907                         Path webappsPathAction = Paths.get(webappsPath.toString()+File.separator+"Action");
2908                         if (Files.notExists(webappsPathConfig)) {
2909                                 try {
2910                                         Files.createDirectories(webappsPathConfig);
2911                                 } catch (IOException e) {
2912                                         PolicyLogger.error(MessageCodes.ERROR_PROCESS_FLOW, e, "XACMLPapServlet", "Failed to create config directory: "
2913                                                         + webappsPathConfig.toAbsolutePath().toString());
2914                                 }
2915                         }
2916                         if (Files.notExists(webappsPathAction)) {
2917                                 try {
2918                                         Files.createDirectories(webappsPathAction);
2919                                 } catch (IOException e) {
2920                                         LOGGER.error(XACMLErrorConstants.ERROR_PROCESS_FLOW + "Failed to create action directory: "
2921                                                         + webappsPathAction.toAbsolutePath().toString(), e);
2922                                 }
2923                         }
2924                         actionHome = webappsPathAction.toString();
2925                         configHome = webappsPathConfig.toString();
2926                 }
2927         }
2928
2929         public static String getConfigHome(){
2930                 try {
2931                         loadWebapps();
2932                 } catch (PAPException e) {
2933                         LOGGER.debug(e);
2934                         return null;
2935                 }
2936                 return configHome;
2937         }
2938
2939         private static void setConfigHome(){
2940             configHome = getConfigHome();
2941         }
2942
2943         public static String getActionHome(){
2944                 try {
2945                         loadWebapps();
2946                 } catch (PAPException e) {
2947                         LOGGER.debug(e);
2948                         return null;
2949                 }
2950                 return actionHome;
2951         }
2952
2953         private static void setActionHome(){
2954             actionHome = getActionHome();
2955         }
2956
2957         public static EntityManagerFactory getEmf() {
2958                 return emf;
2959         }
2960
2961         public IntegrityAudit getIa() {
2962                 return ia;
2963         }
2964
2965         public static String getPDPFile(){
2966                 return XACMLPapServlet.pdpFile;
2967         }
2968
2969         public static String getPersistenceUnit(){
2970                 return PERSISTENCE_UNIT;
2971         }
2972
2973         public static PAPPolicyEngine getPAPEngine(){
2974                 return papEngine;
2975         }
2976
2977         public static PolicyDBDaoTransaction getDbDaoTransaction(){
2978                 return policyDBDao.getNewTransaction();
2979         }
2980         public static String getPapDbDriver() {
2981                 return papDbDriver;
2982         }
2983
2984         public static void setPapDbDriver(String papDbDriver) {
2985                 XACMLPapServlet.papDbDriver = papDbDriver;
2986         }
2987
2988         public static String getPapDbUrl() {
2989                 return papDbUrl;
2990         }
2991
2992         public static void setPapDbUrl(String papDbUrl) {
2993                 XACMLPapServlet.papDbUrl = papDbUrl;
2994         }
2995
2996         public static String getPapDbUser() {
2997                 return papDbUser;
2998         }
2999
3000         public static void setPapDbUser(String papDbUser) {
3001                 XACMLPapServlet.papDbUser = papDbUser;
3002         }
3003
3004         public static String getPapDbPassword() {
3005                 return papDbPassword;
3006         }
3007
3008         public static void setPapDbPassword(String papDbPassword) {
3009                 XACMLPapServlet.papDbPassword = papDbPassword;
3010         }
3011
3012         public static String getMsOnapName() {
3013                 return msOnapName;
3014         }
3015
3016         public static void setMsOnapName(String msOnapName) {
3017                 XACMLPapServlet.msOnapName = msOnapName;
3018         }
3019
3020         public static String getMsPolicyName() {
3021                 return msPolicyName;
3022         }
3023
3024         public static void setMsPolicyName(String msPolicyName) {
3025                 XACMLPapServlet.msPolicyName = msPolicyName;
3026         }
3027 }