org.sonar.plugins.scm.jazzrtc.JazzRtcConfiguration.java Source code

Introduction

Here is the source code for org.sonar.plugins.scm.jazzrtc.JazzRtcConfiguration.java

Source

/*
 * SonarQube :: Plugins :: SCM :: Jazz RTC
 * Copyright (C) 2014-2016 SonarSource SA
 * mailto:contact AT sonarsource DOT com
 *
 * 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  02110-1301, USA.
 */
package org.sonar.plugins.scm.jazzrtc;

import com.google.common.collect.ImmutableList;
import org.sonar.api.BatchComponent;
import org.sonar.api.CoreProperties;
import org.sonar.api.PropertyType;
import org.sonar.api.batch.InstantiationStrategy;
import org.sonar.api.config.PropertyDefinition;
import org.sonar.api.config.Settings;
import org.sonar.api.resources.Qualifiers;

import javax.annotation.CheckForNull;

import java.util.List;

@InstantiationStrategy(InstantiationStrategy.PER_BATCH)
public class JazzRtcConfiguration implements BatchComponent {

    private static final String CATEGORY_JAZZ = "Jazz RTC";
    private static final long CMD_TIMEOUT = 60_000;
    public static final String USER_PROP_KEY = "sonar.jazzrtc.username";
    public static final String PASSWORD_PROP_KEY = "sonar.jazzrtc.password.secured";

    private final Settings settings;

    public JazzRtcConfiguration(Settings settings) {
        this.settings = settings;
    }

    public static List<PropertyDefinition> getProperties() {
        return ImmutableList.of(
                PropertyDefinition.builder(USER_PROP_KEY).name("Username")
                        .description("Username to be used for Jazz RTC authentication").type(PropertyType.STRING)
                        .onQualifiers(Qualifiers.PROJECT).category(CoreProperties.CATEGORY_SCM)
                        .subCategory(CATEGORY_JAZZ).index(0).build(),
                PropertyDefinition.builder(PASSWORD_PROP_KEY).name("Password")
                        .description("Password to be used for Jazz RTC authentication").type(PropertyType.PASSWORD)
                        .onQualifiers(Qualifiers.PROJECT).category(CoreProperties.CATEGORY_SCM)
                        .subCategory(CATEGORY_JAZZ).index(1).build());
    }

    @CheckForNull
    public String username() {
        return settings.getString(USER_PROP_KEY);
    }

    @CheckForNull
    public String password() {
        return settings.getString(PASSWORD_PROP_KEY);
    }

    public long commandTimeout() {
        return CMD_TIMEOUT;
    }

}