Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.schema

Class AoservProtocol

java.lang.Object

com.aoindustries.aoserv.client.AoservObject<String,AoservProtocol>

com.aoindustries.aoserv.client.GlobalObject<String,AoservProtocol>

com.aoindustries.aoserv.client.GlobalObjectStringKey<AoservProtocol>

com.aoindustries.aoserv.client.schema.AoservProtocol

All Implemented Interfaces:

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

public final class AoservProtocol
extends GlobalObjectStringKey<AoservProtocol>

Constants used in communication between the client and server.

Author:

AO Industries, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AoservProtocol.CommandId	Since the ordinals are used in the protocol (for compatibility with older implementations), values must be added to the end of this enum.
static enum	AoservProtocol.Version	The current version of the client/server protocol.

Field Summary

Fields

Modifier and Type	Field	Description
static final byte	DONE
static final int	FALSE
static final String	FILTERED	Indicates that a field was filtered by the server.
static final byte	IO_EXCEPTION
static final byte	NEXT
static final int	SERVER_DOWN
static final byte	SQL_EXCEPTION
static final int	TRUE

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

pkey

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
AoservProtocol()	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 void	checkResult(int code, StreamableInput in)
protected Object	getColumnImpl(int i)
String	getComments()
Date	getCreated()
Date	getLastUsed()
Long	getLastUsed_time()
Table.TableId	getTableId()
String	getVersion()
void	init(ResultSet result)	Initializes this object from the raw database contents.
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	write(StreamableOutput out, AoservProtocol.Version protocolVersion)

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

equals, getKey, hashCode, toStringImpl

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

Field Details

NEXT

public static final byte NEXT

See Also:

• Constant Field Values

DONE

public static final byte DONE

See Also:

• Constant Field Values

IO_EXCEPTION

public static final byte IO_EXCEPTION

See Also:

• Constant Field Values

SQL_EXCEPTION

public static final byte SQL_EXCEPTION

See Also:

• Constant Field Values

FALSE

public static final int FALSE

See Also:

• Constant Field Values

TRUE

public static final int TRUE

See Also:

• Constant Field Values

SERVER_DOWN

public static final int SERVER_DOWN

See Also:

• Constant Field Values

FILTERED

public static final String FILTERED

Indicates that a field was filtered by the server.

See Also:

• Constant Field Values

Constructor Details

AoservProtocol

@Deprecated(forRemoval=true)
public AoservProtocol()

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

checkResult

public static void checkResult(int code,
 StreamableInput in)
                        throws IOException,
SQLException

Throws:

IOException

SQLException

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<String,AoservProtocol>

getVersion

public String getVersion()

getCreated

public Date getCreated()

getComments

public String getComments()

getLastUsed_time

public Long getLastUsed_time()

getLastUsed

public Date getLastUsed()

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<String,AoservProtocol>

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<String,AoservProtocol>

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<String,AoservProtocol>

Throws:

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<String,AoservProtocol>

Throws:

IOException