Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.mysql

Class Server

java.lang.Object

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

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

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

com.aoindustries.aoserv.client.mysql.Server

All Implemented Interfaces:

Streamable, StreamReadable, StreamWritable, Row, AOServReadable, AOServStreamable, AOServWritable, SingleTableObject<Integer,Server>

public final class Server
extends CachedObjectIntegerKey<Server>

A MySQLServer corresponds to a unique MySQL install space on one server. The server name must be unique per server. MySQLDatabases and MySQLServerUsers are unique per MySQLServer.

Author:

AO Industries, Inc.

See Also:

Database, UserServer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Server.MasterStatus
static class	Server.Name	Represents a name that may be used for a MySQL installation.
static class	Server.ReservedWord	Deprecated. 2019-07-14: Is this still used?

Field Summary

Fields

Modifier and Type	Field	Description
static String	COLUMN_AO_SERVER_name
static String	COLUMN_NAME_name
static PosixPath	DATA_BASE_DIR	The directory that contains the MySQL data files.
static Port	DEFAULT_PORT	The default MySQL port.
static int	MAX_SERVER_NAME_LENGTH	Deprecated. Please use Server.Name.MAX_LENGTH instead.
static List<String>	PREFERRED_VERSION_PREFIXES	Gets the versions of MySQL in order of preference.
static String	VERSION_4_0_PREFIX	The supported versions of MySQL.
static String	VERSION_4_1_PREFIX	The supported versions of MySQL.
static String	VERSION_5_0_PREFIX	The supported versions of MySQL.
static String	VERSION_5_1_PREFIX	The supported versions of MySQL.
static String	VERSION_5_6_PREFIX	The supported versions of MySQL.
static String	VERSION_5_7_PREFIX	The supported versions of MySQL.
static String	VERSION_8_0_PREFIX	The supported versions of MySQL.

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

Constructor Summary

Constructors

Constructor	Description
Server()

Method Summary

Modifier and Type	Method	Description
int	addMySQLDatabase(Database.Name name, Package pack)
int	getAoServer_server_pkey()
Bind	getBind()
int	getBind_id()
protected Object	getColumnImpl(int i)
PosixPath	getDataDirectory()
List<MysqlReplication>	getFailoverMySQLReplications()
Server	getLinuxServer()
Server.MasterStatus	getMasterStatus()	Gets the master status or null if no master status provided by MySQL.
int	getMaxConnections()
String	getMinorVersion()	Gets the minor version number in X.X[-max] format.
Database	getMySQLDatabase(Database.Name name)
List<Database>	getMySQLDatabases()
List<DatabaseUser>	getMySQLDBUsers()
UserServer	getMySQLServerUser(User.Name username)
List<UserServer>	getMySQLServerUsers()
List<User>	getMySQLUsers()
Server.Name	getName()
Table.TableID	getTableID()
SoftwareVersion	getVersion()
void	init(ResultSet result)	Initializes this object from the raw database contents.
boolean	isMySQLDatabaseNameAvailable(Database.Name name)
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	restartMySQL()
void	startMySQL()
void	stopMySQL()
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

Field Detail

DEFAULT_PORT

public static final Port DEFAULT_PORT

The default MySQL port.

VERSION_8_0_PREFIX

public static final String VERSION_8_0_PREFIX

The supported versions of MySQL.

See Also:

Constant Field Values

VERSION_5_7_PREFIX

public static final String VERSION_5_7_PREFIX

The supported versions of MySQL.

See Also:

Constant Field Values

VERSION_5_6_PREFIX

public static final String VERSION_5_6_PREFIX

The supported versions of MySQL.

See Also:

Constant Field Values

VERSION_5_1_PREFIX

public static final String VERSION_5_1_PREFIX

The supported versions of MySQL.

See Also:

Constant Field Values

VERSION_5_0_PREFIX

public static final String VERSION_5_0_PREFIX

The supported versions of MySQL.

See Also:

Constant Field Values

VERSION_4_1_PREFIX

public static final String VERSION_4_1_PREFIX

The supported versions of MySQL.

See Also:

Constant Field Values

VERSION_4_0_PREFIX

public static final String VERSION_4_0_PREFIX

The supported versions of MySQL.

See Also:

Constant Field Values

DATA_BASE_DIR

public static final PosixPath DATA_BASE_DIR

The directory that contains the MySQL data files.

PREFERRED_VERSION_PREFIXES

public static final List<String> PREFERRED_VERSION_PREFIXES

Gets the versions of MySQL in order of preference. Index 0 is the most preferred.

COLUMN_AO_SERVER_name

public static final String COLUMN_AO_SERVER_name

See Also:

Constant Field Values

COLUMN_NAME_name

public static final String COLUMN_NAME_name

See Also:

Constant Field Values

MAX_SERVER_NAME_LENGTH

@Deprecated
public static final int MAX_SERVER_NAME_LENGTH

Deprecated.

Please use Server.Name.MAX_LENGTH instead.

The maximum length of the name.

See Also:

Constant Field Values

Constructor Detail

Server

public Server()

Method Detail

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AOServObject<Integer,Server>

getBind_id

public int getBind_id()

getBind

public Bind getBind()
             throws SQLException,
                    IOException

Throws:

SQLException

IOException

getName

public Server.Name getName()

getAoServer_server_pkey

public int getAoServer_server_pkey()

getLinuxServer

public Server getLinuxServer()
                      throws SQLException,
                             IOException

Throws:

SQLException

IOException

getVersion

public SoftwareVersion getVersion()
                           throws SQLException,
                                  IOException

Throws:

SQLException

IOException

getMaxConnections

public int getMaxConnections()

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

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

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<Integer,Server>

Throws:

IOException

addMySQLDatabase

public int addMySQLDatabase(Database.Name name,
                            Package pack)
                     throws IOException,
                            SQLException

Throws:

IOException

SQLException

getDataDirectory

public PosixPath getDataDirectory()

getMinorVersion

public String getMinorVersion()
                       throws SQLException,
                              IOException

Gets the minor version number in X.X[-max] format. This corresponds to the installation directory under /usr/mysql/X.X[-max] or /opt/mysql-X.X[-max]

Throws:

SQLException

IOException

getMySQLDatabase

public Database getMySQLDatabase(Database.Name name)
                          throws IOException,
                                 SQLException

Throws:

IOException

SQLException

getFailoverMySQLReplications

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

Throws:

IOException

SQLException

getMySQLDatabases

public List<Database> getMySQLDatabases()
                                 throws IOException,
                                        SQLException

Throws:

IOException

SQLException

getMySQLDBUsers

public List<DatabaseUser> getMySQLDBUsers()
                                   throws IOException,
                                          SQLException

Throws:

IOException

SQLException

getMySQLServerUser

public UserServer getMySQLServerUser(User.Name username)
                              throws IOException,
                                     SQLException

Throws:

IOException

SQLException

getMySQLServerUsers

public List<UserServer> getMySQLServerUsers()
                                     throws IOException,
                                            SQLException

Throws:

IOException

SQLException

getMySQLUsers

public List<User> getMySQLUsers()
                         throws IOException,
                                SQLException

Throws:

IOException

SQLException

getTableID

public Table.TableID getTableID()

Specified by:

getTableID in class AOServObject<Integer,Server>

isMySQLDatabaseNameAvailable

public boolean isMySQLDatabaseNameAvailable(Database.Name name)
                                     throws IOException,
                                            SQLException

Throws:

IOException

SQLException

restartMySQL

public void restartMySQL()
                  throws IOException,
                         SQLException

Throws:

IOException

SQLException

startMySQL

public void startMySQL()
                throws IOException,
                       SQLException

Throws:

IOException

SQLException

stopMySQL

public void stopMySQL()
               throws IOException,
                      SQLException

Throws:

IOException

SQLException

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<Server>

Throws:

SQLException

IOException

getMasterStatus

public Server.MasterStatus getMasterStatus()
                                    throws IOException,
                                           SQLException

Gets the master status or null if no master status provided by MySQL. If any error occurs, throws either IOException or SQLException.

Throws:

IOException

SQLException