source.dussan.org Git - sonarqube.git/blob

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2024 SonarSource SA
   4  * mailto:info AT sonarsource DOT com
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 3 of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  */
  20 package org.sonar.ce.task.projectanalysis.measure;
  21
  22 import org.sonar.api.ExtensionPoint;
  23 import org.sonar.api.ce.ComputeEngineSide;
  24 import org.sonar.ce.task.projectanalysis.analysis.Branch;
  25
  26 /**
  27  * Extension point that is called during processing of a task
  28  * by {@link PreMeasuresComputationChecksStep}.
  29  *
  30  * It is stateless, the same instance is reused for all tasks.
  31  * As a consequence Compute Engine task components can't be injected
  32  * as dependencies.
  33  */
  34 @ComputeEngineSide
  35 @ExtensionPoint
  36 public interface PreMeasuresComputationCheck {
  37
  38   /**
  39    * Throwing a {@link PreMeasuresComputationCheckException} will only produce an analysis warning.
  40    * Any other exception will fail the analysis.
  41    */
  42   void onCheck(Context context) throws PreMeasuresComputationCheckException;
  43
  44   interface Context {
  45
  46     String getProjectUuid();
  47
  48     Branch getBranch();
  49
  50   }
  51
  52   class PreMeasuresComputationCheckException extends Exception {
  53     public PreMeasuresComputationCheckException(String message) {
  54       super(message);
  55     }
  56
  57     public PreMeasuresComputationCheckException(String message, Throwable cause) {
  58       super(message, cause);
  59     }
  60   }
  61 }