Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.mysql

Class UserServer

java.lang.Object

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

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

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

com.aoindustries.aoserv.client.mysql.UserServer

All Implemented Interfaces:

Streamable, StreamReadable, StreamWritable, Row, AoservReadable, AoservStreamable, AoservWritable, Disablable, PasswordProtected, Removable, SingleTableObject<Integer,UserServer>

public final class UserServer
extends CachedObjectIntegerKey<UserServer>
implements Removable, PasswordProtected, Disablable

A MysqlServerUser grants a MysqlUser access to a Server. Once access is granted to the Server, access may then be granted to individual MysqlDatabases via MysqlDbUsers.

Author:

AO Industries, Inc.

See Also:

• User
• Database
• DatabaseUser
• Server

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANY_HOST	Convenience constants for the most commonly used host values.
static final String	ANY_LOCAL_HOST	Convenience constants for the most commonly used host values.
static final int	DEFAULT_MAX_CONNECTIONS
static final int	DEFAULT_MAX_QUESTIONS
static final int	DEFAULT_MAX_UPDATES
static final int	DEFAULT_MAX_USER_CONNECTIONS
static final int	MAX_HOST_LENGTH
static final int	UNLIMITED_CONNECTIONS
static final int	UNLIMITED_QUESTIONS
static final int	UNLIMITED_UPDATES
static final int	UNLIMITED_USER_CONNECTIONS

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

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

ALL, NONE, SOME

Constructor Summary

Constructors

Constructor	Description
UserServer()	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	arePasswordsSet()
boolean	canDisable()
boolean	canEnable()
boolean	canSetPassword()
List<PasswordChecker.Result>	checkPassword(String password)
void	disable(DisableLog dl)
void	enable()
List<CannotRemoveReason<UserServer>>	getCannotRemoveReasons()	Lists the reasons an object may not be removed.
protected Object	getColumnImpl(int i)
DisableLog	getDisableLog()
Integer	getDisableLog_id()
String	getHost()
int	getMaxConnections()
int	getMaxQuestions()
int	getMaxUpdates()
int	getMaxUserConnections()
List<DatabaseUser>	getMysqlDbUsers()
Server	getMysqlServer()
int	getMysqlServer_id()
User	getMysqlUser()
User.Name	getMysqlUser_username()
String	getPredisablePassword()
Table.TableId	getTableId()
void	init(ResultSet result)	Initializes this object from the raw database contents.
boolean	isDisabled()	Checks if this object is disabled.
boolean	isSpecial()
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	remove()	Removes this object, and all dependant objects, from the system.
void	setPassword(String password)
void	setPredisablePassword(String password)
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

UNLIMITED_QUESTIONS

public static final int UNLIMITED_QUESTIONS

See Also:

• Constant Field Values

DEFAULT_MAX_QUESTIONS

public static final int DEFAULT_MAX_QUESTIONS

See Also:

• Constant Field Values

UNLIMITED_UPDATES

public static final int UNLIMITED_UPDATES

See Also:

• Constant Field Values

DEFAULT_MAX_UPDATES

public static final int DEFAULT_MAX_UPDATES

See Also:

• Constant Field Values

UNLIMITED_CONNECTIONS

public static final int UNLIMITED_CONNECTIONS

See Also:

• Constant Field Values

DEFAULT_MAX_CONNECTIONS

public static final int DEFAULT_MAX_CONNECTIONS

See Also:

• Constant Field Values

UNLIMITED_USER_CONNECTIONS

public static final int UNLIMITED_USER_CONNECTIONS

See Also:

• Constant Field Values

DEFAULT_MAX_USER_CONNECTIONS

public static final int DEFAULT_MAX_USER_CONNECTIONS

See Also:

• Constant Field Values

MAX_HOST_LENGTH

public static final int MAX_HOST_LENGTH

See Also:

• Constant Field Values

ANY_HOST

public static final String ANY_HOST

Convenience constants for the most commonly used host values.

See Also:

• Constant Field Values

ANY_LOCAL_HOST

public static final String ANY_LOCAL_HOST

Convenience constants for the most commonly used host values.

Constructor Details

UserServer

@Deprecated(forRemoval=true)
public UserServer()

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

arePasswordsSet

public int arePasswordsSet()
                    throws IOException,
SQLException

Specified by:

arePasswordsSet in interface PasswordProtected

Throws:

IOException

SQLException

canDisable

public boolean canDisable()

Specified by:

canDisable in interface Disablable

canEnable

public boolean canEnable()
                  throws SQLException,
IOException

Specified by:

canEnable in interface Disablable

Throws:

SQLException

IOException

checkPassword

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

Specified by:

checkPassword in interface PasswordProtected

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

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

getHost

public String getHost()

getMysqlDbUsers

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

Throws:

IOException

SQLException

getMysqlUser_username

public User.Name getMysqlUser_username()

getMysqlUser

public User getMysqlUser()
                  throws SQLException,
IOException

Throws:

SQLException

IOException

isSpecial

public boolean isSpecial()

getPredisablePassword

public String getPredisablePassword()

getMaxQuestions

public int getMaxQuestions()

getMaxUpdates

public int getMaxUpdates()

getMaxConnections

public int getMaxConnections()

getMaxUserConnections

public int getMaxUserConnections()

getMysqlServer_id

public int getMysqlServer_id()

getMysqlServer

public Server getMysqlServer()
                      throws IOException,
SQLException

Throws:

IOException

SQLException

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,UserServer>

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

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

Throws:

IOException

getCannotRemoveReasons

public List<CannotRemoveReason<UserServer>> 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

setPredisablePassword

public void setPredisablePassword(String password)
                           throws IOException,
SQLException

Throws:

IOException

SQLException

toStringImpl

public String toStringImpl()
                    throws IOException,
SQLException

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

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

Throws:

IOException

canSetPassword

public boolean canSetPassword()
                       throws SQLException,
IOException

Specified by:

canSetPassword in interface PasswordProtected

Throws:

SQLException

IOException