1 /*******************************************************************************
2 * ============LICENSE_START==================================================
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
11 * * http://www.apache.org/licenses/LICENSE-2.0
13 * * Unless required by applicable law or agreed to in writing, software
14 * * distributed under the License is distributed on an "AS IS" BASIS,
15 * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * * See the License for the specific language governing permissions and
17 * * limitations under the License.
18 * * ============LICENSE_END====================================================
20 * * ECOMP is a trademark and service mark of AT&T Intellectual Property.
22 ******************************************************************************/
25 package org.onap.dmaap.datarouter.node;
31 import org.apache.log4j.Logger;
32 import org.onap.dmaap.datarouter.node.eelf.EelfMsgs;
34 import com.att.eelf.configuration.EELFLogger;
35 import com.att.eelf.configuration.EELFManager;
39 * Maintain the configuration of a Data Router node
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).
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.
48 public class NodeConfigManager implements DeliveryQueueHelper {
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();
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;
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;
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;
87 private PublishId pid;
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;
98 * Get the default node configuration manager
100 public static NodeConfigManager getInstance() {
105 * Initialize the configuration of a Data Router node
107 private NodeConfigManager() {
108 Properties p = new Properties();
110 p.load(new FileInputStream(System
111 .getProperty("org.onap.dmaap.datarouter.node.properties", "/opt/app/datartr/etc/node.properties")));
112 } catch (Exception e) {
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);
119 provurl = p.getProperty("ProvisioningURL", "https://feeds-drtr.web.att.com/internal/prov");
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);
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");
139 for (File junk : fdir.listFiles()) {
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);
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);
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) {
179 logger.info("NODE0305 Attempting to fetch configuration at " + provurl);
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;
192 fairtimelimit = 60000;
196 initfailuretimer = (long) (Double.parseDouble(getProvParam("DELIVERY_INIT_RETRY_INTERVAL")) * 1000);
197 } catch (Exception e) {
200 maxfailuretimer = (long) (Double.parseDouble(getProvParam("DELIVERY_MAX_RETRY_INTERVAL")) * 1000);
201 } catch (Exception e) {
204 expirationtimer = (long) (Double.parseDouble(getProvParam("DELIVERY_MAX_AGE")) * 1000);
205 } catch (Exception e) {
208 failurebackoff = Double.parseDouble(getProvParam("DELIVERY_RETRY_RATIO"));
209 } catch (Exception e) {
212 deliverythreads = Integer.parseInt(getProvParam("DELIVERY_THREADS"));
213 } catch (Exception e) {
216 fairfilelimit = Integer.parseInt(getProvParam("FAIR_FILE_LIMIT"));
217 } catch (Exception e) {
220 fairtimelimit = (long) (Double.parseDouble(getProvParam("FAIR_TIME_LIMIT")) * 1000);
221 } catch (Exception e) {
224 fdpstart = Double.parseDouble(getProvParam("FREE_DISK_RED_PERCENT")) / 100.0;
225 } catch (Exception e) {
228 fdpstop = Double.parseDouble(getProvParam("FREE_DISK_YELLOW_PERCENT")) / 100.0;
229 } catch (Exception e) {
231 if (fdpstart < 0.01) {
234 if (fdpstart > 0.5) {
237 if (fdpstop < fdpstart) {
245 private void fetchconfig() {
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);
251 configtasks.startRun();
253 while ((rr = configtasks.next()) != null) {
256 } catch (Exception e) {
259 } catch (Exception e) {
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);
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.
273 public synchronized void gofetch(String remoteaddr) {
274 if (provcheck.isFrom(remoteaddr)) {
275 logger.info("NODE0307 Received configuration fetch request from provisioning server " + remoteaddr);
278 logger.info("NODE0308 Received configuration fetch request from unexpected server " + remoteaddr);
285 public boolean isConfigured() {
286 return (config != null);
292 public boolean isShutdown() {
293 return (quiesce.exists());
297 * Given a routing string, get the targets.
299 * @param routing Target string
300 * @return array of targets
302 public Target[] parseRouting(String routing) {
303 return (config.parseRouting(routing));
307 * Given a set of credentials and an IP address, is this request from another node?
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.
313 public boolean isAnotherNode(String credentials, String ip) {
314 return (config.isAnotherNode(credentials, ip));
318 * Check whether publication is allowed.
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.
325 public String isPublishPermitted(String feedid, String credentials, String ip) {
326 return (config.isPublishPermitted(feedid, credentials, ip));
330 * Check who the user is given the feed ID and the offered credentials.
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.
336 public String getAuthUser(String feedid, String credentials) {
337 return (config.getAuthUser(feedid, credentials));
341 * Check if the publish request should be sent to another node based on the feedid, user, and source IP address.
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.
348 public String getIngressNode(String feedid, String user, String ip) {
349 return (config.getIngressNode(feedid, user, ip));
353 * Get a provisioned configuration parameter (from the provisioning server configuration)
355 * @param name The name of the parameter
356 * @return The value of the parameter or null if it is not defined.
358 public String getProvParam(String name) {
359 return (config.getProvParam(name));
363 * Get a provisioned configuration parameter (from the provisioning server configuration)
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.
369 public String getProvParam(String name, String deflt) {
370 name = config.getProvParam(name);
378 * Generate a publish ID
380 public String getPublishId() {
385 * Get all the outbound spooling destinations. This will include both subscriptions and nodes.
387 public DestInfo[] getAllDests() {
388 return (config.getAllDests());
392 * Register a task to run whenever the configuration changes
394 public void registerConfigTask(Runnable task) {
395 configtasks.addTask(task);
399 * Deregister a task to run whenever the configuration changes
401 public void deregisterConfigTask(Runnable task) {
402 configtasks.removeTask(task);
406 * Get the URL to deliver a message to.
408 * @param destinfo The destination information
409 * @param fileid The file ID
410 * @return The URL to deliver to
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);
418 return (purl + "/" + fileid);
422 * Is a destination redirected?
424 public boolean isDestRedirected(DestInfo destinfo) {
425 return (followredirects && rdmgr.isRedirected(destinfo.getSubId()));
429 * Set up redirection on receipt of a 3XX from a target URL
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);
446 * Handle unreachable target URL
448 public void handleUnreachable(DestInfo destinfo) {
449 String subid = destinfo.getSubId();
450 if (followredirects && subid != null) {
456 * Get the timeout before retrying after an initial delivery failure
458 public long getInitFailureTimer() {
459 return (initfailuretimer);
463 * Get the maximum timeout between delivery attempts
465 public long getMaxFailureTimer() {
466 return (maxfailuretimer);
470 * Get the ratio between consecutive delivery attempts
472 public double getFailureBackoff() {
473 return (failurebackoff);
477 * Get the expiration timer for deliveries
479 public long getExpirationTimer() {
480 return (expirationtimer);
484 * Get the maximum number of file delivery attempts before checking if another queue has work to be performed.
486 public int getFairFileLimit() {
487 return (fairfilelimit);
491 * Get the maximum amount of time spent delivering files before checking if another queue has work to be performed.
493 public long getFairTimeLimit() {
494 return (fairtimelimit);
498 * Get the targets for a feed
500 * @param feedid The feed ID
501 * @return The targets this feed should be delivered to
503 public Target[] getTargets(String feedid) {
504 return (config.getTargets(feedid));
508 * Get the spool directory for temporary files
510 public String getSpoolDir() {
511 return (spooldir + "/f");
515 * Get the base directory for spool directories
517 public String getSpoolBase() {
522 * Get the key store type
524 public String getKSType() {
529 * Get the key store file
531 public String getKSFile() {
536 * Get the key store password
538 public String getKSPass() {
543 * Get the key password
545 public String getKPass() {
552 public int getHttpPort() {
559 public int getHttpsPort() {
564 * Get the externally visible https port
566 public int getExtHttpsPort() {
571 * Get the external name of this machine
573 public String getMyName() {
578 * Get the number of threads to use for delivery
580 public int getDeliveryThreads() {
581 return (deliverythreads);
585 * Get the URL for uploading the event log data
587 public String getEventLogUrl() {
588 return (eventlogurl);
592 * Get the prefix for the names of event log files
594 public String getEventLogPrefix() {
595 return (eventlogprefix);
599 * Get the suffix for the names of the event log files
601 public String getEventLogSuffix() {
602 return (eventlogsuffix);
606 * Get the interval between event log file rollovers
608 public String getEventLogInterval() {
609 return (eventloginterval);
613 * Should I follow redirects from subscribers?
615 public boolean isFollowRedirects() {
616 return (followredirects);
620 * Get the directory where the event and node log files live
622 public String getLogDir() {
627 * How long do I keep log files (in milliseconds)
629 public long getLogRetention() {
630 return (logretention);
636 public Timer getTimer() {
641 * Get the feed ID for a subscription
643 * @param subid The subscription ID
644 * @return The feed ID
646 public String getFeedId(String subid) {
647 return (config.getFeedId(subid));
651 * Get the authorization string this node uses
653 * @return The Authorization string for this node
655 public String getMyAuth() {
656 return (config.getMyAuth());
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.
663 public double getFreeDiskStart() {
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.
671 public double getFreeDiskStop() {
676 * Get the spool directory for a subscription
678 public String getSpoolDir(String subid, String remoteaddr) {
679 if (provcheck.isFrom(remoteaddr)) {
680 String sdir = config.getSpoolDir(subid);
682 logger.info("NODE0310 Received subscription reset request for subscription " + subid
683 + " from provisioning server " + remoteaddr);
685 logger.info("NODE0311 Received subscription reset request for unknown subscription " + subid
686 + " from provisioning server " + remoteaddr);
690 logger.info("NODE0312 Received subscription reset request from unexpected server " + remoteaddr);