Package backupmanager
Class BackupManager
java.lang.Object
PamController.PamControlledUnit
backupmanager.BackupManager
- All Implemented Interfaces:
PamSettings
,SettingsNameProvider
PAMGuard module to automatically back up files. Decisions on where to
move files may be based on how many detections they contain,etc, so that
high priority files end up in a different place to files that seem empty.
- Author:
- dg50
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addObserver
(BackupObserver progressObserver) Add an observer that will get updates as backups take place.createDetectionMenu
(Frame parentFrame) Create a JMenu object containing MenuItems associated with PamProcessescreateFileMenu
(JFrame parentFrame) Scan all PamcontrolledUnits for backup streams.static BackupManager
long
void
notifyModelChanged
(int changeType) General notification when the PAMGAURD model changes.boolean
removeObserver
(BackupObserver progressObserver) Add an observer that will get updates as backups take place.boolean
restoreSettings
(PamControlledUnitSettings pamControlledUnitSettings) void
runBackups
(Window parentFrame) Run all the backup.void
setBackupSchedule
(BackupSchedule backupSchedule) void
boolean
updateProgress
(BackupProgress backupProgress) This will be called back from individual BackupStreams in the Swing Worker thread.Methods inherited from class PamController.PamControlledUnit
addOfflineTaskGroup, addOtherRelatedMenuItems, addPamProcess, addPamProcess, addRelatedMenuItems, canClose, canPlayViewerSound, createDisplayMenu, createHelpMenu, flushDataBlockBuffers, getBackupInformation, getFrameNumber, getGUI, getGuiFrame, getInstanceIndex, getModuleStatus, getModuleStatusManager, getModuleSummary, getModuleSummary, getNumOfflineTaskGroups, getNumPamProcesses, getOfflineState, getOfflineTaskGroup, getPamConfiguration, getPamController, getPamModuleInfo, getPamProcess, getPamView, getPlugin, getShortUnitType, getSidePanel, getTabClipCopier, getTabPanel, getTabSpecificMenuBar, getToolbarComponent, getUnitName, getUnitType, getVerboseLevel, gotoTab, isInMainConfiguration, isNetRx, isViewer, pamClose, pamHasStopped, pamToStart, playViewerSound, removePamProcess, removeUnit, rename, saveViewerData, setFrameNumber, setModuleStatusManager, setPamConfiguration, setPamController, setPamModuleInfo, setPamView, setSidePanel, setTabPanel, setToolbarComponent, setupControlledUnit, stopViewerSound, tellModule, terminalPrint, terminalPrintln, toString
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface PamController.PamSettings
getUnitType
Methods inherited from interface PamController.SettingsNameProvider
getUnitName
-
Field Details
-
defaultName
- See Also:
-
-
Constructor Details
-
BackupManager
-
-
Method Details
-
getBackupManager
-
createDetectionMenu
Description copied from class:PamControlledUnit
Create a JMenu object containing MenuItems associated with PamProcesses- Overrides:
createDetectionMenu
in classPamControlledUnit
- Parameters:
parentFrame
- The owner frame of the menu- Returns:
- reference to a JMenu which can be added to an existing menu or
menu bar
Note that if multiple views are to use the same menu, then they should each create a new menu (by setting Create to true) the first time they call this method.
-
createFileMenu
- Overrides:
createFileMenu
in classPamControlledUnit
- Parameters:
parentFrame
- parent frame for the menu- Returns:
- the file menu item
-
runBackups
Run all the backup. Never call this directly. Instead, call the backupSchedule.startBackup() function so that the backup gets correctly logged in the database.- Parameters:
parentFrame
-
-
updateProgress
This will be called back from individual BackupStreams in the Swing Worker thread. It needs to pass the message on to the Swing worker so that the swing worker can publish it. It will then reappear in the BackupWorker.process() function in the AWT thread from where it can be used to notify observers.- Parameters:
backupProgress
-
-
updateConfiguration
public void updateConfiguration() -
findBackupStreams
Scan all PamcontrolledUnits for backup streams. |- Returns:
-
notifyModelChanged
public void notifyModelChanged(int changeType) Description copied from class:PamControlledUnit
General notification when the PAMGAURD model changes.- Overrides:
notifyModelChanged
in classPamControlledUnit
- Parameters:
changeType
- type of change
-
addObserver
Add an observer that will get updates as backups take place.- Parameters:
progressObserver
-
-
removeObserver
Add an observer that will get updates as backups take place.- Parameters:
progressObserver
-- Returns:
- true if it existed
-
getBackupSchedule
- Returns:
- the backupSchedule
-
setBackupSchedule
- Parameters:
backupSchedule
- the backupSchedule to set
-
getSettingsReference
- Specified by:
getSettingsReference
in interfacePamSettings
- Returns:
- The serialisable object that will be stored
-
getSettingsVersion
public long getSettingsVersion()- Specified by:
getSettingsVersion
in interfacePamSettings
- Returns:
- An integer version number for the settings
-
restoreSettings
- Specified by:
restoreSettings
in interfacePamSettings
- Returns:
- true if successful The object performs final checks (if needed) and then casts the settings data pamcontrolledunitSettings.settings into the correct type and uses as required
-
getBackupParams
- Returns:
- the backupParams
-