Module com.aoindustries.aoserv.backup

Package com.aoindustries.aoserv.backup

Interface BackupEnvironment

All Known Implementing Classes:

FileEnvironment, LinuxEnvironment, MacOsXEnvironment, PosixFileEnvironment, WindowsEnvironment

public interface BackupEnvironment

A BackupEnvironment tells the BackupDaemon how to run.

All paths are represented as a String to allow anything to be backed-up, not just local files.

Author:

AO Industries, Inc.

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.
AoservConnector	getConnector()	Gets the connection to the master server.
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.
Iterator<String>	getFilenameIterator(FileReplication ffr)	Gets the Iterator of filenames or null if completed.
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.
Logger	getLogger()	Gets the logger for this environment.
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.
Host	getThisHost()	Gets the host this process is running on.
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.

Method Details

getStatMode

long getStatMode(FileReplication ffr,
 String filename)
          throws IOException

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

Throws:

IOException

getDirectoryList

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

Gets the listing for a directory.

Throws:

IOException

getUid

int getUid(FileReplication ffr,
 String filename)
    throws IOException

Gets the user ID.

Throws:

IOException

getGid

int getGid(FileReplication ffr,
 String filename)
    throws IOException

Gets the group ID.

Throws:

IOException

getModifyTime

long getModifyTime(FileReplication ffr,
 String filename)
            throws IOException

Gets the modified time.

Throws:

IOException

getLength

long getLength(FileReplication ffr,
 String filename)
        throws IOException

Gets the length of the file.

Throws:

IOException

readLink

String readLink(FileReplication ffr,
 String filename)
         throws IOException

Reads a symbolic link.

Throws:

IOException

getDeviceIdentifier

long getDeviceIdentifier(FileReplication ffr,
 String filename)
                  throws IOException

Gets the device file major and minor.

Throws:

IOException

getInputStream

InputStream getInputStream(FileReplication ffr,
 String filename)
                    throws IOException

Gets a stream reading the file.

Throws:

IOException

getNameOfFile

String getNameOfFile(FileReplication ffr,
 String filename)

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

getConnector

AoservConnector getConnector()
                      throws IOException,
SQLException

Gets the connection to the master server.

Throws:

IOException

SQLException

getThisHost

Host getThisHost()
          throws IOException,
SQLException

Gets the host this process is running on.

Throws:

IOException

SQLException

getFailoverBatchSize

int getFailoverBatchSize(FileReplication ffr)
                  throws IOException,
SQLException

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

Throws:

IOException

SQLException

preBackup

void preBackup(FileReplication ffr)
        throws IOException,
SQLException

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)

Throws:

IOException

SQLException

init

void init(FileReplication ffr)
   throws IOException,
SQLException

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.

Throws:

IOException

SQLException

See Also:

• cleanup(FileReplication)
• preBackup(FileReplication)

cleanup

void cleanup(FileReplication ffr)
      throws IOException,
SQLException

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.

Throws:

IOException

SQLException

See Also:

• init(FileReplication)
• preBackup(FileReplication)

postBackup

void postBackup(FileReplication ffr)
         throws IOException,
SQLException

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

Throws:

IOException

SQLException

See Also:

• preBackup(FileReplication)

getRequiredFilenames

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

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

Throws:

IOException

SQLException

getFilenameIterator

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

Gets the Iterator of filenames or null if completed.

Throws:

IOException

SQLException

getDefaultSourceIpAddress

InetAddress getDefaultSourceIpAddress()
                               throws IOException,
SQLException

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

Throws:

IOException

SQLException

getReplicatedMysqlServers

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

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)

Throws:

IOException

SQLException

See Also:

• getReplicatedMysqlMinorVersions(FileReplication)

getReplicatedMysqlMinorVersions

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

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)

Throws:

IOException

SQLException

See Also:

• getReplicatedMysqlServers(FileReplication)

getFastRandom

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.

getLogger

Logger getLogger()

Gets the logger for this environment.

getServerPath

String getServerPath(FileReplication ffr,
 String filename)

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.