dcae-analytics-common/src/main/java/org/openecomp/dcae/apod/analytics/common/AnalyticsConstants.java

   1 /*\r
   2  * ===============================LICENSE_START======================================\r
   3  *  dcae-analytics\r
   4  * ================================================================================\r
   5  *    Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
   6  * ================================================================================\r
   7  *  Licensed under the Apache License, Version 2.0 (the "License");\r
   8  *  you may not use this file except in compliance with the License.\r
   9  *   You may obtain a copy of the License at\r
  10  *\r
  11  *          http://www.apache.org/licenses/LICENSE-2.0\r
  12  *\r
  13  *  Unless required by applicable law or agreed to in writing, software\r
  14  *  distributed under the License is distributed on an "AS IS" BASIS,\r
  15  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  16  *  See the License for the specific language governing permissions and\r
  17  *  limitations under the License.\r
  18  *  ============================LICENSE_END===========================================\r
  19  */\r
  20 \r
  21 package org.openecomp.dcae.apod.analytics.common;\r
  22 \r
  23 /**\r
  24  * Contains static variable for all DCAE Components.\r
  25  *\r
  26  * @author Rajiv Singla . Creation Date: 10/21/2016.\r
  27  */\r
  28 public abstract class AnalyticsConstants {\r
  29 \r
  30     // ===============  Common Constants for all DCAE Analytics Modules ==================== //\r
  31 \r
  32 \r
  33     // ===============  DMaaP Constants for all DCAE Analytics Modules ==================== //\r
  34 \r
  35     // DMaaP Config Constants\r
  36     public static final Integer DEFAULT_PORT_NUMBER = 80; // default port number\r
  37     public static final String DEFAULT_USER_NAME = null; // default to no username\r
  38     public static final String DEFAULT_USER_PASSWORD = null; // defaults to no userPassword\r
  39     public static final String DEFAULT_PROTOCOL = "https"; // defaults to using https protocol\r
  40     public static final String DEFAULT_CONTENT_TYPE = "application/json";  // defaults to json content type\r
  41 \r
  42     public static final String DMAAP_URI_PATH_PREFIX = "/events/";\r
  43     public static final String DMAAP_GROUP_PREFIX = "OpenDCAE-";\r
  44 \r
  45     // ================== DMaaP MR Constants ============================== //\r
  46     // Publisher Constants\r
  47     public static final int DEFAULT_PUBLISHER_MAX_BATCH_SIZE = 1; // disable batching by default\r
  48     public static final int DEFAULT_PUBLISHER_MAX_RECOVERY_QUEUE_SIZE = 100000; // default recovery messages size\r
  49     public static final int PUBLISHER_MAX_FLUSH_RETRIES_ON_CLOSE = 5; // number of retries when flushing messages\r
  50     public static final int PUBLISHER_DELAY_MS_ON_RETRIES_ON_CLOSE = 5000; // delay in retrying for flushing messages\r
  51     // Subscriber Constants\r
  52     public static final int DEFAULT_SUBSCRIBER_TIMEOUT_MS = -1;\r
  53     public static final int DEFAULT_SUBSCRIBER_MESSAGE_LIMIT = -1;\r
  54     public static final String DEFAULT_SUBSCRIBER_GROUP_PREFIX = DMAAP_GROUP_PREFIX + "DMaaPSub-";\r
  55     public static final String SUBSCRIBER_TIMEOUT_QUERY_PARAM_NAME = "timeout";\r
  56     public static final String SUBSCRIBER_MSG_LIMIT_QUERY_PARAM_NAME = "limit";\r
  57 \r
  58 \r
  59     // ================== TCA Constants ============================== //\r
  60 \r
  61     // Default subscriber polling interval\r
  62     public static final Integer TCA_DEFAULT_SUBSCRIBER_POLLING_INTERVAL_MS = 30000;\r
  63 \r
  64     // Default publisher polling interval\r
  65     public static final Integer TCA_DEFAULT_PUBLISHER_POLLING_INTERVAL_MS = 30000;\r
  66 \r
  67     // Default publisher max batch queue size determines the minimum number of messages that need to be published in\r
  68     // batch mode\r
  69     public static final Integer TCA_DEFAULT_PUBLISHER_MAX_BATCH_QUEUE_SIZE = 10;\r
  70 \r
  71     // Default publisher max recovery queue size determines max number of messages can be cached in memory\r
  72     // in case publisher is not responding\r
  73     public static final Integer TCA_DEFAULT_PUBLISHER_MAX_RECOVERY_QUEUE_SIZE = 100000;\r
  74 \r
  75     // Default interval during which TCA DMaaP Worker checks if scheduler is shut down\r
  76     public static final Integer TCA_DEFAULT_WORKER_SHUTDOWN_CHECK_INTERVAL_MS = 5000;\r
  77 \r
  78     // ***** TCA Quartz Scheduler Settings ******//\r
  79 \r
  80     public static final String TCA_QUARTZ_SUBSCRIBER_PROPERTIES_FILE_NAME = "quartz-subscriber.properties";\r
  81 \r
  82     public static final String TCA_QUARTZ_PUBLISHER_PROPERTIES_FILE_NAME = "quartz-publisher.properties";\r
  83 \r
  84     // TCA Quartz Group Settings\r
  85     public static final String TCA_QUARTZ_GROUP_NAME = "TCAQuartzGroup";\r
  86     // TCA Quartz Trigger Settings\r
  87     public static final String TCA_DMAAP_SUBSCRIBER_QUARTZ_TRIGGER_NAME = "TCADMaaPSubscriberTrigger";\r
  88     public static final String TCA_DMAAP_PUBLISHER_QUARTZ_TRIGGER_NAME = "TCADMaaPPublisherTrigger";\r
  89 \r
  90     // TCA Quartz DMaaP Subscriber Job Settings\r
  91     public static final String TCA_DMAAP_SUBSCRIBER_QUARTZ_JOB_NAME = "TCADMaaPSubscriberJob";\r
  92     public static final String TCA_DMAAP_PUBLISHER_QUARTZ_JOB_NAME = "TCADMaaPPublisherJob";\r
  93 \r
  94     // TCA Quartz Publisher and Subscriber Job Parameters\r
  95     // Common Job parameters for both Publisher and Subscriber\r
  96     public static final String WORKER_CONTEXT_VARIABLE_NAME = "WORKER_CONTEXT";\r
  97     public static final String DMAAP_METRICS_VARIABLE_NAME = "DMAAP_METRICS";\r
  98     // TCA Quartz DMaaP Subscriber Job Parameter Settings\r
  99     public static final String CDAP_STREAM_VARIABLE_NAME = "CDAP_STREAM_NAME";\r
 100     public static final String DMAAP_SUBSCRIBER_VARIABLE_NAME = "DMAAP_SUBSCRIBER";\r
 101     // TCA Quartz DMaaP Publisher Job Parameter Settings\r
 102     public static final String CDAP_ALERTS_TABLE_VARIABLE_NAME = "CDAP_TCA_ALERTS_TABLE_NAME";\r
 103     public static final String DMAAP_PUBLISHER_VARIABLE_NAME = "DMAAP_PUBLISHER";\r
 104 \r
 105     // TCA VES Response Constants\r
 106     // VNF Constants\r
 107     public static final String TCA_VES_RESPONSE_VNF_TARGET_TYPE = "VNF";\r
 108     public static final String AAI_VNF_KEY_PREFIX = "generic-vnf.";\r
 109     public static final String TCA_VES_RESPONSE_VNF_TARGET = AAI_VNF_KEY_PREFIX + "vnf-name";\r
 110     // VM Constants\r
 111     public static final String TCA_VES_RESPONSE_VM_TARGET_TYPE = "VM";\r
 112     public static final String AAI_VSERVER_KEY_PREFIX = "vserver.";\r
 113     public static final String TCA_VES_RESPONSE_VM_TARGET =  AAI_VSERVER_KEY_PREFIX + "vserver-name";\r
 114     // VNF & VM - Common Constants\r
 115     public static final String TCA_VES_RESPONSE_FROM = "DCAE";\r
 116 \r
 117     // TCA VES Message Router Partition Key\r
 118     public static final String TCA_VES_MESSAGE_ROUTER_PARTITION_KEY = "VESMessageHash";\r
 119 \r
 120     /**\r
 121      * Default Number of instances for Threshold violation calculator flowlet\r
 122      */\r
 123     public static final Integer TCA_DEFAULT_THRESHOLD_CALCULATOR_FLOWLET_INSTANCES = 2;\r
 124 \r
 125     /**\r
 126      * Default TTL for TCA VES Message status table which contain status of all messages processed by TCA\r
 127      */\r
 128     public static final Integer TCA_DEFAULT_VES_MESSAGE_STATUS_TTL_TABLE = 60 * 60 * 24 * 10; // 10 Days\r
 129 \r
 130     /**\r
 131      * Default TTL for TCA VES Alerts table which contains alerts that can be send to downstream systems\r
 132      */\r
 133     public static final Integer TCA_DEFAULT_VES_ALERTS_TTL_TABLE = 60 * 60 * 24 * 30; // 30 Days\r
 134 \r
 135 \r
 136     /**\r
 137      * Default TTL for TCA Alerts abatement table which contains information to send out abated alerts\r
 138      */\r
 139     public static final Integer TCA_DEFAULT_ALERTS_ABATEMENT_TTL_TABLE = 60 * 60 * 24 * 30; // 30 Days\r
 140 \r
 141 \r
 142     // TCA Policy Runtime Argument Paths\r
 143     public static final String TCA_POLICY_DELIMITER = ".";\r
 144     public static final String TCA_POLICY_DOMAIN_PATH = "domain";\r
 145     public static final String TCA_POLICY_METRICS_PER_FUNCTIONAL_ROLE_PATH = "configuration.metricsPerEventName";\r
 146     public static final String TCA_POLICY_THRESHOLDS_PATH_POSTFIX = "thresholds";\r
 147 \r
 148     public static final String TCA_POLICY_JSON_KEY = "tca_policy";\r
 149     public static final String TCA_POLICY_STRING_DELIMITER = "\"";\r
 150 \r
 151     // TCA Alert output format by default is not CEF\r
 152     public static final Boolean TCA_DEFAULT_ENABLE_CEF_FORMATTED_ALERT = false;\r
 153 \r
 154     // TCA A&AI Enrichment is disabled by default\r
 155     public static final Boolean TCA_DEFAULT_ENABLE_AAI_ENRICHMENT = false;\r
 156     // TCA A&AI SSL Certificate errors by default are *NOT* ignored\r
 157     public static final Boolean TCA_DEFAULT_AAI_ENRICHMENT_IGNORE_SSL_CERTIFICATE_ERRORS = false;\r
 158     // TCA A&AI proxy is disabled by default\r
 159     public static final String TCA_DEFAULT_AAI_ENRICHMENT_PROXY_URL = null;\r
 160 \r
 161 \r
 162 \r
 163     private AnalyticsConstants() {\r
 164 \r
 165     }\r
 166 \r
 167 }\r