datarouter-node/src/main/java/org/onap/dmaap/datarouter/node/NodeConfigManager.java

   1 /*******************************************************************************
   2  * ============LICENSE_START==================================================
   3  * * org.onap.dmaap
   4  * * ===========================================================================
   5  * * Copyright © 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  * * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  21  * *
  22  ******************************************************************************/
  23
  24
  25 package org.onap.dmaap.datarouter.node;
  26
  27 import java.net.*;
  28 import java.util.*;
  29 import java.io.*;
  30
  31 import org.apache.log4j.Logger;
  32 import org.onap.dmaap.datarouter.node.eelf.EelfMsgs;
  33
  34 import com.att.eelf.configuration.EELFLogger;
  35 import com.att.eelf.configuration.EELFManager;
  36
  37
  38 /**
  39  * Maintain the configuration of a Data Router node
  40  * <p>
  41  * The NodeConfigManager is the single point of contact for servlet, delivery, event logging, and log retention
  42  * subsystems to access configuration information.  (Log4J has its own configuration mechanism).
  43  * <p>
  44  * There are two basic sets of configuration data.  The static local configuration data, stored in a local configuration
  45  * file (created as part of installation by SWM), and the dynamic global configuration data fetched from the data router
  46  * provisioning server.
  47  */
  48 public class NodeConfigManager implements DeliveryQueueHelper {
  49
  50     private static EELFLogger eelflogger = EELFManager.getInstance()
  51         .getLogger("org.onap.dmaap.datarouter.node.NodeConfigManager");
  52     private static Logger logger = Logger.getLogger("org.onap.dmaap.datarouter.node.NodeConfigManager");
  53     private static NodeConfigManager base = new NodeConfigManager();
  54
  55     private Timer timer = new Timer("Node Configuration Timer", true);
  56     private long maxfailuretimer;
  57     private long initfailuretimer;
  58     private long expirationtimer;
  59     private double failurebackoff;
  60     private long fairtimelimit;
  61     private int fairfilelimit;
  62     private double fdpstart;
  63     private double fdpstop;
  64     private int deliverythreads;
  65     private String provurl;
  66     private String provhost;
  67     private IsFrom provcheck;
  68     private int gfport;
  69     private int svcport;
  70     private int port;
  71     private String spooldir;
  72     private String logdir;
  73     private long logretention;
  74     private String redirfile;
  75     private String kstype;
  76     private String ksfile;
  77     private String kspass;
  78     private String kpass;
  79     private String tstype;
  80     private String tsfile;
  81     private String tspass;
  82     private String myname;
  83     private RedirManager rdmgr;
  84     private RateLimitedOperation pfetcher;
  85     private NodeConfig config;
  86     private File quiesce;
  87     private PublishId pid;
  88     private String nak;
  89     private TaskList configtasks = new TaskList();
  90     private String eventlogurl;
  91     private String eventlogprefix;
  92     private String eventlogsuffix;
  93     private String eventloginterval;
  94     private boolean followredirects;
  95
  96
  97     /**
  98      * Get the default node configuration manager
  99      */
 100     public static NodeConfigManager getInstance() {
 101         return (base);
 102     }
 103
 104     /**
 105      * Initialize the configuration of a Data Router node
 106      */
 107     private NodeConfigManager() {
 108         Properties p = new Properties();
 109         try {
 110             p.load(new FileInputStream(System
 111                 .getProperty("org.onap.dmaap.datarouter.node.properties", "/opt/app/datartr/etc/node.properties")));
 112         } catch (Exception e) {
 113
 114             NodeUtils.setIpAndFqdnForEelf("NodeConfigManager");
 115             eelflogger.error(EelfMsgs.MESSAGE_PROPERTIES_LOAD_ERROR);
 116             logger.error("NODE0301 Unable to load local configuration file " + System
 117                 .getProperty("org.onap.dmaap.datarouter.node.properties", "/opt/app/datartr/etc/node.properties"), e);
 118         }
 119         provurl = p.getProperty("ProvisioningURL", "https://feeds-drtr.web.att.com/internal/prov");
 120         try {
 121             provhost = (new URL(provurl)).getHost();
 122         } catch (Exception e) {
 123             NodeUtils.setIpAndFqdnForEelf("NodeConfigManager");
 124             eelflogger.error(EelfMsgs.MESSAGE_BAD_PROV_URL, provurl);
 125             logger.error("NODE0302 Bad provisioning server URL " + provurl);
 126             System.exit(1);
 127         }
 128         logger.info("NODE0303 Provisioning server is " + provhost);
 129         eventlogurl = p.getProperty("LogUploadURL", "https://feeds-drtr.web.att.com/internal/logs");
 130         provcheck = new IsFrom(provhost);
 131         gfport = Integer.parseInt(p.getProperty("IntHttpPort", "8080"));
 132         svcport = Integer.parseInt(p.getProperty("IntHttpsPort", "8443"));
 133         port = Integer.parseInt(p.getProperty("ExtHttpsPort", "443"));
 134         long minpfinterval = Long.parseLong(p.getProperty("MinProvFetchInterval", "10000"));
 135         long minrsinterval = Long.parseLong(p.getProperty("MinRedirSaveInterval", "10000"));
 136         spooldir = p.getProperty("SpoolDir", "spool");
 137         File fdir = new File(spooldir + "/f");
 138         fdir.mkdirs();
 139         for (File junk : fdir.listFiles()) {
 140             if (junk.isFile()) {
 141                 junk.delete();
 142             }
 143         }
 144         logdir = p.getProperty("LogDir", "logs");
 145         (new File(logdir)).mkdirs();
 146         logretention = Long.parseLong(p.getProperty("LogRetention", "30")) * 86400000L;
 147         eventlogprefix = logdir + "/events";
 148         eventlogsuffix = ".log";
 149         String redirfile = p.getProperty("RedirectionFile", "etc/redirections.dat");
 150         kstype = p.getProperty("KeyStoreType", "jks");
 151         ksfile = p.getProperty("KeyStoreFile", "etc/keystore");
 152         kspass = p.getProperty("KeyStorePassword", "changeme");
 153         kpass = p.getProperty("KeyPassword", "changeme");
 154         tstype = p.getProperty("TrustStoreType", "jks");
 155         tsfile = p.getProperty("TrustStoreFile");
 156         tspass = p.getProperty("TrustStorePassword", "changeme");
 157         if (tsfile != null && tsfile.length() > 0) {
 158             System.setProperty("javax.net.ssl.trustStoreType", tstype);
 159             System.setProperty("javax.net.ssl.trustStore", tsfile);
 160             System.setProperty("javax.net.ssl.trustStorePassword", tspass);
 161         }
 162         nak = p.getProperty("NodeAuthKey", "Node123!");
 163         quiesce = new File(p.getProperty("QuiesceFile", "etc/SHUTDOWN"));
 164         myname = NodeUtils.getCanonicalName(kstype, ksfile, kspass);
 165         if (myname == null) {
 166             NodeUtils.setIpAndFqdnForEelf("NodeConfigManager");
 167             eelflogger.error(EelfMsgs.MESSAGE_KEYSTORE_FETCH_ERROR, ksfile);
 168             logger.error("NODE0309 Unable to fetch canonical name from keystore file " + ksfile);
 169             System.exit(1);
 170         }
 171         logger.info("NODE0304 My certificate says my name is " + myname);
 172         pid = new PublishId(myname);
 173         rdmgr = new RedirManager(redirfile, minrsinterval, timer);
 174         pfetcher = new RateLimitedOperation(minpfinterval, timer) {
 175             public void run() {
 176                 fetchconfig();
 177             }
 178         };
 179         logger.info("NODE0305 Attempting to fetch configuration at " + provurl);
 180         pfetcher.request();
 181     }
 182
 183     private void localconfig() {
 184         followredirects = Boolean.parseBoolean(getProvParam("FOLLOW_REDIRECTS", "false"));
 185         eventloginterval = getProvParam("LOGROLL_INTERVAL", "5m");
 186         initfailuretimer = 10000;
 187         maxfailuretimer = 3600000;
 188         expirationtimer = 86400000;
 189         failurebackoff = 2.0;
 190         deliverythreads = 40;
 191         fairfilelimit = 100;
 192         fairtimelimit = 60000;
 193         fdpstart = 0.05;
 194         fdpstop = 0.2;
 195         try {
 196             initfailuretimer = (long) (Double.parseDouble(getProvParam("DELIVERY_INIT_RETRY_INTERVAL")) * 1000);
 197         } catch (Exception e) {
 198         }
 199         try {
 200             maxfailuretimer = (long) (Double.parseDouble(getProvParam("DELIVERY_MAX_RETRY_INTERVAL")) * 1000);
 201         } catch (Exception e) {
 202         }
 203         try {
 204             expirationtimer = (long) (Double.parseDouble(getProvParam("DELIVERY_MAX_AGE")) * 1000);
 205         } catch (Exception e) {
 206         }
 207         try {
 208             failurebackoff = Double.parseDouble(getProvParam("DELIVERY_RETRY_RATIO"));
 209         } catch (Exception e) {
 210         }
 211         try {
 212             deliverythreads = Integer.parseInt(getProvParam("DELIVERY_THREADS"));
 213         } catch (Exception e) {
 214         }
 215         try {
 216             fairfilelimit = Integer.parseInt(getProvParam("FAIR_FILE_LIMIT"));
 217         } catch (Exception e) {
 218         }
 219         try {
 220             fairtimelimit = (long) (Double.parseDouble(getProvParam("FAIR_TIME_LIMIT")) * 1000);
 221         } catch (Exception e) {
 222         }
 223         try {
 224             fdpstart = Double.parseDouble(getProvParam("FREE_DISK_RED_PERCENT")) / 100.0;
 225         } catch (Exception e) {
 226         }
 227         try {
 228             fdpstop = Double.parseDouble(getProvParam("FREE_DISK_YELLOW_PERCENT")) / 100.0;
 229         } catch (Exception e) {
 230         }
 231         if (fdpstart < 0.01) {
 232             fdpstart = 0.01;
 233         }
 234         if (fdpstart > 0.5) {
 235             fdpstart = 0.5;
 236         }
 237         if (fdpstop < fdpstart) {
 238             fdpstop = fdpstart;
 239         }
 240         if (fdpstop > 0.5) {
 241             fdpstop = 0.5;
 242         }
 243     }
 244
 245     private void fetchconfig() {
 246         try {
 247             System.out.println("provurl:: " + provurl);
 248             Reader r = new InputStreamReader((new URL(provurl)).openStream());
 249             config = new NodeConfig(new ProvData(r), myname, spooldir, port, nak);
 250             localconfig();
 251             configtasks.startRun();
 252             Runnable rr;
 253             while ((rr = configtasks.next()) != null) {
 254                 try {
 255                     rr.run();
 256                 } catch (Exception e) {
 257                 }
 258             }
 259         } catch (Exception e) {
 260             e.printStackTrace();
 261             NodeUtils.setIpAndFqdnForEelf("fetchconfigs");
 262             eelflogger.error(EelfMsgs.MESSAGE_CONF_FAILED, e.toString());
 263             logger.error("NODE0306 Configuration failed " + e.toString() + " - try again later", e);
 264             pfetcher.request();
 265         }
 266     }
 267
 268     /**
 269      * Process a gofetch request from a particular IP address.  If the IP address is not an IP address we would go to to
 270      * fetch the provisioning data, ignore the request.  If the data has been fetched very recently (default 10
 271      * seconds), wait a while before fetching again.
 272      */
 273     public synchronized void gofetch(String remoteaddr) {
 274         if (provcheck.isFrom(remoteaddr)) {
 275             logger.info("NODE0307 Received configuration fetch request from provisioning server " + remoteaddr);
 276             pfetcher.request();
 277         } else {
 278             logger.info("NODE0308 Received configuration fetch request from unexpected server " + remoteaddr);
 279         }
 280     }
 281
 282     /**
 283      * Am I configured?
 284      */
 285     public boolean isConfigured() {
 286         return (config != null);
 287     }
 288
 289     /**
 290      * Am I shut down?
 291      */
 292     public boolean isShutdown() {
 293         return (quiesce.exists());
 294     }
 295
 296     /**
 297      * Given a routing string, get the targets.
 298      *
 299      * @param routing Target string
 300      * @return array of targets
 301      */
 302     public Target[] parseRouting(String routing) {
 303         return (config.parseRouting(routing));
 304     }
 305
 306     /**
 307      * Given a set of credentials and an IP address, is this request from another node?
 308      *
 309      * @param credentials Credentials offered by the supposed node
 310      * @param ip IP address the request came from
 311      * @return If the credentials and IP address are recognized, true, otherwise false.
 312      */
 313     public boolean isAnotherNode(String credentials, String ip) {
 314         return (config.isAnotherNode(credentials, ip));
 315     }
 316
 317     /**
 318      * Check whether publication is allowed.
 319      *
 320      * @param feedid The ID of the feed being requested
 321      * @param credentials The offered credentials
 322      * @param ip The requesting IP address
 323      * @return True if the IP and credentials are valid for the specified feed.
 324      */
 325     public String isPublishPermitted(String feedid, String credentials, String ip) {
 326         return (config.isPublishPermitted(feedid, credentials, ip));
 327     }
 328
 329     /**
 330      * Check who the user is given the feed ID and the offered credentials.
 331      *
 332      * @param feedid The ID of the feed specified
 333      * @param credentials The offered credentials
 334      * @return Null if the credentials are invalid or the user if they are valid.
 335      */
 336     public String getAuthUser(String feedid, String credentials) {
 337         return (config.getAuthUser(feedid, credentials));
 338     }
 339
 340     /**
 341      * Check if the publish request should be sent to another node based on the feedid, user, and source IP address.
 342      *
 343      * @param feedid The ID of the feed specified
 344      * @param user The publishing user
 345      * @param ip The IP address of the publish endpoint
 346      * @return Null if the request should be accepted or the correct hostname if it should be sent to another node.
 347      */
 348     public String getIngressNode(String feedid, String user, String ip) {
 349         return (config.getIngressNode(feedid, user, ip));
 350     }
 351
 352     /**
 353      * Get a provisioned configuration parameter (from the provisioning server configuration)
 354      *
 355      * @param name The name of the parameter
 356      * @return The value of the parameter or null if it is not defined.
 357      */
 358     public String getProvParam(String name) {
 359         return (config.getProvParam(name));
 360     }
 361
 362     /**
 363      * Get a provisioned configuration parameter (from the provisioning server configuration)
 364      *
 365      * @param name The name of the parameter
 366      * @param deflt The value to use if the parameter is not defined
 367      * @return The value of the parameter or deflt if it is not defined.
 368      */
 369     public String getProvParam(String name, String deflt) {
 370         name = config.getProvParam(name);
 371         if (name == null) {
 372             name = deflt;
 373         }
 374         return (name);
 375     }
 376
 377     /**
 378      * Generate a publish ID
 379      */
 380     public String getPublishId() {
 381         return (pid.next());
 382     }
 383
 384     /**
 385      * Get all the outbound spooling destinations. This will include both subscriptions and nodes.
 386      */
 387     public DestInfo[] getAllDests() {
 388         return (config.getAllDests());
 389     }
 390
 391     /**
 392      * Register a task to run whenever the configuration changes
 393      */
 394     public void registerConfigTask(Runnable task) {
 395         configtasks.addTask(task);
 396     }
 397
 398     /**
 399      * Deregister a task to run whenever the configuration changes
 400      */
 401     public void deregisterConfigTask(Runnable task) {
 402         configtasks.removeTask(task);
 403     }
 404
 405     /**
 406      * Get the URL to deliver a message to.
 407      *
 408      * @param destinfo The destination information
 409      * @param fileid The file ID
 410      * @return The URL to deliver to
 411      */
 412     public String getDestURL(DestInfo destinfo, String fileid) {
 413         String subid = destinfo.getSubId();
 414         String purl = destinfo.getURL();
 415         if (followredirects && subid != null) {
 416             purl = rdmgr.lookup(subid, purl);
 417         }
 418         return (purl + "/" + fileid);
 419     }
 420
 421     /**
 422      * Is a destination redirected?
 423      */
 424     public boolean isDestRedirected(DestInfo destinfo) {
 425         return (followredirects && rdmgr.isRedirected(destinfo.getSubId()));
 426     }
 427
 428     /**
 429      * Set up redirection on receipt of a 3XX from a target URL
 430      */
 431     public boolean handleRedirection(DestInfo destinfo, String redirto, String fileid) {
 432         fileid = "/" + fileid;
 433         String subid = destinfo.getSubId();
 434         String purl = destinfo.getURL();
 435         if (followredirects && subid != null && redirto.endsWith(fileid)) {
 436             redirto = redirto.substring(0, redirto.length() - fileid.length());
 437             if (!redirto.equals(purl)) {
 438                 rdmgr.redirect(subid, purl, redirto);
 439                 return (true);
 440             }
 441         }
 442         return (false);
 443     }
 444
 445     /**
 446      * Handle unreachable target URL
 447      */
 448     public void handleUnreachable(DestInfo destinfo) {
 449         String subid = destinfo.getSubId();
 450         if (followredirects && subid != null) {
 451             rdmgr.forget(subid);
 452         }
 453     }
 454
 455     /**
 456      * Get the timeout before retrying after an initial delivery failure
 457      */
 458     public long getInitFailureTimer() {
 459         return (initfailuretimer);
 460     }
 461
 462     /**
 463      * Get the maximum timeout between delivery attempts
 464      */
 465     public long getMaxFailureTimer() {
 466         return (maxfailuretimer);
 467     }
 468
 469     /**
 470      * Get the ratio between consecutive delivery attempts
 471      */
 472     public double getFailureBackoff() {
 473         return (failurebackoff);
 474     }
 475
 476     /**
 477      * Get the expiration timer for deliveries
 478      */
 479     public long getExpirationTimer() {
 480         return (expirationtimer);
 481     }
 482
 483     /**
 484      * Get the maximum number of file delivery attempts before checking if another queue has work to be performed.
 485      */
 486     public int getFairFileLimit() {
 487         return (fairfilelimit);
 488     }
 489
 490     /**
 491      * Get the maximum amount of time spent delivering files before checking if another queue has work to be performed.
 492      */
 493     public long getFairTimeLimit() {
 494         return (fairtimelimit);
 495     }
 496
 497     /**
 498      * Get the targets for a feed
 499      *
 500      * @param feedid The feed ID
 501      * @return The targets this feed should be delivered to
 502      */
 503     public Target[] getTargets(String feedid) {
 504         return (config.getTargets(feedid));
 505     }
 506
 507     /**
 508      * Get the spool directory for temporary files
 509      */
 510     public String getSpoolDir() {
 511         return (spooldir + "/f");
 512     }
 513
 514     /**
 515      * Get the base directory for spool directories
 516      */
 517     public String getSpoolBase() {
 518         return (spooldir);
 519     }
 520
 521     /**
 522      * Get the key store type
 523      */
 524     public String getKSType() {
 525         return (kstype);
 526     }
 527
 528     /**
 529      * Get the key store file
 530      */
 531     public String getKSFile() {
 532         return (ksfile);
 533     }
 534
 535     /**
 536      * Get the key store password
 537      */
 538     public String getKSPass() {
 539         return (kspass);
 540     }
 541
 542     /**
 543      * Get the key password
 544      */
 545     public String getKPass() {
 546         return (kpass);
 547     }
 548
 549     /**
 550      * Get the http port
 551      */
 552     public int getHttpPort() {
 553         return (gfport);
 554     }
 555
 556     /**
 557      * Get the https port
 558      */
 559     public int getHttpsPort() {
 560         return (svcport);
 561     }
 562
 563     /**
 564      * Get the externally visible https port
 565      */
 566     public int getExtHttpsPort() {
 567         return (port);
 568     }
 569
 570     /**
 571      * Get the external name of this machine
 572      */
 573     public String getMyName() {
 574         return (myname);
 575     }
 576
 577     /**
 578      * Get the number of threads to use for delivery
 579      */
 580     public int getDeliveryThreads() {
 581         return (deliverythreads);
 582     }
 583
 584     /**
 585      * Get the URL for uploading the event log data
 586      */
 587     public String getEventLogUrl() {
 588         return (eventlogurl);
 589     }
 590
 591     /**
 592      * Get the prefix for the names of event log files
 593      */
 594     public String getEventLogPrefix() {
 595         return (eventlogprefix);
 596     }
 597
 598     /**
 599      * Get the suffix for the names of the event log files
 600      */
 601     public String getEventLogSuffix() {
 602         return (eventlogsuffix);
 603     }
 604
 605     /**
 606      * Get the interval between event log file rollovers
 607      */
 608     public String getEventLogInterval() {
 609         return (eventloginterval);
 610     }
 611
 612     /**
 613      * Should I follow redirects from subscribers?
 614      */
 615     public boolean isFollowRedirects() {
 616         return (followredirects);
 617     }
 618
 619     /**
 620      * Get the directory where the event and node log files live
 621      */
 622     public String getLogDir() {
 623         return (logdir);
 624     }
 625
 626     /**
 627      * How long do I keep log files (in milliseconds)
 628      */
 629     public long getLogRetention() {
 630         return (logretention);
 631     }
 632
 633     /**
 634      * Get the timer
 635      */
 636     public Timer getTimer() {
 637         return (timer);
 638     }
 639
 640     /**
 641      * Get the feed ID for a subscription
 642      *
 643      * @param subid The subscription ID
 644      * @return The feed ID
 645      */
 646     public String getFeedId(String subid) {
 647         return (config.getFeedId(subid));
 648     }
 649
 650     /**
 651      * Get the authorization string this node uses
 652      *
 653      * @return The Authorization string for this node
 654      */
 655     public String getMyAuth() {
 656         return (config.getMyAuth());
 657     }
 658
 659     /**
 660      * Get the fraction of free spool disk space where we start throwing away undelivered files.  This is
 661      * FREE_DISK_RED_PERCENT / 100.0.  Default is 0.05.  Limited by 0.01 <= FreeDiskStart <= 0.5.
 662      */
 663     public double getFreeDiskStart() {
 664         return (fdpstart);
 665     }
 666
 667     /**
 668      * Get the fraction of free spool disk space where we stop throwing away undelivered files.  This is
 669      * FREE_DISK_YELLOW_PERCENT / 100.0.  Default is 0.2.  Limited by FreeDiskStart <= FreeDiskStop <= 0.5.
 670      */
 671     public double getFreeDiskStop() {
 672         return (fdpstop);
 673     }
 674
 675     /**
 676      * Get the spool directory for a subscription
 677      */
 678     public String getSpoolDir(String subid, String remoteaddr) {
 679         if (provcheck.isFrom(remoteaddr)) {
 680             String sdir = config.getSpoolDir(subid);
 681             if (sdir != null) {
 682                 logger.info("NODE0310 Received subscription reset request for subscription " + subid
 683                     + " from provisioning server " + remoteaddr);
 684             } else {
 685                 logger.info("NODE0311 Received subscription reset request for unknown subscription " + subid
 686                     + " from provisioning server " + remoteaddr);
 687             }
 688             return (sdir);
 689         } else {
 690             logger.info("NODE0312 Received subscription reset request from unexpected server " + remoteaddr);
 691             return (null);
 692         }
 693     }
 694 }