Module com.aoindustries.aoserv.backup

Package com.aoindustries.aoserv.backup

Class FileEnvironment

java.lang.Object

com.aoindustries.aoserv.backup.FileEnvironment

All Implemented Interfaces:

BackupEnvironment

Direct Known Subclasses:

MacOsXEnvironment, PosixFileEnvironment, WindowsEnvironment

public abstract class FileEnvironment
extends Object
implements BackupEnvironment

A BackupEnvironment for files.

Author:

AO Industries, Inc.

Constructor Summary

Constructors

Constructor	Description
FileEnvironment()

Method Summary

Modifier and Type	Method	Description
void	cleanup(FileReplication ffr)	Called in a finally block after any backup-pass completes, no data will be obtained from the environment after this is called.
InetAddress	getDefaultSourceIpAddress()	Gets the default source IP address or InetAddress.UNSPECIFIED to use the system default.
long	getDeviceIdentifier(FileReplication ffr, String filename)	Gets the device file major and minor.
String[]	getDirectoryList(FileReplication ffr, String filename)	Gets the listing for a directory.
int	getFailoverBatchSize(FileReplication ffr)	Gets the number of items per batch.
Random	getFastRandom()	A fast pseudo-random number generator for non-cryptographic purposes.
protected File	getFile(FileReplication ffr, String filename)
Iterator<String>	getFilenameIterator(FileReplication ffr)	Gets the Iterator of filenames or null if completed.
protected abstract Map<String,FilesystemIteratorRule>	getFilesystemIteratorPrefixRules(FileReplication ffr)	Gets the default set of filesystem prefix rules for this environment.
protected abstract Map<String,FilesystemIteratorRule>	getFilesystemIteratorRules(FileReplication ffr)	Gets the default set of filesystem rules for this environment.
int	getGid(FileReplication ffr, String filename)	Gets the group ID.
InputStream	getInputStream(FileReplication ffr, String filename)	Gets a stream reading the file.
long	getLength(FileReplication ffr, String filename)	Gets the length of the file.
long	getModifyTime(FileReplication ffr, String filename)	Gets the modified time.
String	getNameOfFile(FileReplication ffr, String filename)	Gets the name of a file (the part after the last slash).
List<String>	getReplicatedMysqlMinorVersions(FileReplication ffr)	Gets the list of MySQL server versions (in the same order as the list returned by getReplicatedMysqlServers.
List<Server.Name>	getReplicatedMysqlServers(FileReplication ffr)	Gets the list of MySQL server instance names that are being replicated.
Set<String>	getRequiredFilenames(FileReplication ffr)	Gets the set of paths that must be found in the backup set.
String	getServerPath(FileReplication ffr, String filename)	Converts an environment-specific filename into a server path.
long	getStatMode(FileReplication ffr, String filename)	Gets the stat mode (or a generated and equivalent one) for a file.
int	getUid(FileReplication ffr, String filename)	Gets the user ID.
void	init(FileReplication ffr)	Called before any backup-pass data is retrieved from the environment.
void	postBackup(FileReplication ffr)	Called right after a backup pass ends.
void	preBackup(FileReplication ffr)	Called right before a backup pass begins.
String	readLink(FileReplication ffr, String filename)	Reads a symbolic link.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aoindustries.aoserv.backup.BackupEnvironment

getConnector, getLogger, getThisHost

Constructor Details

FileEnvironment

public FileEnvironment()

Method Details

getFile

protected File getFile(FileReplication ffr,
 String filename)

getStatMode

public long getStatMode(FileReplication ffr,
 String filename)
                 throws IOException

Description copied from interface: BackupEnvironment

Gets the stat mode (or a generated and equivalent one) for a file.

Specified by:

getStatMode in interface BackupEnvironment

Throws:

IOException

getDirectoryList

public String[] getDirectoryList(FileReplication ffr,
 String filename)
                          throws IOException

Description copied from interface: BackupEnvironment

Gets the listing for a directory.

Specified by:

getDirectoryList in interface BackupEnvironment

Throws:

IOException

getUid

public int getUid(FileReplication ffr,
 String filename)
           throws IOException

Description copied from interface: BackupEnvironment

Gets the user ID.

Specified by:

getUid in interface BackupEnvironment

Throws:

IOException

getGid

public int getGid(FileReplication ffr,
 String filename)
           throws IOException

Description copied from interface: BackupEnvironment

Gets the group ID.

Specified by:

getGid in interface BackupEnvironment

Throws:

IOException

getModifyTime

public long getModifyTime(FileReplication ffr,
 String filename)
                   throws IOException

Description copied from interface: BackupEnvironment

Gets the modified time.

Specified by:

getModifyTime in interface BackupEnvironment

Throws:

IOException

getLength

public long getLength(FileReplication ffr,
 String filename)
               throws IOException

Description copied from interface: BackupEnvironment

Gets the length of the file.

Specified by:

getLength in interface BackupEnvironment

Throws:

IOException

readLink

public String readLink(FileReplication ffr,
 String filename)
                throws IOException

Description copied from interface: BackupEnvironment

Reads a symbolic link.

Specified by:

readLink in interface BackupEnvironment

Throws:

IOException

getDeviceIdentifier

public long getDeviceIdentifier(FileReplication ffr,
 String filename)
                         throws IOException

Description copied from interface: BackupEnvironment

Gets the device file major and minor.

Specified by:

getDeviceIdentifier in interface BackupEnvironment

Throws:

IOException

getInputStream

public InputStream getInputStream(FileReplication ffr,
 String filename)
                           throws IOException

Description copied from interface: BackupEnvironment

Gets a stream reading the file.

Specified by:

getInputStream in interface BackupEnvironment

Throws:

IOException

getNameOfFile

public String getNameOfFile(FileReplication ffr,
 String filename)

Description copied from interface: BackupEnvironment

Gets the name of a file (the part after the last slash).

Specified by:

getNameOfFile in interface BackupEnvironment

getFailoverBatchSize

public int getFailoverBatchSize(FileReplication ffr)
                         throws IOException,
SQLException

Description copied from interface: BackupEnvironment

Gets the number of items per batch. A higher value will consume more RAM but better hide latency.

Specified by:

getFailoverBatchSize in interface BackupEnvironment

Throws:

IOException

SQLException

preBackup

public void preBackup(FileReplication ffr)
               throws IOException,
SQLException

Description copied from interface: BackupEnvironment

Called right before a backup pass begins. Implementations should call super.preBackup first.

The process is:

1. preBackup
2. init
3. cleanup (always)
4. postBackup (only when backup pass successful)

Specified by:

preBackup in interface BackupEnvironment

Throws:

IOException

SQLException

init

public void init(FileReplication ffr)
          throws IOException,
SQLException

Description copied from interface: BackupEnvironment

Called before any backup-pass data is retrieved from the environment. cleanup() will also be called in a finally block. Implementations should call super.init first.

Specified by:

init in interface BackupEnvironment

Throws:

IOException

SQLException

See Also:

• BackupEnvironment.cleanup(FileReplication)
• BackupEnvironment.preBackup(FileReplication)

cleanup

public void cleanup(FileReplication ffr)
             throws IOException,
SQLException

Description copied from interface: BackupEnvironment

Called in a finally block after any backup-pass completes, no data will be obtained from the environment after this is called. Implementations should call super.cleanup in a finally block.

Specified by:

cleanup in interface BackupEnvironment

Throws:

IOException

SQLException

See Also:

• BackupEnvironment.init(FileReplication)
• BackupEnvironment.preBackup(FileReplication)

postBackup

public void postBackup(FileReplication ffr)
                throws IOException,
SQLException

Description copied from interface: BackupEnvironment

Called right after a backup pass ends. Implementations should call super.postBackup last.

Specified by:

postBackup in interface BackupEnvironment

Throws:

IOException

SQLException

See Also:

• BackupEnvironment.preBackup(FileReplication)

getRequiredFilenames

public Set<String> getRequiredFilenames(FileReplication ffr)
                                 throws IOException,
SQLException

Description copied from interface: BackupEnvironment

Gets the set of paths that must be found in the backup set. These paths must not include any trailing separators.

Specified by:

getRequiredFilenames in interface BackupEnvironment

Throws:

IOException

SQLException

getFilenameIterator

public Iterator<String> getFilenameIterator(FileReplication ffr)
                                     throws IOException,
SQLException

Description copied from interface: BackupEnvironment

Gets the Iterator of filenames or null if completed.

Specified by:

getFilenameIterator in interface BackupEnvironment

Throws:

IOException

SQLException

getFilesystemIteratorRules

protected abstract Map<String,FilesystemIteratorRule> getFilesystemIteratorRules(FileReplication ffr)
                                                                          throws IOException,
SQLException

Gets the default set of filesystem rules for this environment. This should not include file backup settings, they will override the values returned here. The returned map may be modified, to maintain internal consistency, return a copy of the map if needed.

Throws:

IOException

SQLException

getFilesystemIteratorPrefixRules

protected abstract Map<String,FilesystemIteratorRule> getFilesystemIteratorPrefixRules(FileReplication ffr)
                                                                                throws IOException,
SQLException

Gets the default set of filesystem prefix rules for this environment.

Throws:

IOException

SQLException

getDefaultSourceIpAddress

public InetAddress getDefaultSourceIpAddress()
                                      throws IOException,
SQLException

Description copied from interface: BackupEnvironment

Gets the default source IP address or InetAddress.UNSPECIFIED to use the system default.

Specified by:

getDefaultSourceIpAddress in interface BackupEnvironment

Throws:

IOException

SQLException

getReplicatedMysqlServers

public List<Server.Name> getReplicatedMysqlServers(FileReplication ffr)
                                            throws IOException,
SQLException

Description copied from interface: BackupEnvironment

Gets the list of MySQL server instance names that are being replicated. This is only used for failover mode (retention == 1), and should only be used for a replication that includes MySQL replication (Server only)

Specified by:

getReplicatedMysqlServers in interface BackupEnvironment

Throws:

IOException

SQLException

See Also:

• BackupEnvironment.getReplicatedMysqlMinorVersions(FileReplication)

getReplicatedMysqlMinorVersions

public List<String> getReplicatedMysqlMinorVersions(FileReplication ffr)
                                             throws IOException,
SQLException

Description copied from interface: BackupEnvironment

Gets the list of MySQL server versions (in the same order as the list returned by getReplicatedMysqlServers. This is only used for failover mode (retention == 1), and should only be used for a replication that includes MySQL replication (Server only)

Specified by:

getReplicatedMysqlMinorVersions in interface BackupEnvironment

Throws:

IOException

SQLException

See Also:

• BackupEnvironment.getReplicatedMysqlServers(FileReplication)

getFastRandom

public Random getFastRandom()

A fast pseudo-random number generator for non-cryptographic purposes.

Gets a Random source for the backup daemon. This does not need to be cryptographically strong because it is only used to randomize some sleep times to distribute load on the server processes.

Uses the random source from AoservConnector.getFastRandom().

Specified by:

getFastRandom in interface BackupEnvironment

getServerPath

public String getServerPath(FileReplication ffr,
 String filename)

Description copied from interface: BackupEnvironment

Converts an environment-specific filename into a server path. The server path must begin with /, may not contain /../, and must use / as the path separator.

Specified by:

getServerPath in interface BackupEnvironment