001/* 002 * SonarQube 003 * Copyright (C) 2009-2017 SonarSource SA 004 * mailto:info AT sonarsource DOT com 005 * 006 * This program 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 * This program 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 */ 020package org.sonar.api.batch.scm; 021 022import org.sonar.api.batch.ScannerSide; 023import org.sonar.api.CoreProperties; 024import org.sonar.api.ExtensionPoint; 025import org.sonar.api.batch.InstantiationStrategy; 026 027import java.io.File; 028 029/** 030 * See {@link CoreProperties#LINKS_SOURCES_DEV} to get old Maven URL format. 031 * @since 5.0 032 */ 033@ScannerSide 034@InstantiationStrategy(InstantiationStrategy.PER_BATCH) 035@ExtensionPoint 036public abstract class ScmProvider { 037 038 /** 039 * Unique identifier of the provider. Can be passed to {@link CoreProperties#SCM_PROVIDER_KEY} 040 * Can be used in SCM URL to define the provider to use. 041 */ 042 public abstract String key(); 043 044 /** 045 * Whether this provider is able to manage files located in this directory. 046 * Used by autodetection. Not considered if user has forced the provider key. 047 * @return false by default 048 */ 049 public boolean supports(File baseDir) { 050 return false; 051 } 052 053 public BlameCommand blameCommand() { 054 throw new UnsupportedOperationException("Blame command is not supported by " + key() + " provider"); 055 } 056 057}