Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.linux

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

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

One user may have shell, FTP, and/or email access to any number of servers. However, some of the information is common across all machines, and that set of information is contained in a LinuxAccount.

Author:

AO Industries, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	User.Gecos	Used for the various user-provided fields in the /etc/passwd file.
static class	User.Name	Represents a Linux username.

Field Summary

Fields

Modifier and Type	Field	Description
static final User.Name	ACCOUNTING	Some commonly used system and application account usernames.
static final User.Name	ADM	Some commonly used system and application account usernames.
static final User.Name	AOADMIN	Some commonly used system and application account usernames.
static final User.Name	AOSERV_JILTER	Some commonly used system and application account usernames.
static final User.Name	AOSERV_MASTER	Some commonly used system and application account usernames.
static final User.Name	AOSERV_XEN_MIGRATION	Some commonly used system and application account usernames.
static final User.Name	APACHE	Some commonly used system and application account usernames.
static final User.Name	AVAHI_AUTOIPD	Some commonly used system and application account usernames.
static final User.Name	AWSTATS	Some commonly used system and application account usernames.
static final User.Name	BILLING	Some commonly used system and application account usernames.
static final User.Name	BIN	Some commonly used system and application account usernames.
static final User.Name	BIRD	Some commonly used system and application account usernames.
static final User.Name	CENTOS	Some commonly used system and application account usernames.
static final User.Name	CHRONY	Some commonly used system and application account usernames.
static final User.Name	CLAMSCAN	Some commonly used system and application account usernames.
static final User.Name	CLAMUPDATE	Some commonly used system and application account usernames.
static final User.Name	CYRUS	Some commonly used system and application account usernames.
static final User.Name	DAEMON	Some commonly used system and application account usernames.
static final User.Name	DBUS	Some commonly used system and application account usernames.
static final User.Name	DHCPD	Some commonly used system and application account usernames.
static final User.Name	DISTRIBUTION	Some commonly used system and application account usernames.
static final User.Name	EMAILMON	Some commonly used system and application account usernames.
static final User.Name	FLATPAK	Some commonly used system and application account usernames.
static final User.Name	FTP	Some commonly used system and application account usernames.
static final User.Name	FTPMON	Some commonly used system and application account usernames.
static final User.Name	GAMES	Some commonly used system and application account usernames.
static final User.Name	GEOCLUE	Some commonly used system and application account usernames.
static final User.Name	HALT	Some commonly used system and application account usernames.
static final User.Name	HTTPD	Deprecated. User httpd no longer used.
static final User.Name	INFRASTRUCTURE	Some commonly used system and application account usernames.
static final User.Name	INTERBASE	Some commonly used system and application account usernames.
static final User.Name	JENKINS	Some commonly used system and application account usernames.
static final User.Name	LP	Some commonly used system and application account usernames.
static final User.Name	MAIL	Some commonly used system and application account usernames.
static final User.Name	MAILNULL	Some commonly used system and application account usernames.
static final User.Name	MANAGEMENT	Some commonly used system and application account usernames.
static final User.Name	MEMCACHED	Some commonly used system and application account usernames.
static final User.Name	MONITORING	Some commonly used system and application account usernames.
static final User.Name	MYSQL	Some commonly used system and application account usernames.
static final User.Name	NAMED	Some commonly used system and application account usernames.
static final User.Name	NFSNOBODY	Some commonly used system and application account usernames.
static final User.Name	NGINX	Some commonly used system and application account usernames.
static final String	NO_PASSWORD_CONFIG_VALUE
static final User.Name	NOBODY	Some commonly used system and application account usernames.
static final User.Name	OPERATOR	Some commonly used system and application account usernames.
static final User.Name	OPROFILE	Some commonly used system and application account usernames.
static final User.Name	PIPEWIRE	Some commonly used system and application account usernames.
static final User.Name	POLKITD	Some commonly used system and application account usernames.
static final User.Name	POSTGRES	Some commonly used system and application account usernames.
static final User.Name	REDIS	Some commonly used system and application account usernames.
static final User.Name	RESELLER	Some commonly used system and application account usernames.
static final User.Name	ROOT	Some commonly used system and application account usernames.
static final User.Name	RPC	Some commonly used system and application account usernames.
static final User.Name	RPCUSER	Some commonly used system and application account usernames.
static final User.Name	RTKIT	Some commonly used system and application account usernames.
static final User.Name	SASLAUTH	Some commonly used system and application account usernames.
static final User.Name	SHUTDOWN	Some commonly used system and application account usernames.
static final User.Name	SMMSP	Some commonly used system and application account usernames.
static final User.Name	SONARQUBE	Some commonly used system and application account usernames.
static final User.Name	SSHD	Some commonly used system and application account usernames.
static final User.Name	SSSD	Some commonly used system and application account usernames.
static final User.Name	SYNC	Some commonly used system and application account usernames.
static final User.Name	SYSTEMD_BUS_PROXY	Some commonly used system and application account usernames.
static final User.Name	SYSTEMD_COREDUMP	Some commonly used system and application account usernames.
static final User.Name	SYSTEMD_NETWORK	Some commonly used system and application account usernames.
static final User.Name	SYSTEMD_OOM	Some commonly used system and application account usernames.
static final User.Name	TCPDUMP	Some commonly used system and application account usernames.
static final User.Name	TSS	Some commonly used system and application account usernames.
static final User.Name	UNBOUND	Some commonly used system and application account usernames.

Fields inherited from class com.aoindustries.aoserv.client.linux.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. Only required for implementation, do not use directly.

Method Summary

Modifier and Type	Method	Description
void	addFtpGuestUser()
void	addLinuxGroup(Group group)
int	addLinuxServerAccount(Server aoServer, PosixPath home)
int	arePasswordsSet()
boolean	canDisable()
boolean	canEnable()
boolean	canSetPassword()
static List<PasswordChecker.Result>	checkPassword(User.Name username, String type, String password)	Checks the strength of a password as required for this LinuxAccount.
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)
UnmodifiableTimestamp	getCreated()
DisableLog	getDisableLog()
GuestUser	getFtpGuestUser()
User.Gecos	getHomePhone()
List<Group>	getLinuxGroups()
UserServer	getLinuxServerAccount(Server aoServer)
List<UserServer>	getLinuxServerAccounts()
User.Gecos	getName()
User.Gecos	getOfficeLocation()
User.Gecos	getOfficePhone()
Group	getPrimaryGroup()
Shell	getShell()
Table.TableId	getTableId()
UserType	getType()
User	getUsername()
User.Name	getUsername_id()
List<PosixPath>	getValidHomeDirectories(Server ao)
static List<PosixPath>	getValidHomeDirectories(User.Name username, Server ao)
void	init(ResultSet result)	Initializes this object from the raw database contents.
boolean	isDisabled()	Checks if this object is disabled.
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	remove()	Removes this object, and all dependant objects, from the system.
void	removeLinuxGroup(Group group)
void	setHomePhone(User.Gecos phone)
void	setName(User.Gecos name)
void	setOfficeLocation(User.Gecos location)
void	setOfficePhone(User.Gecos phone)
void	setPassword(String password)
void	setPrimaryLinuxGroup(Group group)
void	setShell(Shell shell)
void	write(StreamableOutput out, AoservProtocol.Version protocolVersion)

Methods inherited from class com.aoindustries.aoserv.client.linux.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

ADM

public static final User.Name ADM

Some commonly used system and application account usernames.

AOADMIN

public static final User.Name AOADMIN

Some commonly used system and application account usernames.

AOSERV_JILTER

public static final User.Name AOSERV_JILTER

Some commonly used system and application account usernames.

AOSERV_XEN_MIGRATION

public static final User.Name AOSERV_XEN_MIGRATION

Some commonly used system and application account usernames.

APACHE

public static final User.Name APACHE

Some commonly used system and application account usernames.

AVAHI_AUTOIPD

public static final User.Name AVAHI_AUTOIPD

Some commonly used system and application account usernames.

AWSTATS

public static final User.Name AWSTATS

Some commonly used system and application account usernames.

BIN

public static final User.Name BIN

Some commonly used system and application account usernames.

BIRD

public static final User.Name BIRD

Some commonly used system and application account usernames.

CHRONY

public static final User.Name CHRONY

Some commonly used system and application account usernames.

CLAMSCAN

public static final User.Name CLAMSCAN

Some commonly used system and application account usernames.

CLAMUPDATE

public static final User.Name CLAMUPDATE

Some commonly used system and application account usernames.

CYRUS

public static final User.Name CYRUS

Some commonly used system and application account usernames.

DAEMON

public static final User.Name DAEMON

Some commonly used system and application account usernames.

DBUS

public static final User.Name DBUS

Some commonly used system and application account usernames.

DHCPD

public static final User.Name DHCPD

Some commonly used system and application account usernames.

EMAILMON

public static final User.Name EMAILMON

Some commonly used system and application account usernames.

FTP

public static final User.Name FTP

Some commonly used system and application account usernames.

FTPMON

public static final User.Name FTPMON

Some commonly used system and application account usernames.

GAMES

public static final User.Name GAMES

Some commonly used system and application account usernames.

HALT

public static final User.Name HALT

Some commonly used system and application account usernames.

INTERBASE

public static final User.Name INTERBASE

Some commonly used system and application account usernames.

LP

public static final User.Name LP

Some commonly used system and application account usernames.

MAIL

public static final User.Name MAIL

Some commonly used system and application account usernames.

MAILNULL

public static final User.Name MAILNULL

Some commonly used system and application account usernames.

MEMCACHED

public static final User.Name MEMCACHED

Some commonly used system and application account usernames.

MYSQL

public static final User.Name MYSQL

Some commonly used system and application account usernames.

NAMED

public static final User.Name NAMED

Some commonly used system and application account usernames.

NFSNOBODY

public static final User.Name NFSNOBODY

Some commonly used system and application account usernames.

NGINX

public static final User.Name NGINX

Some commonly used system and application account usernames.

NOBODY

public static final User.Name NOBODY

Some commonly used system and application account usernames.

OPERATOR

public static final User.Name OPERATOR

Some commonly used system and application account usernames.

POLKITD

public static final User.Name POLKITD

Some commonly used system and application account usernames.

POSTGRES

public static final User.Name POSTGRES

Some commonly used system and application account usernames.

REDIS

public static final User.Name REDIS

Some commonly used system and application account usernames.

ROOT

public static final User.Name ROOT

Some commonly used system and application account usernames.

RPC

public static final User.Name RPC

Some commonly used system and application account usernames.

RPCUSER

public static final User.Name RPCUSER

Some commonly used system and application account usernames.

SASLAUTH

public static final User.Name SASLAUTH

Some commonly used system and application account usernames.

SHUTDOWN

public static final User.Name SHUTDOWN

Some commonly used system and application account usernames.

SMMSP

public static final User.Name SMMSP

Some commonly used system and application account usernames.

SSHD

public static final User.Name SSHD

Some commonly used system and application account usernames.

SYNC

public static final User.Name SYNC

Some commonly used system and application account usernames.

SYSTEMD_BUS_PROXY

public static final User.Name SYSTEMD_BUS_PROXY

Some commonly used system and application account usernames.

SYSTEMD_NETWORK

public static final User.Name SYSTEMD_NETWORK

Some commonly used system and application account usernames.

TCPDUMP

public static final User.Name TCPDUMP

Some commonly used system and application account usernames.

TSS

public static final User.Name TSS

Some commonly used system and application account usernames.

UNBOUND

public static final User.Name UNBOUND

Some commonly used system and application account usernames.

AOSERV_MASTER

public static final User.Name AOSERV_MASTER

Some commonly used system and application account usernames.

ACCOUNTING

public static final User.Name ACCOUNTING

Some commonly used system and application account usernames.

BILLING

public static final User.Name BILLING

Some commonly used system and application account usernames.

DISTRIBUTION

public static final User.Name DISTRIBUTION

Some commonly used system and application account usernames.

INFRASTRUCTURE

public static final User.Name INFRASTRUCTURE

Some commonly used system and application account usernames.

MANAGEMENT

public static final User.Name MANAGEMENT

Some commonly used system and application account usernames.

MONITORING

public static final User.Name MONITORING

Some commonly used system and application account usernames.

RESELLER

public static final User.Name RESELLER

Some commonly used system and application account usernames.

CENTOS

public static final User.Name CENTOS

Some commonly used system and application account usernames.

JENKINS

public static final User.Name JENKINS

Some commonly used system and application account usernames.

OPROFILE

public static final User.Name OPROFILE

Some commonly used system and application account usernames.

SONARQUBE

public static final User.Name SONARQUBE

Some commonly used system and application account usernames.

FLATPAK

public static final User.Name FLATPAK

Some commonly used system and application account usernames.

GEOCLUE

public static final User.Name GEOCLUE

Some commonly used system and application account usernames.

PIPEWIRE

public static final User.Name PIPEWIRE

Some commonly used system and application account usernames.

RTKIT

public static final User.Name RTKIT

Some commonly used system and application account usernames.

SSSD

public static final User.Name SSSD

Some commonly used system and application account usernames.

SYSTEMD_COREDUMP

public static final User.Name SYSTEMD_COREDUMP

Some commonly used system and application account usernames.

SYSTEMD_OOM

public static final User.Name SYSTEMD_OOM

Some commonly used system and application account usernames.

HTTPD

@Deprecated
public static final User.Name HTTPD

Deprecated.

User httpd no longer used.

NO_PASSWORD_CONFIG_VALUE

public static final String NO_PASSWORD_CONFIG_VALUE

See Also:

• Constant Field Values

Constructor Details

User

@Deprecated
public User()

Deprecated.

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

addFtpGuestUser

public void addFtpGuestUser()
                     throws IOException,
SQLException

Throws:

IOException

SQLException

addLinuxGroup

public void addLinuxGroup(Group group)
                   throws IOException,
SQLException

Throws:

IOException

SQLException

addLinuxServerAccount

public int addLinuxServerAccount(Server aoServer,
 PosixPath home)
                          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

Specified by:

checkPassword in interface PasswordProtected

Throws:

IOException

checkPassword

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

Checks the strength of a password as required for this LinuxAccount. The strength requirement depends on the LinuxAccountType.

Throws:

IOException

See Also:

• UserType.getPasswordStrength(java.lang.String)
• PasswordChecker.checkPassword(com.aoindustries.aoserv.client.account.User.Name, java.lang.String, com.aoindustries.aoserv.client.password.PasswordChecker.PasswordStrength)

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>

getCreated

public UnmodifiableTimestamp getCreated()

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

getFtpGuestUser

public GuestUser getFtpGuestUser()
                          throws IOException,
SQLException

Throws:

IOException

SQLException

getHomePhone

public User.Gecos getHomePhone()

getLinuxGroups

public List<Group> getLinuxGroups()
                           throws IOException,
SQLException

Throws:

IOException

SQLException

getLinuxServerAccount

public UserServer getLinuxServerAccount(Server aoServer)
                                 throws IOException,
SQLException

Throws:

IOException

SQLException

getLinuxServerAccounts

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

Throws:

IOException

SQLException

getName

public User.Gecos getName()

getOfficeLocation

public User.Gecos getOfficeLocation()

getOfficePhone

public User.Gecos getOfficePhone()

getPrimaryGroup

public Group getPrimaryGroup()
                      throws IOException,
SQLException

Throws:

IOException

SQLException

getShell

public Shell getShell()
               throws SQLException,
IOException

Throws:

SQLException

IOException

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<User.Name,User>

getType

public UserType getType()
                 throws IOException,
SQLException

Throws:

IOException

SQLException

getUsername_id

public User.Name getUsername_id()

getUsername

public User getUsername()
                 throws SQLException,
IOException

Throws:

SQLException

IOException

getValidHomeDirectories

public List<PosixPath> getValidHomeDirectories(Server ao)
                                        throws SQLException,
IOException

Throws:

SQLException

IOException

getValidHomeDirectories

public static List<PosixPath> getValidHomeDirectories(User.Name username,
 Server ao)
                                               throws SQLException,
IOException

Throws:

SQLException

IOException

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

removeLinuxGroup

public void removeLinuxGroup(Group group)
                      throws IOException,
SQLException

Throws:

IOException

SQLException

setHomePhone

public void setHomePhone(User.Gecos phone)
                  throws IOException,
SQLException

Throws:

IOException

SQLException

setName

public void setName(User.Gecos name)
             throws IOException,
SQLException

Throws:

IOException

SQLException

setOfficeLocation

public void setOfficeLocation(User.Gecos location)
                       throws IOException,
SQLException

Throws:

IOException

SQLException

setOfficePhone

public void setOfficePhone(User.Gecos phone)
                    throws IOException,
SQLException

Throws:

IOException

SQLException

setPassword

public void setPassword(String password)
                 throws SQLException,
IOException

Specified by:

setPassword in interface PasswordProtected

Throws:

SQLException

IOException

setShell

public void setShell(Shell shell)
              throws IOException,
SQLException

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()
                       throws IOException,
SQLException

Specified by:

canSetPassword in interface PasswordProtected

Throws:

IOException

SQLException

setPrimaryLinuxGroup

public void setPrimaryLinuxGroup(Group group)
                          throws SQLException,
IOException

Throws:

SQLException

IOException