Package net.solarnetwork.node.backup

Class BackupServiceSupport

java.lang.Object

net.solarnetwork.node.backup.BackupServiceSupport

All Implemented Interfaces:

BackupService

Direct Known Subclasses:

FileSystemBackupService

public abstract class BackupServiceSupport
extends Object
implements BackupService

Abstract support class for BackupService implementations.

Since:

1.54

Version:

1.2

Author:

matt

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BACKUP_KEY_DATE_FORMAT	A date and time format to use with backup keys.
protected final org.slf4j.Logger	log	A class-level logger.
static final Pattern	NODE_AND_DATE_BACKUP_KEY_PATTERN	A pattern to match node-N-backup-D-Q where N is a node ID and D is a date formatted using BACKUP_KEY_DATE_FORMAT and Q is an optional qualifier.
protected static final com.fasterxml.jackson.databind.ObjectMapper	OBJECT_MAPPER	The object mapper to use.

Constructor Summary

Constructors

Constructor	Description
BackupServiceSupport()	Default constructor.

Method Summary

Modifier and Type	Method	Description
protected Date	backupDateFromProps(Date date, Map<String,String> props)	Shortcut for backupDateFromProps(Date, Map, Pattern, String) using default values.
protected Date	backupDateFromProps(Date date, Map<String,String> props, Pattern nodeIdAndDatePattern, String dateFormat)	Parse a date from a backup key.
protected Long	backupNodeIdFromProps(Long nodeId, Map<String,String> props)	Shortcut for backupNodeIdFromProps(Long, Map, Pattern) using default values.
protected Long	backupNodeIdFromProps(Long nodeId, Map<String,String> props, Pattern nodeIdAndDatePattern)	Parse a node ID from a backup key.
protected File	defaultBackuprDir()	Get a directory to use for local backup data.
static final BackupIdentity	identityFromBackupKey(String key)	Extract backup identity information from a backup key.
static final BackupIdentity	identityFromBackupKey(Pattern nodeIdAndDatePattern, String dateFormat, String key)	Extract backup identity information from a backup key.
boolean	markBackupForRestore(Backup backup, Map<String,String> props)	Mark a specific backup to be restored in the future call to BackupService.markedBackupForRestore(Map).
Backup	markedBackupForRestore(Map<String,String> props)	Get a backup previously set via BackupService.markBackupForRestore(Backup, Map).
protected File	markedBackupForRestoreFile()	Get a file to use for "marked backup" metadata.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.solarnetwork.node.backup.BackupService

backupForKey, getAvailableBackups, getBackupResources, getInfo, getKey, getSettingSpecifierProvider, getSettingSpecifierProviderForRestore, importBackup, performBackup

Field Details

BACKUP_KEY_DATE_FORMAT

public static final String BACKUP_KEY_DATE_FORMAT

A date and time format to use with backup keys.

See Also:

• Constant Field Values

NODE_AND_DATE_BACKUP_KEY_PATTERN

public static final Pattern NODE_AND_DATE_BACKUP_KEY_PATTERN

A pattern to match node-N-backup-D-Q where N is a node ID and D is a date formatted using BACKUP_KEY_DATE_FORMAT and Q is an optional qualifier.

Note that the qualifier and the leading dash is optional, so its Matcher group is 4 (not 3).

OBJECT_MAPPER

protected static final com.fasterxml.jackson.databind.ObjectMapper OBJECT_MAPPER

The object mapper to use.

log

protected final org.slf4j.Logger log

A class-level logger.

Constructor Details

BackupServiceSupport

public BackupServiceSupport()

Default constructor.

Method Details

defaultBackuprDir

protected File defaultBackuprDir()

Get a directory to use for local backup data.

Returns:

a directory to use for local backup data

markedBackupForRestoreFile

protected File markedBackupForRestoreFile()

Get a file to use for "marked backup" metadata.

Returns:

the file for marked backup metadata

backupDateFromProps

protected Date backupDateFromProps(Date date,
 Map<String,String> props)

Shortcut for backupDateFromProps(Date, Map, Pattern, String) using default values.

The NODE_AND_DATE_BACKUP_KEY_PATTERN pattern and BACKUP_KEY_DATE_FORMAT format are used.

Parameters:

date - if not null then return this value

props - a mapping of properties, which may include a BackupManager.BACKUP_KEY value

Returns:

the date, never null

See Also:

• backupDateFromProps(Date, Map, Pattern, String)

backupDateFromProps

protected Date backupDateFromProps(Date date,
 Map<String,String> props,
 Pattern nodeIdAndDatePattern,
 String dateFormat)

Parse a date from a backup key.

If no date can be extracted from the given arguments, the current system time will be returned.

Parameters:

date - if not null then return this value

props - a mapping of properties, which may include a BackupManager.BACKUP_KEY value

nodeIdAndDatePattern - a regular expression to match a node ID and date from a backup key

dateFormat - the format of the date extracted from the nodeIdAndDatePattern

Returns:

the date, never null

backupNodeIdFromProps

protected Long backupNodeIdFromProps(Long nodeId,
 Map<String,String> props)

Shortcut for backupNodeIdFromProps(Long, Map, Pattern) using default values.

The NODE_AND_DATE_BACKUP_KEY_PATTERN pattern is used.

Parameters:

nodeId - if not null then return this value

props - a mapping of properties, which may include a BackupManager.BACKUP_KEY value

Returns:

the node ID, or 0 if not available

See Also:

• backupNodeIdFromProps(Long, Map, Pattern)

backupNodeIdFromProps

protected Long backupNodeIdFromProps(Long nodeId,
 Map<String,String> props,
 Pattern nodeIdAndDatePattern)

Parse a node ID from a backup key.

Parameters:

nodeId - if not null then return this value

props - a mapping of properties, which may include a BackupManager.BACKUP_KEY value

nodeIdAndDatePattern - a regular expression to match a node ID and date from a backup key

Returns:

the node ID, or 0 if not available

identityFromBackupKey

public static final BackupIdentity identityFromBackupKey(String key)

Extract backup identity information from a backup key.

This method calls identityFromBackupKey(Pattern, String, String), passing NODE_AND_DATE_BACKUP_KEY_PATTERN and BACKUP_KEY_DATE_FORMAT for arguments.

Parameters:

key - the key to extract the details from

Returns:

the extracted details, or null if none found

Since:

1.1

identityFromBackupKey

public static final BackupIdentity identityFromBackupKey(Pattern nodeIdAndDatePattern,
 String dateFormat,
 String key)

Extract backup identity information from a backup key.

Parameters:

nodeIdAndDatePattern - a pattern that contains groups for a node ID, date, and an optional qualifier

dateFormat - the date format to parse the date with

key - the key to extract the details from

Returns:

the extracted details, or null if none found

Since:

1.1

markBackupForRestore

public boolean markBackupForRestore(Backup backup,
 Map<String,String> props)

Description copied from interface: BackupService

Mark a specific backup to be restored in the future call to BackupService.markedBackupForRestore(Map).

Specified by:

markBackupForRestore in interface BackupService

Parameters:

backup - The backup to mark for restoration later, or null to clear a previous marked backup.

props - An optional map of properties to save with the mark.

Returns:

true on success

markedBackupForRestore

public Backup markedBackupForRestore(Map<String,String> props)

Description copied from interface: BackupService

Get a backup previously set via BackupService.markBackupForRestore(Backup, Map).

Specified by:

markedBackupForRestore in interface BackupService

Parameters:

props - An optional map in which any properties passed to BackupService.markBackupForRestore(Backup, Map) should be populated into

Returns:

The marked backup, or null if none exists.