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.server.platform.db.migration.step;
  21
  22 import java.util.List;
  23
  24 /**
  25  * Responsible for:
  26  * <ul>
  27  *   <li>looping over all the {@link MigrationStep} to execute</li>
  28  *   <li>put INFO log between each {@link MigrationStep} for user information</li>
  29  *   <li>handle errors during the execution of {@link MigrationStep}</li>
  30  *   <li>update the content of table {@code SCHEMA_MIGRATION}</li>
  31  * </ul>
  32  */
  33 public interface MigrationStepsExecutor {
  34   /**
  35    * @throws MigrationStepExecutionException at the first failing migration step execution
  36    */
  37   void execute(List<RegisteredMigrationStep> steps);
  38 }