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;
  21
  22 import java.util.Date;
  23 import javax.annotation.CheckForNull;
  24
  25 public interface DatabaseMigrationState {
  26
  27   enum Status {
  28     NONE, RUNNING, FAILED, SUCCEEDED
  29   }
  30
  31   /**
  32    * Current status of the migration.
  33    */
  34   Status getStatus();
  35
  36   /**
  37    * The time and day the last migration was started.
  38    * <p>
  39    * If no migration was ever started, the returned date is {@code null}.
  40    * </p>
  41    *
  42    * @return a {@link Date} or {@code null}
  43    */
  44   @CheckForNull
  45   Date getStartedAt();
  46
  47   /**
  48    * The error of the last migration if it failed.
  49    *
  50    * @return a {@link Throwable} or {@code null}
  51    */
  52   @CheckForNull
  53   Throwable getError();
  54 }