Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.backup

Class FileReplication

java.lang.Object

com.aoindustries.aoserv.client.AoservObject<Integer,FileReplication>

com.aoindustries.aoserv.client.CachedObject<Integer,FileReplication>

com.aoindustries.aoserv.client.CachedObjectIntegerKey<FileReplication>

com.aoindustries.aoserv.client.backup.FileReplication

All Implemented Interfaces:

BitRateProvider, Streamable, StreamReadable, StreamWritable, Row, AoservReadable, AoservStreamable, AoservWritable, SingleTableObject<Integer,FileReplication>

public final class FileReplication
extends CachedObjectIntegerKey<FileReplication>
implements BitRateProvider

Causes a server to replicate itself to another machine on a regular basis.

Author:

AO Industries, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FileReplication.Activity

Field Summary

Fields inherited from class com.aoindustries.aoserv.client.CachedObjectIntegerKey

pkey

Fields inherited from class com.aoindustries.aoserv.client.CachedObject

table

Fields inherited from class com.aoindustries.aoserv.client.AoservObject

USE_ARRAY_OF_DOMAIN, USE_SQL_DATA, USE_SQL_DATA_WRITE

Fields inherited from interface com.aoapps.hodgepodge.io.BitRateProvider

MINIMUM_BIT_RATE

Constructor Summary

Constructors

Constructor	Description
FileReplication()	Deprecated, for removal: This API element is subject to removal in a future version. Only required for implementation, do not use directly.

Method Summary

Modifier and Type	Method	Description
int	addFailoverFileLog(long startTime, long endTime, int scanned, int updated, long bytes, boolean isSuccessful)
int	addFileBackupSetting(String path, boolean backupEnabled, boolean required)
FileReplication.Activity	getActivity()
BackupPartition	getBackupPartition()	May be filtered.
Long	getBitRate()
int	getBlockSize()
protected Object	getColumnImpl(int i)
HostAddress	getConnectAddress()	Gets a connect address that should override the normal address resolution mechanisms.
InetAddress	getConnectFrom()	Gets the address connections should be made from that overrides the normal address resolution mechanism.
boolean	getEnabled()	Gets the enabled flag for this replication.
List<FileReplicationLog>	getFailoverFileLogs(int maxRows)	Gets the most recent (by start time) log entries for failover file replications, up to the maximum number of rows.
List<FileReplicationSchedule>	getFailoverFileSchedules()
List<MysqlReplication>	getFailoverMysqlReplications()
FileReplicationSetting	getFileBackupSetting(String path)
List<FileReplicationSetting>	getFileBackupSettings()
Host	getHost()
LinuxId	getQuotaGid()	When set, the group ID will always be set to this value, regardless what the client sends.
BackupRetention	getRetention()
Table.TableId	getTableId()
boolean	getUseCompression()
void	init(ResultSet result)	Initializes this object from the raw database contents.
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
Server.DaemonAccess	requestReplicationDaemonAccess()
void	setBitRate(Long bitRate)
void	setFailoverFileSchedules(List<Short> hours, List<Short> minutes)
void	setFileBackupSettings(List<String> paths, List<Boolean> backupEnableds, List<Boolean> requireds)
String	toStringImpl()	AoservObject.toString() implementation that is allowed to throw exceptions.
void	write(StreamableOutput out, AoservProtocol.Version protocolVersion)

Methods inherited from class com.aoindustries.aoserv.client.CachedObjectIntegerKey

equals, getKey, getPkey, hashCode

Methods inherited from class com.aoindustries.aoserv.client.CachedObject

getTable, setTable

Methods inherited from class com.aoindustries.aoserv.client.AoservObject

compare, compare, compare, compare, compareIgnoreCaseConsistentWithEquals, compareTo, compareTo, compareTo, getAccountingCode, getColumn, getColumns, getColumns, getDomainLabel, getDomainLabels, getDomainName, getDto, getEmail, getGecos, getGroupId, getHashedKey, getHashedPassword, getHostname, getInetAddress, getLinuxId, getLinuxUserName, getMacAddress, getMysqlDatabaseName, getMysqlServerName, getMysqlUserName, getPort, getPostgresDatabaseName, getPostgresServerName, getPostgresUserId, getTableSchema, getTimeMillis, getTimeMillis, getUnixPath, getUserId, read, toString, write

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

FileReplication

@Deprecated(forRemoval=true)
public FileReplication()

Deprecated, for removal: This API element is subject to removal in a future version.

Only required for implementation, do not use directly.

See Also:

• init(java.sql.ResultSet)
• read(com.aoapps.hodgepodge.io.stream.StreamableInput, com.aoindustries.aoserv.client.schema.AoservProtocol.Version)

Method Details

addFailoverFileLog

public int addFailoverFileLog(long startTime,
 long endTime,
 int scanned,
 int updated,
 long bytes,
 boolean isSuccessful)
                       throws IOException,
SQLException

Throws:

IOException

SQLException

getBitRate

public Long getBitRate()

Specified by:

getBitRate in interface BitRateProvider

setBitRate

public void setBitRate(Long bitRate)
                throws IOException,
SQLException

Throws:

IOException

SQLException

getBlockSize

public int getBlockSize()

Specified by:

getBlockSize in interface BitRateProvider

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<Integer,FileReplication>

getFailoverFileSchedules

public List<FileReplicationSchedule> getFailoverFileSchedules()
                                                       throws IOException,
SQLException

Throws:

IOException

SQLException

getHost

public Host getHost()
             throws SQLException,
IOException

Throws:

SQLException

IOException

getBackupPartition

public BackupPartition getBackupPartition()
                                   throws SQLException,
IOException

May be filtered.

Throws:

SQLException

IOException

getFailoverFileLogs

public List<FileReplicationLog> getFailoverFileLogs(int maxRows)
                                             throws IOException,
SQLException

Gets the most recent (by start time) log entries for failover file replications, up to the maximum number of rows. May return less than this number of rows. The results are sorted by start_time descending (most recent at index zero).

Throws:

IOException

SQLException

getFailoverMysqlReplications

public List<MysqlReplication> getFailoverMysqlReplications()
                                                    throws IOException,
SQLException

Throws:

IOException

SQLException

getUseCompression

public boolean getUseCompression()

getRetention

public BackupRetention getRetention()
                             throws SQLException,
IOException

Throws:

SQLException

IOException

getConnectAddress

public HostAddress getConnectAddress()

Gets a connect address that should override the normal address resolution mechanisms. This allows a replication to be specifically sent through a gigabit connection or alternate route.

getConnectFrom

public InetAddress getConnectFrom()

Gets the address connections should be made from that overrides the normal address resolution mechanism. This allows a replication to be specifically sent through a gigabit connection or alternate route.

getEnabled

public boolean getEnabled()

Gets the enabled flag for this replication.

getQuotaGid

public LinuxId getQuotaGid()

When set, the group ID will always be set to this value, regardless what the client sends. This gid is only unique per backup_partition, thus on a single host the same gid may be used for different accounts. Also, the gid will not exist in /etc/groups and has nothing to do with the shell accounts on the server. This is to track quotas per backup partition by group ID. This may only be set (and must be set) when stored on a backup_partition with quota_enabled.

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,FileReplication>

init

public void init(ResultSet result)
          throws SQLException

Description copied from class: AoservObject

Initializes this object from the raw database contents.

Specified by:

init in class AoservObject<Integer,FileReplication>

Parameters:

result - the ResultSet containing the row to copy into this object

Throws:

SQLException

read

public void read(StreamableInput in,
 AoservProtocol.Version protocolVersion)
          throws IOException

Specified by:

read in interface AoservReadable

Specified by:

read in interface AoservStreamable

Specified by:

read in class AoservObject<Integer,FileReplication>

Throws:

IOException

toStringImpl

public String toStringImpl()
                    throws SQLException,
IOException

Description copied from class: AoservObject

AoservObject.toString() implementation that is allowed to throw exceptions.

Implementation Note:
This default implementation calls AoservObject.toString() on the key (from AoservObject.getKey()). When the key is null, uses the default implementation from Object.toString().

Overrides:

toStringImpl in class CachedObjectIntegerKey<FileReplication>

Throws:

SQLException

IOException

write

public void write(StreamableOutput out,
 AoservProtocol.Version protocolVersion)
           throws IOException

Specified by:

write in interface AoservStreamable

Specified by:

write in interface AoservWritable

Specified by:

write in class AoservObject<Integer,FileReplication>

Throws:

IOException

addFileBackupSetting

public int addFileBackupSetting(String path,
 boolean backupEnabled,
 boolean required)
                         throws IOException,
SQLException

Throws:

IOException

SQLException

getFileBackupSetting

public FileReplicationSetting getFileBackupSetting(String path)
                                            throws IOException,
SQLException

Throws:

IOException

SQLException

getFileBackupSettings

public List<FileReplicationSetting> getFileBackupSettings()
                                                   throws IOException,
SQLException

Throws:

IOException

SQLException

setFailoverFileSchedules

public void setFailoverFileSchedules(List<Short> hours,
 List<Short> minutes)
                              throws IOException,
SQLException

Throws:

IOException

SQLException

setFileBackupSettings

public void setFileBackupSettings(List<String> paths,
 List<Boolean> backupEnableds,
 List<Boolean> requireds)
                           throws IOException,
SQLException

Throws:

IOException

SQLException

requestReplicationDaemonAccess

public Server.DaemonAccess requestReplicationDaemonAccess()
                                                   throws IOException,
SQLException

Throws:

IOException

SQLException

getActivity

public FileReplication.Activity getActivity()
                                     throws IOException,
SQLException

Throws:

IOException

SQLException