Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client

Class AoservObject<K,T extends AoservObject<K,T>>

java.lang.Object

com.aoindustries.aoserv.client.AoservObject<K,T>

All Implemented Interfaces:

Streamable, StreamReadable, StreamWritable, Row, AoservReadable, AoservStreamable, AoservWritable

Direct Known Subclasses:

BackupReport, BankTransaction, CachedObject, FileReplicationLog, FilesystemCachedObject, GlobalObject, Process, ServerStat, SpamMessage

public abstract class AoservObject<K,T extends AoservObject<K,T>>
extends Object
implements Row, AoservStreamable

An AoservObject is the lowest level object for all data in the system. Each AoservObject belongs to a AoservTable, and each table contains AoservObjects.

Author:

AO Industries, Inc.

See Also:

• AoservTable

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	USE_ARRAY_OF_DOMAIN	Enables the use of arrays of domains.
static final boolean	USE_SQL_DATA	Enables the use of SQLData.
static final boolean	USE_SQL_DATA_WRITE	Enables the use of SQLData on writeObject.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AoservObject()	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
static int	compare(int i1, int i2)	Deprecated. This method moved to ComparatorUtils.compare(int, int)
static int	compare(long l1, long l2)	Deprecated. This method moved to ComparatorUtils.compare(long, long)
static int	compare(short s1, short s2)	Deprecated. This method moved to ComparatorUtils.compare(short, short)
static <T extends Comparable<T>> int	compare(T obj1, T obj2)	Compares two objects allowing for nulls, sorts non-null before null.
static int	compareIgnoreCaseConsistentWithEquals(String s1, String s2)	Deprecated. This method moved to ComparatorUtils.compareIgnoreCaseConsistentWithEquals(java.lang.String, java.lang.String)
final int	compareTo(AoservConnector conn, AoservObject<?,?> other, SqlExpression[] sortExpressions, boolean[] sortOrders)
final int	compareTo(AoservConnector conn, Comparable<?> value, SqlExpression[] sortExpressions, boolean[] sortOrders)
final int	compareTo(AoservConnector conn, Object[] objects, SqlExpression[] sortExpressions, boolean[] sortOrders)
boolean	equals(Object obj)
protected static Account.Name	getAccountingCode(AccountName accounting)	null-safe accounting code conversion.
final Object	getColumn(int i)
protected abstract Object	getColumnImpl(int i)
final List<Object>	getColumns(AoservConnector connector)
final int	getColumns(AoservConnector connector, List<Object> buff)
protected static DomainLabel	getDomainLabel(DomainLabel domainLabel)	null-safe domain label conversion.
protected static DomainLabels	getDomainLabels(DomainLabels domainLabels)	null-safe domain labels conversion.
protected static DomainName	getDomainName(DomainName domainName)	null-safe domain name conversion.
protected static <B> B	getDto(DtoFactory<B> dtoFactory)	null-safe getDto.
protected static Email	getEmail(Email email)	null-safe email conversion.
protected static User.Gecos	getGecos(Gecos gecos)	null-safe GECOS conversion.
protected static Group.Name	getGroupId(LinuxGroupName gid)	null-safe group id conversion.
protected static HashedKey	getHashedKey(HashedKey hashedKey)	null-safe hashed key conversion.
protected static HashedPassword	getHashedPassword(HashedPassword hashedPassword)	null-safe hashed password conversion.
protected static HostAddress	getHostname(HostAddress hostname)	null-safe hostname conversion.
protected static InetAddress	getInetAddress(InetAddress inetAddress)	null-safe inet address conversion.
abstract K	getKey()
protected static LinuxId	getLinuxId(LinuxId lid)	null-safe Linux id conversion.
protected static User.Name	getLinuxUserName(LinuxUserName linuxUserName)	null-safe Linux user name conversion.
protected static MacAddress	getMacAddress(MacAddress macAddress)	null-safe MAC address conversion.
protected static Database.Name	getMysqlDatabaseName(MysqlDatabaseName databaseName)	null-safe MySQL database name conversion.
protected static Server.Name	getMysqlServerName(MysqlServerName serverName)	null-safe MySQL server name conversion.
protected static User.Name	getMysqlUserName(MysqlUserName mysqlUserId)	null-safe MySQL user name conversion.
protected static Port	getPort(Port port)	null-safe port conversion.
protected static Database.Name	getPostgresDatabaseName(PostgresDatabaseName databaseName)	null-safe PostgreSQL database name conversion.
protected static Server.Name	getPostgresServerName(PostgresServerName serverName)	null-safe PostgreSQL server name conversion.
protected static User.Name	getPostgresUserId(PostgresUserName postgresUserId)	null-safe PostgreSQL user id conversion.
abstract Table.TableId	getTableId()
final Table	getTableSchema(AoservConnector connector)
protected static Long	getTimeMillis(Calendar datetime)	null-safe conversion from Calendar to Long.
protected static Long	getTimeMillis(Date date)	null-safe conversion from Date to Long.
protected static PosixPath	getUnixPath(PosixPath unixPath)	null-safe Unix path conversion.
protected static User.Name	getUserId(UserName userId)	null-safe user id conversion.
int	hashCode()
abstract void	init(ResultSet results)	Initializes this object from the raw database contents.
abstract void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
final void	read(StreamableInput in, String protocolVersion)	Deprecated. This is maintained only for compatibility with the Streamable interface.
final String	toString()
String	toStringImpl()	toString() implementation that is allowed to throw exceptions.
abstract void	write(StreamableOutput out, AoservProtocol.Version protocolVersion)
final void	write(StreamableOutput out, String protocolVersion)	Deprecated. This is maintained only for compatibility with the Streamable interface.

Methods inherited from class java.lang.Object

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

Field Details

USE_SQL_DATA

public static final boolean USE_SQL_DATA

Enables the use of SQLData. This currently requires our forked PostgreSQL JDBC driver to function correctly. See Issue #641 for more details.

See Also:

• Constant Field Values

USE_SQL_DATA_WRITE

public static final boolean USE_SQL_DATA_WRITE

Enables the use of SQLData on writeObject. This currently requires our forked PostgreSQL JDBC driver to function correctly. See Pull request #1377 for more details.

See Also:

• Constant Field Values

USE_ARRAY_OF_DOMAIN

public static final boolean USE_ARRAY_OF_DOMAIN

Enables the use of arrays of domains. This is currently not supported by PostgreSQL.

See Also:

• Constant Field Values

Constructor Details

AoservObject

@Deprecated(forRemoval=true)
protected AoservObject()

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

compareIgnoreCaseConsistentWithEquals

@Deprecated
public static int compareIgnoreCaseConsistentWithEquals(String s1,
 String s2)

Deprecated.

This method moved to ComparatorUtils.compareIgnoreCaseConsistentWithEquals(java.lang.String, java.lang.String)

compare

@Deprecated
public static int compare(int i1,
 int i2)

Deprecated.

This method moved to ComparatorUtils.compare(int, int)

compare

@Deprecated
public static int compare(short s1,
 short s2)

Deprecated.

This method moved to ComparatorUtils.compare(short, short)

compare

@Deprecated
public static int compare(long l1,
 long l2)

Deprecated.

This method moved to ComparatorUtils.compare(long, long)

compare

public static <T extends Comparable<T>> int compare(T obj1,
 T obj2)

Compares two objects allowing for nulls, sorts non-null before null.

compareTo

public final int compareTo(AoservConnector conn,
 AoservObject<?,?> other,
 SqlExpression[] sortExpressions,
 boolean[] sortOrders)
                    throws IllegalArgumentException,
SQLException,
UnknownHostException,
IOException

Throws:

IllegalArgumentException

SQLException

UnknownHostException

IOException

compareTo

public final int compareTo(AoservConnector conn,
 Comparable<?> value,
 SqlExpression[] sortExpressions,
 boolean[] sortOrders)
                    throws IllegalArgumentException,
SQLException,
UnknownHostException,
IOException

Throws:

IllegalArgumentException

SQLException

UnknownHostException

IOException

compareTo

public final int compareTo(AoservConnector conn,
 Object[] objects,
 SqlExpression[] sortExpressions,
 boolean[] sortOrders)
                    throws IllegalArgumentException,
SQLException,
UnknownHostException,
IOException

Throws:

IllegalArgumentException

SQLException

UnknownHostException

IOException

getDto

protected static <B> B getDto(DtoFactory<B> dtoFactory)

null-safe getDto.

getAccountingCode

protected static Account.Name getAccountingCode(AccountName accounting)
                                         throws ValidationException

null-safe accounting code conversion.

Throws:

ValidationException

getDomainLabel

protected static DomainLabel getDomainLabel(DomainLabel domainLabel)
                                     throws ValidationException

null-safe domain label conversion.

Throws:

ValidationException

getDomainLabels

protected static DomainLabels getDomainLabels(DomainLabels domainLabels)
                                       throws ValidationException

null-safe domain labels conversion.

Throws:

ValidationException

getDomainName

protected static DomainName getDomainName(DomainName domainName)
                                   throws ValidationException

null-safe domain name conversion.

Throws:

ValidationException

getEmail

protected static Email getEmail(Email email)
                         throws ValidationException

null-safe email conversion.

Throws:

ValidationException

getGecos

protected static User.Gecos getGecos(Gecos gecos)
                              throws ValidationException

null-safe GECOS conversion.

Throws:

ValidationException

getGroupId

protected static Group.Name getGroupId(LinuxGroupName gid)
                                throws ValidationException

null-safe group id conversion.

Throws:

ValidationException

getHashedKey

protected static HashedKey getHashedKey(HashedKey hashedKey)
                                 throws IllegalArgumentException

null-safe hashed key conversion.

Throws:

IllegalArgumentException

getHashedPassword

protected static HashedPassword getHashedPassword(HashedPassword hashedPassword)
                                           throws IllegalArgumentException

null-safe hashed password conversion.

Throws:

IllegalArgumentException

getHostname

protected static HostAddress getHostname(HostAddress hostname)
                                  throws ValidationException

null-safe hostname conversion.

Throws:

ValidationException

getInetAddress

protected static InetAddress getInetAddress(InetAddress inetAddress)
                                     throws ValidationException

null-safe inet address conversion.

Throws:

ValidationException

getLinuxId

protected static LinuxId getLinuxId(LinuxId lid)
                             throws ValidationException

null-safe Linux id conversion.

Throws:

ValidationException

getLinuxUserName

protected static User.Name getLinuxUserName(LinuxUserName linuxUserName)
                                     throws ValidationException

null-safe Linux user name conversion.

Throws:

ValidationException

getMacAddress

protected static MacAddress getMacAddress(MacAddress macAddress)
                                   throws ValidationException

null-safe MAC address conversion.

Throws:

ValidationException

getMysqlDatabaseName

protected static Database.Name getMysqlDatabaseName(MysqlDatabaseName databaseName)
                                             throws ValidationException

null-safe MySQL database name conversion.

Throws:

ValidationException

getMysqlServerName

protected static Server.Name getMysqlServerName(MysqlServerName serverName)
                                         throws ValidationException

null-safe MySQL server name conversion.

Throws:

ValidationException

getMysqlUserName

protected static User.Name getMysqlUserName(MysqlUserName mysqlUserId)
                                     throws ValidationException

null-safe MySQL user name conversion.

Throws:

ValidationException

getPort

protected static Port getPort(Port port)
                       throws ValidationException

null-safe port conversion.

Throws:

ValidationException

getPostgresDatabaseName

protected static Database.Name getPostgresDatabaseName(PostgresDatabaseName databaseName)
                                                throws ValidationException

null-safe PostgreSQL database name conversion.

Throws:

ValidationException

getPostgresServerName

protected static Server.Name getPostgresServerName(PostgresServerName serverName)
                                            throws ValidationException

null-safe PostgreSQL server name conversion.

Throws:

ValidationException

getPostgresUserId

protected static User.Name getPostgresUserId(PostgresUserName postgresUserId)
                                      throws ValidationException

null-safe PostgreSQL user id conversion.

Throws:

ValidationException

getTimeMillis

protected static Long getTimeMillis(Date date)

null-safe conversion from Date to Long.

getTimeMillis

protected static Long getTimeMillis(Calendar datetime)

null-safe conversion from Calendar to Long.

getUnixPath

protected static PosixPath getUnixPath(PosixPath unixPath)
                                throws ValidationException

null-safe Unix path conversion.

Throws:

ValidationException

getUserId

protected static User.Name getUserId(UserName userId)
                              throws ValidationException

null-safe user id conversion.

Throws:

ValidationException

equals

public boolean equals(Object obj)

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

Overrides:

equals in class Object

getColumn

public final Object getColumn(int i)

Specified by:

getColumn in interface Row

getColumnImpl

protected abstract Object getColumnImpl(int i)
                                 throws IOException,
SQLException

Throws:

IOException

SQLException

getColumns

public final List<Object> getColumns(AoservConnector connector)
                              throws IOException,
SQLException

Throws:

IOException

SQLException

getColumns

public final int getColumns(AoservConnector connector,
 List<Object> buff)
                     throws IOException,
SQLException

Throws:

IOException

SQLException

getKey

public abstract K getKey()

getTableId

public abstract Table.TableId getTableId()

getTableSchema

public final Table getTableSchema(AoservConnector connector)
                           throws IOException,
SQLException

Throws:

IOException

SQLException

hashCode

public int hashCode()

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

Overrides:

hashCode in class Object

init

public abstract void init(ResultSet results)
                   throws SQLException

Initializes this object from the raw database contents.

Parameters:

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

Throws:

SQLException

read

@Deprecated
public final void read(StreamableInput in,
 String protocolVersion)
                throws IOException

Deprecated.

This is maintained only for compatibility with the Streamable interface.

Specified by:

read in interface AoservStreamable

Specified by:

read in interface Streamable

Specified by:

read in interface StreamReadable

Throws:

IOException

See Also:

• read(StreamableInput, com.aoindustries.aoserv.client.schema.AoservProtocol.Version)

read

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

Specified by:

read in interface AoservReadable

Specified by:

read in interface AoservStreamable

Throws:

IOException

toString

public final String toString()

Implementation Note:
This default implementation calls toStringImpl(), which is allowed to throw exceptions.

Overrides:

toString in class Object

Throws:

WrappedException - when toStringImpl() throws an exception

See Also:

• toStringImpl()

toStringImpl

public String toStringImpl()
                    throws IOException,
SQLException

toString() implementation that is allowed to throw exceptions.

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

Throws:

IOException

SQLException

write

@Deprecated
public final void write(StreamableOutput out,
 String protocolVersion)
                 throws IOException

Deprecated.

This is maintained only for compatibility with the Streamable interface.

Specified by:

write in interface AoservStreamable

Specified by:

write in interface Streamable

Specified by:

write in interface StreamWritable

Throws:

IOException

See Also:

• write(StreamableOutput, com.aoindustries.aoserv.client.schema.AoservProtocol.Version)

write

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

Specified by:

write in interface AoservStreamable

Specified by:

write in interface AoservWritable

Throws:

IOException