BlockMonitoring.java

  1. /*
  2.  * The coLAB project
  3.  * Copyright (C) 2022-2023 AlbaSim, MEI, HEIG-VD, HES-SO
  4.  *
  5.  * Licensed under the MIT License
  6.  */
  7. package ch.colabproject.colab.api.microchanges.live.monitoring;

  9. import ch.colabproject.colab.generator.model.annotations.ExtractJavaDoc;
  10. import ch.colabproject.colab.generator.model.interfaces.WithJsonDiscriminator;
  11. import javax.validation.constraints.NotNull;

  13. /**
  14.  * Admin tool to monitor live block changes
  15.  *
  16.  * @author maxence
  17.  */
  18. @ExtractJavaDoc
  19. public class BlockMonitoring implements WithJsonDiscriminator {

  21.     private static final long serialVersionUID = 1L;

  23.     /**
  24.      * Status of the block
  25.      */
  26.     public enum BlockStatus implements WithJsonDiscriminator {
  27.         /** everything looks fine */
  28.         HEALTHY,
  29.         /** pending changes are inconsistent */
  30.         UNHEALTHY,
  31.         /** unable to restore data from live cache */
  32.         DATA_ERROR,
  33.         /** no pending changes */
  34.         PROCESSED,
  35.         /**
  36.          * some pending changes exist but block has been deleted in the meantime
  37.          */
  38.         DELETED;
  39.     }

  41.     /** Id of the block being live-edited */
  42.     @NotNull
  43.     private Long blockId;

  45.     /** Human readable description */
  46.     @NotNull
  47.     private String title;

  49.     /** Status of the live edition */
  50.     @NotNull
  51.     private BlockStatus status;

  53.     /**
  54.      * Get id
  55.      *
  56.      * @return the id of the block
  57.      */
  58.     public Long getBlockId() {
  59.         return blockId;
  60.     }

  62.     /**
  63.      * set block id
  64.      *
  65.      * @param blockId new block id
  66.      */
  67.     public void setBlockId(Long blockId) {
  68.         this.blockId = blockId;
  69.     }

  71.     /**
  72.      * status of the live-edition
  73.      *
  74.      * @return the status
  75.      */
  76.     public BlockStatus getStatus() {
  77.         return status;
  78.     }

  80.     /**
  81.      * set status
  82.      *
  83.      * @param status the status
  84.      */
  85.     public void setStatus(BlockStatus status) {
  86.         this.status = status;
  87.     }

  89.     /**
  90.      * Get human description
  91.      *
  92.      * @return the description
  93.      */
  94.     public String getTitle() {
  95.         return title;
  96.     }

  98.     /**
  99.      * Set human description
  100.      *
  101.      * @param title new text
  102.      */
  103.     public void setTitle(String title) {
  104.         this.title = title;
  105.     }
  106. }
Created with JaCoCo 0.8.8.202204050719