Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.account

Class Administrator

java.lang.Object

com.aoindustries.aoserv.client.AoservObject<User.Name,Administrator>

com.aoindustries.aoserv.client.CachedObject<User.Name,Administrator>

com.aoindustries.aoserv.client.account.CachedObjectUserNameKey<Administrator>

com.aoindustries.aoserv.client.account.Administrator

All Implemented Interfaces:

Streamable, StreamReadable, StreamWritable, Row, AoservReadable, AoservStreamable, AoservWritable, Disablable, PasswordProtected, Removable, SingleTableObject<User.Name,Administrator>, Comparable<Administrator>

public final class Administrator
extends CachedObjectUserNameKey<Administrator>
implements PasswordProtected, Removable, Disablable, Comparable<Administrator>

An Administrator is a username and password pair, usually representing an individual or an application, that has administrative control over all resources in an Account or any any of its child businesses.

Author:

AO Industries, Inc.

See Also:

• Account

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
Administrator()	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()
boolean	canSwitchUser(Administrator other)
boolean	canSwitchUsers()
static List<PasswordChecker.Result>	checkPassword(User.Name username, String password)	Validates a password and returns a description of the problem.
List<PasswordChecker.Result>	checkPassword(String password)
int	compareTo(Administrator o)	Sorts by username.
void	disable(DisableLog dl)	Validates a password and returns a description of the problem.
void	enable()
String	getAddress1()
String	getAddress2()
Date	getBirthday()
List<CannotRemoveReason<?>>	getCannotRemoveReasons()	Lists the reasons an object may not be removed.
String	getCellPhone()
String	getCity()
protected Object	getColumnImpl(int i)
CountryCode	getCountry()
UnmodifiableTimestamp	getCreated()
List<Ticket>	getCreatedTickets()
DisableLog	getDisableLog()
Email	getEmail()
String	getFax()
String	getHomePhone()
User	getMasterUser()
List<MonthlyCharge>	getMonthlyCharges()
String	getName()
HashedPassword	getPassword()	Gets the hashed password for this business_administrator.
List<AdministratorPermission>	getPermissions()
String	getState()
String	getSupportCode()
Table.TableId	getTableId()
List<Action>	getTicketActions()
List<Assignment>	getTicketAssignments()
String	getTitle()
List<Transaction>	getTransactions()	Deprecated. Please use TransactionTable.getTransactions(com.aoindustries.aoserv.client.account.Administrator) directly
User	getUsername()
User.Name	getUsername_userId()
String	getWorkPhone()
String	getZip()
boolean	hasPermission(Permission permission)	Checks if this business administrator has the provided permission.
boolean	hasPermission(Permission.Name permission)	Checks if this business administrator has the provided permission.
boolean	hasPermission(String permission)	Checks if this business administrator has the provided permission.
void	init(ResultSet result)	Initializes this object from the raw database contents.
boolean	isActiveAccounting()
boolean	isActiveBankAccounting()
boolean	isActiveDnsAdmin()
boolean	isActiveTableInvalidator()
boolean	isActiveWebAdmin()
boolean	isDisabled()	Checks if this object is disabled.
boolean	isPreferred()
boolean	isPrivate()
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	remove()	Removes this object, and all dependant objects, from the system.
void	setPassword(String plaintext)	Sets the password for this Administrator.
void	setProfile(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)
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

Administrator

@Deprecated(forRemoval=true)
public Administrator()

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

Specified by:

canDisable in interface Disablable

Throws:

SQLException

IOException

canSwitchUsers

public boolean canSwitchUsers()

getSupportCode

public String getSupportCode()

canSwitchUser

public boolean canSwitchUser(Administrator other)
                      throws SQLException,
IOException

Throws:

SQLException

IOException

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 password)
                                                  throws IOException

Validates a password and returns a description of the problem. If the password is valid, then null is returned.

Throws:

IOException

disable

public void disable(DisableLog dl)
             throws IOException,
SQLException

Validates a password and returns a description of the problem. If the password is valid, then null is returned.

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

getTicketActions

public List<Action> getTicketActions()
                              throws IOException,
SQLException

Throws:

IOException

SQLException

getTicketAssignments

public List<Assignment> getTicketAssignments()
                                      throws IOException,
SQLException

Throws:

IOException

SQLException

getAddress1

public String getAddress1()

getAddress2

public String getAddress2()

getBirthday

public Date getBirthday()

getCellPhone

public String getCellPhone()

getCity

public String getCity()

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<User.Name,Administrator>

getCountry

public CountryCode getCountry()
                       throws SQLException,
IOException

Throws:

SQLException

IOException

getCreated

public UnmodifiableTimestamp getCreated()

getCreatedTickets

public List<Ticket> getCreatedTickets()
                               throws IOException,
SQLException

Throws:

IOException

SQLException

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

getEmail

public Email getEmail()

getFax

public String getFax()

getHomePhone

public String getHomePhone()

getMasterUser

public User getMasterUser()
                   throws IOException,
SQLException

Throws:

IOException

SQLException

getMonthlyCharges

public List<MonthlyCharge> getMonthlyCharges()
                                      throws IOException,
SQLException

Throws:

IOException

SQLException

getName

public String getName()

getPassword

public HashedPassword getPassword()

Gets the hashed password for this business_administrator. This information is only available if all communication has been over secure connections. Otherwise, all passwords will be changed to NO_PASSWORD.

See Also:

• AoservConnector.isSecure()

getState

public String getState()

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<User.Name,Administrator>

getTitle

public String getTitle()

getTransactions

@Deprecated
public List<Transaction> getTransactions()
                                  throws IOException,
SQLException

Deprecated.

Please use TransactionTable.getTransactions(com.aoindustries.aoserv.client.account.Administrator) directly

Throws:

IOException

SQLException

getUsername_userId

public User.Name getUsername_userId()

getUsername

public User getUsername()
                 throws SQLException,
IOException

Throws:

SQLException

IOException

getWorkPhone

public String getWorkPhone()

getZip

public String getZip()

isActiveAccounting

public boolean isActiveAccounting()
                           throws IOException,
SQLException

Throws:

IOException

SQLException

isActiveBankAccounting

public boolean isActiveBankAccounting()
                               throws IOException,
SQLException

Throws:

IOException

SQLException

isActiveDnsAdmin

public boolean isActiveDnsAdmin()
                         throws IOException,
SQLException

Throws:

IOException

SQLException

isActiveTableInvalidator

public boolean isActiveTableInvalidator()
                                 throws IOException,
SQLException

Throws:

IOException

SQLException

isActiveWebAdmin

public boolean isActiveWebAdmin()
                         throws IOException,
SQLException

Throws:

IOException

SQLException

isPreferred

public boolean isPreferred()

isPrivate

public boolean isPrivate()

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

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

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

Sets the password for this Administrator. All connections must be over secure protocols for this method to work. If the connections are not secure, an IOException is thrown.

Specified by:

setPassword in interface PasswordProtected

Throws:

IOException

SQLException

setProfile

public void setProfile(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)
                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,Administrator>

Throws:

IOException

canSetPassword

public boolean canSetPassword()

Specified by:

canSetPassword in interface PasswordProtected

getPermissions

public List<AdministratorPermission> getPermissions()
                                             throws IOException,
SQLException

Throws:

IOException

SQLException

hasPermission

public boolean hasPermission(Permission permission)
                      throws IOException,
SQLException

Checks if this business administrator has the provided permission.

Throws:

IOException

SQLException

hasPermission

public boolean hasPermission(Permission.Name permission)
                      throws IOException,
SQLException

Checks if this business administrator has the provided permission.

Throws:

IOException

SQLException

hasPermission

public boolean hasPermission(String permission)
                      throws IOException,
SQLException

Checks if this business administrator has the provided permission.

Throws:

IOException

SQLException

compareTo

public int compareTo(Administrator o)

Sorts by username.

TODO: Consider handling comparisons at the AoservTable and making all AoservObject's comparable. We could then return things as sets where appropriate. Maybe have getMap, getList, getSet, and getSortedSet as appropriate?

Specified by:

compareTo in interface Comparable<Administrator>