+/*******************************************************************************\r
+ * ============LICENSE_START==================================================\r
+ * * org.onap.dmaap\r
+ * * ===========================================================================\r
+ * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
+ * * ===========================================================================\r
+ * * Licensed under the Apache License, Version 2.0 (the "License");\r
+ * * you may not use this file except in compliance with the License.\r
+ * * You may obtain a copy of the License at\r
+ * * \r
+ * * http://www.apache.org/licenses/LICENSE-2.0\r
+ * * \r
+ * * Unless required by applicable law or agreed to in writing, software\r
+ * * distributed under the License is distributed on an "AS IS" BASIS,\r
+ * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ * * See the License for the specific language governing permissions and\r
+ * * limitations under the License.\r
+ * * ============LICENSE_END====================================================\r
+ * *\r
+ * * ECOMP is a trademark and service mark of AT&T Intellectual Property.\r
+ * *\r
+ ******************************************************************************/\r
+\r
+\r
+package com.att.research.datarouter.node;\r
+\r
+import java.net.*;\r
+import java.util.*;\r
+import java.io.*;\r
+import org.apache.log4j.Logger;\r
+\r
+import com.att.eelf.configuration.EELFLogger;\r
+import com.att.eelf.configuration.EELFManager;\r
+import com.att.research.datarouter.node.eelf.EelfMsgs;\r
+\r
+\r
+/**\r
+ * Maintain the configuration of a Data Router node\r
+ * <p>\r
+ * The NodeConfigManager is the single point of contact for servlet, delivery, event logging, and log retention subsystems to access configuration information. (Log4J has its own configuration mechanism).\r
+ * <p>\r
+ * There are two basic sets of configuration data. The\r
+ * static local configuration data, stored in a local configuration file (created\r
+ * as part of installation by SWM), and the dynamic global\r
+ * configuration data fetched from the data router provisioning server.\r
+ */\r
+public class NodeConfigManager implements DeliveryQueueHelper {\r
+ private static EELFLogger eelflogger = EELFManager.getInstance().getLogger("com.att.research.datarouter.node.NodeConfigManager");\r
+ private static Logger logger = Logger.getLogger("com.att.research.datarouter.node.NodeConfigManager");\r
+ private static NodeConfigManager base = new NodeConfigManager();\r
+\r
+ private Timer timer = new Timer("Node Configuration Timer", true);\r
+ private long maxfailuretimer;\r
+ private long initfailuretimer;\r
+ private long expirationtimer;\r
+ private double failurebackoff;\r
+ private long fairtimelimit;\r
+ private int fairfilelimit;\r
+ private double fdpstart;\r
+ private double fdpstop;\r
+ private int deliverythreads;\r
+ private String provurl;\r
+ private String provhost;\r
+ private IsFrom provcheck;\r
+ private int gfport;\r
+ private int svcport;\r
+ private int port;\r
+ private String spooldir;\r
+ private String logdir;\r
+ private long logretention;\r
+ private String redirfile;\r
+ private String kstype;\r
+ private String ksfile;\r
+ private String kspass;\r
+ private String kpass;\r
+ private String tstype;\r
+ private String tsfile;\r
+ private String tspass;\r
+ private String myname;\r
+ private RedirManager rdmgr;\r
+ private RateLimitedOperation pfetcher;\r
+ private NodeConfig config;\r
+ private File quiesce;\r
+ private PublishId pid;\r
+ private String nak;\r
+ private TaskList configtasks = new TaskList();\r
+ private String eventlogurl;\r
+ private String eventlogprefix;\r
+ private String eventlogsuffix;\r
+ private String eventloginterval;\r
+ private boolean followredirects;\r
+\r
+ \r
+ /**\r
+ * Get the default node configuration manager\r
+ */\r
+ public static NodeConfigManager getInstance() {\r
+ return(base);\r
+ }\r
+ /**\r
+ * Initialize the configuration of a Data Router node\r
+ */\r
+ private NodeConfigManager() {\r
+ Properties p = new Properties();\r
+ try {\r
+ p.load(new FileInputStream(System.getProperty("com.att.research.datarouter.node.ConfigFile", "/opt/app/datartr/etc/node.properties")));\r
+ } catch (Exception e) {\r
+ \r
+ NodeUtils.setIpAndFqdnForEelf("NodeConfigManager");\r
+ eelflogger.error(EelfMsgs.MESSAGE_PROPERTIES_LOAD_ERROR);\r
+ logger.error("NODE0301 Unable to load local configuration file " + System.getProperty("com.att.research.datarouter.node.ConfigFile", "/opt/app/datartr/etc/node.properties"), e);\r
+ }\r
+ provurl = p.getProperty("ProvisioningURL", "https://feeds-drtr.web.att.com/internal/prov");\r
+ try {\r
+ provhost = (new URL(provurl)).getHost();\r
+ } catch (Exception e) {\r
+ NodeUtils.setIpAndFqdnForEelf("NodeConfigManager");\r
+ eelflogger.error(EelfMsgs.MESSAGE_BAD_PROV_URL, provurl);\r
+ logger.error("NODE0302 Bad provisioning server URL " + provurl);\r
+ System.exit(1);\r
+ }\r
+ logger.info("NODE0303 Provisioning server is " + provhost);\r
+ eventlogurl = p.getProperty("LogUploadURL", "https://feeds-drtr.web.att.com/internal/logs");\r
+ provcheck = new IsFrom(provhost);\r
+ gfport = Integer.parseInt(p.getProperty("IntHttpPort", "8080"));\r
+ svcport = Integer.parseInt(p.getProperty("IntHttpsPort", "8443"));\r
+ port = Integer.parseInt(p.getProperty("ExtHttpsPort", "443"));\r
+ long minpfinterval = Long.parseLong(p.getProperty("MinProvFetchInterval", "10000"));\r
+ long minrsinterval = Long.parseLong(p.getProperty("MinRedirSaveInterval", "10000"));\r
+ spooldir = p.getProperty("SpoolDir", "spool");\r
+ File fdir = new File(spooldir + "/f");\r
+ fdir.mkdirs();\r
+ for (File junk: fdir.listFiles()) {\r
+ if (junk.isFile()) {\r
+ junk.delete();\r
+ }\r
+ }\r
+ logdir = p.getProperty("LogDir", "logs");\r
+ (new File(logdir)).mkdirs();\r
+ logretention = Long.parseLong(p.getProperty("LogRetention", "30")) * 86400000L;\r
+ eventlogprefix = logdir + "/events";\r
+ eventlogsuffix = ".log";\r
+ String redirfile = p.getProperty("RedirectionFile", "etc/redirections.dat");\r
+ kstype = p.getProperty("KeyStoreType", "jks");\r
+ ksfile = p.getProperty("KeyStoreFile", "etc/keystore");\r
+ kspass = p.getProperty("KeyStorePassword", "changeme");\r
+ kpass = p.getProperty("KeyPassword", "changeme");\r
+ tstype = p.getProperty("TrustStoreType", "jks");\r
+ tsfile = p.getProperty("TrustStoreFile");\r
+ tspass = p.getProperty("TrustStorePassword", "changeme");\r
+ if (tsfile != null && tsfile.length() > 0) {\r
+ System.setProperty("javax.net.ssl.trustStoreType", tstype);\r
+ System.setProperty("javax.net.ssl.trustStore", tsfile);\r
+ System.setProperty("javax.net.ssl.trustStorePassword", tspass);\r
+ }\r
+ nak = p.getProperty("NodeAuthKey", "Node123!");\r
+ quiesce = new File(p.getProperty("QuiesceFile", "etc/SHUTDOWN"));\r
+ myname = NodeUtils.getCanonicalName(kstype, ksfile, kspass);\r
+ if (myname == null) {\r
+ NodeUtils.setIpAndFqdnForEelf("NodeConfigManager");\r
+ eelflogger.error(EelfMsgs.MESSAGE_KEYSTORE_FETCH_ERROR, ksfile);\r
+ logger.error("NODE0309 Unable to fetch canonical name from keystore file " + ksfile);\r
+ System.exit(1);\r
+ }\r
+ logger.info("NODE0304 My certificate says my name is " + myname);\r
+ pid = new PublishId(myname);\r
+ rdmgr = new RedirManager(redirfile, minrsinterval, timer);\r
+ pfetcher = new RateLimitedOperation(minpfinterval, timer) {\r
+ public void run() {\r
+ fetchconfig();\r
+ }\r
+ };\r
+ logger.info("NODE0305 Attempting to fetch configuration at " + provurl);\r
+ pfetcher.request();\r
+ }\r
+ private void localconfig() {\r
+ followredirects = Boolean.parseBoolean(getProvParam("FOLLOW_REDIRECTS", "false"));\r
+ eventloginterval = getProvParam("LOGROLL_INTERVAL", "5m");\r
+ initfailuretimer = 10000;\r
+ maxfailuretimer = 3600000;\r
+ expirationtimer = 86400000;\r
+ failurebackoff = 2.0;\r
+ deliverythreads = 40;\r
+ fairfilelimit = 100;\r
+ fairtimelimit = 60000;\r
+ fdpstart = 0.05;\r
+ fdpstop = 0.2;\r
+ try { initfailuretimer = (long)(Double.parseDouble(getProvParam("DELIVERY_INIT_RETRY_INTERVAL")) * 1000); } catch (Exception e) {}\r
+ try { maxfailuretimer = (long)(Double.parseDouble(getProvParam("DELIVERY_MAX_RETRY_INTERVAL")) * 1000); } catch (Exception e) {}\r
+ try { expirationtimer = (long)(Double.parseDouble(getProvParam("DELIVERY_MAX_AGE")) * 1000); } catch (Exception e) {}\r
+ try { failurebackoff = Double.parseDouble(getProvParam("DELIVERY_RETRY_RATIO")); } catch (Exception e) {}\r
+ try { deliverythreads = Integer.parseInt(getProvParam("DELIVERY_THREADS")); } catch (Exception e) {}\r
+ try { fairfilelimit = Integer.parseInt(getProvParam("FAIR_FILE_LIMIT")); } catch (Exception e) {}\r
+ try { fairtimelimit = (long)(Double.parseDouble(getProvParam("FAIR_TIME_LIMIT")) * 1000); } catch (Exception e) {}\r
+ try { fdpstart = Double.parseDouble(getProvParam("FREE_DISK_RED_PERCENT")) / 100.0; } catch (Exception e) {}\r
+ try { fdpstop = Double.parseDouble(getProvParam("FREE_DISK_YELLOW_PERCENT")) / 100.0; } catch (Exception e) {}\r
+ if (fdpstart < 0.01) {\r
+ fdpstart = 0.01;\r
+ }\r
+ if (fdpstart > 0.5) {\r
+ fdpstart = 0.5;\r
+ }\r
+ if (fdpstop < fdpstart) {\r
+ fdpstop = fdpstart;\r
+ }\r
+ if (fdpstop > 0.5) {\r
+ fdpstop = 0.5;\r
+ }\r
+ }\r
+ private void fetchconfig() {\r
+ try {\r
+ System.out.println("provurl:: "+provurl);\r
+ Reader r = new InputStreamReader((new URL(provurl)).openStream());\r
+ config = new NodeConfig(new ProvData(r), myname, spooldir, port, nak);\r
+ localconfig();\r
+ configtasks.startRun();\r
+ Runnable rr;\r
+ while ((rr = configtasks.next()) != null) {\r
+ try {\r
+ rr.run();\r
+ } catch (Exception e) {\r
+ }\r
+ }\r
+ } catch (Exception e) {\r
+ e.printStackTrace();\r
+ NodeUtils.setIpAndFqdnForEelf("fetchconfigs");\r
+ eelflogger.error(EelfMsgs.MESSAGE_CONF_FAILED, e.toString());\r
+ logger.error("NODE0306 Configuration failed " + e.toString() + " - try again later", e);\r
+ pfetcher.request();\r
+ }\r
+ }\r
+ /**\r
+ * Process a gofetch request from a particular IP address. If the\r
+ * IP address is not an IP address we would go to to fetch the\r
+ * provisioning data, ignore the request. If the data has been\r
+ * fetched very recently (default 10 seconds), wait a while before fetching again.\r
+ */\r
+ public synchronized void gofetch(String remoteaddr) {\r
+ if (provcheck.isFrom(remoteaddr)) {\r
+ logger.info("NODE0307 Received configuration fetch request from provisioning server " + remoteaddr);\r
+ pfetcher.request();\r
+ } else {\r
+ logger.info("NODE0308 Received configuration fetch request from unexpected server " + remoteaddr);\r
+ }\r
+ }\r
+ /**\r
+ * Am I configured?\r
+ */\r
+ public boolean isConfigured() {\r
+ return(config != null);\r
+ }\r
+ /**\r
+ * Am I shut down?\r
+ */\r
+ public boolean isShutdown() {\r
+ return(quiesce.exists());\r
+ }\r
+ /**\r
+ * Given a routing string, get the targets.\r
+ * @param routing Target string\r
+ * @return array of targets\r
+ */\r
+ public Target[] parseRouting(String routing) {\r
+ return(config.parseRouting(routing));\r
+ }\r
+ /**\r
+ * Given a set of credentials and an IP address, is this request from another node?\r
+ * @param credentials Credentials offered by the supposed node\r
+ * @param ip IP address the request came from\r
+ * @return If the credentials and IP address are recognized, true, otherwise false.\r
+ */\r
+ public boolean isAnotherNode(String credentials, String ip) {\r
+ return(config.isAnotherNode(credentials, ip));\r
+ }\r
+ /**\r
+ * Check whether publication is allowed.\r
+ * @param feedid The ID of the feed being requested\r
+ * @param credentials The offered credentials\r
+ * @param ip The requesting IP address\r
+ * @return True if the IP and credentials are valid for the specified feed.\r
+ */\r
+ public String isPublishPermitted(String feedid, String credentials, String ip) {\r
+ return(config.isPublishPermitted(feedid, credentials, ip));\r
+ }\r
+ /**\r
+ * Check who the user is given the feed ID and the offered credentials.\r
+ * @param feedid The ID of the feed specified\r
+ * @param credentials The offered credentials\r
+ * @return Null if the credentials are invalid or the user if they are valid.\r
+ */\r
+ public String getAuthUser(String feedid, String credentials) {\r
+ return(config.getAuthUser(feedid, credentials));\r
+ }\r
+ /**\r
+ * Check if the publish request should be sent to another node based on the feedid, user, and source IP address.\r
+ * @param feedid The ID of the feed specified\r
+ * @param user The publishing user\r
+ * @param ip The IP address of the publish endpoint\r
+ * @return Null if the request should be accepted or the correct hostname if it should be sent to another node.\r
+ */\r
+ public String getIngressNode(String feedid, String user, String ip) {\r
+ return(config.getIngressNode(feedid, user, ip));\r
+ }\r
+ /**\r
+ * Get a provisioned configuration parameter (from the provisioning server configuration)\r
+ * @param name The name of the parameter\r
+ * @return The value of the parameter or null if it is not defined.\r
+ */\r
+ public String getProvParam(String name) {\r
+ return(config.getProvParam(name));\r
+ }\r
+ /**\r
+ * Get a provisioned configuration parameter (from the provisioning server configuration)\r
+ * @param name The name of the parameter\r
+ * @param deflt The value to use if the parameter is not defined\r
+ * @return The value of the parameter or deflt if it is not defined.\r
+ */\r
+ public String getProvParam(String name, String deflt) {\r
+ name = config.getProvParam(name);\r
+ if (name == null) {\r
+ name = deflt;\r
+ }\r
+ return(name);\r
+ }\r
+ /**\r
+ * Generate a publish ID\r
+ */\r
+ public String getPublishId() {\r
+ return(pid.next());\r
+ }\r
+ /**\r
+ * Get all the outbound spooling destinations.\r
+ * This will include both subscriptions and nodes.\r
+ */\r
+ public DestInfo[] getAllDests() {\r
+ return(config.getAllDests());\r
+ }\r
+ /**\r
+ * Register a task to run whenever the configuration changes\r
+ */\r
+ public void registerConfigTask(Runnable task) {\r
+ configtasks.addTask(task);\r
+ }\r
+ /**\r
+ * Deregister a task to run whenever the configuration changes\r
+ */\r
+ public void deregisterConfigTask(Runnable task) {\r
+ configtasks.removeTask(task);\r
+ }\r
+ /**\r
+ * Get the URL to deliver a message to.\r
+ * @param destinfo The destination information\r
+ * @param fileid The file ID\r
+ * @return The URL to deliver to\r
+ */\r
+ public String getDestURL(DestInfo destinfo, String fileid) {\r
+ String subid = destinfo.getSubId();\r
+ String purl = destinfo.getURL();\r
+ if (followredirects && subid != null) {\r
+ purl = rdmgr.lookup(subid, purl);\r
+ }\r
+ return(purl + "/" + fileid);\r
+ }\r
+ /**\r
+ * Is a destination redirected?\r
+ */\r
+ public boolean isDestRedirected(DestInfo destinfo) {\r
+ return(followredirects && rdmgr.isRedirected(destinfo.getSubId()));\r
+ }\r
+ /**\r
+ * Set up redirection on receipt of a 3XX from a target URL\r
+ */\r
+ public boolean handleRedirection(DestInfo destinfo, String redirto, String fileid) {\r
+ fileid = "/" + fileid;\r
+ String subid = destinfo.getSubId();\r
+ String purl = destinfo.getURL();\r
+ if (followredirects && subid != null && redirto.endsWith(fileid)) {\r
+ redirto = redirto.substring(0, redirto.length() - fileid.length());\r
+ if (!redirto.equals(purl)) {\r
+ rdmgr.redirect(subid, purl, redirto);\r
+ return(true);\r
+ }\r
+ }\r
+ return(false);\r
+ }\r
+ /**\r
+ * Handle unreachable target URL\r
+ */\r
+ public void handleUnreachable(DestInfo destinfo) {\r
+ String subid = destinfo.getSubId();\r
+ if (followredirects && subid != null) {\r
+ rdmgr.forget(subid);\r
+ }\r
+ }\r
+ /**\r
+ * Get the timeout before retrying after an initial delivery failure\r
+ */\r
+ public long getInitFailureTimer() {\r
+ return(initfailuretimer);\r
+ }\r
+ /**\r
+ * Get the maximum timeout between delivery attempts\r
+ */\r
+ public long getMaxFailureTimer() {\r
+ return(maxfailuretimer);\r
+ }\r
+ /**\r
+ * Get the ratio between consecutive delivery attempts\r
+ */\r
+ public double getFailureBackoff() {\r
+ return(failurebackoff);\r
+ }\r
+ /**\r
+ * Get the expiration timer for deliveries\r
+ */\r
+ public long getExpirationTimer() {\r
+ return(expirationtimer);\r
+ }\r
+ /**\r
+ * Get the maximum number of file delivery attempts before checking\r
+ * if another queue has work to be performed.\r
+ */\r
+ public int getFairFileLimit() {\r
+ return(fairfilelimit);\r
+ }\r
+ /**\r
+ * Get the maximum amount of time spent delivering files before\r
+ * checking if another queue has work to be performed.\r
+ */\r
+ public long getFairTimeLimit() {\r
+ return(fairtimelimit);\r
+ }\r
+ /**\r
+ * Get the targets for a feed\r
+ * @param feedid The feed ID\r
+ * @return The targets this feed should be delivered to\r
+ */\r
+ public Target[] getTargets(String feedid) {\r
+ return(config.getTargets(feedid));\r
+ }\r
+ /**\r
+ * Get the spool directory for temporary files\r
+ */\r
+ public String getSpoolDir() {\r
+ return(spooldir + "/f");\r
+ }\r
+ /**\r
+ * Get the base directory for spool directories\r
+ */\r
+ public String getSpoolBase() {\r
+ return(spooldir);\r
+ }\r
+ /**\r
+ * Get the key store type\r
+ */\r
+ public String getKSType() {\r
+ return(kstype);\r
+ }\r
+ /**\r
+ * Get the key store file\r
+ */\r
+ public String getKSFile() {\r
+ return(ksfile);\r
+ }\r
+ /**\r
+ * Get the key store password\r
+ */\r
+ public String getKSPass() {\r
+ return(kspass);\r
+ }\r
+ /**\r
+ * Get the key password\r
+ */\r
+ public String getKPass() {\r
+ return(kpass);\r
+ }\r
+ /**\r
+ * Get the http port\r
+ */\r
+ public int getHttpPort() {\r
+ return(gfport);\r
+ }\r
+ /**\r
+ * Get the https port\r
+ */\r
+ public int getHttpsPort() {\r
+ return(svcport);\r
+ }\r
+ /**\r
+ * Get the externally visible https port\r
+ */\r
+ public int getExtHttpsPort() {\r
+ return(port);\r
+ }\r
+ /**\r
+ * Get the external name of this machine\r
+ */\r
+ public String getMyName() {\r
+ return(myname);\r
+ }\r
+ /**\r
+ * Get the number of threads to use for delivery\r
+ */\r
+ public int getDeliveryThreads() {\r
+ return(deliverythreads);\r
+ }\r
+ /**\r
+ * Get the URL for uploading the event log data\r
+ */\r
+ public String getEventLogUrl() {\r
+ return(eventlogurl);\r
+ }\r
+ /**\r
+ * Get the prefix for the names of event log files\r
+ */\r
+ public String getEventLogPrefix() {\r
+ return(eventlogprefix);\r
+ }\r
+ /**\r
+ * Get the suffix for the names of the event log files\r
+ */\r
+ public String getEventLogSuffix() {\r
+ return(eventlogsuffix);\r
+ }\r
+ /**\r
+ * Get the interval between event log file rollovers\r
+ */\r
+ public String getEventLogInterval() {\r
+ return(eventloginterval);\r
+ }\r
+ /**\r
+ * Should I follow redirects from subscribers?\r
+ */\r
+ public boolean isFollowRedirects() {\r
+ return(followredirects);\r
+ }\r
+ /**\r
+ * Get the directory where the event and node log files live\r
+ */\r
+ public String getLogDir() {\r
+ return(logdir);\r
+ }\r
+ /**\r
+ * How long do I keep log files (in milliseconds)\r
+ */\r
+ public long getLogRetention() {\r
+ return(logretention);\r
+ }\r
+ /**\r
+ * Get the timer\r
+ */\r
+ public Timer getTimer() {\r
+ return(timer);\r
+ }\r
+ /**\r
+ * Get the feed ID for a subscription\r
+ * @param subid The subscription ID\r
+ * @return The feed ID\r
+ */\r
+ public String getFeedId(String subid) {\r
+ return(config.getFeedId(subid));\r
+ }\r
+ /**\r
+ * Get the authorization string this node uses\r
+ * @return The Authorization string for this node\r
+ */\r
+ public String getMyAuth() {\r
+ return(config.getMyAuth());\r
+ }\r
+ /**\r
+ * Get the fraction of free spool disk space where we start throwing away undelivered files. This is FREE_DISK_RED_PERCENT / 100.0. Default is 0.05. Limited by 0.01 <= FreeDiskStart <= 0.5.\r
+ */\r
+ public double getFreeDiskStart() {\r
+ return(fdpstart);\r
+ }\r
+ /**\r
+ * Get the fraction of free spool disk space where we stop throwing away undelivered files. This is FREE_DISK_YELLOW_PERCENT / 100.0. Default is 0.2. Limited by FreeDiskStart <= FreeDiskStop <= 0.5.\r
+ */\r
+ public double getFreeDiskStop() {\r
+ return(fdpstop);\r
+ }\r
+ /**\r
+ * Get the spool directory for a subscription\r
+ */\r
+ public String getSpoolDir(String subid, String remoteaddr) {\r
+ if (provcheck.isFrom(remoteaddr)) {\r
+ String sdir = config.getSpoolDir(subid);\r
+ if (sdir != null) {\r
+ logger.info("NODE0310 Received subscription reset request for subscription " + subid + " from provisioning server " + remoteaddr);\r
+ } else {\r
+ logger.info("NODE0311 Received subscription reset request for unknown subscription " + subid + " from provisioning server " + remoteaddr);\r
+ }\r
+ return(sdir);\r
+ } else {\r
+ logger.info("NODE0312 Received subscription reset request from unexpected server " + remoteaddr);\r
+ return(null);\r
+ }\r
+ }\r
+}\r