Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.backup

Class BackupReport

java.lang.Object

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

com.aoindustries.aoserv.client.backup.BackupReport

All Implemented Interfaces:

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

public final class BackupReport
extends AoservObject<Integer,BackupReport>
implements SingleTableObject<Integer,BackupReport>

A BackupReport is generated once per day per package and per server. This information is averaged through a month and used for account billing. The reports are processed at or near 2:00am and basically represent the report for the previous day.

Author:

AO Industries, Inc.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BACKUP_REPORT_HOUR	The hour of the day (in master server time zone) that backup reports will be created.
static final int	BACKUP_REPORT_MINUTE	The minute (in master server time zone) that backup reports will be created.
static final int	MAX_REPORT_AGE	The maximum number of days that reports will be maintained.

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

USE_ARRAY_OF_DOMAIN, USE_SQL_DATA, USE_SQL_DATA_WRITE

Constructor Summary

Constructors

Constructor	Description
BackupReport()	Deprecated. Only required for implementation, do not use directly.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
protected Object	getColumnImpl(int i)
Date	getDate()
long	getDiskSize()
int	getFileCount()
Host	getHost()
int	getHost_id()
Integer	getKey()
Package	getPackage()
int	getPackage_id()
int	getPkey()
AoservTable<Integer,BackupReport>	getTable()	Gets the AoservTable that contains this AoservObject.
Table.TableId	getTableId()
int	hashCode()
void	init(ResultSet result)	Initializes this object from the raw database contents.
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	setTable(AoservTable<Integer,BackupReport> table)
void	write(StreamableOutput out, AoservProtocol.Version protocolVersion)

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, toStringImpl, write

Methods inherited from class java.lang.Object

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

Field Details

BACKUP_REPORT_HOUR

public static final int BACKUP_REPORT_HOUR

The hour of the day (in master server time zone) that backup reports will be created.

See Also:

• Constant Field Values

BACKUP_REPORT_MINUTE

public static final int BACKUP_REPORT_MINUTE

The minute (in master server time zone) that backup reports will be created.

See Also:

• Constant Field Values

MAX_REPORT_AGE

public static final int MAX_REPORT_AGE

The maximum number of days that reports will be maintained. This is roughly 5 years.

See Also:

• Constant Field Values

Constructor Details

BackupReport

@Deprecated
public BackupReport()

Deprecated.

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

equals

public boolean equals(Object obj)

Description copied from class: AoservObject

Implementation Note:
This default implementation considers the object equal when it is the same class (via Object.getClass() and has equal keys (via AoservObject.getKey()).

Overrides:

equals in class AoservObject<Integer,BackupReport>

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<Integer,BackupReport>

getPkey

public int getPkey()

getHost_id

public int getHost_id()

getHost

public Host getHost()
             throws SQLException,
IOException

Throws:

SQLException

IOException

getPackage_id

public int getPackage_id()

getPackage

public Package getPackage()
                   throws IOException,
SQLException

Throws:

IOException

SQLException

getDate

public Date getDate()

getFileCount

public int getFileCount()

getDiskSize

public long getDiskSize()

getKey

public Integer getKey()

Specified by:

getKey in class AoservObject<Integer,BackupReport>

getTable

public AoservTable<Integer,BackupReport> getTable()

Description copied from interface: SingleTableObject

Gets the AoservTable that contains this AoservObject.

Specified by:

getTable in interface SingleTableObject<Integer,BackupReport>

Returns:

the AoservTable.

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,BackupReport>

hashCode

public int hashCode()

Description copied from class: AoservObject

Implementation Note:
This default implementation calls AoservObject.hashCode() on the key (from AoservObject.getKey()).

Overrides:

hashCode in class AoservObject<Integer,BackupReport>

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,BackupReport>

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,BackupReport>

Throws:

IOException

setTable

public void setTable(AoservTable<Integer,BackupReport> table)

Specified by:

setTable in interface SingleTableObject<Integer,BackupReport>

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,BackupReport>

Throws:

IOException