#950 Add getters to NBackupManager

Author: mrotteveel

src/docs/asciidoc/release_notes.adoc

@@ -690,6 +690,7 @@ See also https://github.com/FirebirdSQL/jaybird/blob/master/devdoc/jdp/jdp-2026-
 This change was contributed by https://github.com/FuriousFourier[FuriousFourier^]
 * Improvement: Add getters to `BackupManager` and allow "`use default`" to be set (https://github.com/FirebirdSQL/jaybird/issues/948[#948])
 * Improvement: Allow "`use default`" (`-1`) on `FBManager#setPageSize` (https://github.com/FirebirdSQL/jaybird/issues/949[#949])
+* Improvement: Add getters to `NBackupManager` (https://github.com/FirebirdSQL/jaybird/issues/950[#950])
 * ...
 
 [#compatibility-changes]

src/main/org/firebirdsql/management/FBNBackupManager.java

@@ -211,39 +211,79 @@ public void setBackupLevel(int backupLevel) {
         this.backupLevel = backupLevel;
     }
 
+    @Override
+    public int getBackupLevel() {
+        return backupLevel;
+    }
+
     @Override
     public void setBackupGuid(@Nullable String guid) {
         backupGuid = guid;
     }
 
+    @Override
+    public @Nullable String getBackupGuid() {
+        return backupGuid;
+    }
+
     @Override
     public void setNoDBTriggers(boolean noDBTriggers) {
         this.noDBTriggers = noDBTriggers;
     }
 
+    @Override
+    public boolean isNoDBTriggers() {
+        return noDBTriggers;
+    }
+
     @Override
     public void setInPlaceRestore(boolean inPlaceRestore) {
         this.inPlaceRestore = inPlaceRestore;
     }
 
+    @Override
+    public boolean isInPlaceRestore() {
+        return inPlaceRestore;
+    }
+
     @Override
     public void setPreserveSequence(boolean preserveSequence) {
         this.preserveSequence = preserveSequence;
     }
 
+    @Override
+    public boolean isPreserveSequence() {
+        return preserveSequence;
+    }
+
     @Override
     public void setCleanHistory(boolean cleanHistory) {
         this.cleanHistory = cleanHistory;
     }
 
+    @Override
+    public boolean isCleanHistory() {
+        return cleanHistory;
+    }
+
     @Override
     public void setKeepDays(int days) {
         keepDays = days;
     }
 
+    @Override
+    public int getKeepDays() {
+        return keepDays;
+    }
+
     @Override
     public void setKeepRows(int rows) {
         keepRows = rows;
     }
 
+    @Override
+    public int getKeepRows() {
+        return keepRows;
+    }
+
 }

src/main/org/firebirdsql/management/NBackupManager.java

@@ -102,46 +102,87 @@ public interface NBackupManager extends ServiceManager {
     void fixupDatabase() throws SQLException;
 
     /**
-     * Sets the backup level (0 = full, 1..n = incremental)
+     * Sets the backup level (0 = full, 1..n = incremental, -1 = not set).
+     * <p>
+     * This setting is mutually exclusive with {@link #setBackupGuid(String)} (unless set to {@code -1}). Values are not
+     * validated client-side, only server-side.
+     * </p>
      *
      * @param level
-     *         backup level (e.g. 0 = full backup, 1 = level 1 incremental backup based on level 0 backup
+     *         backup level (e.g. 0 = full backup, 1 = level 1 incremental backup based on level 0 backup, etc.); use
+     *         {@code -1} to clear
+     * @see #getBackupLevel()
+     * @see #setBackupGuid(String)
      */
     void setBackupLevel(int level);
 
+    /**
+     * @return backup level (e.g. 0 = full backup, 1 = level 1 incremental backup based on level 0 backup, etc.),
+     * {@code -1} means the backup level is not set (it will either use {@code 0} or the backup GUID)
+     * @see #setBackupLevel(int)
+     * @since 7
+     */
+    int getBackupLevel();
+
     /**
      * Sets the backup GUID (Firebird 4 and higher only).
      * <p>
      * The backup GUID is the GUID of a previous backup of the (source) database. This is used by Firebird to back up
      * the pages modified since that backup.
      * </p>
      * <p>
-     * This setting is mutually exclusive with {@link #setBackupLevel(int)}, but this is only checked server-side.
+     * This setting is mutually exclusive with {@link #setBackupLevel(int)} (unless set to {@code null}). Values are not
+     * validated client-side, only server-side.
      * </p>
      *
      * @param guid
-     *         A GUID string of a previous backup, enclosed in braces.
+     *         GUID string of a previous backup, enclosed in braces
+     * @see #getBackupGuid()
+     * @see #setBackupLevel(int)
      * @since 4.0.4
      */
     void setBackupGuid(@Nullable String guid);
 
+    /**
+     * @return GUID string of a previous backup, enclosed in braces
+     * @see #setBackupGuid(String)
+     * @since 7
+     */
+    @Nullable String getBackupGuid();
+
     /**
      * Sets the option no database triggers when connecting at backup or in-place restore.
      *
      * @param noDBTriggers
-     *         {@code true} disable db triggers during backup or in-place restore.
+     *         {@code true} disable db triggers during backup or in-place restore
+     * @see #isNoDBTriggers()
      */
     void setNoDBTriggers(boolean noDBTriggers);
 
+    /**
+     * @return {@code true} db triggers during backup or in-place restore are disabled
+     * @see #setNoDBTriggers(boolean)
+     * @since 7
+     */
+    boolean isNoDBTriggers();
+
     /**
      * Enables in-place restore.
      *
      * @param inPlaceRestore
      *         {@code true} to enable in-place restore
+     * @see #isInPlaceRestore()
      * @since 4.0.4
      */
     void setInPlaceRestore(boolean inPlaceRestore);
 
+    /**
+     * @return {@code true} in-place restore enabled
+     * @see #setInPlaceRestore(boolean)
+     * @since 7
+     */
+    boolean isInPlaceRestore();
+
     /**
      * Enables preserve sequence (for fixup or restore).
      * <p>
@@ -150,22 +191,40 @@ public interface NBackupManager extends ServiceManager {
      *
      * @param preserveSequence
      *         {@code true} to enable preserve sequence
+     * @see #isPreserveSequence()
      * @since 5
      */
     void setPreserveSequence(boolean preserveSequence);
 
+    /**
+     * @return {@code true} preserve sequence enabled
+     * @see #setPreserveSequence(boolean)
+     * @since 7
+     */
+    boolean isPreserveSequence();
+
     /**
      * Enables clean history on backup.
      * <p>
-     * The backup will fail if {@link #setKeepDays(int)} or {@link #setKeepRows(int)} has not been called.
+     * The backup will fail if {@link #setKeepDays(int)} or {@link #setKeepRows(int)} have not been set.
      * </p>
      *
      * @param cleanHistory
      *         {@code true} to enable clean history
+     * @see #isCleanHistory()
+     * @see #setKeepDays(int)
+     * @see #setKeepRows(int)
      * @since 4.0.7
      */
     void setCleanHistory(boolean cleanHistory);
 
+    /**
+     * @return {@code true} clean history enabled
+     * @see #setCleanHistory(boolean)
+     * @since 7
+     */
+    boolean isCleanHistory();
+
     /**
      * Sets the number of days of backup history to keep.
      * <p>
@@ -178,12 +237,20 @@ public interface NBackupManager extends ServiceManager {
      *
      * @param days
      *         number of days to keep history when cleaning, or {@code -1} to clear current value
+     * @see #getKeepDays()
      * @see #setCleanHistory(boolean)
      * @see #setKeepRows(int)
      * @since 4.0.7
      */
     void setKeepDays(int days);
 
+    /**
+     * @return number of days to keep history when cleaning, or {@code -1} if not set
+     * @see #setKeepDays(int)
+     * @since 7
+     */
+    int getKeepDays();
+
     /**
      * Sets the number of rows of backup history to keep (this includes the row created by the backup).
      * <p>
@@ -196,10 +263,18 @@ public interface NBackupManager extends ServiceManager {
      *
      * @param rows
      *         number of rows to keep history when cleaning, or {@code -1} to clear current value
+     * @see #getKeepRows()
      * @see #setCleanHistory(boolean)
      * @see #setKeepDays(int)
      * @since 4.0.7
      */
     void setKeepRows(int rows);
-    
+
+    /**
+     * @return number of rows to keep history when cleaning, or {@code -1} if not set
+     * @see #setKeepRows(int)
+     * @since 7
+     */
+    int getKeepRows();
+
 }

src/test/org/firebirdsql/management/FBNBackupManagerTest.java

@@ -86,6 +86,7 @@ void backupWithGuid() throws Exception {
         MappedPath backup2 = getTempPath("backup2.nbk");
         manager.setBackupFile(backup2.toServerPath());
         manager.setBackupGuid(guid);
+        assertEquals(guid, manager.getBackupGuid(), "backupGuid");
         manager.backupDatabase();
 
         manager.clearBackupFiles();
@@ -151,7 +152,9 @@ && getDefaultSupportInfo().supportsNBackupInPlaceRestore(),
         }
 
         manager.clearBackupFiles();
+        assertFalse(manager.isInPlaceRestore(), "inPlaceRestore");
         manager.setInPlaceRestore(true);
+        assertTrue(manager.isInPlaceRestore(), "inPlaceRestore");
         manager.addBackupFile(backup2.toServerPath());
         manager.restoreDatabase();
 
@@ -199,7 +202,9 @@ && getDefaultSupportInfo().supportsNBackupPreserveSequence(),
         }
 
         manager.setDatabase(getDatabasePath());
+        assertFalse(manager.isPreserveSequence(), "preserveSequence");
         manager.setPreserveSequence(true);
+        assertTrue(manager.isPreserveSequence(), "preserveSequence");
         manager.fixupDatabase();
 
         final String afterFixupDbGuid = getCurrentDbGuid();
@@ -235,8 +240,12 @@ void restore_withPreserveSequence() throws Exception {
     @Test
     void backupCleanHistoryWithKeepDays() {
         assumeTrue(getDefaultSupportInfo().supportsNBackupCleanHistory(), "Requires NBackup clean history support");
+        assertFalse(manager.isCleanHistory(), "cleanHistory");
         manager.setCleanHistory(true);
+        assertTrue(manager.isCleanHistory(), "cleanHistory");
+        assertEquals(-1, manager.getKeepDays(), "keepDays");
         manager.setKeepDays(5);
+        assertEquals(5, manager.getKeepDays(), "keepDays");
 
         MappedPath backup1 = getTempPath("backup1.nbk");
         manager.setBackupFile(backup1.toServerPath());
@@ -249,8 +258,12 @@ void backupCleanHistoryWithKeepDays() {
     @Test
     void backupCleanHistoryWithKeepRows() {
         assumeTrue(getDefaultSupportInfo().supportsNBackupCleanHistory(), "Requires NBackup clean history support");
+        assertFalse(manager.isCleanHistory(), "cleanHistory");
         manager.setCleanHistory(true);
+        assertTrue(manager.isCleanHistory(), "cleanHistory");
+        assertEquals(-1, manager.getKeepRows(), "keepRows");
         manager.setKeepRows(5);
+        assertEquals(5, manager.getKeepRows(), "keepRows");
 
         MappedPath backup1 = getTempPath("backup1.nbk");
         manager.setBackupFile(backup1.toServerPath());