Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.account

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

com.aoindustries.aoserv.client.account.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

Each Username is unique across all systems and must be allocated to a Package before use in any of the account types.

Author:

AO Industries, Inc.

See Also:

• Administrator
• User
• User
• User

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	User.Name	Represents the most general form of a user name.

Field Summary

Fields inherited from class com.aoindustries.aoserv.client.account.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
void	addAdministrator(String name, String title, Date birthday, boolean isPrivate, String workPhone, String homePhone, String cellPhone, String fax, Email email, String address1, String address2, String city, String state, String country, String zip, boolean enableEmailSupport)
void	addLinuxAccount(Group.Name primaryGroup, User.Gecos name, User.Gecos officeLocation, User.Gecos officePhone, User.Gecos homePhone, String type, PosixPath shell)
void	addLinuxAccount(Group primaryGroup, User.Gecos name, User.Gecos officeLocation, User.Gecos officePhone, User.Gecos homePhone, UserType typeObject, Shell shellObject)
void	addMysqlUser()
void	addPostgresUser()
int	arePasswordsSet()
boolean	canDisable()
boolean	canEnable()
boolean	canSetPassword()
List<PasswordChecker.Result>	checkPassword(String password)	Checks the strength of a password as used by this Username.
void	disable(DisableLog dl)
void	enable()
Administrator	getAdministrator()
List<CannotRemoveReason<?>>	getCannotRemoveReasons()	Lists the reasons an object may not be removed.
protected Object	getColumnImpl(int i)
DisableLog	getDisableLog()
User	getLinuxAccount()
User	getMysqlUser()
Package	getPackage()
Account.Name	getPackage_name()
User	getPostgresUser()
Table.TableId	getTableId()
User.Name	getUsername()
static int	groupPasswordsSet(List<? extends PasswordProtected> pps)
void	init(ResultSet result)	Initializes this object from the raw database contents.
boolean	isDisabled()	Checks if this object is disabled.
boolean	isUsed()
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.account.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

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

addAdministrator

public void addAdministrator(String name,
 String title,
 Date birthday,
 boolean isPrivate,
 String workPhone,
 String homePhone,
 String cellPhone,
 String fax,
 Email email,
 String address1,
 String address2,
 String city,
 String state,
 String country,
 String zip,
 boolean enableEmailSupport)
                      throws IOException,
SQLException

Throws:

IOException

SQLException

addLinuxAccount

public void addLinuxAccount(Group primaryGroup,
 User.Gecos name,
 User.Gecos officeLocation,
 User.Gecos officePhone,
 User.Gecos homePhone,
 UserType typeObject,
 Shell shellObject)
                     throws IOException,
SQLException

Throws:

IOException

SQLException

addLinuxAccount

public void addLinuxAccount(Group.Name primaryGroup,
 User.Gecos name,
 User.Gecos officeLocation,
 User.Gecos officePhone,
 User.Gecos homePhone,
 String type,
 PosixPath shell)
                     throws IOException,
SQLException

Throws:

IOException

SQLException

addMysqlUser

public void addMysqlUser()
                  throws IOException,
SQLException

Throws:

IOException

SQLException

addPostgresUser

public void addPostgresUser()
                     throws IOException,
SQLException

Throws:

IOException

SQLException

arePasswordsSet

public int arePasswordsSet()
                    throws IOException,
SQLException

Specified by:

arePasswordsSet in interface PasswordProtected

Throws:

IOException

SQLException

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

checkPassword

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

Checks the strength of a password as used by this Username.

Specified by:

checkPassword in interface PasswordProtected

Throws:

IOException

SQLException

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

getAdministrator

public Administrator getAdministrator()
                               throws IOException,
SQLException

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

public DisableLog getDisableLog()
                         throws SQLException,
IOException

Specified by:

getDisableLog in interface Disablable

Throws:

SQLException

IOException

getLinuxAccount

public User getLinuxAccount()
                     throws IOException,
SQLException

Throws:

IOException

SQLException

getMysqlUser

public User getMysqlUser()
                  throws IOException,
SQLException

Throws:

IOException

SQLException

getPackage_name

public Account.Name getPackage_name()

getPackage

public Package getPackage()
                   throws SQLException,
IOException

Throws:

SQLException

IOException

getPostgresUser

public User getPostgresUser()
                     throws IOException,
SQLException

Throws:

IOException

SQLException

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<User.Name,User>

getUsername

public User.Name getUsername()

groupPasswordsSet

public static int groupPasswordsSet(List<? extends PasswordProtected> pps)
                             throws IOException,
SQLException

Throws:

IOException

SQLException

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

isUsed

public boolean isUsed()
               throws IOException,
SQLException

Throws:

IOException

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<?>> 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 SQLException,
IOException

Specified by:

setPassword in interface PasswordProtected

Throws:

SQLException

IOException

canSetPassword

public boolean canSetPassword()
                       throws IOException,
SQLException

Specified by:

canSetPassword 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