Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.postgresql

Class Server

java.lang.Object

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

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

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

com.aoindustries.aoserv.client.postgresql.Server

All Implemented Interfaces:

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

public final class Server
extends CachedObjectIntegerKey<Server>

A PostgresServer corresponds to a unique PostgreSQL install space on one server. The server name must be unique per server. PostgresDatabases and PostgresServerUsers are unique per PostgresServer.

Author:

AO Industries, Inc.

See Also:

• Version
• Database
• UserServer

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final PosixPath	DATA_BASE_DIR	The directory that contains the PostgreSQL data files.
static final Port	DEFAULT_PORT	The default PostSQL port.

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()	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	addPostgresDatabase(Database.Name name, UserServer datdba, Encoding encoding, boolean enablePostgis)
int	getAoServer_server_pkey()
Bind	getBind()
int	getBind_id()
protected Object	getColumnImpl(int i)
PosixPath	getDataDirectory()
boolean	getFsync()
Server	getLinuxServer()
int	getMaxConnections()
Server.Name	getName()
Database	getPostgresDatabase(Database.Name name)
List<Database>	getPostgresDatabases()
UserServer	getPostgresServerUser(User.Name username)
List<UserServer>	getPostgresServerUsers()
List<User>	getPostgresUsers()
int	getSharedBuffers()
int	getSortMem()
Table.TableId	getTableId()
Version	getVersion()
int	getVersion_version_id()
void	init(ResultSet result)	Initializes this object from the raw database contents.
boolean	isPostgresDatabaseNameAvailable(Database.Name name)
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	restartPostgresql()
void	startPostgresql()
void	stopPostgresql()
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 Details

DEFAULT_PORT

public static final Port DEFAULT_PORT

The default PostSQL port.

DATA_BASE_DIR

public static final PosixPath DATA_BASE_DIR

The directory that contains the PostgreSQL data files.

Constructor Details

Server

@Deprecated(forRemoval=true)
public Server()

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

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

getAoServer_server_pkey

public int getAoServer_server_pkey()

getLinuxServer

public Server getLinuxServer()
                      throws SQLException,
IOException

Throws:

SQLException

IOException

getVersion_version_id

public int getVersion_version_id()

getVersion

public Version getVersion()
                   throws SQLException,
IOException

Throws:

SQLException

IOException

getMaxConnections

public int getMaxConnections()

getSortMem

public int getSortMem()

getSharedBuffers

public int getSharedBuffers()

getFsync

public boolean getFsync()

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

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,Server>

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

addPostgresDatabase

public int addPostgresDatabase(Database.Name name,
 UserServer datdba,
 Encoding encoding,
 boolean enablePostgis)
                        throws IOException,
SQLException

Throws:

IOException

SQLException

getDataDirectory

public PosixPath getDataDirectory()

getName

public Server.Name getName()

getPostgresDatabase

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

Throws:

IOException

SQLException

getPostgresDatabases

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

Throws:

IOException

SQLException

getPostgresServerUser

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

Throws:

IOException

SQLException

getPostgresServerUsers

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

Throws:

IOException

SQLException

getPostgresUsers

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

Throws:

SQLException

IOException

isPostgresDatabaseNameAvailable

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

Throws:

IOException

SQLException

restartPostgresql

public void restartPostgresql()
                       throws IOException,
SQLException

Throws:

IOException

SQLException

startPostgresql

public void startPostgresql()
                     throws IOException,
SQLException

Throws:

IOException

SQLException

stopPostgresql

public void stopPostgresql()
                    throws IOException,
SQLException

Throws:

IOException

SQLException