001 /*
002 * SonarQube, open source software quality management tool.
003 * Copyright (C) 2008-2013 SonarSource
004 * mailto:contact AT sonarsource DOT com
005 *
006 * SonarQube 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 * SonarQube 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 License
017 * along with this program; if not, write to the Free Software Foundation,
018 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
019 */
020 package 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 */
028 public 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_INCLUSIONS_PROPERTY = "sonar.inclusions";
112 String PROJECT_EXCLUSIONS_PROPERTY = "sonar.exclusions";
113
114 /**
115 * @since 3.3
116 */
117 String PROJECT_TEST_INCLUSIONS_PROPERTY = "sonar.test.inclusions";
118 String PROJECT_TEST_EXCLUSIONS_PROPERTY = "sonar.test.exclusions";
119 String GLOBAL_EXCLUSIONS_PROPERTY = "sonar.global.exclusions";
120 String GLOBAL_TEST_EXCLUSIONS_PROPERTY = "sonar.global.test.exclusions";
121 String GLOBAL_TEST_EXCLUSIONS_DEFAULT = "**/package-info.java";
122
123 /**
124 * @deprecated since 2.5. See discussion from http://jira.codehaus.org/browse/SONAR-1873
125 */
126 @Deprecated
127 String REUSE_RULES_CONFIGURATION_PROPERTY = "sonar.reuseExistingRulesConfiguration";
128
129 /* Sonar Core */
130 String CORE_VIOLATION_LOCALE_PROPERTY = "sonar.violationLocale";
131 String CORE_VIOLATION_LOCALE_DEFAULT_VALUE = "en";
132 String CORE_IMPORT_SOURCES_PROPERTY = "sonar.importSources";
133 boolean CORE_IMPORT_SOURCES_DEFAULT_VALUE = true;
134 String CORE_SKIPPED_MODULES_PROPERTY = "sonar.skippedModules";
135 String CORE_RULE_WEIGHTS_PROPERTY = "sonar.core.rule.weight";
136 String CORE_RULE_WEIGHTS_DEFAULT_VALUE = "INFO=0;MINOR=1;MAJOR=3;CRITICAL=5;BLOCKER=10";
137
138 /**
139 * @deprecated since 3.6. See http://jira.codehaus.org/browse/SONAR-4145
140 */
141 @Deprecated
142 String CORE_TENDENCY_DEPTH_PROPERTY = "tendency.depth";
143
144 /**
145 * @deprecated since 2.5. See http://jira.codehaus.org/browse/SONAR-4145
146 */
147 @Deprecated
148 int CORE_TENDENCY_DEPTH_DEFAULT_VALUE = 30;
149
150 String CORE_FORCE_AUTHENTICATION_PROPERTY = "sonar.forceAuthentication";
151 boolean CORE_FORCE_AUTHENTICATION_DEFAULT_VALUE = false;
152 String CORE_ALLOW_USERS_TO_SIGNUP_PROPERTY = "sonar.allowUsersToSignUp";
153 String CORE_DEFAULT_GROUP = "sonar.defaultGroup";
154 String CORE_DEFAULT_GROUP_DEFAULT_VALUE = "sonar-users";
155 boolean CORE_ALLOW_USERS_TO_SIGNUP_DEAULT_VALUE = false;
156
157 /**
158 * @deprecated since 2.14. See http://jira.codehaus.org/browse/SONAR-3153. Replaced by {@link #CORE_AUTHENTICATOR_REALM}.
159 */
160 @Deprecated
161 String CORE_AUTHENTICATOR_CLASS = "sonar.authenticator.class";
162
163 /**
164 * @since 2.14
165 */
166 String CORE_AUTHENTICATOR_REALM = "sonar.security.realm";
167
168 String CORE_AUTHENTICATOR_IGNORE_STARTUP_FAILURE = "sonar.authenticator.ignoreStartupFailure";
169 String CORE_AUTHENTICATOR_CREATE_USERS = "sonar.authenticator.createUsers";
170
171 /**
172 * @since 3.6
173 */
174 String CORE_AUTHENTICATOR_UPDATE_USER_ATTRIBUTES = "sonar.security.updateUserAttributes";
175
176 String SERVER_VERSION = "sonar.core.version";
177 String SERVER_ID = "sonar.core.id";
178
179 // format is yyyy-MM-dd'T'HH:mm:ssZ
180 String SERVER_STARTTIME = "sonar.core.startTime";
181
182 /**
183 * @deprecated since 3.6. See http://jira.codehaus.org/browse/SONAR-4145
184 */
185 @Deprecated
186 String SKIP_TENDENCIES_PROPERTY = "sonar.skipTendencies";
187
188 /**
189 * @deprecated since 3.6. See http://jira.codehaus.org/browse/SONAR-4145
190 */
191 @Deprecated
192 boolean SKIP_TENDENCIES_DEFAULT_VALUE = false;
193
194 String BATCH_INCLUDE_PLUGINS = "sonar.includePlugins";
195 String BATCH_EXCLUDE_PLUGINS = "sonar.excludePlugins";
196
197 /**
198 * @since 3.4
199 */
200 String DRY_RUN_INCLUDE_PLUGINS = "sonar.dryRun.includePlugins";
201 String DRY_RUN_INCLUDE_PLUGINS_DEFAULT_VALUE = "";
202
203 /**
204 * @since 3.4
205 */
206 String DRY_RUN_EXCLUDE_PLUGINS = "sonar.dryRun.excludePlugins";
207 String DRY_RUN_EXCLUDE_PLUGINS_DEFAULT_VALUE = "devcockpit,pdfreport,report,scmactivity,views";
208
209 /**
210 * @since 2.10
211 */
212 String SERVER_BASE_URL = "sonar.core.serverBaseURL";
213
214 /**
215 * @see #SERVER_BASE_URL
216 * @since 2.10
217 */
218 String SERVER_BASE_URL_DEFAULT_VALUE = "http://localhost:9000";
219
220 /* CPD */
221 String CPD_PLUGIN = "cpd";
222
223 /**
224 * @deprecated in 3.1
225 */
226 @Deprecated
227 String CPD_MINIMUM_TOKENS_PROPERTY = "sonar.cpd.minimumTokens";
228
229 /**
230 * @deprecated in 3.1
231 */
232 @Deprecated
233 int CPD_MINIMUM_TOKENS_DEFAULT_VALUE = 100;
234
235 /**
236 * @deprecated in 3.1
237 */
238 @Deprecated
239 String CPD_IGNORE_LITERALS_PROPERTY = "sonar.cpd.ignore_literals";
240
241 /**
242 * @deprecated in 3.1
243 */
244 @Deprecated
245 String CPD_IGNORE_LITERALS_DEFAULT_VALUE = "true";
246
247 /**
248 * @deprecated in 3.1
249 */
250 @Deprecated
251 String CPD_IGNORE_IDENTIFIERS_PROPERTY = "sonar.cpd.ignore_identifiers";
252
253 /**
254 * @deprecated in 3.1
255 */
256 @Deprecated
257 String CPD_IGNORE_IDENTIFIERS_DEFAULT_VALUE = "false";
258
259 String CPD_SKIP_PROPERTY = "sonar.cpd.skip";
260
261 /**
262 * @since 2.11
263 * @deprecated in 3.1
264 */
265 @Deprecated
266 String CPD_ENGINE = "sonar.cpd.engine";
267
268 /**
269 * @see #CPD_ENGINE
270 * @since 2.11
271 * @deprecated in 3.1
272 */
273 @Deprecated
274 String CPD_ENGINE_DEFAULT_VALUE = "sonar";
275
276 /**
277 * @since 2.11
278 */
279 String CPD_CROSS_RPOJECT = "sonar.cpd.cross_project";
280
281 /**
282 * @see #CPD_CROSS_RPOJECT
283 * @since 2.11
284 */
285 boolean CPD_CROSS_RPOJECT_DEFAULT_VALUE = false;
286
287 /**
288 * @since 3.5
289 */
290 String CPD_EXCLUSIONS = "sonar.cpd.exclusions";
291
292 /* Design */
293
294 /**
295 * Indicates whether Java bytecode analysis should be skipped.
296 *
297 * @since 2.0
298 */
299 String DESIGN_SKIP_DESIGN_PROPERTY = "sonar.skipDesign";
300 boolean DESIGN_SKIP_DESIGN_DEFAULT_VALUE = false;
301
302 /**
303 * Indicates whether Package Design Analysis should be skipped.
304 *
305 * @since 2.9
306 */
307 String DESIGN_SKIP_PACKAGE_DESIGN_PROPERTY = "sonar.skipPackageDesign";
308 boolean DESIGN_SKIP_PACKAGE_DESIGN_DEFAULT_VALUE = false;
309
310 /* Google Analytics */
311 String GOOGLE_ANALYTICS_PLUGIN = "google-analytics";
312 String GOOGLE_ANALYTICS_ACCOUNT_PROPERTY = "sonar.google-analytics.account";
313
314 /* Time machine periods */
315 String TIMEMACHINE_PERIOD_PREFIX = "sonar.timemachine.period";
316 String TIMEMACHINE_MODE_PREVIOUS_ANALYSIS = "previous_analysis";
317 String TIMEMACHINE_MODE_DATE = "date";
318 String TIMEMACHINE_MODE_VERSION = "version";
319 String TIMEMACHINE_MODE_DAYS = "days";
320 String TIMEMACHINE_MODE_PREVIOUS_VERSION = "previous_version";
321 String TIMEMACHINE_DEFAULT_PERIOD_1 = TIMEMACHINE_MODE_PREVIOUS_ANALYSIS;
322 String TIMEMACHINE_DEFAULT_PERIOD_2 = "5";
323 String TIMEMACHINE_DEFAULT_PERIOD_3 = "30";
324 String TIMEMACHINE_DEFAULT_PERIOD_4 = "";
325 String TIMEMACHINE_DEFAULT_PERIOD_5 = "";
326
327 /**
328 * @since 2.11
329 */
330 String ORGANISATION = "sonar.organisation";
331
332 /**
333 * @since 2.11
334 */
335 String PERMANENT_SERVER_ID = "sonar.server_id";
336
337 /**
338 * @since 2.11
339 */
340 String SERVER_ID_IP_ADDRESS = "sonar.server_id.ip_address";
341
342 /**
343 * @since 3.3
344 */
345 String LINKS_HOME_PAGE = "sonar.links.homepage";
346
347 /**
348 * @since 3.3
349 */
350 String LINKS_CI = "sonar.links.ci";
351
352 /**
353 * @since 3.3
354 */
355 String LINKS_ISSUE_TRACKER = "sonar.links.issue";
356
357 /**
358 * @since 3.3
359 */
360 String LINKS_SOURCES = "sonar.links.scm";
361
362 /**
363 * @since 3.3
364 */
365 String LINKS_SOURCES_DEV = "sonar.links.scm_dev";
366
367 /**
368 * @since 3.4
369 */
370 String LOGIN = "sonar.login";
371
372 /**
373 * @since 3.4
374 */
375 String PASSWORD = "sonar.password";
376
377 /**
378 * @since 3.4
379 */
380 String DRY_RUN = "sonar.dryRun";
381
382 /**
383 * @since 3.5
384 */
385 String TASK = "sonar.task";
386
387 /**
388 * @since 3.6
389 */
390 String SCAN_TASK = "scan";
391
392 /**
393 * @since 3.6
394 */
395 String PROFILING_LOG_PROPERTY = "sonar.showProfiling";
396
397 /**
398 * @deprecated replaced in v3.4 by properties specific to languages, for example sonar.java.coveragePlugin
399 * See http://jira.codehaus.org/browse/SONARJAVA-39 for more details.
400 */
401 @Deprecated
402 String CORE_COVERAGE_PLUGIN_PROPERTY = "sonar.core.codeCoveragePlugin";
403 }