001/* 002 * Sonar, open source software quality management tool. 003 * Copyright (C) 2008-2012 SonarSource 004 * mailto:contact AT sonarsource DOT com 005 * 006 * Sonar is free software; you can redistribute it and/or 007 * modify it under the terms of the GNU Lesser General Public 008 * License as published by the Free Software Foundation; either 009 * version 3 of the License, or (at your option) any later version. 010 * 011 * Sonar is distributed in the hope that it will be useful, 012 * but WITHOUT ANY WARRANTY; without even the implied warranty of 013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014 * Lesser General Public License for more details. 015 * 016 * You should have received a copy of the GNU Lesser General Public 017 * License along with Sonar; if not, write to the Free Software 018 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02 019 */ 020package org.sonar.api; 021 022/** 023 * CoreProperties is used to group various properties of Sonar as well 024 * as default values of configuration in a single place 025 * 026 * @since 1.11 027 */ 028public interface CoreProperties { 029 030 /** 031 * @since 3.0 032 */ 033 String ENCRYPTION_SECRET_KEY_PATH = "sonar.secretKeyPath"; 034 035 /** 036 * @since 2.11 037 */ 038 String CATEGORY_GENERAL = "general"; 039 040 /** 041 * @since 2.11 042 */ 043 String CATEGORY_CODE_COVERAGE = "codeCoverage"; 044 045 /** 046 * @since 2.11 047 */ 048 String CATEGORY_DUPLICATIONS = "duplications"; 049 050 /** 051 * @since 2.11 052 */ 053 String CATEGORY_SECURITY = "security"; 054 055 /** 056 * @since 2.11 057 */ 058 String CATEGORY_L10N = "localization"; 059 060 /** 061 * @since 2.11 062 */ 063 String CATEGORY_JAVA = "java"; 064 065 /** 066 * @since 2.11 067 */ 068 String CATEGORY_DIFFERENTIAL_VIEWS = "differentialViews"; 069 070 /** 071 * @since 3.3 072 */ 073 String CATEGORY_EXCLUSIONS = "exclusions"; 074 075 /* Global settings */ 076 String SONAR_HOME = "SONAR_HOME"; 077 String PROJECT_BRANCH_PROPERTY = "sonar.branch"; 078 String PROJECT_VERSION_PROPERTY = "sonar.projectVersion"; 079 080 /** 081 * @since 2.6 082 */ 083 String PROJECT_KEY_PROPERTY = "sonar.projectKey"; 084 085 /** 086 * @since 2.6 087 */ 088 String PROJECT_NAME_PROPERTY = "sonar.projectName"; 089 090 /** 091 * @since 2.6 092 */ 093 String PROJECT_DESCRIPTION_PROPERTY = "sonar.projectDescription"; 094 095 /** 096 * To determine value of this property use {@link org.sonar.api.resources.ProjectFileSystem#getSourceCharset()}. 097 * 098 * @since 2.6 099 */ 100 String ENCODING_PROPERTY = "sonar.sourceEncoding"; 101 102 /** 103 * Value format is yyyy-MM-dd 104 */ 105 String PROJECT_DATE_PROPERTY = "sonar.projectDate"; 106 107 String PROJECT_LANGUAGE_PROPERTY = "sonar.language"; 108 String DYNAMIC_ANALYSIS_PROPERTY = "sonar.dynamicAnalysis"; 109 110 /* Exclusions */ 111 String PROJECT_EXCLUSIONS_PROPERTY = "sonar.exclusions"; 112 113 /** 114 * @since 3.3 115 */ 116 String PROJECT_TEST_EXCLUSIONS_PROPERTY = "sonar.test.exclusions"; 117 String GLOBAL_EXCLUSIONS_PROPERTY = "sonar.global.exclusions"; 118 String GLOBAL_TEST_EXCLUSIONS_PROPERTY = "sonar.global.test.exclusions"; 119 String GLOBAL_TEST_EXCLUSIONS_DEFAULT = "**/package-info.java"; 120 121 /** 122 * @deprecated since 2.5. See discussion from http://jira.codehaus.org/browse/SONAR-1873 123 */ 124 @Deprecated 125 String REUSE_RULES_CONFIGURATION_PROPERTY = "sonar.reuseExistingRulesConfiguration"; 126 127 /* Checkstyle */ 128 String CHECKSTYLE_PLUGIN = "checkstyle"; 129 130 /* Cobertura */ 131 String COBERTURA_PLUGIN = "cobertura"; 132 String COBERTURA_REPORT_PATH_PROPERTY = "sonar.cobertura.reportPath"; 133 String COBERTURA_MAXMEM_PROPERTY = "sonar.cobertura.maxmem"; 134 String COBERTURA_MAXMEM_DEFAULT_VALUE = "64m"; 135 136 /* Sonar Core */ 137 String CORE_PLUGIN = "core"; 138 String CORE_VIOLATION_LOCALE_PROPERTY = "sonar.violationLocale"; 139 String CORE_VIOLATION_LOCALE_DEFAULT_VALUE = "en"; 140 String CORE_COVERAGE_PLUGIN_PROPERTY = "sonar.core.codeCoveragePlugin"; 141 String CORE_IMPORT_SOURCES_PROPERTY = "sonar.importSources"; 142 boolean CORE_IMPORT_SOURCES_DEFAULT_VALUE = true; 143 String CORE_SKIPPED_MODULES_PROPERTY = "sonar.skippedModules"; 144 String CORE_RULE_WEIGHTS_PROPERTY = "sonar.core.rule.weight"; 145 String CORE_RULE_WEIGHTS_DEFAULT_VALUE = "INFO=0;MINOR=1;MAJOR=3;CRITICAL=5;BLOCKER=10"; 146 String CORE_TENDENCY_DEPTH_PROPERTY = "tendency.depth"; 147 int CORE_TENDENCY_DEPTH_DEFAULT_VALUE = 30; 148 String CORE_FORCE_AUTHENTICATION_PROPERTY = "sonar.forceAuthentication"; 149 boolean CORE_FORCE_AUTHENTICATION_DEFAULT_VALUE = false; 150 String CORE_ALLOW_USERS_TO_SIGNUP_PROPERTY = "sonar.allowUsersToSignUp"; 151 String CORE_DEFAULT_GROUP = "sonar.defaultGroup"; 152 String CORE_DEFAULT_GROUP_DEFAULT_VALUE = "sonar-users"; 153 boolean CORE_ALLOW_USERS_TO_SIGNUP_DEAULT_VALUE = false; 154 String CORE_AUTHENTICATOR_CLASS = "sonar.authenticator.class"; 155 String CORE_AUTHENTICATOR_IGNORE_STARTUP_FAILURE = "sonar.authenticator.ignoreStartupFailure"; 156 String CORE_AUTHENTICATOR_CREATE_USERS = "sonar.authenticator.createUsers"; 157 String SERVER_VERSION = "sonar.core.version"; 158 String SERVER_ID = "sonar.core.id"; 159 String SERVER_STARTTIME = "sonar.core.startTime"; // format is yyyy-MM-dd'T'HH:mm:ssZ 160 String SKIP_TENDENCIES_PROPERTY = "sonar.skipTendencies"; 161 boolean SKIP_TENDENCIES_DEFAULT_VALUE = false; 162 String BATCH_INCLUDE_PLUGINS = "sonar.includePlugins"; 163 String BATCH_EXCLUDE_PLUGINS = "sonar.excludePlugins"; 164 165 /** 166 * @since 2.10 167 */ 168 String SERVER_BASE_URL = "sonar.core.serverBaseURL"; 169 170 /** 171 * @see #SERVER_BASE_URL 172 * @since 2.10 173 */ 174 String SERVER_BASE_URL_DEFAULT_VALUE = "http://localhost:9000"; 175 176 /* CPD */ 177 String CPD_PLUGIN = "cpd"; 178 179 /** 180 * @deprecated in 3.1 181 */ 182 @Deprecated 183 String CPD_MINIMUM_TOKENS_PROPERTY = "sonar.cpd.minimumTokens"; 184 185 /** 186 * @deprecated in 3.1 187 */ 188 @Deprecated 189 int CPD_MINIMUM_TOKENS_DEFAULT_VALUE = 100; 190 191 /** 192 * @deprecated in 3.1 193 */ 194 @Deprecated 195 String CPD_IGNORE_LITERALS_PROPERTY = "sonar.cpd.ignore_literals"; 196 197 /** 198 * @deprecated in 3.1 199 */ 200 @Deprecated 201 String CPD_IGNORE_LITERALS_DEFAULT_VALUE = "true"; 202 203 /** 204 * @deprecated in 3.1 205 */ 206 @Deprecated 207 String CPD_IGNORE_IDENTIFIERS_PROPERTY = "sonar.cpd.ignore_identifiers"; 208 209 /** 210 * @deprecated in 3.1 211 */ 212 @Deprecated 213 String CPD_IGNORE_IDENTIFIERS_DEFAULT_VALUE = "false"; 214 215 String CPD_SKIP_PROPERTY = "sonar.cpd.skip"; 216 217 /** 218 * @since 2.11 219 * @deprecated in 3.1 220 */ 221 @Deprecated 222 String CPD_ENGINE = "sonar.cpd.engine"; 223 224 /** 225 * @see #CPD_ENGINE 226 * @since 2.11 227 * @deprecated in 3.1 228 */ 229 @Deprecated 230 String CPD_ENGINE_DEFAULT_VALUE = "sonar"; 231 232 /** 233 * @since 2.11 234 */ 235 String CPD_CROSS_RPOJECT = "sonar.cpd.cross_project"; 236 237 /** 238 * @see #CPD_CROSS_RPOJECT 239 * @since 2.11 240 */ 241 boolean CPD_CROSS_RPOJECT_DEFAULT_VALUE = false; 242 243 /* Design */ 244 245 /** 246 * Indicates whether Java bytecode analysis should be skipped. 247 * 248 * @since 2.0 249 */ 250 String DESIGN_SKIP_DESIGN_PROPERTY = "sonar.skipDesign"; 251 boolean DESIGN_SKIP_DESIGN_DEFAULT_VALUE = false; 252 253 /** 254 * Indicates whether Package Design Analysis should be skipped. 255 * 256 * @since 2.9 257 */ 258 String DESIGN_SKIP_PACKAGE_DESIGN_PROPERTY = "sonar.skipPackageDesign"; 259 boolean DESIGN_SKIP_PACKAGE_DESIGN_DEFAULT_VALUE = false; 260 261 /* Findbugs */ 262 String FINDBUGS_PLUGIN = "findbugs"; 263 String FINDBUGS_EFFORT_PROPERTY = "sonar.findbugs.effort"; 264 String FINDBUGS_EFFORT_DEFAULT_VALUE = "Default"; 265 String FINDBUGS_CONFIDENCE_LEVEL_PROPERTY = "sonar.findbugs.confidenceLevel"; 266 String FINDBUGS_CONFIDENCE_LEVEL_DEFAULT_VALUE = "medium"; 267 String FINDBUGS_REPORT_PATH = "sonar.findbugs.reportPath"; 268 String FINDBUGS_TIMEOUT_PROPERTY = "sonar.findbugs.timeout"; 269 long FINDBUGS_TIMEOUT_DEFAULT_VALUE = 600000; 270 271 /* Google Analytics */ 272 String GOOGLE_ANALYTICS_PLUGIN = "google-analytics"; 273 String GOOGLE_ANALYTICS_ACCOUNT_PROPERTY = "sonar.google-analytics.account"; 274 275 /* PMD */ 276 String PMD_PLUGIN = "pmd"; 277 278 /* Squid */ 279 String SQUID_PLUGIN = "squid"; 280 281 /* Surefire */ 282 String SUREFIRE_PLUGIN = "surefire"; 283 String SUREFIRE_REPORTS_PATH_PROPERTY = "sonar.surefire.reportsPath"; 284 285 /* Time machine periods */ 286 String TIMEMACHINE_PERIOD_PREFIX = "sonar.timemachine.period"; 287 String TIMEMACHINE_MODE_PREVIOUS_ANALYSIS = "previous_analysis"; 288 String TIMEMACHINE_MODE_DATE = "date"; 289 String TIMEMACHINE_MODE_VERSION = "version"; 290 String TIMEMACHINE_MODE_DAYS = "days"; 291 String TIMEMACHINE_MODE_PREVIOUS_VERSION = "previous_version"; 292 String TIMEMACHINE_DEFAULT_PERIOD_1 = TIMEMACHINE_MODE_PREVIOUS_ANALYSIS; 293 String TIMEMACHINE_DEFAULT_PERIOD_2 = "5"; 294 String TIMEMACHINE_DEFAULT_PERIOD_3 = "30"; 295 String TIMEMACHINE_DEFAULT_PERIOD_4 = ""; 296 String TIMEMACHINE_DEFAULT_PERIOD_5 = ""; 297 298 /** 299 * @since 2.11 300 */ 301 String ORGANISATION = "sonar.organisation"; 302 303 /** 304 * @since 2.11 305 */ 306 String PERMANENT_SERVER_ID = "sonar.server_id"; 307 308 /** 309 * @since 2.11 310 */ 311 String SERVER_ID_IP_ADDRESS = "sonar.server_id.ip_address"; 312 313 /** 314 * @since 3.3 315 */ 316 String LINKS_HOME_PAGE = "sonar.links.homepage"; 317 318 /** 319 * @since 3.3 320 */ 321 String LINKS_CI = "sonar.links.ci"; 322 323 /** 324 * @since 3.3 325 */ 326 String LINKS_ISSUE_TRACKER = "sonar.links.issue"; 327 328 /** 329 * @since 3.3 330 */ 331 String LINKS_SOURCES = "sonar.links.scm"; 332 333 /** 334 * @since 3.3 335 */ 336 String LINKS_SOURCES_DEV = "sonar.links.scm_dev"; 337}