Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.mysql

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.mysql.CachedObjectUserNameKey<User>

com.aoindustries.aoserv.client.mysql.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 PasswordProtected, Removable, Disablable

A MysqlUser stores the details of a MySQL account that are common to all servers.

Author:

AO Industries, Inc.

See Also:

• UserServer
• DatabaseUser

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_USERNAME_LENGTH	Deprecated. Please use User.Name.MAX_LENGTH instead.
static final User.Name	MYSQL_SESSION	The username of the MySQL mysql.session user added in MySQL 5.7.
static final User.Name	MYSQL_SYS	The username of the MySQL mysql.sys user added in MySQL 5.7.
static final User.Name	MYSQLMON	The default username for MySQL monitoring.
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	ROOT	The username of the MySQL super user.

Fields inherited from class com.aoindustries.aoserv.client.mysql.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	addMysqlServerUser(Server mysqlServer, String host)
int	arePasswordsSet()
boolean	canAlter()
boolean	canAlterRoutine()
boolean	canCreate()
boolean	canCreateRoutine()
boolean	canCreateTempTable()
boolean	canCreateUser()
boolean	canCreateView()
boolean	canDelete()
boolean	canDisable()
boolean	canDrop()
boolean	canEnable()
boolean	canEvent()
boolean	canExecute()
boolean	canFile()
boolean	canGrant()
boolean	canIndex()
boolean	canInsert()
boolean	canLockTables()
boolean	canProcess()
boolean	canReference()
boolean	canReload()
boolean	canSelect()
boolean	canSetPassword()
boolean	canShowDb()
boolean	canShowView()
boolean	canShutdown()
boolean	canTrigger()
boolean	canUpdate()
static List<PasswordChecker.Result>	checkPassword(User.Name username, String password)
List<PasswordChecker.Result>	checkPassword(String password)
void	disable(DisableLog dl)
void	enable()
List<CannotRemoveReason<User>>	getCannotRemoveReasons()	Lists the reasons an object may not be removed.
protected Object	getColumnImpl(int i)
DisableLog	getDisableLog()
Integer	getDisableLog_id()
UserServer	getMysqlServerUser(Server mysqlServer)
List<UserServer>	getMysqlServerUsers()
Table.TableId	getTableId()
User	getUsername()
User.Name	getUsername_id()
void	init(ResultSet result)	Initializes this object from the raw database contents.
boolean	isDisabled()	Checks if this object is disabled.
boolean	isReplicationClient()
boolean	isReplicationSlave()
boolean	isSpecial()
static boolean	isSpecial(User.Name username)	Special MySQL users may not be added or removed.
boolean	isSuper()
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.mysql.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 MySQL username.

See Also:

• Constant Field Values

ROOT

public static final User.Name ROOT

The username of the MySQL super user.

MYSQL_SESSION

public static final User.Name MYSQL_SESSION

The username of the MySQL mysql.session user added in MySQL 5.7.

MYSQL_SYS

public static final User.Name MYSQL_SYS

The username of the MySQL mysql.sys user added in MySQL 5.7.

MYSQLMON

public static final User.Name MYSQLMON

The default username for MySQL monitoring.

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 MySQL users may not be added or removed.

addMysqlServerUser

public int addMysqlServerUser(Server mysqlServer,
 String host)
                       throws IOException,
SQLException

Throws:

IOException

SQLException

arePasswordsSet

public int arePasswordsSet()
                    throws IOException,
SQLException

Specified by:

arePasswordsSet in interface PasswordProtected

Throws:

IOException

SQLException

canAlter

public boolean canAlter()

canShowDb

public boolean canShowDb()

isSuper

public boolean isSuper()

canCreateTempTable

public boolean canCreateTempTable()

canLockTables

public boolean canLockTables()

canExecute

public boolean canExecute()

isReplicationSlave

public boolean isReplicationSlave()

isReplicationClient

public boolean isReplicationClient()

canCreateView

public boolean canCreateView()

canShowView

public boolean canShowView()

canCreateRoutine

public boolean canCreateRoutine()

canAlterRoutine

public boolean canAlterRoutine()

canCreateUser

public boolean canCreateUser()

canEvent

public boolean canEvent()

canTrigger

public boolean canTrigger()

canCreate

public boolean canCreate()

canDelete

public boolean canDelete()

canDisable

public boolean canDisable()
                   throws IOException,
SQLException

Specified by:

canDisable in interface Disablable

Throws:

IOException

SQLException

canDrop

public boolean canDrop()

canEnable

public boolean canEnable()
                  throws SQLException,
IOException

Specified by:

canEnable in interface Disablable

Throws:

SQLException

IOException

canFile

public boolean canFile()

canGrant

public boolean canGrant()

canIndex

public boolean canIndex()

canInsert

public boolean canInsert()

canProcess

public boolean canProcess()

canReference

public boolean canReference()

canReload

public boolean canReload()

canSelect

public boolean canSelect()

canShutdown

public boolean canShutdown()

canUpdate

public boolean canUpdate()

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

getMysqlServerUser

public UserServer getMysqlServerUser(Server mysqlServer)
                              throws IOException,
SQLException

Throws:

IOException

SQLException

getMysqlServerUsers

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

Throws:

IOException

SQLException

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<User.Name,User>

getUsername_id

public User.Name getUsername_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

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<User>> getCannotRemoveReasons()

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

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