Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.linux

Class UserType

java.lang.Object

com.aoindustries.aoserv.client.AoservObject<String,UserType>

com.aoindustries.aoserv.client.GlobalObject<String,UserType>

com.aoindustries.aoserv.client.GlobalObjectStringKey<UserType>

com.aoindustries.aoserv.client.linux.UserType

All Implemented Interfaces:

Streamable, StreamReadable, StreamWritable, Row, AoservReadable, AoservStreamable, AoservWritable

public final class UserType
extends GlobalObjectStringKey<UserType>

The LinuxAccountType of a LinuxAccount controls which systems the account may access. If the LinuxAccount is able to access multiple Servers, its type will be the same on all servers.

TODO: Make this class an enum? How would API version compatibility work? Same for group type.

Author:

AO Industries, Inc.

See Also:

• User
• UserServer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPLICATION	The different Linux account types.
static final String	BACKUP	The different Linux account types.
static final String	EMAIL	The different Linux account types.
static final String	FTPONLY	The different Linux account types.
static final String	MERCENARY	The different Linux account types.
static final String	SYSTEM	The different Linux account types.
static final String	USER	The different Linux account types.

Fields inherited from class com.aoindustries.aoserv.client.GlobalObjectStringKey

pkey

Fields inherited from class com.aoindustries.aoserv.client.AoservObject

USE_ARRAY_OF_DOMAIN, USE_SQL_DATA, USE_SQL_DATA_WRITE

Constructor Summary

Constructors

Constructor	Description
UserType()	Deprecated. Only required for implementation, do not use directly.

Method Summary

Modifier and Type	Method	Description
boolean	canPostgresIdent()
static boolean	canPostgresIdent(String type)
boolean	canSetPassword()
static boolean	canSetPassword(String type)
List<Shell>	getAllowedShells(AoservConnector connector)
protected Object	getColumnImpl(int i)
String	getDescription()
String	getName()
PasswordChecker.PasswordStrength	getPasswordStrength()
static PasswordChecker.PasswordStrength	getPasswordStrength(String type)
Table.TableId	getTableId()
void	init(ResultSet result)	Initializes this object from the raw database contents.
boolean	isAllowedShell(PosixPath path)
boolean	isAllowedShell(Shell shell)
static boolean	isAllowedShell(String type, PosixPath path)
boolean	isEmail()
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
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.GlobalObjectStringKey

equals, getKey, hashCode

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

BACKUP

public static final String BACKUP

The different Linux account types.

See Also:

• Constant Field Values

EMAIL

public static final String EMAIL

The different Linux account types.

See Also:

• Constant Field Values

FTPONLY

public static final String FTPONLY

The different Linux account types.

See Also:

• Constant Field Values

USER

public static final String USER

The different Linux account types.

See Also:

• Constant Field Values

MERCENARY

public static final String MERCENARY

The different Linux account types.

See Also:

• Constant Field Values

SYSTEM

public static final String SYSTEM

The different Linux account types.

See Also:

• Constant Field Values

APPLICATION

public static final String APPLICATION

The different Linux account types.

See Also:

• Constant Field Values

Constructor Details

UserType

@Deprecated
public UserType()

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

getPasswordStrength

public PasswordChecker.PasswordStrength getPasswordStrength()

getPasswordStrength

public static PasswordChecker.PasswordStrength getPasswordStrength(String type)

getAllowedShells

public List<Shell> getAllowedShells(AoservConnector connector)
                             throws SQLException,
IOException

Throws:

SQLException

IOException

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<String,UserType>

getDescription

public String getDescription()

getName

public String getName()

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<String,UserType>

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<String,UserType>

Parameters:

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

Throws:

SQLException

canPostgresIdent

public boolean canPostgresIdent()

canPostgresIdent

public static boolean canPostgresIdent(String type)

isAllowedShell

public boolean isAllowedShell(Shell shell)
                       throws SQLException

Throws:

SQLException

isAllowedShell

public boolean isAllowedShell(PosixPath path)
                       throws SQLException

Throws:

SQLException

isAllowedShell

public static boolean isAllowedShell(String type,
 PosixPath path)
                              throws SQLException

Throws:

SQLException

isEmail

public boolean isEmail()

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<String,UserType>

Throws:

IOException

toStringImpl

public String toStringImpl()

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 GlobalObjectStringKey<UserType>

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<String,UserType>

Throws:

IOException

canSetPassword

public static boolean canSetPassword(String type)

canSetPassword

public boolean canSetPassword()