ScmActivityPlugin.java

/*
 * Sonar SCM Activity Plugin
 * Copyright (C) 2010 SonarSource
 * dev@sonar.codehaus.org
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
 */

package org.sonar.plugins.scmactivity;

import org.sonar.api.Plugin;
import org.sonar.api.Properties;
import org.sonar.api.Property;

import java.util.Arrays;
import java.util.List;

/**
 * @author Evgeny Mandrikov
 */
@Properties({
    @Property(
        key = ScmActivityPlugin.ENABLED_PROPERTY,
        defaultValue = ScmActivityPlugin.ENABLED_DEFAULT_VALUE + "",
        name = "Enable loading of SCM activity. It requires to connect to SCM server.",
        description = "",
        module = true,
        project = true,
        global = true
    ),
    @Property(
        key = ScmActivityPlugin.URL_PROPERTY,
        defaultValue = "",
        name = "SCM URL",
        description = "SCM URL. The format is described in <a href='http://maven.apache.org/scm/scm-url-format.html'>this page</a>. Example:" +
            "<i>scm:svn:https://svn.codehaus.org/sonar-plugins/trunk/scm-activity</i>",
        module = true,
        project = true,
        global = false
    ),
    @Property(
        key = ScmActivityPlugin.USER_PROPERTY,
        defaultValue = "",
        name = "User",
        description = "User to connect with SCM. Leave blank for anonymous. This property is usually defined in settings of project.",
        module = false,
        project = true,
        global = true
    ),
    @Property(
        key = ScmActivityPlugin.PASSWORD_PROPERTY,
        defaultValue = "",
        name = "Password",
        description = "Password to connect with SCM. Leave blank for anonymous. This property is usually defined in settings of project.",
        module = false,
        project = true,
        global = true
    ),
    @Property(
        key = ScmActivityPlugin.IGNORE_LOCAL_MODIFICATIONS,
        defaultValue = "" + ScmActivityPlugin.IGNORE_LOCAL_MODIFICATIONS_DEFAULT_VALUE,
        name = "Ignore local modifications",
        description = "By default local modifications are forbidden in order to have consistent data with SCM repository.",
        module = true,
        project = true,
        global = true
    ),
    @Property(
        key = ScmActivityPlugin.VERBOSE_PROPERTY,
        defaultValue = "" + ScmActivityPlugin.VERBOSE_DEFAULT_VALUE,
        name = "Verbose mode",
        description = "The verbose mode stores the results of SCM commands on disk",
        module = true,
        project = true,
        global = false
    )})
public final class ScmActivityPlugin implements Plugin {

  public static final String IGNORE_LOCAL_MODIFICATIONS = "sonar.scm.ignoreLocalModifications";
  public static final boolean IGNORE_LOCAL_MODIFICATIONS_DEFAULT_VALUE = false;
  public static final String URL_PROPERTY = "sonar.scm.url";
  public static final String ENABLED_PROPERTY = "sonar.scm.enabled";
  public static final boolean ENABLED_DEFAULT_VALUE = false;
  public static final String VERBOSE_PROPERTY = "sonar.scm.verbose";
  public static final boolean VERBOSE_DEFAULT_VALUE = false;
  public static final String USER_PROPERTY = "sonar.scm.user.secured";
  public static final String PASSWORD_PROPERTY = "sonar.scm.password.secured";

  public String getKey() {
    return "scm-activity";
  }

  public String getName() {
    return "SCM Activity";
  }

  public String getDescription() {
    return "Collects information from SCM.";
  }

  public List getExtensions() {
    return Arrays.asList(
        ScmConfiguration.class, MavenScmConfiguration.class, SonarScmRepository.class, Changelog.class,
        SonarScmManager.class, ScmActivitySensor.class, ScmDecorator.class,
        LocalModificationChecker.class, Blame.class, UrlChecker.class,
        ScmActivityWidget.class);
  }
}