001    /*
002     * Sonar, open source software quality management tool.
003     * Copyright (C) 2009 SonarSource SA
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     */
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      /* Global settings */
031      String SONAR_HOME = "sonar.home";
032      String PROJECT_BRANCH_PROPERTY = "sonar.branch";
033      String PROJECT_VERSION_PROPERTY = "sonar.projectVersion";
034    
035      /**
036       * Value format is yyyy-MM-dd
037       */
038      String PROJECT_DATE_PROPERTY = "sonar.projectDate";
039      String PROJECT_LANGUAGE_PROPERTY = "sonar.language";
040      String DYNAMIC_ANALYSIS_PROPERTY = "sonar.dynamicAnalysis";
041      String PROJECT_EXCLUSIONS_PROPERTY = "sonar.exclusions";
042    
043      /**
044       * @deprecated since 2.5. See discussion from http://jira.codehaus.org/browse/SONAR-1873
045       */
046      @Deprecated
047      String REUSE_RULES_CONFIGURATION_PROPERTY = "sonar.reuseExistingRulesConfiguration";
048    
049      /* Checkstyle */
050      String CHECKSTYLE_PLUGIN = "checkstyle";
051    
052      /* Cobertura */
053      String COBERTURA_PLUGIN = "cobertura";
054      String COBERTURA_REPORT_PATH_PROPERTY = "sonar.cobertura.reportPath";
055      String COBERTURA_MAXMEM_PROPERTY = "sonar.cobertura.maxmen";
056      String COBERTURA_MAXMEM_DEFAULT_VALUE = "64m";
057    
058      /* Sonar Core */
059      String CORE_PLUGIN = "core";
060      String CORE_COVERAGE_PLUGIN_PROPERTY = "sonar.core.codeCoveragePlugin";
061      String CORE_IMPORT_SOURCES_PROPERTY = "sonar.importSources";
062      boolean CORE_IMPORT_SOURCES_DEFAULT_VALUE = true;
063      String CORE_SKIPPED_MODULES_PROPERTY = "sonar.skippedModules";
064      String CORE_RULE_WEIGHTS_PROPERTY = "sonar.core.rule.weight";
065      String CORE_RULE_WEIGHTS_DEFAULT_VALUE = "INFO=0;MINOR=1;MAJOR=3;CRITICAL=5;BLOCKER=10";
066      String CORE_TENDENCY_DEPTH_PROPERTY = "tendency.depth";
067      int CORE_TENDENCY_DEPTH_DEFAULT_VALUE = 30;
068      String CORE_FORCE_AUTHENTICATION_PROPERTY = "sonar.forceAuthentication";
069      boolean CORE_FORCE_AUTHENTICATION_DEFAULT_VALUE = false;
070      String CORE_ALLOW_USERS_TO_SIGNUP_PROPERTY = "sonar.allowUsersToSignUp";
071      String CORE_DEFAULT_GROUP = "sonar.defaultGroup";
072      String CORE_DEFAULT_GROUP_DEFAULT_VALUE = "sonar-users";
073      boolean CORE_ALLOW_USERS_TO_SIGNUP_DEAULT_VALUE = false;
074      String CORE_AUTHENTICATOR_CLASS = "sonar.authenticator.class";
075      String CORE_AUTHENTICATOR_IGNORE_STARTUP_FAILURE = "sonar.authenticator.ignoreStartupFailure";
076      String CORE_AUTHENTICATOR_CREATE_USERS = "sonar.authenticator.createUsers";
077      String SERVER_VERSION = "sonar.core.version";
078      String SERVER_ID = "sonar.core.id";
079      String SERVER_STARTTIME = "sonar.core.startTime"; // format is yyyy-MM-dd'T'HH:mm:ssZ
080      String SKIP_TENDENCIES_PROPERTY = "sonar.skipTendencies";
081      boolean SKIP_TENDENCIES_DEFAULT_VALUE = false;
082    
083      /* CPD */
084      String CPD_PLUGIN = "cpd";
085      String CPD_MINIMUM_TOKENS_PROPERTY = "sonar.cpd.minimumTokens";
086      int CPD_MINIMUM_TOKENS_DEFAULT_VALUE = 100;
087      String CPD_IGNORE_LITERALS_PROPERTY = "sonar.cpd.ignore_literals";
088      String CPD_IGNORE_LITERALS_DEFAULT_VALUE = "true";
089      String CPD_IGNORE_IDENTIFIERS_PROPERTY = "sonar.cpd.ignore_identifiers";
090      String CPD_IGNORE_IDENTIFIERS_DEFAULT_VALUE = "false";
091      String CPD_SKIP_PROPERTY = "sonar.cpd.skip";
092    
093      /* Design */
094      String DESIGN_SKIP_DESIGN_PROPERTY = "sonar.skipDesign";
095      boolean DESIGN_SKIP_DESIGN_DEFAULT_VALUE = false;
096    
097      /* Findbugs */
098      String FINDBUGS_PLUGIN = "findbugs";
099      String FINDBUGS_EFFORT_PROPERTY = "sonar.findbugs.effort";
100      String FINDBUGS_EFFORT_DEFAULT_VALUE = "Default";
101      String FINDBUGS_REPORT_PATH = "sonar.findbugs.reportPath";
102      String FINDBUGS_TIMEOUT_PROPERTY = "sonar.findbugs.timeout";
103      long FINDBUGS_TIMEOUT_DEFAULT_VALUE = 600000;
104    
105      /* Google Analytics */
106      String GOOGLE_ANALYTICS_PLUGIN = "google-analytics";
107      String GOOGLE_ANALYTICS_ACCOUNT_PROPERTY = "sonar.google-analytics.account";
108    
109      /* PMD */
110      String PMD_PLUGIN = "pmd";
111    
112      /* Squid */
113      String SQUID_PLUGIN = "squid";
114    
115      /* Surefire */
116      String SUREFIRE_PLUGIN = "surefire";
117      String SUREFIRE_REPORTS_PATH_PROPERTY = "sonar.surefire.reportsPath";
118    
119      /* Time machine periods */
120      String TIMEMACHINE_PERIOD_PREFIX = "sonar.timemachine.period";
121      String TIMEMACHINE_MODE_PREVIOUS_ANALYSIS = "previous_analysis";
122      String TIMEMACHINE_DEFAULT_PERIOD_1 = TIMEMACHINE_MODE_PREVIOUS_ANALYSIS;
123      String TIMEMACHINE_DEFAULT_PERIOD_2 = "5";
124      String TIMEMACHINE_DEFAULT_PERIOD_3 = "30";
125      String TIMEMACHINE_DEFAULT_PERIOD_4 = "";
126      String TIMEMACHINE_DEFAULT_PERIOD_5 = "";
127    }