Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.postgresql

Class User

java.lang.Object

com.aoindustries.aoserv.client.AoservObject<User.Name,User>

com.aoindustries.aoserv.client.CachedObject<User.Name,User>

com.aoindustries.aoserv.client.postgresql.CachedObjectUserNameKey<User>

com.aoindustries.aoserv.client.postgresql.User

All Implemented Interfaces:

Streamable, StreamReadable, StreamWritable, Row, AoservReadable, AoservStreamable, AoservWritable, Disablable, PasswordProtected, Removable, SingleTableObject<User.Name,User>

public final class User
extends CachedObjectUserNameKey<User>
implements Removable, PasswordProtected, Disablable

A PostgresUser may have access to multiple servers. The information common to all servers is contained in PostgresUser.

Author:

AO Industries, Inc.

See Also:

• UserServer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	User.Name	Represents a PostgreSQL user ID.

Field Summary

Fields

Modifier and Type	Field	Description
static final User.Name	AOADMIN	The username of the PostgreSQL special users.
static final User.Name	AOSERV_APP	The username of the PostgreSQL special users.
static final User.Name	AOWEB_APP	The username of the PostgreSQL special users.
static final int	MAX_USERNAME_LENGTH	Deprecated. Please use User.Name.MAX_LENGTH instead.
static final String	NO_PASSWORD	A password may be set to null, which means that the account will be disabled.
static final String	NO_PASSWORD_DB_VALUE
static final User.Name	PG_CHECKPOINT	The username of the PostgreSQL special users.
static final User.Name	PG_DATABASE_OWNER	The username of the PostgreSQL special users.
static final User.Name	PG_EXECUTE_SERVER_PROGRAM	The username of the PostgreSQL special users.
static final User.Name	PG_MONITOR	The username of the PostgreSQL special users.
static final User.Name	PG_READ_ALL_DATA	The username of the PostgreSQL special users.
static final User.Name	PG_READ_ALL_SETTINGS	The username of the PostgreSQL special users.
static final User.Name	PG_READ_ALL_STATS	The username of the PostgreSQL special users.
static final User.Name	PG_READ_SERVER_FILES	The username of the PostgreSQL special users.
static final User.Name	PG_SIGNAL_BACKEND	The username of the PostgreSQL special users.
static final User.Name	PG_STAT_SCAN_TABLES	The username of the PostgreSQL special users.
static final User.Name	PG_WRITE_ALL_DATA	The username of the PostgreSQL special users.
static final User.Name	PG_WRITE_SERVER_FILES	The username of the PostgreSQL special users.
static final User.Name	POSTGRES	The username of the PostgreSQL special users.
static final User.Name	POSTGRESMON	The username of the PostgreSQL special users.

Fields inherited from class com.aoindustries.aoserv.client.postgresql.CachedObjectUserNameKey

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

Fields inherited from interface com.aoindustries.aoserv.client.password.PasswordProtected

ALL, NONE, SOME

Constructor Summary

Constructors

Constructor	Description
User()	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	addPostgresServerUser(Server postgresServer)
int	arePasswordsSet()
boolean	canCatupd()
boolean	canCreatedb()
boolean	canDisable()
boolean	canEnable()
boolean	canSetPassword()
boolean	canTrace()
static List<PasswordChecker.Result>	checkPassword(User.Name username, String password)
List<PasswordChecker.Result>	checkPassword(String password)
void	disable(DisableLog dl)
void	enable()
List<CannotRemoveReason<?>>	getCannotRemoveReasons()	Lists the reasons an object may not be removed.
protected Object	getColumnImpl(int i)
DisableLog	getDisableLog()
Integer	getDisableLog_id()
UserServer	getPostgresServerUser(Server server)
List<UserServer>	getPostgresServerUsers()
Table.TableId	getTableId()
User	getUsername()
User.Name	getUsername_username_id()
void	init(ResultSet result)	Initializes this object from the raw database contents.
boolean	isDatabaseAdmin()
boolean	isDisabled()	Checks if this object is disabled.
boolean	isSpecial()
static boolean	isSpecial(User.Name username)	Special PostgreSQL users may not be added or removed.
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	remove()	Removes this object, and all dependant objects, from the system.
void	setPassword(String password)
void	write(StreamableOutput out, AoservProtocol.Version protocolVersion)

Methods inherited from class com.aoindustries.aoserv.client.postgresql.CachedObjectUserNameKey

equals, getKey, hashCode, toStringImpl

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

MAX_USERNAME_LENGTH

@Deprecated
public static final int MAX_USERNAME_LENGTH

Deprecated.

Please use User.Name.MAX_LENGTH instead.

The maximum length of a PostgreSQL username.

See Also:

• Constant Field Values

POSTGRES

public static final User.Name POSTGRES

The username of the PostgreSQL special users.

PG_MONITOR

public static final User.Name PG_MONITOR

The username of the PostgreSQL special users.

PG_READ_ALL_SETTINGS

public static final User.Name PG_READ_ALL_SETTINGS

The username of the PostgreSQL special users.

PG_READ_ALL_STATS

public static final User.Name PG_READ_ALL_STATS

The username of the PostgreSQL special users.

PG_SIGNAL_BACKEND

public static final User.Name PG_SIGNAL_BACKEND

The username of the PostgreSQL special users.

PG_STAT_SCAN_TABLES

public static final User.Name PG_STAT_SCAN_TABLES

The username of the PostgreSQL special users.

PG_EXECUTE_SERVER_PROGRAM

public static final User.Name PG_EXECUTE_SERVER_PROGRAM

The username of the PostgreSQL special users.

PG_READ_SERVER_FILES

public static final User.Name PG_READ_SERVER_FILES

The username of the PostgreSQL special users.

PG_WRITE_SERVER_FILES

public static final User.Name PG_WRITE_SERVER_FILES

The username of the PostgreSQL special users.

PG_READ_ALL_DATA

public static final User.Name PG_READ_ALL_DATA

The username of the PostgreSQL special users.

PG_WRITE_ALL_DATA

public static final User.Name PG_WRITE_ALL_DATA

The username of the PostgreSQL special users.

PG_DATABASE_OWNER

public static final User.Name PG_DATABASE_OWNER

The username of the PostgreSQL special users.

PG_CHECKPOINT

public static final User.Name PG_CHECKPOINT

The username of the PostgreSQL special users.

POSTGRESMON

public static final User.Name POSTGRESMON

The username of the PostgreSQL special users.

AOADMIN

public static final User.Name AOADMIN

The username of the PostgreSQL special users.

AOSERV_APP

public static final User.Name AOSERV_APP

The username of the PostgreSQL special users.

AOWEB_APP

public static final User.Name AOWEB_APP

The username of the PostgreSQL special users.

NO_PASSWORD

public static final String NO_PASSWORD

A password may be set to null, which means that the account will be disabled.

NO_PASSWORD_DB_VALUE

public static final String NO_PASSWORD_DB_VALUE

See Also:

• Constant Field Values

Constructor Details

User

@Deprecated(forRemoval=true)
public User()

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

isSpecial

public static boolean isSpecial(User.Name username)

Special PostgreSQL users may not be added or removed.

addPostgresServerUser

public int addPostgresServerUser(Server postgresServer)
                          throws IOException,
SQLException

Throws:

IOException

SQLException

arePasswordsSet

public int arePasswordsSet()
                    throws IOException,
SQLException

Specified by:

arePasswordsSet in interface PasswordProtected

Throws:

IOException

SQLException

canCatupd

public boolean canCatupd()

canCreatedb

public boolean canCreatedb()

canDisable

public boolean canDisable()
                   throws IOException,
SQLException

Specified by:

canDisable in interface Disablable

Throws:

IOException

SQLException

canEnable

public boolean canEnable()
                  throws SQLException,
IOException

Specified by:

canEnable in interface Disablable

Throws:

SQLException

IOException

canTrace

public boolean canTrace()

checkPassword

public List<PasswordChecker.Result> checkPassword(String password)
                                           throws IOException

Specified by:

checkPassword in interface PasswordProtected

Throws:

IOException

checkPassword

public static List<PasswordChecker.Result> checkPassword(User.Name username,
 String password)
                                                  throws IOException

Throws:

IOException

disable

public void disable(DisableLog dl)
             throws IOException,
SQLException

Specified by:

disable in interface Disablable

Throws:

IOException

SQLException

enable

public void enable()
            throws IOException,
SQLException

Specified by:

enable in interface Disablable

Throws:

IOException

SQLException

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<User.Name,User>

isDisabled

public boolean isDisabled()

Description copied from interface: Disablable

Checks if this object is disabled. This should execute very quickly (not incur any round-trip to any database) and thus does not throw any checked exceptions.

Specified by:

isDisabled in interface Disablable

getDisableLog_id

public Integer getDisableLog_id()

getDisableLog

public DisableLog getDisableLog()
                         throws SQLException,
IOException

Specified by:

getDisableLog in interface Disablable

Throws:

SQLException

IOException

getPostgresServerUser

public UserServer getPostgresServerUser(Server server)
                                 throws IOException,
SQLException

Throws:

IOException

SQLException

getPostgresServerUsers

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

Throws:

IOException

SQLException

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<User.Name,User>

getUsername_username_id

public User.Name getUsername_username_id()

getUsername

public User getUsername()
                 throws SQLException,
IOException

Throws:

SQLException

IOException

isSpecial

public boolean isSpecial()

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<User.Name,User>

Parameters:

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

Throws:

SQLException

isDatabaseAdmin

public boolean isDatabaseAdmin()

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<User.Name,User>

Throws:

IOException

getCannotRemoveReasons

public List<CannotRemoveReason<?>> getCannotRemoveReasons()
                                                   throws SQLException,
IOException

Description copied from interface: Removable

Lists the reasons an object may not be removed.

Specified by:

getCannotRemoveReasons in interface Removable

Returns:

an empty List<CannotRemoveReason> if this object may be removed, or a list of descriptions

Throws:

SQLException

IOException

remove

public void remove()
            throws IOException,
SQLException

Description copied from interface: Removable

Removes this object, and all dependant objects, from the system.

Specified by:

remove in interface Removable

Throws:

IOException

SQLException

setPassword

public void setPassword(String password)
                 throws IOException,
SQLException

Specified by:

setPassword in interface PasswordProtected

Throws:

IOException

SQLException

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<User.Name,User>

Throws:

IOException

canSetPassword

public boolean canSetPassword()

Specified by:

canSetPassword in interface PasswordProtected