Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client

Class SimpleAoservClient

java.lang.Object

com.aoindustries.aoserv.client.SimpleAoservClient

public final class SimpleAoservClient
extends Object

SimpleAoservClient is a simplified interface into the client code. Not all information is available, but less knowledge is required to accomplish some common tasks. All methods are invoked using standard data types. The underlying implementation changes over time, but this access point does not change as frequently.

Most of the Aosh commands resolve to these method calls.

Author:

AO Industries, Inc.

See Also:

• Aosh
• AoservConnector

Constructor Summary

Constructors

Constructor	Description
SimpleAoservClient(AoservConnector connector)	Creates a new SimpleAoservClient using the provided AoservConnector.

Method Summary

Modifier and Type	Method	Description
void	addAccount(Account.Name accounting, String contractVersion, String defaultServer, Account.Name parent, boolean canAddBackupServers, boolean canAddBusinesses, boolean canSeePrices, boolean billParent)	Adds a new Account to the system.
int	addAccountHost(Account.Name accounting, String host)	Grants an Account access to a Host.
void	addAdministrator(User.Name username, 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)	Adds a new Administrator to an Account.
int	addBackupHost(String hostname, String farm, Account.Name owner, String description, int backupHour, String osType, String osVersion, String architecture, User.Name username, String password, String contactPhone, String contactEmail)	Adds a new backup Host.
int	addCvsRepository(String aoServer, PosixPath path, User.Name username, Group.Name group, long mode)	Adds a new CvsRepository to a Server.
int	addDnsRecord(String zone, String domain, String type, int priority, int weight, int port, short flag, String tag, String destination, int ttl)	Adds a new Record to a Zone.
void	addDnsZone(Account.Name packageName, String zone, InetAddress ip, int ttl)	Adds a new Zone to a system.
int	addEmailDomain(DomainName domain, String aoServer, Account.Name packageName)	Adds a new Domain to a Server.
int	addEmailForwarding(String address, DomainName domain, String aoServer, Email destination)	Forwards email addressed to an address at a Domain to a different email address.
int	addEmailList(String aoServer, PosixPath path, User.Name username, Group.Name group)	Adds a new List to the system.
int	addEmailListAddress(String address, DomainName domain, PosixPath path, String aoServer)	Adds to the list of Address to which the List will accept mail.
int	addEmailPipe(String aoServer, String command, Account.Name packageName)	Adds a new Pipe to the system.
int	addEmailPipeAddress(String address, DomainName domain, int pkey)	Adds an address to the list of email addresses that will be piped to an Pipe.
int	addEmailSmtpRelay(Account.Name packageName, String aoServer, HostAddress host, String type, long duration)	Grants access to the SMTP server.
int	addFileBackupSetting(int replication, String path, boolean backupEnabled, boolean required)	Adds a FileReplicationSetting to a FileReplication.
void	addFtpGuestUser(User.Name username)	Flags a User as being a GuestUser.
int	addHttpdJbossSite(String aoServer, String siteName, Account.Name packageName, User.Name jvmUsername, Group.Name groupName, Email serverAdmin, boolean useApache, InetAddress ipAddress, String netDevice, DomainName primaryHttpHostname, DomainName[] altHttpHostnames, String jbossVersion)	Adds a new Site to the system.
int	addHttpdSharedTomcat(String name, String aoServer, String version, User.Name linuxServerAccount, Group.Name linuxServerGroup)	Adds a new SharedTomcat to a server.
int	addHttpdSiteAuthenticatedLocation(String siteName, String aoServer, String path, boolean isRegularExpression, String authName, PosixPath authGroupFile, PosixPath authUserFile, String require, String handler)	Adds a new Location to a Site.
int	addHttpdTomcatContext(String siteName, String aoServer, String className, boolean cookies, boolean crossContext, PosixPath docBase, boolean override, String path, boolean privileged, boolean reloadable, boolean useNaming, String wrapperClass, int debug, PosixPath workDir, boolean serverXmlConfigured)	Adds a new Context to a Site.
int	addHttpdTomcatDataSource(String siteName, String aoServer, String path, String name, String driverClassName, String url, String username, String password, int maxActive, int maxIdle, int maxWait, String validationQuery)	Adds a new data source to a Context.
int	addHttpdTomcatParameter(String siteName, String aoServer, String path, String name, String value, boolean override, String description)	Adds a new parameter to a Context.
int	addHttpdTomcatSharedSite(String aoServer, String siteName, Account.Name packageName, User.Name jvmUsername, Group.Name groupName, Email serverAdmin, boolean useApache, InetAddress ipAddress, String netDevice, DomainName primaryHttpHostname, DomainName[] altHttpHostnames, String sharedTomcatName)	Adds a new SharedTomcatSite to the system.
int	addHttpdTomcatSiteJkMount(String siteName, String aoServer, String path, boolean mount)	Adds a new JkMount to a Site.
int	addHttpdTomcatStdSite(String aoServer, String siteName, Account.Name packageName, User.Name jvmUsername, Group.Name groupName, Email serverAdmin, boolean useApache, InetAddress ipAddress, String netDevice, DomainName primaryHttpHostname, DomainName[] altHttpHostnames, String tomcatVersion)	Adds a new PrivateTomcatSite to the system.
void	addIpReputation(String identifier, String host, String confidence, String reputationType, short score)
int	addLinuxAccAddress(String address, DomainName domain, String aoServer, User.Name username)	Adds an Address to a User.
void	addLinuxAccount(User.Name username, Group.Name primaryGroup, User.Gecos name, User.Gecos officeLocation, User.Gecos officePhone, User.Gecos homePhone, String type, PosixPath shell)	Adds a new User the system.
void	addLinuxGroup(Group.Name name, Account.Name packageName, String type)	Adds a Group to the system.
int	addLinuxGroupAccount(Group.Name group, User.Name username)	Once a User and a Group have been established, permission for the User to access the Group may be granted using a GroupUser.
int	addLinuxServerAccount(User.Name username, String aoServer, PosixPath home)	Grants a User access to a Server.
int	addLinuxServerGroup(Group.Name group, String aoServer)	Grants a Group access to a Server.
int	addMajordomoList(DomainName domain, String aoServer, String listName)	Adds a new MajordomoList to a MajordomoServer.
void	addMajordomoServer(DomainName domain, String aoServer, User.Name linuxAccount, Group.Name linuxGroup, String version)	Adds a new MajordomoServer to an Domain.
int	addMysqlDatabase(Database.Name name, Server.Name mysqlServer, String aoServer, Account.Name packageName)	Adds a new Database to the system.
int	addMysqlDbUser(Database.Name name, Server.Name mysqlServer, String aoServer, User.Name username, boolean canSelect, boolean canInsert, boolean canUpdate, boolean canDelete, boolean canCreate, boolean canDrop, boolean canReference, boolean canIndex, boolean canAlter, boolean canCreateTempTable, boolean canLockTables, boolean canCreateView, boolean canShowView, boolean canCreateRoutine, boolean canAlterRoutine, boolean canExecute, boolean canEvent, boolean canTrigger)	Grants a UserServer permission to access a Database.
int	addMysqlServerUser(User.Name username, Server.Name mysqlServer, String aoServer, String host)	Grants a User access to a Server by adding a UserServer.
void	addMysqlUser(User.Name username)	Adds a User to the system.
int	addNetBind(String server, Account.Name packageName, InetAddress ipAddress, String netDevice, Port port, String appProtocol, boolean monitoringEnabled, Set<FirewallZone.Name> firewalldZoneNames)	Adds a network bind to the system.
int	addNoticeLog(Account.Name accounting, String billingContact, Email emailAddress, String type, int transid)	Whenever a credit card transaction fails, or when an account has not been paid for over month, the billing contact for the Account is notified.
int	addPackage(Account.Name packageName, Account.Name accounting, int packageDefinition)	Each Account can have multiple Packages associated with it.
int	addPostgresDatabase(Database.Name name, Server.Name postgresServer, String aoServer, User.Name datdba, String encoding, boolean enablePostgis)	Adds a new Database to the system.
int	addPostgresServerUser(User.Name username, Server.Name postgresServer, String aoServer)	Grants a User access to a Server by adding a UserServer.
void	addPostgresUser(User.Name username)	Adds a User to the system.
int	addProfile(Account.Name business, String name, boolean isPrivate, String phone, String fax, String address1, String address2, String city, String state, String country, String zip, boolean sendInvoice, String billingContact, Set<Email> billingEmail, String billingEmailFormat, String technicalContact, Set<Email> technicalEmail, String technicalEmailFormat)	Adds a new Profile to an Account.
int	addSpamEmailMessage(int emailRelay, String message)	Adds a SpamMessage.
int	addTransaction(int timeType, Timestamp time, Account.Name accountName, Account.Name sourceAccountName, User.Name administrator, String type, String description, int quantity, Money rate, String paymentType, String paymentInfo, String processor, byte paymentConfirmed)	Adds a new Transaction to a Account.
void	addUsername(Account.Name packageName, User.Name username)	Adds a new User to a Package.
int	addVirtualHostName(int hsbPkey, DomainName hostname)	Adds a new VirtualHostName to a VirtualHost.
int	areLinuxAccountPasswordsSet(User.Name username)	Determines if a User currently has passwords set.
int	areMysqlUserPasswordsSet(User.Name username)	Determines if a User currently has passwords set.
int	arePostgresUserPasswordsSet(User.Name username)	Determines if a User currently has passwords set.
int	areUsernamePasswordsSet(User.Name username)	Determines if a User currently has passwords set.
void	cancelAccount(Account.Name accounting, String reason)	Cancels an Account.
static List<PasswordChecker.Result>	checkAdministratorPassword(User.Name username, String password)	Checks the strength of a password that will be used for a Administrator.
void	checkDnsZone(String zone)	Checks the format of a Zone.
void	checkEmailListPath(String aoServer, PosixPath path)	Checks the format of an email list path.
List<PasswordChecker.Result>	checkLinuxAccountPassword(User.Name username, String password)	Checks the strength of a password that will be used for a User or UserServer.
static void	checkMajordomoListName(String listName)	Checks the format of a Majordomo list name.
static List<PasswordChecker.Result>	checkMysqlPassword(User.Name username, String password)	Checks the strength of a password that will be used for a UserServer.
static List<PasswordChecker.Result>	checkPostgresPassword(User.Name username, String password)	Checks the strength of a password that will be used for a UserServer.
static void	checkSharedTomcatName(String tomcatName)	Checks the format of an SharedTomcat name.
static void	checkSiteName(String siteName)	Checks the format of an Site name.
List<Certificate.Check>	checkSslCertificate(String aoServer, String keyFileOrCertbotName, boolean allowCached)
List<PasswordChecker.Result>	checkUsernamePassword(User.Name username, String password)	Checks the strength of a password that will be used for a User.
boolean	compareLinuxServerAccountPassword(User.Name username, String aoServer, String password)	Checks if a password matches a UserServer.
long	copyHomeDirectory(User.Name username, String fromAoServer, String toAoServer)	Copies the contents of user's home directory from one server to another.
void	copyLinuxServerAccountPassword(User.Name fromUsername, String fromAoServer, User.Name toUsername, String toAoServer)	Copies the password from one UserServer to another.
String	createVirtualServer(String virtualServer)
static String	crypt(String password, String salt)	Deprecated. Please use HashedPassword instead.
void	declineCreditCard(int pkey, String reason)	Disables a CreditCard.
String	destroyVirtualServer(String virtualServer)
int	disableAccount(Account.Name accounting, String disableReason)	Disables a business, recursively disabling all of its enabled child components.
int	disableAdministrator(User.Name username, String disableReason)	Disables a Administrator.
int	disableCvsRepository(int pkey, String disableReason)	Disables a CvsRepository.
int	disableEmailList(PosixPath path, String aoServer, String disableReason)	Disables an List.
int	disableEmailPipe(int pkey, String disableReason)	Disables an Pipe.
int	disableEmailSmtpRelay(int pkey, String disableReason)	Disables a SmtpRelay.
int	disableHttpdSharedTomcat(String name, String aoServer, String disableReason)	Disables a SharedTomcat.
int	disableHttpdSite(String name, String aoServer, String disableReason)	Disables a Site.
int	disableHttpdSiteBind(int pkey, String disableReason)	Disables a VirtualHost.
int	disableLinuxAccount(User.Name username, String disableReason)	Disables a User.
int	disableLinuxServerAccount(User.Name username, String aoServer, String disableReason)	Disables a UserServer.
int	disableMysqlServerUser(User.Name username, Server.Name mysqlServer, String aoServer, String disableReason)	Disables a UserServer.
int	disableMysqlUser(User.Name username, String disableReason)	Disables a User.
int	disablePackage(Account.Name name, String disableReason)	Disables a package, recursively disabling all of its enabled child components.
int	disablePostgresServerUser(User.Name username, Server.Name postgresServer, String aoServer, String disableReason)	Disables a UserServer.
int	disablePostgresUser(User.Name username, String disableReason)	Disables a User.
int	disableUsername(User.Name username, String disableReason)	Disables a User and all uses of the username.
void	dumpMysqlDatabase(Database.Name name, Server.Name mysqlServer, String aoServer, boolean gzip, StreamHandler streamHandler)	Dumps the contents of a Database to an OutputStream, optionally gzipped.
void	dumpMysqlDatabase(Database.Name name, Server.Name mysqlServer, String aoServer, Writer out)	Dumps the contents of a Database to a Writer.
void	dumpPostgresDatabase(Database.Name name, Server.Name postgresServer, String aoServer, boolean gzip, StreamHandler streamHandler)	Dumps the contents of a Database to an OutputStream, optionally gzipped.
void	dumpPostgresDatabase(Database.Name name, Server.Name postgresServer, String aoServer, Writer out)	Dumps the contents of a Database to a Writer.
void	enableAccount(Account.Name accounting)	Enables a business, recursively enabling all of its disabled child components.
void	enableAdministrator(User.Name username)	Enables an Administrator.
void	enableCvsRepository(int pkey)	Enables a CvsRepository.
void	enableEmailList(PosixPath path, String aoServer)	Enables an List.
void	enableEmailPipe(int pkey)	Enables an Pipe.
void	enableEmailSmtpRelay(int pkey)	Enables a SmtpRelay.
void	enableHttpdSharedTomcat(String name, String aoServer)	Enables a SharedTomcat.
void	enableHttpdSite(String name, String aoServer)	Enables a Site.
void	enableHttpdSiteBind(int pkey)	Enables a VirtualHost.
void	enableLinuxAccount(User.Name username)	Enables a User.
void	enableLinuxServerAccount(User.Name username, String aoServer)	Enables a UserServer.
void	enableMysqlServerUser(User.Name username, Server.Name mysqlServer, String aoServer)	Enables a UserServer.
void	enableMysqlUser(User.Name username)	Enables a User.
void	enablePackage(Account.Name name)	Enables a package, recursively enabling all of its disabled child components.
void	enablePostgresServerUser(User.Name username, Server.Name postgresServer, String aoServer)	Enables a UserServer.
void	enablePostgresUser(User.Name username)	Enables a User.
void	enableUsername(User.Name username)	Enables a User and all uses of the username.
Account.Name	generateAccountingCode(Account.Name accountingTemplate)	Generates a unique accounting code that may be used to create a new Account.
Database.Name	generateMysqlDatabaseName(String templateBase, String templateAdded)	Generates a unique MySQL database name.
Account.Name	generatePackageName(Account.Name template)	Generates a unique Package name.
String	generatePassword()	Generates a random, valid password.
Database.Name	generatePostgresDatabaseName(String templateBase, String templateAdded)	Generates a unique PostgreSQL database name.
String	generateSharedTomcatName(String template)	Generates a unique SharedTomcat name.
String	generateSiteName(String template)	Generates a unique Site name.
String	getAutoresponderContent(User.Name username, String aoServer)	Gets the autoresponder content.
void	getAwstatsFile(String siteName, String aoServer, String path, String queryString, OutputStream out)	Gets the contents of an AWStats file.
long	getBackupPartitionTotalSize(String aoServer, String path)	Gets the total size of a BackupPartition.
long	getBackupPartitionUsedSize(String aoServer, String path)	Gets the used size of a BackupPartition.
AoservConnector	getConnector()	Gets the AoservConnector used for communication with the server.
String	getCronTable(User.Name username, String aoServer)	Gets a user's cron table on one server.
String	getEmailListAddressList(PosixPath path, String aoServer)	Gets the list of email addresses that an List will be forwarded to.
FileReplication.Activity	getFailoverFileReplicationActivity(String fromServer, String toServer, String path)	Gets the last reported activity for a FileReplication.
int	getHttpdServerConcurrency(String aoServer, String name)
long[]	getImapFolderSizes(User.Name username, String aoServer, String[] folderNames)	Gets the IMAP folder sizes for an inbox.
InboxAttributes	getInboxAttributes(User.Name username, String aoServer)	Gets the attributes of an inbox.
String	getMajordomoInfoFile(DomainName domain, String aoServer, String listName)	Gets the info file for a MajordomoList.
String	getMajordomoIntroFile(DomainName domain, String aoServer, String listName)	Gets the intro file for a MajordomoList.
void	getMrtgFile(String aoServer, String filename, OutputStream out)	Gets the contents of a MRTG file.
String	getPrimaryVirtualServer(String virtualServer)
Account.Name	getRootAccount()	Gets the name of the root Account in the tree of accounts.
String	getSecondaryVirtualServer(String virtualServer)
String	getUpsStatus(String aoServer)	Gets the current status of the UPS.
int	getVirtualServerStatus(String virtualServer)
void	invalidate(int tableId, String server)	Invalidates a table, causing all caches of the table to be removed and all configurations based on the table to be reevaluated.
boolean	isAccountingAvailable(Account.Name accounting)	Determines if an accounting code is available.
boolean	isAdministratorPasswordSet(User.Name username)	Determines if a Administrator currently has a password set.
boolean	isDnsZoneAvailable(String zone)	Determines if a Zone is available.
boolean	isEmailDomainAvailable(DomainName domain, String aoServer)	Determines if a Domain is available.
boolean	isIpAddressUsed(InetAddress ipAddress, String server, String netDevice)	Determines if an IpAddress is currently being used.
boolean	isLinuxGroupNameAvailable(Group.Name groupname)	Determines if a groupname is available.
boolean	isLinuxServerAccountPasswordSet(User.Name username, String aoServer)	Determines if a UserServer currently has a password set.
int	isLinuxServerAccountProcmailManual(User.Name username, String aoServer)	Determines if a UserServer is currently in manual procmail mode.
boolean	isMysqlDatabaseNameAvailable(Database.Name name, Server.Name mysqlServer, String aoServer)	Determines if a Database name is available on the specified Server.
boolean	isMysqlServerNameAvailable(Server.Name name, String aoServer)	Determines if a Server name is available on the specified Server.
boolean	isMysqlServerUserPasswordSet(User.Name username, Server.Name mysqlServer, String aoServer)	Determines if a UserServer currently has a password set.
boolean	isPackageNameAvailable(Account.Name packageName)	Determines if a Package name is available.
boolean	isPostgresDatabaseNameAvailable(Database.Name name, Server.Name postgresServer, String aoServer)	Determines if a Database name is available on the specified Server.
boolean	isPostgresServerNameAvailable(Server.Name name, String aoServer)	Determines if a Server name is available on the specified Server.
boolean	isPostgresServerUserPasswordSet(User.Name username, Server.Name postgresServer, String aoServer)	Determines if a UserServer currently has a password set.
boolean	isSharedTomcatNameAvailable(String name)	Determines if a name is available for use as a SharedTomcat.
boolean	isSiteNameAvailable(String siteName)	Determines if a site name is available.
boolean	isUsernameAvailable(User.Name username)	Determines if a User is available.
void	moveAccount(Account.Name business, String from, String to, TerminalWriter out)	Moves all resources for one Account from one Server to another Server.
void	moveIpAddress(InetAddress ipAddress, String fromServer, String fromNetDevice, String toServer)	Moves an IpAddress from one Host to another.
String	pauseVirtualServer(String virtualServer)
int	ping()	Times the latency of the communication with the server.
void	printZoneFile(String zone, PrintWriter out)	Prints the contents of a Zone as used by the named process.
String	rebootVirtualServer(String virtualServer)
void	refreshEmailSmtpRelay(int pkey, long minDuration)	Refreshes the time window for SMTP server access by resetting the expiration to 24 hours from the current time.
void	removeAccountHost(Account.Name accounting, String server)	Revokes an account's access to a Host.
void	removeAdministrator(User.Name username)	Removes an Administrator from the system.
void	removeBlackholeEmailAddress(String address, DomainName domain, String aoServer)	Removes a BlackholeAddress from the system.
void	removeCreditCard(int pkey)	Removes a CreditCard.
void	removeCvsRepository(String aoServer, PosixPath path)	Removes a CvsRepository.
void	removeDnsRecord(int pkey)	Removes one record from a Zone.
void	removeDnsRecord(String zone, String domain, String type, String tag, String destination)
void	removeDnsZone(String zone)	Completely removes a Zone from the servers.
void	removeEmailAddress(String address, DomainName domain, String aoServer)	Removes an Address from the system.
void	removeEmailDomain(DomainName domain, String aoServer)	Removes an Domain and all of its Addresses.
void	removeEmailForwarding(String address, DomainName domain, String aoServer, Email destination)	Removes an Forwarding from the system.
void	removeEmailList(PosixPath path, String aoServer)	Removes an List from the system.
void	removeEmailListAddress(String address, DomainName domain, PosixPath path, String aoServer)	Removes an ListAddress from the system.
void	removeEmailPipe(int pkey)	Removes an Pipe from the system.
void	removeEmailPipeAddress(String address, DomainName domain, int pipe)	Removes an PipeAddress from the system.
void	removeEmailSmtpRelay(int pkey)	Removes an SmtpRelay from the system, revoking access to the SMTP server from one IP address.
void	removeFileBackupSetting(int replication, String path)	Removes a FileReplicationSetting from the system.
void	removeFtpGuestUser(User.Name username)	Removes the GuestUser flag from a User, allowing access to the server root directory.
void	removeHttpdSharedTomcat(String name, String aoServer)	Completely removes a SharedTomcat from the servers.
void	removeHttpdSite(String name, String aoServer)	Completely removes a Site from the servers.
void	removeHttpdTomcatContext(int pkey)	Removes a Context from the servers.
void	removeHttpdTomcatDataSource(int pkey)	Removes a ContextDataSource from a Context.
void	removeHttpdTomcatParameter(int pkey)	Removes a ContextParameter from a Context.
void	removeHttpdTomcatSiteJkMount(String siteName, String aoServer, String path)	Removes a JkMount from a Site.
void	removeLinuxAccAddress(String address, DomainName domain, String aoServer, User.Name username)	Removes a InboxAddress from the system.
void	removeLinuxAccount(User.Name username)	Removes a User and all related data from the system.
void	removeLinuxGroup(Group.Name name)	Removes a Group and all related data from the system.
void	removeLinuxGroupAccount(Group.Name group, User.Name username)	Removes a User's access to a Group.
void	removeLinuxServerAccount(User.Name username, String aoServer)	Removes a UserServer from a Server.
void	removeLinuxServerGroup(Group.Name group, String aoServer)	Removes a GroupServer from a Server.
void	removeMajordomoServer(DomainName domain, String aoServer)	Removes a MajordomoServer and all of its MajordomoLists.
void	removeMysqlDatabase(Database.Name name, Server.Name mysqlServer, String aoServer)	Removes a Database from the system.
void	removeMysqlDbUser(Database.Name name, Server.Name mysqlServer, String aoServer, User.Name username)	Removes a DatabaseUser from the system.
void	removeMysqlServerUser(User.Name username, Server.Name mysqlServer, String aoServer)	Removes a UserServer from a the system..
void	removeMysqlUser(User.Name username)	Removes a User from a the system.
void	removeNetBind(int pkey)	Removes a Bind from a the system.
void	removePostgresDatabase(Database.Name name, Server.Name postgresServer, String aoServer)	Removes a Database from the system.
void	removePostgresServerUser(User.Name username, Server.Name postgresServer, String aoServer)	Removes a UserServer from a the system..
void	removePostgresUser(User.Name username)	Removes a User from a the system..
void	removeUsername(User.Name username)	Removes a User from the system.
void	removeVirtualHostName(int pkey)	Removes a VirtualHostName from the servers.
void	restartApache(String aoServer)	Restarts the Apache web server.
void	restartCron(String aoServer)	Restarts the cron doggie.
void	restartMysql(Server.Name mysqlServer, String aoServer)	Restarts the MySQL database server.
void	restartPostgresql(Server.Name postgresServer, String aoServer)	Restarts the PostgreSQL database server.
void	restartXfs(String aoServer)	Restarts the X Font Server.
void	restartXvfb(String aoServer)	Restarts the X Virtual Frame Buffer.
void	setAccountAccounting(Account.Name oldAccounting, Account.Name newAccounting)	Sets the accounting code for the business.
void	setAdministratorPassword(User.Name username, String password)	Sets the password for an Administrator.
void	setAdministratorProfile(User.Name username, 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)	Sets the profile of an Administrator, which is all of their contact information and other details.
void	setAutoresponder(User.Name username, String aoServer, String address, DomainName domain, String subject, String content, boolean enabled)	Sets the autoresponder behavior for a Linux server account.
void	setCronTable(User.Name username, String aoServer, String cronTable)	Sets a user's cron table on one server.
void	setCvsRepositoryMode(String aoServer, PosixPath path, long mode)	Sets the permissions for a CVS repository directory.
void	setDefaultAccountHost(Account.Name accounting, String server)	Sets the default Host for an Account.
void	setDnsZoneTtl(String zone, int ttl)	Completely removes a Zone from the servers.
void	setEmailListAddressList(PosixPath path, String aoServer, String addresses)	Sets the list of addresses that an List will forward messages to.
void	setFileBackupSetting(int replication, String path, boolean backupEnabled, boolean required)	Sets the settings contained by one FileReplicationSetting.
void	setHttpdSharedTomcatAutoDeploy(String name, String aoServer, boolean autoDeploy)	Sets the autoDeploy setting for a SharedTomcat.
void	setHttpdSharedTomcatIsManual(String name, String aoServer, boolean isManual)	Sets the is_manual flag for a SharedTomcat.
void	setHttpdSharedTomcatMaxParameterCount(String name, String aoServer, int maxParameterCount)	Sets the maxParameterCount for a SharedTomcat.
void	setHttpdSharedTomcatMaxPostSize(String name, String aoServer, int maxPostSize)	Sets the maxPostSize for a SharedTomcat.
void	setHttpdSharedTomcatTomcatAuthentication(String name, String aoServer, boolean tomcatAuthentication)	Sets the tomcatAuthentication setting for a SharedTomcat.
void	setHttpdSharedTomcatUndeployOldVersions(String name, String aoServer, boolean undeployOldVersions)	Sets the undeployOldVersions setting for a SharedTomcat.
void	setHttpdSharedTomcatUnpackWars(String name, String aoServer, boolean unpackWars)	Sets the unpackWars setting for a SharedTomcat.
void	setHttpdSharedTomcatVersion(String name, String aoServer, String version)	Sets the Tomcat version for a SharedTomcat.
void	setHttpdSiteAuthenticatedLocationAttributes(String siteName, String aoServer, String path, boolean isRegularExpression, String authName, PosixPath authGroupFile, PosixPath authUserFile, String require, String handler)	Updates a Location.
void	setHttpdSiteBindIsManual(int pkey, boolean isManual)	Sets the is_manual flag for a VirtualHost.
void	setHttpdSiteBindRedirectToPrimaryHostname(int pkey, boolean redirectToPrimaryHostname)	Sets the redirect_to_primary_hostname flag for a VirtualHost.
void	setHttpdSiteBlockCoreDumps(String siteName, String aoServer, boolean blockCoreDumps)	Sets the block_core_dumps flag for a Site.
void	setHttpdSiteBlockEditorBackups(String siteName, String aoServer, boolean blockEditorBackups)	Sets the block_editor_backups flag for a Site.
void	setHttpdSiteBlockScm(String siteName, String aoServer, boolean blockScm)	Sets the block_scm flag for a Site.
void	setHttpdSiteBlockTraceTrack(String siteName, String aoServer, boolean blockTraceTrack)	Sets the block_trace_track flag for a Site.
void	setHttpdSiteEnableAnonymousFtp(String siteName, String aoServer, boolean enableAnonymousFtp)	Sets the enable_anonymous_ftp flag for a Site.
void	setHttpdSiteEnableCgi(String siteName, String aoServer, boolean enableCgi)	Sets the enable_cgi flag for a Site.
void	setHttpdSiteEnableFollowSymlinks(String siteName, String aoServer, boolean enableFollowSymlinks)	Sets the enable_follow_symlinks flag for a Site.
void	setHttpdSiteEnableHtaccess(String siteName, String aoServer, boolean enableHtaccess)	Sets the enable_htaccess flag for a Site.
void	setHttpdSiteEnableIndexes(String siteName, String aoServer, boolean enableIndexes)	Sets the enable_indexes flag for a Site.
void	setHttpdSiteEnableSsi(String siteName, String aoServer, boolean enableSsi)	Sets the enable_ssi flag for a Site.
void	setHttpdSiteIsManual(String siteName, String aoServer, boolean isManual)	Sets the is_manual flag for a Site.
void	setHttpdSitePhpVersion(String siteName, String aoServer, String phpVersion)	Sets the PHP version for a Site.
void	setHttpdSiteServerAdmin(String siteName, String aoServer, Email emailAddress)	Sets the administrative email address for a Site.
void	setHttpdTomcatContextAttributes(String siteName, String aoServer, String oldPath, String className, boolean cookies, boolean crossContext, PosixPath docBase, boolean override, String newPath, boolean privileged, boolean reloadable, boolean useNaming, String wrapperClass, int debug, PosixPath workDir, boolean serverXmlConfigured)	Sets the attributes for a Context.
void	setHttpdTomcatSiteBlockWebinf(String siteName, String aoServer, boolean blockWebinf)	Sets the block_webinf flag for a Site.
void	setHttpdTomcatStdSiteAutoDeploy(String siteName, String aoServer, boolean autoDeploy)	Sets the autoDeploy setting for a PrivateTomcatSite.
void	setHttpdTomcatStdSiteMaxParameterCount(String siteName, String aoServer, int maxParameterCount)	Sets the maxParameterCount for a PrivateTomcatSite.
void	setHttpdTomcatStdSiteMaxPostSize(String siteName, String aoServer, int maxPostSize)	Sets the maxPostSize for a PrivateTomcatSite.
void	setHttpdTomcatStdSiteTomcatAuthentication(String siteName, String aoServer, boolean tomcatAuthentication)	Sets the tomcatAuthentication setting for a PrivateTomcatSite.
void	setHttpdTomcatStdSiteUndeployOldVersions(String siteName, String aoServer, boolean undeployOldVersions)	Sets the undeployOldVersions setting for a PrivateTomcatSite.
void	setHttpdTomcatStdSiteUnpackWars(String siteName, String aoServer, boolean unpackWars)	Sets the unpackWars setting for a PrivateTomcatSite.
void	setHttpdTomcatStdSiteVersion(String siteName, String aoServer, String version)	Sets the Tomcat version for a PrivateTomcatSite.
void	setIpAddressDhcpAddress(int ipAddress, InetAddress dhcpAddress)	Sets the IP address of a DHCP-enabled IpAddress.
void	setIpAddressHostname(InetAddress ipAddress, String server, String netDevice, DomainName hostname)	Sets the hostname of an IpAddress.
void	setIpAddressMonitoringEnabled(InetAddress ipAddress, String server, String netDevice, boolean enabled)	Sets the monitoring status of an IpAddress.
void	setIpAddressPackage(InetAddress ipAddress, String server, String netDevice, Account.Name newPackage)	Sets the ownership of an IpAddress.
void	setLinuxAccountHomePhone(User.Name username, User.Gecos phone)	Sets the home phone number associated with a User.
void	setLinuxAccountName(User.Name username, User.Gecos name)	Sets the full name associated with a User.
void	setLinuxAccountOfficeLocation(User.Name username, User.Gecos location)	Sets the office location associated with a User.
void	setLinuxAccountOfficePhone(User.Name username, User.Gecos phone)	Sets the office phone number associated with a User.
void	setLinuxAccountPassword(User.Name username, String password)	Sets the password for a User by setting the password for each one of its UserServers.
void	setLinuxAccountShell(User.Name username, PosixPath path)	Sets the shell used by a User.
void	setLinuxServerAccountJunkEmailRetention(User.Name username, String aoServer, int days)	Sets the number of days junk email is kept.
void	setLinuxServerAccountPassword(User.Name username, String aoServer, String password)	Sets the password for a UserServer.
void	setLinuxServerAccountSpamAssassinIntegrationMode(User.Name username, String aoServer, String mode)	Sets the SpamAssassin integration mode for an email account.
void	setLinuxServerAccountSpamAssassinRequiredScore(User.Name username, String aoServer, float requiredScore)	Sets the SpamAssassin required score for an email account.
void	setLinuxServerAccountTrashEmailRetention(User.Name username, String aoServer, int days)	Sets the number of days trash email is kept.
void	setLinuxServerAccountUseInbox(User.Name username, String aoServer, boolean useInbox)	Sets the use_inbox flag on a UserServer.
void	setMajordomoInfoFile(DomainName domain, String aoServer, String listName, String file)	Sets the info file for a MajordomoList.
void	setMajordomoIntroFile(DomainName domain, String aoServer, String listName, String file)	Sets the intro file for a MajordomoList.
void	setMysqlServerUserPassword(User.Name username, Server.Name mysqlServer, String aoServer, String password)	Sets the password for a UserServer.
void	setMysqlUserPassword(User.Name username, String password)	Sets the password for a User by settings the password for all of its UserServers.
void	setNetBindFirewalldZones(int pkey, Set<FirewallZone.Name> firewalldZones)	Sets the firewalld zones enable for a Bind.
void	setNetBindMonitoringEnabled(int pkey, boolean enabled)	Sets the monitoring status for a Bind.
void	setPostgresServerUserPassword(User.Name username, Server.Name postgresServer, String aoServer, String password)	Sets the password for a UserServer.
void	setPostgresUserPassword(User.Name username, String password)	Sets the password for a User by settings the password for all of its UserServers.
void	setPrimaryLinuxGroupAccount(Group.Name groupName, User.Name username)	Sets the primary group for a User.
void	setPrimaryVirtualHostName(int pkey)	Sets the primary URL for a VirtualHost.
void	setUsernamePassword(User.Name username, String password)	Sets the password for a User.
String	shutdownVirtualServer(String virtualServer)
void	startApache(String aoServer)	Starts the Apache web server if it is not already running.
void	startCron(String aoServer)	Starts the cron process if it is not already running.
void	startDistro(String aoServer, boolean includeUser)	Starts the distribution on a server and/or changes the setting of the user file scanning.
String	startJvm(String siteName, String aoServer)	Starts and/or restarts the Tomcat or JBoss Java VM for the provided site.
void	startMysql(Server.Name mysqlServer, String aoServer)	Starts the MySQL database server if it is not already running.
void	startPostgresql(Server.Name postgresServer, String aoServer)	Starts the PostgreSQL database server if it is not already running.
void	startXfs(String aoServer)	Starts the X Font Server if it is not already running.
void	startXvfb(String aoServer)	Starts the X Virtual Frame Buffer if it is not already running.
void	stopApache(String aoServer)	Stops the Apache web server if it is running.
void	stopCron(String aoServer)	Stops the cron daemon if it is running.
String	stopJvm(String siteName, String aoServer)	Stops the Tomcat or JBoss Java VM for the provided site.
void	stopMysql(Server.Name mysqlServer, String aoServer)	Stops the MySQL database server if it is running.
void	stopPostgresql(Server.Name postgresServer, String aoServer)	Stops the PostgreSQL database server if it is running.
void	stopXfs(String aoServer)	Stops the X Font Server if it is running.
void	stopXvfb(String aoServer)	Stops the X Virtual Frame Buffer if it is running.
String	unpauseVirtualServer(String virtualServer)
void	updateHttpdTomcatDataSource(String siteName, String aoServer, String path, String oldName, String newName, String driverClassName, String url, String username, String password, int maxActive, int maxIdle, int maxWait, String validationQuery)	Updates a Context data source.
void	updateHttpdTomcatParameter(String siteName, String aoServer, String path, String oldName, String newName, String value, boolean override, String description)	Updates a Context parameter.
long	verifyVirtualDisk(String virtualServer, String device)	Begins a verification of the redundancy of the virtual disk.
void	waitForHttpdSiteRebuild(String aoServer)	Waits for any processing or pending updates of the Apache configurations to complete.
void	waitForLinuxAccountRebuild(String aoServer)	Waits for any processing or pending updates of the Linux account configurations to complete.
void	waitForMysqlDatabaseRebuild(String aoServer)	Waits for any processing or pending updates of the MySQL configurations to complete.
void	waitForMysqlDbUserRebuild(String aoServer)	Waits for any processing or pending updates of the MySQL configurations to complete.
void	waitForMysqlServerRebuild(String aoServer)	Waits for any processing or pending updates of the MySQL server configurations to complete.
void	waitForMysqlUserRebuild(String aoServer)	Waits for any processing or pending updates of the MySQL configurations to complete.
void	waitForPostgresDatabaseRebuild(String aoServer)	Waits for any processing or pending updates of the PostgreSQL configurations to complete.
void	waitForPostgresServerRebuild(String aoServer)	Waits for any processing or pending updates of the PostgreSQL server configurations to complete.
void	waitForPostgresUserRebuild(String aoServer)	Waits for any processing or pending updates of the PostgreSQL configurations to complete.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SimpleAoservClient

public SimpleAoservClient(AoservConnector connector)

Creates a new SimpleAoservClient using the provided AoservConnector.

Parameters:

connector - the AoservConnector that will be used for communication with the server.

See Also:

• AoservConnector.getConnector()
• TcpConnector.getTcpConnector(com.aoapps.net.HostAddress, com.aoapps.net.InetAddress, com.aoapps.net.Port, com.aoindustries.aoserv.client.account.User.Name, com.aoindustries.aoserv.client.account.User.Name, java.lang.String, com.aoapps.net.DomainName, int, long)
• SslConnector.getSslConnector(com.aoapps.net.HostAddress, com.aoapps.net.InetAddress, com.aoapps.net.Port, com.aoindustries.aoserv.client.account.User.Name, com.aoindustries.aoserv.client.account.User.Name, java.lang.String, com.aoapps.net.DomainName, int, long, java.lang.String, java.lang.String)

Method Details

addBackupHost

public int addBackupHost(String hostname,
 String farm,
 Account.Name owner,
 String description,
 int backupHour,
 String osType,
 String osVersion,
 String architecture,
 User.Name username,
 String password,
 String contactPhone,
 String contactEmail)
                  throws IllegalArgumentException,
IOException,
SQLException

Adds a new backup Host.

Parameters:

hostname - the desired hostname for the server

farm - the farm the server is part of

owner - the package the server belongs to

description - a description of the server

backupHour - the hour the backup will be run if used in daemon mode, expressed in server-local time

osType - the type of operating system on the server

osVersion - the version of operating system on the server

architecture - the type of CPU(s) on the server

username - the desired backup account username

password - the desired backup account password

contactPhone - the phone number to call for anything related to this server

contactEmail - the email address to contact for anything related to this server

Throws:

IOException - if unable to communicate with the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the ServerFarm, Account, Architecture, OperatingSystem, or OperatingSystemVersion

See Also:

• Host
• HostTable.addBackupHost(java.lang.String, com.aoindustries.aoserv.client.infrastructure.ServerFarm, com.aoindustries.aoserv.client.billing.Package, java.lang.String, int, com.aoindustries.aoserv.client.distribution.OperatingSystemVersion, com.aoindustries.aoserv.client.account.User.Name, java.lang.String, java.lang.String, java.lang.String)

addAccount

public void addAccount(Account.Name accounting,
 String contractVersion,
 String defaultServer,
 Account.Name parent,
 boolean canAddBackupServers,
 boolean canAddBusinesses,
 boolean canSeePrices,
 boolean billParent)
                throws IllegalArgumentException,
SQLException,
IOException

Adds a new Account to the system.

Parameters:

accounting - the accounting code of the new business

contractVersion - the version number of the digitally signed contract

defaultServer - the hostname of the default server

parent - the parent business of the new business

canAddBackupServers - allows backup servers to be added to the system

canAddBusinesses - if true, the new business is allowed to add additional businesses

billParent - if true the parent account will be billed instead of this account

Throws:

IOException - if unable to communicate with the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the server or parent business

See Also:

• Account
• Host.addAccount(com.aoindustries.aoserv.client.account.Account.Name, java.lang.String, com.aoindustries.aoserv.client.account.Account, boolean, boolean, boolean, boolean)

addAdministrator

public void addAdministrator(User.Name username,
 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 IllegalArgumentException,
IOException,
SQLException

Adds a new Administrator to an Account.

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find the User

See Also:

• Administrator
• Account
• User.addAdministrator(java.lang.String, java.lang.String, java.sql.Date, boolean, java.lang.String, java.lang.String, java.lang.String, java.lang.String, com.aoapps.net.Email, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean)

addProfile

public int addProfile(Account.Name business,
 String name,
 boolean isPrivate,
 String phone,
 String fax,
 String address1,
 String address2,
 String city,
 String state,
 String country,
 String zip,
 boolean sendInvoice,
 String billingContact,
 Set<Email> billingEmail,
 String billingEmailFormat,
 String technicalContact,
 Set<Email> technicalEmail,
 String technicalEmailFormat)
               throws IllegalArgumentException,
IOException,
SQLException

Adds a new Profile to an Account. The profile is a complete set of contact information about a business. New profiles can be added, and they are used as the contact information, but old profiles are still available.

Throws:

IllegalArgumentException - if unable to find the Account

IOException

SQLException

See Also:

• Profile
• Account
• Account.addProfile(java.lang.String, boolean, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, java.lang.String, java.util.Set<com.aoapps.net.Email>, com.aoindustries.aoserv.client.account.Profile.EmailFormat, java.lang.String, java.util.Set<com.aoapps.net.Email>, com.aoindustries.aoserv.client.account.Profile.EmailFormat)

addAccountHost

public int addAccountHost(Account.Name accounting,
 String host)
                   throws IllegalArgumentException,
SQLException,
IOException

Grants an Account access to a Host.

Parameters:

accounting - the accounting code of the business

host - the hostname of the server

Returns:

the pkey of the new AccountHost

Throws:

IOException - if unable to communicate with the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the business or server

See Also:

• AccountHost
• Account.addAccountHost(com.aoindustries.aoserv.client.net.Host)

addCvsRepository

public int addCvsRepository(String aoServer,
 PosixPath path,
 User.Name username,
 Group.Name group,
 long mode)
                     throws IllegalArgumentException,
IOException,
SQLException

Adds a new CvsRepository to a Server.

Parameters:

aoServer - the hostname of the server

path - the full path of the repository

username - the name of the shell account that owns the directory

group - the group that owns the directory

mode - the permissions of the directory

Returns:

the id of the new CvsRepository

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Server, UserServer, or GroupServer

See Also:

• Server.addCvsRepository(com.aoindustries.aoserv.client.linux.PosixPath, com.aoindustries.aoserv.client.linux.UserServer, com.aoindustries.aoserv.client.linux.GroupServer, long)

addDnsRecord

public int addDnsRecord(String zone,
 String domain,
 String type,
 int priority,
 int weight,
 int port,
 short flag,
 String tag,
 String destination,
 int ttl)
                 throws IllegalArgumentException,
IOException,
SQLException

Adds a new Record to a Zone. Each Zone can have multiple DNS records in it, each being a Record.

Parameters:

zone - the zone, in the name.topleveldomain. format. Please note the trailing period (.)

domain - the part of the name before the zone or @ for the zone itself. For example, the domain for the hostname of www.aoindustries.com. in the aoindustries.com. zone is www.

type - the RecordType

priority - if a RecordType.MX or RecordType.SRV type, then the value is the priority of the record, otherwise it is Record.NO_PRIORITY.

weight - if a RecordType.SRV type, then the value is the weight of the record, otherwise it is Record.NO_WEIGHT.

port - if a RecordType.SRV type, then the value is the port of the record, otherwise it is Record.NO_PORT.

Returns:

the id of the new Record

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if the priority is provided for a non-RecordType.MX and non-RecordType.SRV record, the priority is not provided for a RecordType.MX or RecordType.SRV record, if the weight is provided for a non-RecordType.SRV record, the weight is not provided for a RecordType.SRV record, if the port is provided for a non-RecordType.SRV record, the port is not provided for a RecordType.SRV record, the destination is not the correct format for the RecordType, or unable to find the Zone or RecordType

See Also:

• Zone.addDnsRecord(java.lang.String, com.aoindustries.aoserv.client.dns.RecordType, int, int, int, short, java.lang.String, java.lang.String, int)
• Record
• addDnsZone(com.aoindustries.aoserv.client.account.Account.Name, java.lang.String, com.aoapps.net.InetAddress, int)
• RecordType.checkDestination(java.lang.String, java.lang.String)

addDnsZone

public void addDnsZone(Account.Name packageName,
 String zone,
 InetAddress ip,
 int ttl)
                throws IllegalArgumentException,
IOException,
SQLException

Adds a new Zone to a system. A Zone is one unique domain in the name servers. It is always one host up from a top level domain. In mydomain.com. com is the top level domain, which are defined by TopLevelDomains.

Parameters:

packageName - the name of the Package that owns this domain

zone - the complete domain of the new Zone

ip - the IP address that will be used for the default Records

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Package or either parameter is not in the proper format.

See Also:

• Package.addDnsZone(java.lang.String, com.aoapps.net.InetAddress, int)
• Zone
• addDnsRecord(java.lang.String, java.lang.String, java.lang.String, int, int, int, short, java.lang.String, java.lang.String, int)
• IpAddress
• TopLevelDomain

addEmailForwarding

public int addEmailForwarding(String address,
 DomainName domain,
 String aoServer,
 Email destination)
                       throws IllegalArgumentException,
IOException,
SQLException

Forwards email addressed to an address at a Domain to a different email address. The destination email address may be any email address, not just those in a Domain.

Parameters:

address - the part of the email address before the @

domain - the part of the email address after the @

aoServer - the hostname of the server hosting the domain

destination - the completed email address of the final delivery address

Throws:

IOException - if unable to communicate with the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable find the Domain

See Also:

• Address.addEmailForwarding(com.aoapps.net.Email)
• Domain

addEmailList

public int addEmailList(String aoServer,
 PosixPath path,
 User.Name username,
 Group.Name group)
                 throws IllegalArgumentException,
IOException,
SQLException

Adds a new List to the system. When an email is sent to an List, it is immediately forwarded to all addresses contained in the list. The list may accept mail on any number of addresses and forward to any number of recipients.

Even though the List may receive email on any number of addresses, each address must be part of a Domain that is hosted on the same Server as the List. If email in a domain on another Server is required to be sent to this list, it must be forwarded from the other Server via a Forwarding.

The list of destinations for the List is stored on the Server in a flat file of one address per line. This file may be either manipulated through the API or used directly on the filesystem.

Parameters:

aoServer - the hostname of the server the list is hosted on

path - the name of the file that stores the list

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find find the Server, UserServer, or GroupServer

See Also:

• checkEmailListPath(java.lang.String, com.aoindustries.aoserv.client.linux.PosixPath)
• addEmailListAddress(java.lang.String, com.aoapps.net.DomainName, com.aoindustries.aoserv.client.linux.PosixPath, java.lang.String)
• ListAddress
• Domain
• Forwarding
• Host
• UserServer
• GroupServer

addEmailListAddress

public int addEmailListAddress(String address,
 DomainName domain,
 PosixPath path,
 String aoServer)
                        throws IllegalArgumentException,
IOException,
SQLException

Adds to the list of Address to which the List will accept mail.

Parameters:

address - the part of the email address before the @

domain - the part of the email address after the @

path - the path of the list

aoServer - the hostname of the server

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Domain or List

See Also:

• addEmailList(java.lang.String, com.aoindustries.aoserv.client.linux.PosixPath, com.aoindustries.aoserv.client.linux.User.Name, com.aoindustries.aoserv.client.linux.Group.Name)
• List
• Address
• Domain

addEmailPipe

public int addEmailPipe(String aoServer,
 String command,
 Account.Name packageName)
                 throws IllegalArgumentException,
IOException,
SQLException

Adds a new Pipe to the system. When an email is sent to an Pipe, a process is invoked with the email pipes into the process' standard input.

Parameters:

aoServer - the hostname of the server that the process exists on

command - the full command line of the program to launch

packageName - the package that this Pipe belongs to

Returns:

the pkey of the new pipe

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find find the Server or Package

See Also:

• addEmailPipeAddress(java.lang.String, com.aoapps.net.DomainName, int)
• Server.addEmailPipe(java.lang.String, com.aoindustries.aoserv.client.billing.Package)

addEmailPipeAddress

public int addEmailPipeAddress(String address,
 DomainName domain,
 int pkey)
                        throws IllegalArgumentException,
IOException,
SQLException

Adds an address to the list of email addresses that will be piped to an Pipe.

Parameters:

address - the part of the email address before the @

domain - the part of the email address after the @

pkey - the pkey of the List

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Domain or Pipe

See Also:

• addEmailPipe(java.lang.String, java.lang.String, com.aoindustries.aoserv.client.account.Account.Name)
• Pipe
• Address
• Domain

addFileBackupSetting

public int addFileBackupSetting(int replication,
 String path,
 boolean backupEnabled,
 boolean required)
                         throws IllegalArgumentException,
IOException,
SQLException

Adds a FileReplicationSetting to a FileReplication.

Parameters:

replication - the pkey of the FailoverFileReplication

path - the path that is being configured

backupEnabled - the enabled flag for the prefix

Returns:

the pkey of the newly created FileReplicationSetting

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the FileReplication, or Package

See Also:

• FileReplication.addFileBackupSetting(java.lang.String, boolean, boolean)
• FileReplicationSetting

addFtpGuestUser

public void addFtpGuestUser(User.Name username)
                     throws IllegalArgumentException,
IOException,
SQLException

Flags a User as being a GuestUser. Once flagged, FTP connections as that user will be limited to transfers in their home directory.

Parameters:

username - the username of the User

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the User

See Also:

• addLinuxAccount(com.aoindustries.aoserv.client.linux.User.Name, com.aoindustries.aoserv.client.linux.Group.Name, com.aoindustries.aoserv.client.linux.User.Gecos, com.aoindustries.aoserv.client.linux.User.Gecos, com.aoindustries.aoserv.client.linux.User.Gecos, com.aoindustries.aoserv.client.linux.User.Gecos, java.lang.String, com.aoindustries.aoserv.client.linux.PosixPath)
• User.addFtpGuestUser()

addHttpdJbossSite

public int addHttpdJbossSite(String aoServer,
 String siteName,
 Account.Name packageName,
 User.Name jvmUsername,
 Group.Name groupName,
 Email serverAdmin,
 boolean useApache,
 InetAddress ipAddress,
 String netDevice,
 DomainName primaryHttpHostname,
 DomainName[] altHttpHostnames,
 String jbossVersion)
                      throws IllegalArgumentException,
SQLException,
IOException

Adds a new Site to the system. An Site is an Site that uses the Tomcat servlet engine and JBoss as an EJB container.

Parameters:

aoServer - the hostname of the Server

siteName - the name of the PrivateTomcatSite

packageName - the name of the Package

jvmUsername - the username of the User that the Java VM will run as

groupName - the name of the Group that the web site will be owned by

serverAdmin - the email address of the person who is responsible for the site content and reliability

useApache - instructs the system to host static content, shtml, CGI, and PHP using Apache, comes at the price of less request control through Tomcat

ipAddress - the IpAddress that the web site will bind to. In order for HTTP requests to succeed, Record entries must point the hostnames of this PrivateTomcatSite to this IpAddress. If null, the system will assign a shared IP address.

primaryHttpHostname - the primary hostname of the PrivateTomcatSite for the HTTP protocol

altHttpHostnames - any number of alternate hostnames for the HTTP protocol or null for none

jbossVersion - the version number of JBoss to install in the site

Returns:

the id of the new PrivateTomcatSite

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find a referenced object or a parameter is not in the right format

See Also:

• Site

addHttpdSharedTomcat

public int addHttpdSharedTomcat(String name,
 String aoServer,
 String version,
 User.Name linuxServerAccount,
 Group.Name linuxServerGroup)
                         throws IllegalArgumentException,
SQLException,
IOException

Adds a new SharedTomcat to a server.

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find the UserServer, the GroupServer, or the Server

See Also:

• SharedTomcat
• UserServer
• GroupServer
• Host

addVirtualHostName

public int addVirtualHostName(int hsbPkey,
 DomainName hostname)
                       throws IllegalArgumentException,
IOException,
SQLException

Adds a new VirtualHostName to a VirtualHost.

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find the VirtualHost

addHttpdSiteAuthenticatedLocation

public int addHttpdSiteAuthenticatedLocation(String siteName,
 String aoServer,
 String path,
 boolean isRegularExpression,
 String authName,
 PosixPath authGroupFile,
 PosixPath authUserFile,
 String require,
 String handler)
                                      throws IllegalArgumentException,
IOException,
SQLException

Adds a new Location to a Site.

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find the Site

setHttpdSiteAuthenticatedLocationAttributes

public void setHttpdSiteAuthenticatedLocationAttributes(String siteName,
 String aoServer,
 String path,
 boolean isRegularExpression,
 String authName,
 PosixPath authGroupFile,
 PosixPath authUserFile,
 String require,
 String handler)
                                                 throws IllegalArgumentException,
IOException,
SQLException

Updates a Location.

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find the Site

addHttpdTomcatContext

public int addHttpdTomcatContext(String siteName,
 String aoServer,
 String className,
 boolean cookies,
 boolean crossContext,
 PosixPath docBase,
 boolean override,
 String path,
 boolean privileged,
 boolean reloadable,
 boolean useNaming,
 String wrapperClass,
 int debug,
 PosixPath workDir,
 boolean serverXmlConfigured)
                          throws IllegalArgumentException,
IOException,
SQLException

Adds a new Context to a Site.

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find the Server, Site, or Site

addHttpdTomcatDataSource

public int addHttpdTomcatDataSource(String siteName,
 String aoServer,
 String path,
 String name,
 String driverClassName,
 String url,
 String username,
 String password,
 int maxActive,
 int maxIdle,
 int maxWait,
 String validationQuery)
                             throws IllegalArgumentException,
IOException,
SQLException

Adds a new data source to a Context.

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find the Server, Site, Site or Context.

addHttpdTomcatParameter

public int addHttpdTomcatParameter(String siteName,
 String aoServer,
 String path,
 String name,
 String value,
 boolean override,
 String description)
                            throws IllegalArgumentException,
IOException,
SQLException

Adds a new parameter to a Context.

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find the Server, Site, Site or Context.

addHttpdTomcatSiteJkMount

public int addHttpdTomcatSiteJkMount(String siteName,
 String aoServer,
 String path,
 boolean mount)
                              throws IllegalArgumentException,
IOException,
SQLException

Adds a new JkMount to a Site.

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find the Server, Site, or Site

See Also:

• Site.addJkMount(java.lang.String, boolean)

removeHttpdTomcatSiteJkMount

public void removeHttpdTomcatSiteJkMount(String siteName,
 String aoServer,
 String path)
                                  throws IllegalArgumentException,
IOException,
SQLException

Removes a JkMount from a Site.

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find the Server, Site, or Site

See Also:

• JkMount.remove()

addHttpdTomcatSharedSite

public int addHttpdTomcatSharedSite(String aoServer,
 String siteName,
 Account.Name packageName,
 User.Name jvmUsername,
 Group.Name groupName,
 Email serverAdmin,
 boolean useApache,
 InetAddress ipAddress,
 String netDevice,
 DomainName primaryHttpHostname,
 DomainName[] altHttpHostnames,
 String sharedTomcatName)
                             throws IllegalArgumentException,
SQLException,
IOException

Adds a new SharedTomcatSite to the system. An SharedTomcatSite is an Site that uses a shared Tomcat servlet engine in a virtual-hosting configuration. It hosts multiple sites per Java VM.

Parameters:

aoServer - the hostname of the Server

siteName - the name of the SharedTomcatSite

packageName - the name of the Package

jvmUsername - the username of the User that the Java VM will run as

groupName - the name of the Group that the web site will be owned by

serverAdmin - the email address of the person who is responsible for the site content and reliability

useApache - instructs the system to host static content, shtml, CGI, and PHP using Apache, comes at the price of less request control through Tomcat

ipAddress - the IpAddress that the web site will bind to. In order for HTTP requests to succeed, Record entries must point the hostnames of this SharedTomcatSite to this IpAddress. If null, the system will assign a shared IP address.

primaryHttpHostname - the primary hostname of the SharedTomcatSite for the HTTP protocol

altHttpHostnames - any number of alternate hostnames for the HTTP protocol or null for none

sharedTomcatName - the shared Tomcat JVM under which this site runs

Returns:

the id of the new SharedTomcatSite

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find a referenced object or a parameter is not in the right format

See Also:

• Server.addHttpdTomcatSharedSite(java.lang.String, com.aoindustries.aoserv.client.billing.Package, com.aoindustries.aoserv.client.linux.User, com.aoindustries.aoserv.client.linux.Group, com.aoapps.net.Email, boolean, com.aoindustries.aoserv.client.net.IpAddress, com.aoapps.net.DomainName, com.aoapps.net.DomainName[], java.lang.String)
• SharedTomcatSite
• Site
• Site

addHttpdTomcatStdSite

public int addHttpdTomcatStdSite(String aoServer,
 String siteName,
 Account.Name packageName,
 User.Name jvmUsername,
 Group.Name groupName,
 Email serverAdmin,
 boolean useApache,
 InetAddress ipAddress,
 String netDevice,
 DomainName primaryHttpHostname,
 DomainName[] altHttpHostnames,
 String tomcatVersion)
                          throws IllegalArgumentException,
SQLException,
IOException

Adds a new PrivateTomcatSite to the system. An PrivateTomcatSite is an Site that contains a Tomcat servlet engine in the standard configuration. It only hosts one site per Java VM, but is arranged in the stock Tomcat structure and uses no special code.

Parameters:

aoServer - the hostname of the Server

siteName - the name of the PrivateTomcatSite

packageName - the name of the Package

jvmUsername - the username of the User that the Java VM will run as

groupName - the name of the Group that the web site will be owned by

serverAdmin - the email address of the person who is responsible for the site content and reliability

useApache - instructs the system to host static content, shtml, CGI, and PHP using Apache, comes at the price of less request control through Tomcat

ipAddress - the IpAddress that the web site will bind to. In order for HTTP requests to succeed, Record entries must point the hostnames of this PrivateTomcatSite to this IpAddress. If null, the system will assign a shared IP address.

primaryHttpHostname - the primary hostname of the PrivateTomcatSite for the HTTP protocol

altHttpHostnames - any number of alternate hostnames for the HTTP protocol or null for none

tomcatVersion - the version number of Tomcat to install in the site

Returns:

the id of the new PrivateTomcatSite

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find a referenced object or a parameter is not in the right format

See Also:

• Server.addHttpdTomcatStdSite(java.lang.String, com.aoindustries.aoserv.client.billing.Package, com.aoindustries.aoserv.client.linux.User, com.aoindustries.aoserv.client.linux.Group, com.aoapps.net.Email, boolean, com.aoindustries.aoserv.client.net.IpAddress, com.aoapps.net.DomainName, com.aoapps.net.DomainName[], com.aoindustries.aoserv.client.web.tomcat.Version)
• PrivateTomcatSite
• Site
• Site

addLinuxAccAddress

public int addLinuxAccAddress(String address,
 DomainName domain,
 String aoServer,
 User.Name username)
                       throws IllegalArgumentException,
IOException,
SQLException

Adds an Address to a User. Not all Users may be used as an email inbox. The UserType of the account determines which accounts may store email. When email is allowed for the account, an Address is associated with the account as a InboxAddress.

Parameters:

address - the part of the email address before the @

domain - the part of the email address after the @

aoServer - the hostname of the server storing the email account

username - the username of the User to route the emails to

Returns:

the pkey of the new LinuxAccAddress

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Domain or User

See Also:

• UserServer.addEmailAddress(com.aoindustries.aoserv.client.email.Address)
• InboxAddress
• addLinuxAccount(com.aoindustries.aoserv.client.linux.User.Name, com.aoindustries.aoserv.client.linux.Group.Name, com.aoindustries.aoserv.client.linux.User.Gecos, com.aoindustries.aoserv.client.linux.User.Gecos, com.aoindustries.aoserv.client.linux.User.Gecos, com.aoindustries.aoserv.client.linux.User.Gecos, java.lang.String, com.aoindustries.aoserv.client.linux.PosixPath)
• addEmailDomain(com.aoapps.net.DomainName, java.lang.String, com.aoindustries.aoserv.client.account.Account.Name)
• Address

addLinuxAccount

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

Adds a new User the system. A User does not grant access to any servers, addLinuxServerAccount(com.aoindustries.aoserv.client.linux.User.Name, java.lang.String, com.aoindustries.aoserv.client.linux.PosixPath) must be used after the User has been created.

Parameters:

username - the username of the new User

primaryGroup - the primary group of the new account

name - the account's full name

officeLocation - optional office location available via the Unix finger command

officePhone - optional phone number available via the Unix finger command

homePhone - optional home phone number available vie the Unix finger command

type - the UserType

shell - the login Shell

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if the name is not a valid format or unable to find the User, UserType, or Shell

See Also:

• User.addLinuxAccount(com.aoindustries.aoserv.client.linux.Group, com.aoindustries.aoserv.client.linux.User.Gecos, com.aoindustries.aoserv.client.linux.User.Gecos, com.aoindustries.aoserv.client.linux.User.Gecos, com.aoindustries.aoserv.client.linux.User.Gecos, com.aoindustries.aoserv.client.linux.UserType, com.aoindustries.aoserv.client.linux.Shell)
• addUsername(com.aoindustries.aoserv.client.account.Account.Name, com.aoindustries.aoserv.client.account.User.Name)
• addLinuxServerAccount(com.aoindustries.aoserv.client.linux.User.Name, java.lang.String, com.aoindustries.aoserv.client.linux.PosixPath)
• User
• UserType
• UserServer

addLinuxGroup

public void addLinuxGroup(Group.Name name,
 Account.Name packageName,
 String type)
                   throws IllegalArgumentException,
IOException,
SQLException

Adds a Group to the system. After adding the Group, the group may be added to a Server via a GroupServer. Also, Users may be granted access to the group using GroupUser.

Parameters:

name - the name of the new Group

packageName - the name of the Package that the group belongs to

type - the GroupType

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Package or GroupType

See Also:

• Package.addLinuxGroup(com.aoindustries.aoserv.client.linux.Group.Name, com.aoindustries.aoserv.client.linux.GroupType)
• Group
• GroupType
• Package
• addLinuxServerGroup(com.aoindustries.aoserv.client.linux.Group.Name, java.lang.String)
• addLinuxGroupAccount(com.aoindustries.aoserv.client.linux.Group.Name, com.aoindustries.aoserv.client.linux.User.Name)

addLinuxGroupAccount

public int addLinuxGroupAccount(Group.Name group,
 User.Name username)
                         throws IllegalArgumentException,
IOException,
SQLException

Once a User and a Group have been established, permission for the User to access the Group may be granted using a GroupUser.

Parameters:

group - the name of the Group

username - the username of the User

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Group or User

See Also:

• Group.addLinuxAccount(com.aoindustries.aoserv.client.linux.User)
• GroupUser
• Group
• User
• UserServer
• GroupServer

addLinuxServerAccount

public int addLinuxServerAccount(User.Name username,
 String aoServer,
 PosixPath home)
                          throws IllegalArgumentException,
IOException,
SQLException

Grants a User access to a Server. The primary Group for this account must already have a GroupServer for the Server.

Parameters:

username - the username of the User

aoServer - the hostname of the Server

home - the home directory of the user, typically /home/username. If null, the default home directory for username is used.

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the User, Host or Server

See Also:

• User.addLinuxServerAccount(com.aoindustries.aoserv.client.linux.Server, com.aoindustries.aoserv.client.linux.PosixPath)
• addLinuxAccount(com.aoindustries.aoserv.client.linux.User.Name, com.aoindustries.aoserv.client.linux.Group.Name, com.aoindustries.aoserv.client.linux.User.Gecos, com.aoindustries.aoserv.client.linux.User.Gecos, com.aoindustries.aoserv.client.linux.User.Gecos, com.aoindustries.aoserv.client.linux.User.Gecos, java.lang.String, com.aoindustries.aoserv.client.linux.PosixPath)
• addLinuxGroupAccount(com.aoindustries.aoserv.client.linux.Group.Name, com.aoindustries.aoserv.client.linux.User.Name)
• addLinuxServerGroup(com.aoindustries.aoserv.client.linux.Group.Name, java.lang.String)
• Server

addLinuxServerGroup

public int addLinuxServerGroup(Group.Name group,
 String aoServer)
                        throws IllegalArgumentException,
IOException,
SQLException

Grants a Group access to a Server. If the group is the primary Group for any User that will be added to the Server, the Group must be added to the Server first via a GroupServer.

Parameters:

group - the name of the Group

aoServer - the hostname of the Server

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Group or Server

See Also:

• Group.addLinuxServerGroup(com.aoindustries.aoserv.client.linux.Server)
• addLinuxGroup(com.aoindustries.aoserv.client.linux.Group.Name, com.aoindustries.aoserv.client.account.Account.Name, java.lang.String)
• addLinuxGroupAccount(com.aoindustries.aoserv.client.linux.Group.Name, com.aoindustries.aoserv.client.linux.User.Name)
• Host

addMajordomoList

public int addMajordomoList(DomainName domain,
 String aoServer,
 String listName)
                     throws IllegalArgumentException,
IOException,
SQLException

Adds a new MajordomoList to a MajordomoServer.

Parameters:

domain - the domain of the MajordomoServer

aoServer - the hostname of the Server

listName - the name of the new list

Returns:

the pkey of the new List

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if the name is not valid or unable to find the Server, Domain, or MajordomoServer

See Also:

• MajordomoServer.addMajordomoList(java.lang.String)
• removeEmailList(com.aoindustries.aoserv.client.linux.PosixPath, java.lang.String)

addMajordomoServer

public void addMajordomoServer(DomainName domain,
 String aoServer,
 User.Name linuxAccount,
 Group.Name linuxGroup,
 String version)
                        throws IllegalArgumentException,
IOException,
SQLException

Adds a new MajordomoServer to an Domain.

Parameters:

domain - the domain of the Domain

aoServer - the hostname of the Server

linuxAccount - the username of the User

linuxGroup - the naem of the Group

version - the version of the MajordomoVersion

Throws:

IllegalArgumentException - if unable to find the Server, Domain, UserServer, GroupServer, or MajordomoVersion

IOException

SQLException

See Also:

• Domain.addMajordomoServer(com.aoindustries.aoserv.client.linux.UserServer, com.aoindustries.aoserv.client.linux.GroupServer, com.aoindustries.aoserv.client.email.MajordomoVersion)
• removeMajordomoServer(com.aoapps.net.DomainName, java.lang.String)

addMysqlDatabase

public int addMysqlDatabase(Database.Name name,
 Server.Name mysqlServer,
 String aoServer,
 Account.Name packageName)
                     throws IllegalArgumentException,
IOException,
SQLException

Adds a new Database to the system. Once added, Users may be granted access to the Database using a DatabaseUser.

Because updates the the MySQL configurations are batched, the database may not be immediately created in the MySQL system. To ensure the database is ready for use, call waitForMysqlDatabaseRebuild(java.lang.String).

Parameters:

name - the name of the new database

aoServer - the hostname of the Server

packageName - the name of the Package that owns the database

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if the database name is not valid or unable to find the Server or Package

See Also:

• Server.addMysqlDatabase(com.aoindustries.aoserv.client.mysql.Database.Name, com.aoindustries.aoserv.client.billing.Package)
• addMysqlUser(com.aoindustries.aoserv.client.mysql.User.Name)
• addMysqlServerUser(com.aoindustries.aoserv.client.mysql.User.Name, com.aoindustries.aoserv.client.mysql.Server.Name, java.lang.String, java.lang.String)
• addMysqlDbUser(com.aoindustries.aoserv.client.mysql.Database.Name, com.aoindustries.aoserv.client.mysql.Server.Name, java.lang.String, com.aoindustries.aoserv.client.mysql.User.Name, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean)
• removeMysqlDatabase(com.aoindustries.aoserv.client.mysql.Database.Name, com.aoindustries.aoserv.client.mysql.Server.Name, java.lang.String)
• waitForMysqlDatabaseRebuild(java.lang.String)

addMysqlDbUser

public int addMysqlDbUser(Database.Name name,
 Server.Name mysqlServer,
 String aoServer,
 User.Name username,
 boolean canSelect,
 boolean canInsert,
 boolean canUpdate,
 boolean canDelete,
 boolean canCreate,
 boolean canDrop,
 boolean canReference,
 boolean canIndex,
 boolean canAlter,
 boolean canCreateTempTable,
 boolean canLockTables,
 boolean canCreateView,
 boolean canShowView,
 boolean canCreateRoutine,
 boolean canAlterRoutine,
 boolean canExecute,
 boolean canEvent,
 boolean canTrigger)
                   throws IllegalArgumentException,
IOException,
SQLException

Grants a UserServer permission to access a Database.

Parameters:

name - the name of the Database

aoServer - the hostname of the Server

username - the username of the User

canSelect - grants the user SELECT privileges

canInsert - grants the user INSERT privileges

canUpdate - grants the user UPDATE privileges

canDelete - grants the user DELETE privileges

canCreate - grants the user CREATE privileges

canDrop - grants the user DROP privileges

canIndex - grants the user INDEX privileges

canAlter - grants the user ALTER privileges

canCreateTempTable - grants the user CREATE TEMPORARY TABLE privileges

canLockTables - grants the user LOCK TABLE privileges

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Server, Database, or UserServer

See Also:

• Database.addMysqlServerUser(com.aoindustries.aoserv.client.mysql.UserServer, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean)
• addMysqlUser(com.aoindustries.aoserv.client.mysql.User.Name)
• addMysqlServerUser(com.aoindustries.aoserv.client.mysql.User.Name, com.aoindustries.aoserv.client.mysql.Server.Name, java.lang.String, java.lang.String)
• addMysqlDatabase(com.aoindustries.aoserv.client.mysql.Database.Name, com.aoindustries.aoserv.client.mysql.Server.Name, java.lang.String, com.aoindustries.aoserv.client.account.Account.Name)

addMysqlServerUser

public int addMysqlServerUser(User.Name username,
 Server.Name mysqlServer,
 String aoServer,
 String host)
                       throws IllegalArgumentException,
IOException,
SQLException

Grants a User access to a Server by adding a UserServer.

Parameters:

username - the username of the User

aoServer - the hostname of the Server

host - the host the user is allowed to connect from, almost always UserServer.ANY_LOCAL_HOST because the host limitation is provided on a per-database level by DatabaseUser

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the User or Server

See Also:

• User.addMysqlServerUser(com.aoindustries.aoserv.client.mysql.Server, java.lang.String)
• UserServer.ANY_LOCAL_HOST
• addMysqlUser(com.aoindustries.aoserv.client.mysql.User.Name)
• addMysqlDbUser(com.aoindustries.aoserv.client.mysql.Database.Name, com.aoindustries.aoserv.client.mysql.Server.Name, java.lang.String, com.aoindustries.aoserv.client.mysql.User.Name, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean)

addMysqlUser

public void addMysqlUser(User.Name username)
                  throws IllegalArgumentException,
IOException,
SQLException

Adds a User to the system. A User does not exist on any Server, it merely indicates that a User will be used for accessing a Database. In order to grant the new User access to a Database, first add a UserServer on the same Server as the Database, then add a DatabaseUser granting permission to the Database.

Parameters:

username - the User that will be used for accessing MySQL

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the User

See Also:

• User.addMysqlUser()
• addUsername(com.aoindustries.aoserv.client.account.Account.Name, com.aoindustries.aoserv.client.account.User.Name)
• addMysqlServerUser(com.aoindustries.aoserv.client.mysql.User.Name, com.aoindustries.aoserv.client.mysql.Server.Name, java.lang.String, java.lang.String)
• addMysqlDatabase(com.aoindustries.aoserv.client.mysql.Database.Name, com.aoindustries.aoserv.client.mysql.Server.Name, java.lang.String, com.aoindustries.aoserv.client.account.Account.Name)
• addMysqlDbUser(com.aoindustries.aoserv.client.mysql.Database.Name, com.aoindustries.aoserv.client.mysql.Server.Name, java.lang.String, com.aoindustries.aoserv.client.mysql.User.Name, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean)
• User

addNetBind

public int addNetBind(String server,
 Account.Name packageName,
 InetAddress ipAddress,
 String netDevice,
 Port port,
 String appProtocol,
 boolean monitoringEnabled,
 Set<FirewallZone.Name> firewalldZoneNames)
               throws IllegalArgumentException,
SQLException,
IOException

Adds a network bind to the system.

Throws:

IOException - if unable to access the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find a referenced object.

See Also:

• Host.addNetBind(com.aoindustries.aoserv.client.billing.Package, com.aoindustries.aoserv.client.net.IpAddress, com.aoapps.net.Port, com.aoindustries.aoserv.client.net.AppProtocol, boolean, java.util.Set<com.aoindustries.aoserv.client.net.FirewallZone.Name>)

addNoticeLog

public int addNoticeLog(Account.Name accounting,
 String billingContact,
 Email emailAddress,
 String type,
 int transid)
                 throws IllegalArgumentException,
IOException,
SQLException

Whenever a credit card transaction fails, or when an account has not been paid for over month, the billing contact for the Account is notified. The details of this notification are logged as a NoticeLog.

Parameters:

accounting - the accounting code of the Account

billingContact - the name of the person who was contacted

emailAddress - the email address that the email was sent to

type - the NoticeType

transid - the transaction ID associated with this notification or NoticeLog.NO_TRANSACTION for none

Throws:

IOException - if unable to access the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find the Account, NoticeType, or Transaction.

See Also:

• NoticeLogTable.addNoticeLog(com.aoindustries.aoserv.client.account.Account, java.lang.String, com.aoapps.net.Email, com.aoindustries.aoserv.client.billing.NoticeType, com.aoindustries.aoserv.client.billing.Transaction)
• NoticeType
• Account
• Transaction

addPackage

public int addPackage(Account.Name packageName,
 Account.Name accounting,
 int packageDefinition)
               throws IllegalArgumentException,
IOException,
SQLException

Each Account can have multiple Packages associated with it. Each Package is an allotment of resources with a monthly charge.

To determine if this connection can set prices:

SimpleAoservClient client=new SimpleAoservClient();

 boolean canSetPrices=client
     .getConnector()
     .getCurrentAdministrator()
     .getUsername()
     .getPackage()
     .getAccount()
     .canSetPrices();

Parameters:

packageName - the name for the new package

accounting - the accounting code of the Account

packageDefinition - the unique identifier of the PackageDefinition

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find

See Also:

• addAccount(com.aoindustries.aoserv.client.account.Account.Name, java.lang.String, java.lang.String, com.aoindustries.aoserv.client.account.Account.Name, boolean, boolean, boolean, boolean)
• PackageDefinition

addPostgresDatabase

public int addPostgresDatabase(Database.Name name,
 Server.Name postgresServer,
 String aoServer,
 User.Name datdba,
 String encoding,
 boolean enablePostgis)
                        throws IllegalArgumentException,
SQLException,
IOException

Adds a new Database to the system.

Because updates the the PostgreSQL configurations are batched, the database may not be immediately created in the PostgreSQL system. To ensure the database is ready for use, call waitForPostgresDatabaseRebuild(java.lang.String).

Parameters:

name - the name of the new database

aoServer - the hostname of the Server

datdba - the username of the UserServer who owns the database

encoding - the encoding of the database

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if the database name is not valid or unable to find the Server, User, UserServer, or Encoding

See Also:

• Server.addPostgresDatabase(com.aoindustries.aoserv.client.postgresql.Database.Name, com.aoindustries.aoserv.client.postgresql.UserServer, com.aoindustries.aoserv.client.postgresql.Encoding, boolean)
• addPostgresUser(com.aoindustries.aoserv.client.postgresql.User.Name)
• addPostgresServerUser(com.aoindustries.aoserv.client.postgresql.User.Name, com.aoindustries.aoserv.client.postgresql.Server.Name, java.lang.String)
• removePostgresDatabase(com.aoindustries.aoserv.client.postgresql.Database.Name, com.aoindustries.aoserv.client.postgresql.Server.Name, java.lang.String)
• waitForPostgresDatabaseRebuild(java.lang.String)
• Encoding

addPostgresServerUser

public int addPostgresServerUser(User.Name username,
 Server.Name postgresServer,
 String aoServer)
                          throws IllegalArgumentException,
IOException,
SQLException

Grants a User access to a Server by adding a UserServer.

Parameters:

username - the username of the User

postgresServer - the name of the PostgreSQL server

aoServer - the hostname of the Server

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the User or Server

See Also:

• User.addPostgresServerUser(com.aoindustries.aoserv.client.postgresql.Server)
• addPostgresUser(com.aoindustries.aoserv.client.postgresql.User.Name)

addPostgresUser

public void addPostgresUser(User.Name username)
                     throws IllegalArgumentException,
IOException,
SQLException

Adds a User to the system. A User does not exist on any Server, it merely indicates that a User will be used for accessing a Database. In order to grant the new User access to a Database, first add a UserServer on the same Server as the Database, then use the PostgreSQL grant and revoke commands.

Parameters:

username - the User that will be used for accessing PostgreSQL

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the User

See Also:

• User.addPostgresUser()
• addUsername(com.aoindustries.aoserv.client.account.Account.Name, com.aoindustries.aoserv.client.account.User.Name)
• addPostgresServerUser(com.aoindustries.aoserv.client.postgresql.User.Name, com.aoindustries.aoserv.client.postgresql.Server.Name, java.lang.String)
• addPostgresDatabase(com.aoindustries.aoserv.client.postgresql.Database.Name, com.aoindustries.aoserv.client.postgresql.Server.Name, java.lang.String, com.aoindustries.aoserv.client.postgresql.User.Name, java.lang.String, boolean)
• User

addEmailDomain

public int addEmailDomain(DomainName domain,
 String aoServer,
 Account.Name packageName)
                   throws IllegalArgumentException,
IOException,
SQLException

Adds a new Domain to a Server. Once added, the Server will accept email for the provided domain. In order for the email to function, however, a DNS RecordType.MX entry for the domain must point to a hostname that resolves to an IpAddress on the Server.

Parameters:

domain - the email domain that will be hosted

aoServer - the hostname of the Server that is being added

packageName - the name of the Package that owns the email domain

Throws:

IOException - if unable to access the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if the domain is not in the correct format or unable to find the Package

See Also:

• Server.addEmailDomain(com.aoapps.net.DomainName, com.aoindustries.aoserv.client.billing.Package)
• addDnsRecord(java.lang.String, java.lang.String, java.lang.String, int, int, int, short, java.lang.String, java.lang.String, int)
• addEmailForwarding(java.lang.String, com.aoapps.net.DomainName, java.lang.String, com.aoapps.net.Email)
• addEmailListAddress(java.lang.String, com.aoapps.net.DomainName, com.aoindustries.aoserv.client.linux.PosixPath, java.lang.String)
• addEmailPipeAddress(java.lang.String, com.aoapps.net.DomainName, int)
• addLinuxAccAddress(java.lang.String, com.aoapps.net.DomainName, java.lang.String, com.aoindustries.aoserv.client.linux.User.Name)

addEmailSmtpRelay

public int addEmailSmtpRelay(Account.Name packageName,
 String aoServer,
 HostAddress host,
 String type,
 long duration)
                      throws IllegalArgumentException,
SQLException,
IOException

Grants access to the SMTP server. Access to the SMTP server is granted when an email client successfully logs into either the IMAP or POP3 servers. If desired, access to the SMTP server may also be granted from the API. In either case, the SMTP access will be revoked after 24 hours unless refresh.

Parameters:

packageName - the name of the Package that is granted access

aoServer - the hostname of the Server

host - the hostname or IP address that is being configured

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if the IP address is for valid or unable to find the Package or Server

See Also:

• Package.addEmailSmtpRelay(com.aoindustries.aoserv.client.linux.Server, com.aoapps.net.HostAddress, com.aoindustries.aoserv.client.email.SmtpRelayType, long)

addSpamEmailMessage

public int addSpamEmailMessage(int emailRelay,
 String message)
                        throws IllegalArgumentException,
IOException,
SQLException

Adds a SpamMessage.

Returns:

the pkey of the SpamMessage that was created

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to the SmtpRelay

See Also:

• SmtpRelay.addSpamEmailMessage(java.lang.String)

addTransaction

public int addTransaction(int timeType,
 Timestamp time,
 Account.Name accountName,
 Account.Name sourceAccountName,
 User.Name administrator,
 String type,
 String description,
 int quantity,
 Money rate,
 String paymentType,
 String paymentInfo,
 String processor,
 byte paymentConfirmed)
                   throws IllegalArgumentException,
IOException,
SQLException

Adds a new Transaction to a Account.

Parameters:

accountName - the accounting code of the Account

sourceAccountName - the accounting code of the originating Account

administrator - the username of the Administrator making this Transaction

type - the type as found in PackageDefinitionLimit

description - the description

quantity - the quantity in thousandths

rate - the rate in hundredths

paymentConfirmed - the confirmation status of the transaction

Returns:

the transid of the new Transaction

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Server, Account, Administrator, PackageDefinitionLimit, PaymentType, or payment_confirmed

See Also:

• Account.addTransaction(int, java.sql.Timestamp, com.aoindustries.aoserv.client.account.Account, com.aoindustries.aoserv.client.account.Administrator, com.aoindustries.aoserv.client.billing.TransactionType, java.lang.String, int, com.aoapps.lang.i18n.Money, com.aoindustries.aoserv.client.payment.PaymentType, java.lang.String, com.aoindustries.aoserv.client.payment.Processor, byte)
• Transaction
• addAccount(com.aoindustries.aoserv.client.account.Account.Name, java.lang.String, java.lang.String, com.aoindustries.aoserv.client.account.Account.Name, boolean, boolean, boolean, boolean)
• Account
• addAdministrator(com.aoindustries.aoserv.client.account.User.Name, java.lang.String, java.lang.String, java.sql.Date, boolean, java.lang.String, java.lang.String, java.lang.String, java.lang.String, com.aoapps.net.Email, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean)
• Administrator
• TransactionType

addUsername

public void addUsername(Account.Name packageName,
 User.Name username)
                 throws IllegalArgumentException,
IOException,
SQLException

Adds a new User to a Package. A username is unique to the system, regardless of which service(s) it is used for. For example, if a username is allocated for use as a MySQL user for business A, business B may not use the username as a PostgreSQL user.

Parameters:

packageName - the name of the Package that owns the User

username - the username to add

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if the username is not a valid username or unable to find the Package

See Also:

• Package.addUsername(com.aoindustries.aoserv.client.account.User.Name)
• User
• addPackage(com.aoindustries.aoserv.client.account.Account.Name, com.aoindustries.aoserv.client.account.Account.Name, int)
• Package

areLinuxAccountPasswordsSet

public int areLinuxAccountPasswordsSet(User.Name username)
                                throws IllegalArgumentException,
IOException,
SQLException

Determines if a User currently has passwords set.

Parameters:

username - the username of the account

Returns:

an int containing PasswordProtected.NONE, PasswordProtected.SOME, or PasswordProtected.ALL

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if the User is not found

See Also:

• User.arePasswordsSet()
• setLinuxAccountPassword(com.aoindustries.aoserv.client.linux.User.Name, java.lang.String)
• User
• PasswordProtected

areMysqlUserPasswordsSet

public int areMysqlUserPasswordsSet(User.Name username)
                             throws IllegalArgumentException,
IOException,
SQLException

Determines if a User currently has passwords set.

Parameters:

username - the username of the user

Returns:

an int containing PasswordProtected.NONE, PasswordProtected.SOME, or PasswordProtected.ALL

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if the User is not found

See Also:

• User.arePasswordsSet()
• setMysqlUserPassword(com.aoindustries.aoserv.client.mysql.User.Name, java.lang.String)
• User
• PasswordProtected

arePostgresUserPasswordsSet

public int arePostgresUserPasswordsSet(User.Name username)
                                throws IllegalArgumentException,
IOException,
SQLException

Determines if a User currently has passwords set.

Parameters:

username - the username of the user

Returns:

an int containing PasswordProtected.NONE, PasswordProtected.SOME, or PasswordProtected.ALL

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if the User is not found

See Also:

• User.arePasswordsSet()
• setPostgresUserPassword(com.aoindustries.aoserv.client.postgresql.User.Name, java.lang.String)
• User
• PasswordProtected

areUsernamePasswordsSet

public int areUsernamePasswordsSet(User.Name username)
                            throws IllegalArgumentException,
IOException,
SQLException

Determines if a User currently has passwords set.

Parameters:

username - the username

Returns:

an int containing PasswordProtected.NONE, PasswordProtected.SOME, or PasswordProtected.ALL

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if the User is not found

See Also:

• User.arePasswordsSet()
• setUsernamePassword(com.aoindustries.aoserv.client.account.User.Name, java.lang.String)
• User
• PasswordProtected

cancelAccount

public void cancelAccount(Account.Name accounting,
 String reason)
                   throws IllegalArgumentException,
IOException,
SQLException

Cancels an Account. The Account must already be disabled.

Parameters:

accounting - the accounting code of the business

reason - the reason the account is being canceled

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Account

See Also:

• Account.cancel(java.lang.String)

checkAdministratorPassword

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

Checks the strength of a password that will be used for a Administrator.

Parameters:

username - the username of the Administrator whose password will be set

password - the new password

Returns:

a description of why the password is weak or null if all checks succeed

Throws:

IOException

See Also:

• setAdministratorPassword(com.aoindustries.aoserv.client.account.User.Name, java.lang.String)
• Administrator.checkPassword(java.lang.String)

checkDnsZone

public void checkDnsZone(String zone)
                  throws IllegalArgumentException,
IOException,
SQLException

Checks the format of a Zone.

Parameters:

zone - the new DNS zone name, some examples include aoindustries.com. and netspade.co.uk.

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if the format is not valid

See Also:

• ZoneTable.checkDnsZone(java.lang.String)
• Zone

checkEmailListPath

public void checkEmailListPath(String aoServer,
 PosixPath path)
                        throws IllegalArgumentException,
IOException,
SQLException

Checks the format of an email list path.

Parameters:

aoServer - the hostname of the server the list would be hosted on

path - the path of the list

Throws:

IllegalArgumentException - if the name is not in a valid format

IOException

SQLException

See Also:

• List.isValidRegularPath(com.aoindustries.aoserv.client.linux.PosixPath, int)

checkLinuxAccountPassword

public List<PasswordChecker.Result> checkLinuxAccountPassword(User.Name username,
 String password)
                                                       throws IllegalArgumentException,
IOException,
SQLException

Checks the strength of a password that will be used for a User or UserServer.

Parameters:

username - the username of the account that will have its password set

password - the new password for the account

Returns:

a String describing why the password is not secure or null if the password is strong

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the User

See Also:

• User.checkPassword(java.lang.String)
• setLinuxAccountPassword(com.aoindustries.aoserv.client.linux.User.Name, java.lang.String)
• setLinuxServerAccountPassword(com.aoindustries.aoserv.client.linux.User.Name, java.lang.String, java.lang.String)
• PasswordChecker

checkMysqlPassword

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

Checks the strength of a password that will be used for a UserServer.

Parameters:

username - the username of the UserServer whos password will be set

password - the new password

Returns:

a description of why the password is weak or null if all checks succeed

Throws:

IOException - if unable to load the dictionary resource

See Also:

• setMysqlUserPassword(com.aoindustries.aoserv.client.mysql.User.Name, java.lang.String)
• setMysqlServerUserPassword(com.aoindustries.aoserv.client.mysql.User.Name, com.aoindustries.aoserv.client.mysql.Server.Name, java.lang.String, java.lang.String)
• User.checkPassword(java.lang.String)

checkPostgresPassword

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

Checks the strength of a password that will be used for a UserServer.

Parameters:

username - the username of the UserServer whos password will be set

password - the new password

Returns:

a description of why the password is weak or null if all checks succeed

Throws:

IOException - if unable to load the dictionary resource

See Also:

• setPostgresUserPassword(com.aoindustries.aoserv.client.postgresql.User.Name, java.lang.String)
• setPostgresServerUserPassword(com.aoindustries.aoserv.client.postgresql.User.Name, com.aoindustries.aoserv.client.postgresql.Server.Name, java.lang.String, java.lang.String)
• User.checkPassword(java.lang.String)

checkMajordomoListName

public static void checkMajordomoListName(String listName)
                                   throws IllegalArgumentException

Checks the format of a Majordomo list name.

Throws:

IllegalArgumentException - if the domain is not in a valid format

See Also:

• MajordomoList.isValidListName(java.lang.String)
• addMajordomoList(com.aoapps.net.DomainName, java.lang.String, java.lang.String)

checkSharedTomcatName

public static void checkSharedTomcatName(String tomcatName)
                                  throws IllegalArgumentException

Checks the format of an SharedTomcat name.

Parameters:

tomcatName - the name of the SharedTomcat

Throws:

IllegalArgumentException - if the name is not in a valid format

See Also:

• SharedTomcat.isValidSharedTomcatName(java.lang.String)
• addHttpdSharedTomcat(java.lang.String, java.lang.String, java.lang.String, com.aoindustries.aoserv.client.linux.User.Name, com.aoindustries.aoserv.client.linux.Group.Name)
• addHttpdTomcatSharedSite(java.lang.String, java.lang.String, com.aoindustries.aoserv.client.account.Account.Name, com.aoindustries.aoserv.client.linux.User.Name, com.aoindustries.aoserv.client.linux.Group.Name, com.aoapps.net.Email, boolean, com.aoapps.net.InetAddress, java.lang.String, com.aoapps.net.DomainName, com.aoapps.net.DomainName[], java.lang.String)

checkSiteName

public static void checkSiteName(String siteName)
                          throws IllegalArgumentException

Checks the format of an Site name.

Parameters:

siteName - the name of the Site

Throws:

IllegalArgumentException - if the name is not in a valid format

See Also:

• Site.isValidSiteName(java.lang.String)
• addHttpdTomcatStdSite(java.lang.String, java.lang.String, com.aoindustries.aoserv.client.account.Account.Name, com.aoindustries.aoserv.client.linux.User.Name, com.aoindustries.aoserv.client.linux.Group.Name, com.aoapps.net.Email, boolean, com.aoapps.net.InetAddress, java.lang.String, com.aoapps.net.DomainName, com.aoapps.net.DomainName[], java.lang.String)

checkUsernamePassword

public List<PasswordChecker.Result> checkUsernamePassword(User.Name username,
 String password)
                                                   throws IllegalArgumentException,
IOException,
SQLException

Checks the strength of a password that will be used for a User. The strength requirement is based on which services use the User.

Parameters:

username - the username whos password will be set

password - the new password

Returns:

a description of why the password is weak or null if all checks succeed

Throws:

IOException - if unable to load the dictionary resource or unable to access the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find the User

See Also:

• setUsernamePassword(com.aoindustries.aoserv.client.account.User.Name, java.lang.String)
• User.checkPassword(java.lang.String)

compareLinuxServerAccountPassword

public boolean compareLinuxServerAccountPassword(User.Name username,
 String aoServer,
 String password)
                                          throws IllegalArgumentException,
IOException,
SQLException

Checks if a password matches a UserServer.

Parameters:

username - the username of the account

aoServer - the hostname of the server to check

password - the password to compare against

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if the User, Host, Server, or UserServer is not found

See Also:

• UserServer.passwordMatches(java.lang.String)
• addLinuxServerAccount(com.aoindustries.aoserv.client.linux.User.Name, java.lang.String, com.aoindustries.aoserv.client.linux.PosixPath)

copyHomeDirectory

public long copyHomeDirectory(User.Name username,
 String fromAoServer,
 String toAoServer)
                       throws IllegalArgumentException,
IOException,
SQLException

Copies the contents of user's home directory from one server to another.

Parameters:

username - the username of the User

fromAoServer - the server to get the data from

toAoServer - the server to put the data on

Returns:

the number of bytes transferred

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find the source UserServer or destination Server

See Also:

• UserServer.copyHomeDirectory(com.aoindustries.aoserv.client.linux.Server)
• addLinuxServerAccount(com.aoindustries.aoserv.client.linux.User.Name, java.lang.String, com.aoindustries.aoserv.client.linux.PosixPath)
• removeLinuxServerAccount(com.aoindustries.aoserv.client.linux.User.Name, java.lang.String)

copyLinuxServerAccountPassword

public void copyLinuxServerAccountPassword(User.Name fromUsername,
 String fromAoServer,
 User.Name toUsername,
 String toAoServer)
                                    throws IllegalArgumentException,
IOException,
SQLException

Copies the password from one UserServer to another.

Parameters:

fromUsername - the username to copy from

fromAoServer - the server to get the data from

toUsername - the username to copy to

toAoServer - the server to put the data on

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find a UserServer

See Also:

• UserServer.copyPassword(com.aoindustries.aoserv.client.linux.UserServer)
• addLinuxServerAccount(com.aoindustries.aoserv.client.linux.User.Name, java.lang.String, com.aoindustries.aoserv.client.linux.PosixPath)
• removeLinuxServerAccount(com.aoindustries.aoserv.client.linux.User.Name, java.lang.String)

crypt

@Deprecated
public static String crypt(String password,
 String salt)

Deprecated.

Please use HashedPassword instead.

Encrypts a password using a pure Java implementation of the standard Unix crypt function.

Parameters:

password - the password that is to be encrypted

salt - the two character salt for the encryption process, if null, a random salt will be used

See Also:

• HashedPassword

declineCreditCard

public void declineCreditCard(int pkey,
 String reason)
                       throws IllegalArgumentException,
IOException,
SQLException

Disables a CreditCard. When a Transaction using a CreditCard fails, the CreditCard is disabled.

Parameters:

pkey - the unique identifier of the CreditCard

reason - the reason the card is being disabled

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the CreditCard

See Also:

• CreditCard.declined(java.lang.String)
• Transaction
• CreditCard

disableAccount

public int disableAccount(Account.Name accounting,
 String disableReason)
                   throws IllegalArgumentException,
IOException,
SQLException

Disables a business, recursively disabling all of its enabled child components.

Parameters:

accounting - the accounting code to disable

disableReason - the reason the account is being disabled

Returns:

the pkey of the new DisableLog

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the necessary AoservObjects

disablePackage

public int disablePackage(Account.Name name,
 String disableReason)
                   throws IllegalArgumentException,
SQLException,
IOException

Disables a package, recursively disabling all of its enabled child components.

Parameters:

name - the name of the package

disableReason - the reason the account is being disabled

Returns:

the pkey of the new DisableLog

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the necessary AoservObjects

disableHttpdSharedTomcat

public int disableHttpdSharedTomcat(String name,
 String aoServer,
 String disableReason)
                             throws IllegalArgumentException,
IOException,
SQLException

Disables a SharedTomcat.

Parameters:

name - the name of the tomcat JVM

aoServer - the server that hosts the JVM

disableReason - the reason the JVM is being disabled

Returns:

the pkey of the new DisableLog

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Server, or SharedTomcat

disableEmailPipe

public int disableEmailPipe(int pkey,
 String disableReason)
                     throws IllegalArgumentException,
SQLException,
IOException

Disables an Pipe.

Parameters:

pkey - the pkey of the pipe

disableReason - the reason the pipe is being disabled

Returns:

the pkey of the new DisableLog

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Pipe

disableHttpdSite

public int disableHttpdSite(String name,
 String aoServer,
 String disableReason)
                     throws IllegalArgumentException,
SQLException,
IOException

Disables a Site.

Parameters:

name - the name of the site

aoServer - the server that hosts the site

disableReason - the reason the site is being disabled

Returns:

the pkey of the new DisableLog

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Server, or Site

disableHttpdSiteBind

public int disableHttpdSiteBind(int pkey,
 String disableReason)
                         throws IllegalArgumentException,
SQLException,
IOException

Disables a VirtualHost.

Parameters:

pkey - the pkey of the bind

disableReason - the reason the bind is being disabled

Returns:

the pkey of the new DisableLog

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the VirtualHost

disableEmailList

public int disableEmailList(PosixPath path,
 String aoServer,
 String disableReason)
                     throws IllegalArgumentException,
SQLException,
IOException

Disables an List.

Parameters:

path - the path of the list

aoServer - the server the list is part of

disableReason - the reason the bind is being disabled

Returns:

the pkey of the new DisableLog

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the List

disableEmailSmtpRelay

public int disableEmailSmtpRelay(int pkey,
 String disableReason)
                          throws IllegalArgumentException,
SQLException,
IOException

Disables a SmtpRelay.

Parameters:

pkey - the pkey of the relay

disableReason - the reason the bind is being disabled

Returns:

the pkey of the new DisableLog

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the SmtpRelay

disableUsername

public int disableUsername(User.Name username,
 String disableReason)
                    throws IllegalArgumentException,
SQLException,
IOException

Disables a User and all uses of the username.

Parameters:

username - the username to disable

disableReason - the reason the bind is being disabled

Returns:

the pkey of the new DisableLog

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the User

disableLinuxAccount

public int disableLinuxAccount(User.Name username,
 String disableReason)
                        throws IllegalArgumentException,
SQLException,
IOException

Disables a User.

Parameters:

username - the username to disable

disableReason - the reason the account is being disabled

Returns:

the pkey of the new DisableLog

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the User or User

disableLinuxServerAccount

public int disableLinuxServerAccount(User.Name username,
 String aoServer,
 String disableReason)
                              throws IllegalArgumentException,
SQLException,
IOException

Disables a UserServer.

Parameters:

username - the username to disable

aoServer - the server the account is on

disableReason - the reason the account is being disabled

Returns:

the pkey of the new DisableLog

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the User, User, or UserServer

disableCvsRepository

public int disableCvsRepository(int pkey,
 String disableReason)
                         throws IllegalArgumentException,
SQLException,
IOException

Disables a CvsRepository.

Parameters:

pkey - the pkey of the repository to disable

disableReason - the reason the account is being disabled

Returns:

the pkey of the new DisableLog

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the CvsRepository

disableMysqlUser

public int disableMysqlUser(User.Name username,
 String disableReason)
                     throws IllegalArgumentException,
SQLException,
IOException

Disables a User.

Parameters:

username - the username to disable

disableReason - the reason the account is being disabled

Returns:

the pkey of the new DisableLog

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the User or User

disableMysqlServerUser

public int disableMysqlServerUser(User.Name username,
 Server.Name mysqlServer,
 String aoServer,
 String disableReason)
                           throws IllegalArgumentException,
SQLException,
IOException

Disables a UserServer.

Parameters:

username - the username to disable

aoServer - the server the account is on

disableReason - the reason the account is being disabled

Returns:

the pkey of the new DisableLog

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Server or User

disablePostgresUser

public int disablePostgresUser(User.Name username,
 String disableReason)
                        throws IllegalArgumentException,
SQLException,
IOException

Disables a User.

Parameters:

username - the username to disable

disableReason - the reason the account is being disabled

Returns:

the pkey of the new DisableLog

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the User or User

disablePostgresServerUser

public int disablePostgresServerUser(User.Name username,
 Server.Name postgresServer,
 String aoServer,
 String disableReason)
                              throws IllegalArgumentException,
SQLException,
IOException

Disables a UserServer.

Parameters:

username - the username to disable

postgresServer - the name of the PostgresServer

aoServer - the server the account is on

disableReason - the reason the account is being disabled

Returns:

the pkey of the new DisableLog

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Server or User

disableAdministrator

public int disableAdministrator(User.Name username,
 String disableReason)
                         throws IllegalArgumentException,
SQLException,
IOException

Disables a Administrator.

Parameters:

username - the username to disable

disableReason - the reason the account is being disabled

Returns:

the pkey of the new DisableLog

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the User or Administrator

enableAccount

public void enableAccount(Account.Name accounting)
                   throws IllegalArgumentException,
IOException,
SQLException

Enables a business, recursively enabling all of its disabled child components.

Parameters:

accounting - the accounting code to enable

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the necessary accounts

enablePackage

public void enablePackage(Account.Name name)
                   throws IllegalArgumentException,
SQLException,
IOException

Enables a package, recursively enabling all of its disabled child components.

Parameters:

name - the name of the package

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the necessary AoservObjects

enableHttpdSharedTomcat

public void enableHttpdSharedTomcat(String name,
 String aoServer)
                             throws IllegalArgumentException,
SQLException,
IOException

Enables a SharedTomcat.

Parameters:

name - the name of the tomcat JVM

aoServer - the server that hosts the JVM

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Server, or SharedTomcat

enableEmailPipe

public void enableEmailPipe(int pkey)
                     throws IllegalArgumentException,
SQLException,
IOException

Enables an Pipe.

Parameters:

pkey - the pkey of the pipe

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Pipe

enableHttpdSite

public void enableHttpdSite(String name,
 String aoServer)
                     throws IllegalArgumentException,
SQLException,
IOException

Enables a Site.

Parameters:

name - the name of the site

aoServer - the server that hosts the site

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Server, or Site

enableHttpdSiteBind

public void enableHttpdSiteBind(int pkey)
                         throws IllegalArgumentException,
SQLException,
IOException

Enables a VirtualHost.

Parameters:

pkey - the pkey of the bind

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the VirtualHost

enableEmailList

public void enableEmailList(PosixPath path,
 String aoServer)
                     throws IllegalArgumentException,
SQLException,
IOException

Enables an List.

Parameters:

path - the path of the list

aoServer - the server the list is part of

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the List

enableEmailSmtpRelay

public void enableEmailSmtpRelay(int pkey)
                          throws IllegalArgumentException,
IOException,
SQLException

Enables a SmtpRelay.

Parameters:

pkey - the pkey of the relay

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the SmtpRelay

enableUsername

public void enableUsername(User.Name username)
                    throws IllegalArgumentException,
SQLException,
IOException

Enables a User and all uses of the username.

Parameters:

username - the username to enable

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the User

enableLinuxAccount

public void enableLinuxAccount(User.Name username)
                        throws IllegalArgumentException,
SQLException,
IOException

Enables a User.

Parameters:

username - the username to enable

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the User or User

enableLinuxServerAccount

public void enableLinuxServerAccount(User.Name username,
 String aoServer)
                              throws IllegalArgumentException,
SQLException,
IOException

Enables a UserServer.

Parameters:

username - the username to enable

aoServer - the server the account is on

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the User, User, or UserServer

enableCvsRepository

public void enableCvsRepository(int pkey)
                         throws IllegalArgumentException,
SQLException,
IOException

Enables a CvsRepository.

Parameters:

pkey - the pkey of the repository to enable

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the CvsRepository

enableMysqlUser

public void enableMysqlUser(User.Name username)
                     throws IllegalArgumentException,
SQLException,
IOException

Enables a User.

Parameters:

username - the username to enable

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the User or User

enableMysqlServerUser

public void enableMysqlServerUser(User.Name username,
 Server.Name mysqlServer,
 String aoServer)
                           throws IllegalArgumentException,
SQLException,
IOException

Enables a UserServer.

Parameters:

username - the username to enable

aoServer - the server the account is on

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Server or User

enablePostgresUser

public void enablePostgresUser(User.Name username)
                        throws IllegalArgumentException,
SQLException,
IOException

Enables a User.

Parameters:

username - the username to enable

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the User or User

enablePostgresServerUser

public void enablePostgresServerUser(User.Name username,
 Server.Name postgresServer,
 String aoServer)
                              throws IllegalArgumentException,
IOException,
SQLException

Enables a UserServer.

Parameters:

username - the username to enable

postgresServer - the name of the PostgreSQL server

aoServer - the server the account is on

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Server or User

enableAdministrator

public void enableAdministrator(User.Name username)
                         throws IllegalArgumentException,
SQLException,
IOException

Enables an Administrator.

Parameters:

username - the username to enable

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the User or Administrator

dumpMysqlDatabase

public void dumpMysqlDatabase(Database.Name name,
 Server.Name mysqlServer,
 String aoServer,
 Writer out)
                       throws IllegalArgumentException,
IOException,
SQLException

Dumps the contents of a Database to a Writer.

Parameters:

name - the name of the Database

aoServer - the hostname of the Server

out - the Writer to dump to

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Server or Database

See Also:

• Database.dump(java.io.PrintWriter)
• Database

dumpMysqlDatabase

public void dumpMysqlDatabase(Database.Name name,
 Server.Name mysqlServer,
 String aoServer,
 boolean gzip,
 StreamHandler streamHandler)
                       throws IllegalArgumentException,
IOException,
SQLException

Dumps the contents of a Database to an OutputStream, optionally gzipped.

Parameters:

name - the name of the Database

aoServer - the hostname of the Server

gzip - the gzip flag

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Server or Database

See Also:

• Database.dump(java.io.PrintWriter)
• Database

dumpPostgresDatabase

public void dumpPostgresDatabase(Database.Name name,
 Server.Name postgresServer,
 String aoServer,
 Writer out)
                          throws IllegalArgumentException,
IOException,
SQLException

Dumps the contents of a Database to a Writer.

Parameters:

name - the name of the Database

postgresServer - the name of the PostgreSQL server

aoServer - the hostname of the Server

out - the Writer to dump to

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Server or Database

See Also:

• Database.dump(java.io.PrintWriter)
• Database

dumpPostgresDatabase

public void dumpPostgresDatabase(Database.Name name,
 Server.Name postgresServer,
 String aoServer,
 boolean gzip,
 StreamHandler streamHandler)
                          throws IllegalArgumentException,
IOException,
SQLException

Dumps the contents of a Database to an OutputStream, optionally gzipped.

Parameters:

name - the name of the Database

postgresServer - the name of the PostgreSQL server

aoServer - the hostname of the Server

gzip - the gzip flag

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Server or Database

See Also:

• Database.dump(java.io.PrintWriter)
• Database

generateAccountingCode

public Account.Name generateAccountingCode(Account.Name accountingTemplate)
                                    throws IOException,
SQLException

Generates a unique accounting code that may be used to create a new Account.

Parameters:

accountingTemplate - the beginning part of the accounting code, such as "AO_"

Returns:

the available accounting code

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

See Also:

• AccountTable.generateAccountingCode(com.aoindustries.aoserv.client.account.Account.Name)
• addAccount(com.aoindustries.aoserv.client.account.Account.Name, java.lang.String, java.lang.String, com.aoindustries.aoserv.client.account.Account.Name, boolean, boolean, boolean, boolean)
• Account

generateMysqlDatabaseName

public Database.Name generateMysqlDatabaseName(String templateBase,
 String templateAdded)
                                        throws IOException,
SQLException

Generates a unique MySQL database name.

Parameters:

templateBase - the beginning part of the template, such as "AO"

templateAdded - the part of the template added between the template_base and the generated number, such as "_"

Returns:

the available database name

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

See Also:

• DatabaseTable.generateMysqlDatabaseName(java.lang.String, java.lang.String)
• addMysqlDatabase(com.aoindustries.aoserv.client.mysql.Database.Name, com.aoindustries.aoserv.client.mysql.Server.Name, java.lang.String, com.aoindustries.aoserv.client.account.Account.Name)
• Database

generatePackageName

public Account.Name generatePackageName(Account.Name template)
                                 throws IOException,
SQLException

Generates a unique Package name.

Parameters:

template - the beginning part of the template, such as "AO_"

Returns:

the available Package name

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

See Also:

• PackageTable.generatePackageName(com.aoindustries.aoserv.client.account.Account.Name)
• addPackage(com.aoindustries.aoserv.client.account.Account.Name, com.aoindustries.aoserv.client.account.Account.Name, int)
• Package

generatePassword

public String generatePassword()
                        throws IOException

Generates a random, valid password.

Returns:

the password

Throws:

IOException - if unable to contact the server

generatePostgresDatabaseName

public Database.Name generatePostgresDatabaseName(String templateBase,
 String templateAdded)
                                           throws IOException,
SQLException

Generates a unique PostgreSQL database name.

Parameters:

templateBase - the beginning part of the template, such as "AO"

templateAdded - the part of the template added between the template_base and the generated number, such as "_"

Returns:

the available database name

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

See Also:

• DatabaseTable.generatePostgresDatabaseName(java.lang.String, java.lang.String)
• addPostgresDatabase(com.aoindustries.aoserv.client.postgresql.Database.Name, com.aoindustries.aoserv.client.postgresql.Server.Name, java.lang.String, com.aoindustries.aoserv.client.postgresql.User.Name, java.lang.String, boolean)
• Database

generateSharedTomcatName

public String generateSharedTomcatName(String template)
                                throws IOException,
SQLException

Generates a unique SharedTomcat name.

Parameters:

template - the beginning part of the template, such as "ao"

Returns:

the available SharedTomcat name

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

See Also:

• SharedTomcatTable.generateSharedTomcatName(java.lang.String)
• addHttpdSharedTomcat(java.lang.String, java.lang.String, java.lang.String, com.aoindustries.aoserv.client.linux.User.Name, com.aoindustries.aoserv.client.linux.Group.Name)
• addHttpdTomcatSharedSite(java.lang.String, java.lang.String, com.aoindustries.aoserv.client.account.Account.Name, com.aoindustries.aoserv.client.linux.User.Name, com.aoindustries.aoserv.client.linux.Group.Name, com.aoapps.net.Email, boolean, com.aoapps.net.InetAddress, java.lang.String, com.aoapps.net.DomainName, com.aoapps.net.DomainName[], java.lang.String)
• Site

generateSiteName

public String generateSiteName(String template)
                        throws IOException,
SQLException

Generates a unique Site name.

Parameters:

template - the beginning part of the template, such as "ao"

Returns:

the available Site name

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

See Also:

• SiteTable.generateSiteName(java.lang.String)
• addHttpdTomcatStdSite(java.lang.String, java.lang.String, com.aoindustries.aoserv.client.account.Account.Name, com.aoindustries.aoserv.client.linux.User.Name, com.aoindustries.aoserv.client.linux.Group.Name, com.aoapps.net.Email, boolean, com.aoapps.net.InetAddress, java.lang.String, com.aoapps.net.DomainName, com.aoapps.net.DomainName[], java.lang.String)
• Site

getAutoresponderContent

public String getAutoresponderContent(User.Name username,
 String aoServer)
                               throws IllegalArgumentException,
IOException,
SQLException

Gets the autoresponder content.

Parameters:

username - the username of the UserServer

aoServer - the server to get the data from

Returns:

the autoresponder content

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find the source UserServer

See Also:

• UserServer.getAutoresponderContent()
• setAutoresponder(com.aoindustries.aoserv.client.linux.User.Name, java.lang.String, java.lang.String, com.aoapps.net.DomainName, java.lang.String, java.lang.String, boolean)

getConnector

public AoservConnector getConnector()

Gets the AoservConnector used for communication with the server.

getCronTable

public String getCronTable(User.Name username,
 String aoServer)
                    throws IllegalArgumentException,
IOException,
SQLException

Gets a user's cron table on one server.

Parameters:

username - the username of the User

aoServer - the server to get the data from

Returns:

the cron table

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find the source UserServer

See Also:

• UserServer.getCronTable()
• setCronTable(com.aoindustries.aoserv.client.linux.User.Name, java.lang.String, java.lang.String)
• addLinuxServerAccount(com.aoindustries.aoserv.client.linux.User.Name, java.lang.String, com.aoindustries.aoserv.client.linux.PosixPath)
• removeLinuxServerAccount(com.aoindustries.aoserv.client.linux.User.Name, java.lang.String)

getEmailListAddressList

public String getEmailListAddressList(PosixPath path,
 String aoServer)
                               throws IllegalArgumentException,
IOException,
SQLException

Gets the list of email addresses that an List will be forwarded to.

Parameters:

path - the path of the list

aoServer - the server this list is part of

Returns:

the list of addresses, one address per line separated by '\n'

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find the List

See Also:

• List.getAddressList()
• addEmailList(java.lang.String, com.aoindustries.aoserv.client.linux.PosixPath, com.aoindustries.aoserv.client.linux.User.Name, com.aoindustries.aoserv.client.linux.Group.Name)
• setEmailListAddressList(com.aoindustries.aoserv.client.linux.PosixPath, java.lang.String, java.lang.String)
• List

getBackupPartitionTotalSize

public long getBackupPartitionTotalSize(String aoServer,
 String path)
                                 throws IllegalArgumentException,
IOException,
SQLException

Gets the total size of a BackupPartition.

Parameters:

aoServer - the hostname of the server

path - the path of the BackupPartition

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find the Server or BackupPartition

See Also:

• BackupPartition.getDiskTotalSize()

getBackupPartitionUsedSize

public long getBackupPartitionUsedSize(String aoServer,
 String path)
                                throws IllegalArgumentException,
IOException,
SQLException

Gets the used size of a BackupPartition.

Parameters:

aoServer - the hostname of the server

path - the path of the BackupPartition

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find the Server or BackupPartition

See Also:

• BackupPartition.getDiskUsedSize()

getFailoverFileReplicationActivity

public FileReplication.Activity getFailoverFileReplicationActivity(String fromServer,
 String toServer,
 String path)
                                                            throws IllegalArgumentException,
IOException,
SQLException

Gets the last reported activity for a FileReplication.

Parameters:

fromServer - the server that is being backed-up

toServer - the hostname of the server the stores the backups

path - the path of the BackupPartition

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find the Host, Server, BackupPartition, or FileReplication

See Also:

• FileReplication.getActivity()

getHttpdServerConcurrency

public int getHttpdServerConcurrency(String aoServer,
 String name)
                              throws IllegalArgumentException,
IOException,
SQLException

Parameters:

aoServer - the server hosting the account

name - the name of the instance of null for the default instance

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find the Host, Server, or HttpdServer

See Also:

• HttpdServer.getConcurrency()

getInboxAttributes

public InboxAttributes getInboxAttributes(User.Name username,
 String aoServer)
                                   throws IllegalArgumentException,
IOException,
SQLException

Gets the attributes of an inbox.

Parameters:

username - the username of the UserServer

aoServer - the server hosting the account

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find the UserServer

See Also:

• UserServer.getInboxAttributes()

getImapFolderSizes

public long[] getImapFolderSizes(User.Name username,
 String aoServer,
 String[] folderNames)
                          throws IllegalArgumentException,
IOException,
SQLException

Gets the IMAP folder sizes for an inbox.

Parameters:

username - the username of the UserServer

aoServer - the server hosting the account

folderNames - the folder names

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find the UserServer

See Also:

• UserServer.getImapFolderSizes(java.lang.String[])

getMajordomoInfoFile

public String getMajordomoInfoFile(DomainName domain,
 String aoServer,
 String listName)
                            throws IllegalArgumentException,
IOException,
SQLException

Gets the info file for a MajordomoList.

Parameters:

domain - the domain of the MajordomoServer

aoServer - the hostname of the Server

listName - the name of the new list

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if the name is not valid or unable to find the Server, Domain, MajordomoServer, or MajordomoList

See Also:

• MajordomoList.getInfoFile()
• addMajordomoList(com.aoapps.net.DomainName, java.lang.String, java.lang.String)
• removeEmailList(com.aoindustries.aoserv.client.linux.PosixPath, java.lang.String)

getMajordomoIntroFile

public String getMajordomoIntroFile(DomainName domain,
 String aoServer,
 String listName)
                             throws IllegalArgumentException,
IOException,
SQLException

Gets the intro file for a MajordomoList.

Parameters:

domain - the domain of the MajordomoServer

aoServer - the hostname of the Server

listName - the name of the new list

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if the name is not valid or unable to find the Server, Domain, MajordomoServer, or MajordomoList

See Also:

• MajordomoList.getIntroFile()
• addMajordomoList(com.aoapps.net.DomainName, java.lang.String, java.lang.String)
• removeEmailList(com.aoindustries.aoserv.client.linux.PosixPath, java.lang.String)

getMrtgFile

public void getMrtgFile(String aoServer,
 String filename,
 OutputStream out)
                 throws IllegalArgumentException,
IOException,
SQLException

Gets the contents of a MRTG file.

Parameters:

aoServer - the hostname of the server to get the file from

filename - the filename on the server

out - the OutputStream to write the file to

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find the Host or Server

See Also:

• Server.getMrtgFile(java.lang.String, java.io.OutputStream)

getUpsStatus

public String getUpsStatus(String aoServer)
                    throws IllegalArgumentException,
IOException,
SQLException

Gets the current status of the UPS.

Parameters:

aoServer - the hostname of the server to get the file from

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find the Host or Server

See Also:

• Server.getMrtgFile(java.lang.String, java.io.OutputStream)

getAwstatsFile

public void getAwstatsFile(String siteName,
 String aoServer,
 String path,
 String queryString,
 OutputStream out)
                    throws IllegalArgumentException,
IOException,
SQLException

Gets the contents of an AWStats file.

Parameters:

siteName - the site name

aoServer - the hostname of the server to get the file from

path - the filename on the server

queryString - the query string for the request

out - the OutputStream to write the file to

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find the Host, Server, or Site

See Also:

• Site.getAwstatsFile(java.lang.String, java.lang.String, java.io.OutputStream)

getRootAccount

public Account.Name getRootAccount()
                            throws IOException,
SQLException

Gets the name of the root Account in the tree of accounts.

Returns:

the accounting code of the root Account

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

See Also:

• AccountTable.getRootAccount_name()

invalidate

public void invalidate(int tableId,
 String server)
                throws IllegalArgumentException,
SQLException,
IOException

Invalidates a table, causing all caches of the table to be removed and all configurations based on the table to be reevaluated.

Parameters:

tableId - the ID of the AoservTable to invalidate

server - the server that should be invalidated or null or "" for none, accepts ao_servers.hostname, servers.package || '/' || servers.name, or servers.pkey

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if the table ID is invalid

See Also:

• AoservConnector.invalidateTable(int, int)
• Administrator.isActiveTableInvalidator()

isAccountingAvailable

public boolean isAccountingAvailable(Account.Name accounting)
                              throws SQLException,
IOException

Determines if an accounting code is available.

Parameters:

accounting - the accounting code

Returns:

true if the accounting code is available

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

See Also:

• AccountTable.isAccountingAvailable(com.aoindustries.aoserv.client.account.Account.Name)
• addAccount(com.aoindustries.aoserv.client.account.Account.Name, java.lang.String, java.lang.String, com.aoindustries.aoserv.client.account.Account.Name, boolean, boolean, boolean, boolean)
• generateAccountingCode(com.aoindustries.aoserv.client.account.Account.Name)
• Account

isAdministratorPasswordSet

public boolean isAdministratorPasswordSet(User.Name username)
                                   throws IllegalArgumentException,
IOException,
SQLException

Determines if a Administrator currently has a password set.

Parameters:

username - the username of the administrator

Returns:

if the Administrator has a password set

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if the Administrator is not found

See Also:

• Administrator.arePasswordsSet()
• setAdministratorPassword(com.aoindustries.aoserv.client.account.User.Name, java.lang.String)
• Administrator

isDnsZoneAvailable

public boolean isDnsZoneAvailable(String zone)
                           throws IOException,
SQLException

Determines if a Zone is available.

Parameters:

zone - the zone in domain.tld. format

Returns:

true if the Zone is available

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

See Also:

• ZoneTable.isDnsZoneAvailable(java.lang.String)
• addDnsZone(com.aoindustries.aoserv.client.account.Account.Name, java.lang.String, com.aoapps.net.InetAddress, int)
• Zone

isIpAddressUsed

public boolean isIpAddressUsed(InetAddress ipAddress,
 String server,
 String netDevice)
                        throws IllegalArgumentException,
IOException,
SQLException

Determines if an IpAddress is currently being used.

Parameters:

ipAddress - the IP address

Returns:

true if the IpAddress is in use

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find the IpAddress

See Also:

• IpAddress.isUsed()
• setIpAddressPackage(com.aoapps.net.InetAddress, java.lang.String, java.lang.String, com.aoindustries.aoserv.client.account.Account.Name)

isLinuxGroupNameAvailable

public boolean isLinuxGroupNameAvailable(Group.Name groupname)
                                  throws IOException,
SQLException

Determines if a groupname is available.

Parameters:

groupname - the groupname

Returns:

true if the groupname is available

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

See Also:

• GroupTable.isLinuxGroupNameAvailable(com.aoindustries.aoserv.client.linux.Group.Name)
• addLinuxGroup(com.aoindustries.aoserv.client.linux.Group.Name, com.aoindustries.aoserv.client.account.Account.Name, java.lang.String)
• Group

isLinuxServerAccountPasswordSet

public boolean isLinuxServerAccountPasswordSet(User.Name username,
 String aoServer)
                                        throws IllegalArgumentException,
IOException,
SQLException

Determines if a UserServer currently has a password set.

Parameters:

username - the username of the account

aoServer - the server the account is hosted on

Returns:

if the UserServer has a password set

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if the UserServer is not found

See Also:

• UserServer.arePasswordsSet()
• setLinuxServerAccountPassword(com.aoindustries.aoserv.client.linux.User.Name, java.lang.String, java.lang.String)
• UserServer

isLinuxServerAccountProcmailManual

public int isLinuxServerAccountProcmailManual(User.Name username,
 String aoServer)
                                       throws IllegalArgumentException,
IOException,
SQLException

Determines if a UserServer is currently in manual procmail mode. Manual procmail mode is initiated when the header comment in the .procmailrc file is altered or removed.

Parameters:

username - the username of the account

aoServer - the server the account is hosted on

Returns:

if the UserServer is in manual mode

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if the UserServer is not found

See Also:

• UserServer.isProcmailManual()
• UserServer

isMysqlDatabaseNameAvailable

public boolean isMysqlDatabaseNameAvailable(Database.Name name,
 Server.Name mysqlServer,
 String aoServer)
                                     throws IllegalArgumentException,
IOException,
SQLException

Determines if a Database name is available on the specified Server.

Parameters:

name - the name of the database

aoServer - the hostname of the Server

Returns:

true if the Database is available

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if the database name is invalid or unable to find the Server

See Also:

• Server.isMysqlDatabaseNameAvailable(com.aoindustries.aoserv.client.mysql.Database.Name)

isMysqlServerNameAvailable

public boolean isMysqlServerNameAvailable(Server.Name name,
 String aoServer)
                                   throws IllegalArgumentException,
IOException,
SQLException

Determines if a Server name is available on the specified Server.

Parameters:

name - the name of the MySQL server

aoServer - the hostname of the Server

Returns:

true if the Server is available

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if the server name is invalid or unable to find the Server

See Also:

• Server.isMysqlServerNameAvailable(com.aoindustries.aoserv.client.mysql.Server.Name)

isMysqlServerUserPasswordSet

public boolean isMysqlServerUserPasswordSet(User.Name username,
 Server.Name mysqlServer,
 String aoServer)
                                     throws IllegalArgumentException,
IOException,
SQLException

Determines if a UserServer currently has a password set.

Parameters:

username - the username of the account

aoServer - the server the account is hosted on

Returns:

if the UserServer has a password set

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if the UserServer is not found

See Also:

• UserServer.arePasswordsSet()
• setMysqlServerUserPassword(com.aoindustries.aoserv.client.mysql.User.Name, com.aoindustries.aoserv.client.mysql.Server.Name, java.lang.String, java.lang.String)
• UserServer

isPackageNameAvailable

public boolean isPackageNameAvailable(Account.Name packageName)
                               throws IOException,
SQLException

Determines if a Package name is available.

Parameters:

packageName - the name of the Package

Returns:

true if the Package name is available

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

See Also:

• PackageTable.isPackageNameAvailable(com.aoindustries.aoserv.client.account.Account.Name)
• generatePackageName(com.aoindustries.aoserv.client.account.Account.Name)
• addPackage(com.aoindustries.aoserv.client.account.Account.Name, com.aoindustries.aoserv.client.account.Account.Name, int)
• Package

isPostgresDatabaseNameAvailable

public boolean isPostgresDatabaseNameAvailable(Database.Name name,
 Server.Name postgresServer,
 String aoServer)
                                        throws IllegalArgumentException,
IOException,
SQLException

Determines if a Database name is available on the specified Server.

Parameters:

name - the name of the database

postgresServer - the name of the PostgreSQL server

aoServer - the hostname of the Server

Returns:

true if the Database is available

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if the database name is invalid or unable to find the Server

See Also:

• Server.isPostgresDatabaseNameAvailable(com.aoindustries.aoserv.client.postgresql.Database.Name)

isPostgresServerNameAvailable

public boolean isPostgresServerNameAvailable(Server.Name name,
 String aoServer)
                                      throws IllegalArgumentException,
IOException,
SQLException

Determines if a Server name is available on the specified Server.

Parameters:

name - the name of the PostgreSQL server

aoServer - the hostname of the Server

Returns:

true if the Server is available

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if the server name is invalid or unable to find the Server

See Also:

• Server.isPostgresServerNameAvailable(com.aoindustries.aoserv.client.postgresql.Server.Name)

isPostgresServerUserPasswordSet

public boolean isPostgresServerUserPasswordSet(User.Name username,
 Server.Name postgresServer,
 String aoServer)
                                        throws IllegalArgumentException,
IOException,
SQLException

Determines if a UserServer currently has a password set.

Parameters:

username - the username of the account

postgresServer - the name of the PostgreSQL server

aoServer - the server the account is hosted on

Returns:

if the UserServer has a password set

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if the UserServer is not found

See Also:

• UserServer.arePasswordsSet()
• setPostgresServerUserPassword(com.aoindustries.aoserv.client.postgresql.User.Name, com.aoindustries.aoserv.client.postgresql.Server.Name, java.lang.String, java.lang.String)
• UserServer

isEmailDomainAvailable

public boolean isEmailDomainAvailable(DomainName domain,
 String aoServer)
                               throws IllegalArgumentException,
IOException,
SQLException

Determines if a Domain is available.

Parameters:

domain - the domain

aoServer - the hostname of the server

Returns:

true if the Domain is available

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if the Domain is invalid

See Also:

• Server.isEmailDomainAvailable(com.aoapps.net.DomainName)
• addEmailDomain(com.aoapps.net.DomainName, java.lang.String, com.aoindustries.aoserv.client.account.Account.Name)
• Domain

isSharedTomcatNameAvailable

public boolean isSharedTomcatNameAvailable(String name)
                                    throws IOException,
SQLException

Determines if a name is available for use as a SharedTomcat.

Parameters:

name - the name

Returns:

true if the name is available

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

See Also:

• SharedTomcatTable.isSharedTomcatNameAvailable(java.lang.String)
• generateSharedTomcatName(java.lang.String)
• SharedTomcat

isSiteNameAvailable

public boolean isSiteNameAvailable(String siteName)
                            throws IllegalArgumentException,
IOException,
SQLException

Determines if a site name is available.

Parameters:

siteName - the site name

Returns:

true if the site name is available

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if the site name is invalid

See Also:

• SiteTable.isSiteNameAvailable(java.lang.String)

isUsernameAvailable

public boolean isUsernameAvailable(User.Name username)
                            throws IOException,
SQLException

Determines if a User is available.

Parameters:

username - the username

Returns:

true if the User is available

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

See Also:

• UserTable.isUsernameAvailable(com.aoindustries.aoserv.client.account.User.Name)
• addUsername(com.aoindustries.aoserv.client.account.Account.Name, com.aoindustries.aoserv.client.account.User.Name)
• User

moveAccount

public void moveAccount(Account.Name business,
 String from,
 String to,
 TerminalWriter out)
                 throws IllegalArgumentException,
IOException,
SQLException

Moves all resources for one Account from one Server to another Server.

Parameters:

business - the accounting code of the Account

from - the hostname of the Server to get all the resources from

to - the hostname of the Server to place all the resources on

out - an optional TerminalWriter to send diagnostic output to

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find the Account or either of the servers

See Also:

• Account.move(com.aoindustries.aoserv.client.linux.Server, com.aoindustries.aoserv.client.linux.Server, com.aoapps.hodgepodge.io.TerminalWriter)

moveIpAddress

public void moveIpAddress(InetAddress ipAddress,
 String fromServer,
 String fromNetDevice,
 String toServer)
                   throws IllegalArgumentException,
IOException,
SQLException

Moves an IpAddress from one Host to another.

Parameters:

ipAddress - the IP address to move

toServer - the destination server

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database

IllegalArgumentException - if unable to find the IpAddress or the Host

See Also:

• IpAddress.moveTo(com.aoindustries.aoserv.client.net.Host)

ping

public int ping()
         throws IOException,
SQLException

Times the latency of the communication with the server.

Returns:

the latency of the communication in milliseconds

Throws:

IOException

SQLException

See Also:

• AoservConnector.ping()

printZoneFile

public void printZoneFile(String zone,
 PrintWriter out)
                   throws IllegalArgumentException,
SQLException,
IOException

Prints the contents of a Zone as used by the named process.

Parameters:

zone - the name of the Zone

out - the PrintWriter to write to

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Zone

See Also:

• Zone.printZoneFile(java.io.PrintWriter)
• addDnsZone(com.aoindustries.aoserv.client.account.Account.Name, java.lang.String, com.aoapps.net.InetAddress, int)

refreshEmailSmtpRelay

public void refreshEmailSmtpRelay(int pkey,
 long minDuration)
                           throws IllegalArgumentException,
IOException,
SQLException

Refreshes the time window for SMTP server access by resetting the expiration to 24 hours from the current time.

Parameters:

pkey - the id of the SmtpRelay

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the SmtpRelay

See Also:

• SmtpRelay.refresh(long)
• addEmailSmtpRelay(com.aoindustries.aoserv.client.account.Account.Name, java.lang.String, com.aoapps.net.HostAddress, java.lang.String, long)
• SmtpRelay

removeBlackholeEmailAddress

public void removeBlackholeEmailAddress(String address,
 DomainName domain,
 String aoServer)
                                 throws IllegalArgumentException,
IOException,
SQLException

Removes a BlackholeAddress from the system.

Parameters:

address - the part of the email address before the @

domain - the part of the email address after the @

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Domain, Address, or BlackholeAddress

See Also:

• BlackholeAddress.remove()

removeAdministrator

public void removeAdministrator(User.Name username)
                         throws IllegalArgumentException,
IOException,
SQLException

Removes an Administrator from the system.

Parameters:

username - the username of the Administrator

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the User or Administrator

See Also:

• Administrator.remove()
• addAdministrator(com.aoindustries.aoserv.client.account.User.Name, java.lang.String, java.lang.String, java.sql.Date, boolean, java.lang.String, java.lang.String, java.lang.String, java.lang.String, com.aoapps.net.Email, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean)

removeAccountHost

public void removeAccountHost(Account.Name accounting,
 String server)
                       throws IllegalArgumentException,
IOException,
SQLException

Revokes an account's access to a Host. The server must not have any resources allocated for the business, and the server must not be the default server for the business.

Parameters:

accounting - the accounting code of the business

server - the hostname of the server

Throws:

IOException - if unable to communicate with the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the business or server

See Also:

• AccountHost
• AccountHost.remove()
• addAccountHost(com.aoindustries.aoserv.client.account.Account.Name, java.lang.String)
• setDefaultAccountHost(com.aoindustries.aoserv.client.account.Account.Name, java.lang.String)

removeCreditCard

public void removeCreditCard(int pkey)
                      throws IllegalArgumentException,
SQLException,
IOException

Removes a CreditCard.

Parameters:

pkey - the id of the CreditCard to remove

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the CreditCard

See Also:

• CreditCard.remove()

removeCvsRepository

public void removeCvsRepository(String aoServer,
 PosixPath path)
                         throws IllegalArgumentException,
IOException,
SQLException

Removes a CvsRepository.

Parameters:

aoServer - the hostname of the Server

path - the path of the repository

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Server or CvsRepository

See Also:

• CvsRepository.remove()
• addCvsRepository(java.lang.String, com.aoindustries.aoserv.client.linux.PosixPath, com.aoindustries.aoserv.client.linux.User.Name, com.aoindustries.aoserv.client.linux.Group.Name, long)
• CvsRepository

removeDnsRecord

public void removeDnsRecord(int pkey)
                     throws IllegalArgumentException,
IOException,
SQLException

Removes one record from a Zone.

Parameters:

pkey - the id of the Record to remove

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Record

See Also:

• Record.remove()
• addDnsRecord(java.lang.String, java.lang.String, java.lang.String, int, int, int, short, java.lang.String, java.lang.String, int)
• Record

removeDnsRecord

public void removeDnsRecord(String zone,
 String domain,
 String type,
 String tag,
 String destination)
                     throws IllegalArgumentException,
IOException,
SQLException

Throws:

IllegalArgumentException

IOException

SQLException

removeDnsZone

public void removeDnsZone(String zone)
                   throws IllegalArgumentException,
IOException,
SQLException

Completely removes a Zone from the servers.

Parameters:

zone - the name of the Zone to remove

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Zone

See Also:

• Zone.remove()
• addDnsZone(com.aoindustries.aoserv.client.account.Account.Name, java.lang.String, com.aoapps.net.InetAddress, int)
• Zone

setDnsZoneTtl

public void setDnsZoneTtl(String zone,
 int ttl)
                   throws IllegalArgumentException,
IOException,
SQLException

Completely removes a Zone from the servers.

Parameters:

zone - the name of the Zone to remove

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Zone

See Also:

• Zone.remove()
• addDnsZone(com.aoindustries.aoserv.client.account.Account.Name, java.lang.String, com.aoapps.net.InetAddress, int)
• Zone

removeEmailAddress

public void removeEmailAddress(String address,
 DomainName domain,
 String aoServer)
                        throws IllegalArgumentException,
IOException,
SQLException

Removes an Address from the system. If the Address is used by other resources, such as ListAddress, those resources are also removed.

Parameters:

address - the part of the email address before the @

domain - the part of the email address after the @

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Domain or Address

See Also:

• Address.remove()
• addEmailForwarding(java.lang.String, com.aoapps.net.DomainName, java.lang.String, com.aoapps.net.Email)
• addEmailListAddress(java.lang.String, com.aoapps.net.DomainName, com.aoindustries.aoserv.client.linux.PosixPath, java.lang.String)
• addEmailPipeAddress(java.lang.String, com.aoapps.net.DomainName, int)
• addLinuxAccAddress(java.lang.String, com.aoapps.net.DomainName, java.lang.String, com.aoindustries.aoserv.client.linux.User.Name)

removeEmailForwarding

public void removeEmailForwarding(String address,
 DomainName domain,
 String aoServer,
 Email destination)
                           throws IllegalArgumentException,
IOException,
SQLException

Removes an Forwarding from the system.

Parameters:

address - the part of the email address before the @

domain - the part of the email address after the @

aoServer - the hostname of the server that hosts this domain

destination - the destination of the email forwarding

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Domain, Address, or Forwarding

See Also:

• Forwarding.remove()
• addEmailForwarding(java.lang.String, com.aoapps.net.DomainName, java.lang.String, com.aoapps.net.Email)

removeEmailList

public void removeEmailList(PosixPath path,
 String aoServer)
                     throws IllegalArgumentException,
IOException,
SQLException

Removes an List from the system. All Addresses that are directed to the list are also removed. The file that stores the list contents is removed from the file system.

Parameters:

path - the path of the List to remove

aoServer - the server that hosts this list

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the List

See Also:

• List.remove()
• addEmailList(java.lang.String, com.aoindustries.aoserv.client.linux.PosixPath, com.aoindustries.aoserv.client.linux.User.Name, com.aoindustries.aoserv.client.linux.Group.Name)

removeEmailListAddress

public void removeEmailListAddress(String address,
 DomainName domain,
 PosixPath path,
 String aoServer)
                            throws IllegalArgumentException,
IOException,
SQLException

Removes an ListAddress from the system.

Parameters:

address - the part of the email address before the @

domain - the part of the email address after the @

path - the list the emails are sent to

aoServer - the hostname of the server hosting the list

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Domain, Address, List, or ListAddress

See Also:

• ListAddress.remove()
• addEmailListAddress(java.lang.String, com.aoapps.net.DomainName, com.aoindustries.aoserv.client.linux.PosixPath, java.lang.String)

removeEmailPipe

public void removeEmailPipe(int pkey)
                     throws IllegalArgumentException,
IOException,
SQLException

Removes an Pipe from the system. All Addresses that are directed to the pipe are also removed.

Parameters:

pkey - the id of the Pipe to remove

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Pipe

See Also:

• Pipe.remove()
• addEmailPipe(java.lang.String, java.lang.String, com.aoindustries.aoserv.client.account.Account.Name)

removeEmailPipeAddress

public void removeEmailPipeAddress(String address,
 DomainName domain,
 int pipe)
                            throws IllegalArgumentException,
IOException,
SQLException

Removes an PipeAddress from the system.

Parameters:

address - the part of the email address before the @

domain - the part of the email address after the @

pipe - the pkey of the email pipe

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Domain, Address, Pipe, or PipeAddress

See Also:

• PipeAddress.remove()
• addEmailPipeAddress(java.lang.String, com.aoapps.net.DomainName, int)

removeFtpGuestUser

public void removeFtpGuestUser(User.Name username)
                        throws IllegalArgumentException,
IOException,
SQLException

Removes the GuestUser flag from a User, allowing access to the server root directory.

Parameters:

username - the username of the GuestUser

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the GuestUser

See Also:

• GuestUser.remove()
• addFtpGuestUser(com.aoindustries.aoserv.client.linux.User.Name)

removeHttpdSharedTomcat

public void removeHttpdSharedTomcat(String name,
 String aoServer)
                             throws IllegalArgumentException,
IOException,
SQLException

Completely removes a SharedTomcat from the servers.

Parameters:

name - the name of the site

aoServer - the server the site runs on

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the SharedTomcat

See Also:

• SharedTomcat.remove()
• SharedTomcat

removeHttpdSite

public void removeHttpdSite(String name,
 String aoServer)
                     throws IllegalArgumentException,
IOException,
SQLException

Completely removes a Site from the servers.

Parameters:

name - the name of the site

aoServer - the server the site runs on

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Site

See Also:

• Site.remove()
• Site

removeVirtualHostName

public void removeVirtualHostName(int pkey)
                           throws IllegalArgumentException,
IOException,
SQLException

Removes a VirtualHostName from the servers.

Parameters:

pkey - the pkey of the site URL

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the VirtualHostName

See Also:

• VirtualHostName.remove()

removeHttpdTomcatContext

public void removeHttpdTomcatContext(int pkey)
                              throws IllegalArgumentException,
IOException,
SQLException

Removes a Context from the servers.

Parameters:

pkey - the pkey of the context

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Context

See Also:

• Context.remove()

removeHttpdTomcatDataSource

public void removeHttpdTomcatDataSource(int pkey)
                                 throws IllegalArgumentException,
IOException,
SQLException

Removes a ContextDataSource from a Context.

Parameters:

pkey - the pkey of the data source

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the ContextDataSource

See Also:

• Context.remove()

removeHttpdTomcatParameter

public void removeHttpdTomcatParameter(int pkey)
                                throws IllegalArgumentException,
IOException,
SQLException

Removes a ContextParameter from a Context.

Parameters:

pkey - the pkey of the parameter

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the ContextParameter

See Also:

• Context.remove()

removeLinuxAccAddress

public void removeLinuxAccAddress(String address,
 DomainName domain,
 String aoServer,
 User.Name username)
                           throws IllegalArgumentException,
IOException,
SQLException

Removes a InboxAddress from the system.

Parameters:

address - the part of the email address before the @

domain - the part of the email address after the @

username - the account the emails are sent to

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Domain, Address, User, User, or InboxAddress

See Also:

• InboxAddress.remove()
• addLinuxAccAddress(java.lang.String, com.aoapps.net.DomainName, java.lang.String, com.aoindustries.aoserv.client.linux.User.Name)

removeLinuxAccount

public void removeLinuxAccount(User.Name username)
                        throws IllegalArgumentException,
IOException,
SQLException

Removes a User and all related data from the system.

Parameters:

username - the username of the User to remove

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the User

See Also:

• User.remove()
• addLinuxAccount(com.aoindustries.aoserv.client.linux.User.Name, com.aoindustries.aoserv.client.linux.Group.Name, com.aoindustries.aoserv.client.linux.User.Gecos, com.aoindustries.aoserv.client.linux.User.Gecos, com.aoindustries.aoserv.client.linux.User.Gecos, com.aoindustries.aoserv.client.linux.User.Gecos, java.lang.String, com.aoindustries.aoserv.client.linux.PosixPath)

removeLinuxGroup

public void removeLinuxGroup(Group.Name name)
                      throws IllegalArgumentException,
IOException,
SQLException

Removes a Group and all related data from the system.

Parameters:

name - the name of the Group to remove

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Group

See Also:

• Group.remove()
• addLinuxGroup(com.aoindustries.aoserv.client.linux.Group.Name, com.aoindustries.aoserv.client.account.Account.Name, java.lang.String)

removeLinuxGroupAccount

public void removeLinuxGroupAccount(Group.Name group,
 User.Name username)
                             throws IllegalArgumentException,
IOException,
SQLException

Removes a User's access to a Group.

Parameters:

group - the name of the Group to remove access to

username - the username of the User to remove access from

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Group, User, or GroupUser

See Also:

• GroupUser.remove()
• addLinuxGroupAccount(com.aoindustries.aoserv.client.linux.Group.Name, com.aoindustries.aoserv.client.linux.User.Name)
• addLinuxGroup(com.aoindustries.aoserv.client.linux.Group.Name, com.aoindustries.aoserv.client.account.Account.Name, java.lang.String)
• addLinuxAccount(com.aoindustries.aoserv.client.linux.User.Name, com.aoindustries.aoserv.client.linux.Group.Name, com.aoindustries.aoserv.client.linux.User.Gecos, com.aoindustries.aoserv.client.linux.User.Gecos, com.aoindustries.aoserv.client.linux.User.Gecos, com.aoindustries.aoserv.client.linux.User.Gecos, java.lang.String, com.aoindustries.aoserv.client.linux.PosixPath)

removeLinuxServerAccount

public void removeLinuxServerAccount(User.Name username,
 String aoServer)
                              throws IllegalArgumentException,
IOException,
SQLException

Removes a UserServer from a Server.

Parameters:

username - the username of the UserServer to remove

aoServer - the hostname of the Server to remove the account from

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the User, Server, or UserServer

See Also:

• UserServer.remove()
• addLinuxServerAccount(com.aoindustries.aoserv.client.linux.User.Name, java.lang.String, com.aoindustries.aoserv.client.linux.PosixPath)

removeLinuxServerGroup

public void removeLinuxServerGroup(Group.Name group,
 String aoServer)
                            throws IllegalArgumentException,
IOException,
SQLException

Removes a GroupServer from a Server.

Parameters:

group - the name of the GroupServer to remove

aoServer - the hostname of the Server

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Group, Server, or GroupServer

See Also:

• GroupServer.remove()
• addLinuxServerGroup(com.aoindustries.aoserv.client.linux.Group.Name, java.lang.String)

removeMysqlDatabase

public void removeMysqlDatabase(Database.Name name,
 Server.Name mysqlServer,
 String aoServer)
                         throws IllegalArgumentException,
IOException,
SQLException

Removes a Database from the system. All related DatabaseUsers are also removed, and all data is removed from the MySQL server. The data is not dumped or backed-up during the removal, if a backup is desired, use dumpMysqlDatabase(com.aoindustries.aoserv.client.mysql.Database.Name, com.aoindustries.aoserv.client.mysql.Server.Name, java.lang.String, java.io.Writer).

Parameters:

name - the name of the database

aoServer - the server the database is hosted on

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Server or Database

See Also:

• Database.remove()
• addMysqlDatabase(com.aoindustries.aoserv.client.mysql.Database.Name, com.aoindustries.aoserv.client.mysql.Server.Name, java.lang.String, com.aoindustries.aoserv.client.account.Account.Name)
• dumpMysqlDatabase(com.aoindustries.aoserv.client.mysql.Database.Name, com.aoindustries.aoserv.client.mysql.Server.Name, java.lang.String, java.io.Writer)

removeMysqlDbUser

public void removeMysqlDbUser(Database.Name name,
 Server.Name mysqlServer,
 String aoServer,
 User.Name username)
                       throws IllegalArgumentException,
IOException,
SQLException

Removes a DatabaseUser from the system. The User is no longer allowed to access the Database.

Parameters:

name - the name of the Database

aoServer - the hostname of the Server

username - the username of the User

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Server, Database, UserServer, or DatabaseUser

See Also:

• DatabaseUser.remove()
• addMysqlDbUser(com.aoindustries.aoserv.client.mysql.Database.Name, com.aoindustries.aoserv.client.mysql.Server.Name, java.lang.String, com.aoindustries.aoserv.client.mysql.User.Name, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean)

removeMysqlServerUser

public void removeMysqlServerUser(User.Name username,
 Server.Name mysqlServer,
 String aoServer)
                           throws IllegalArgumentException,
IOException,
SQLException

Removes a UserServer from a the system.. The User is no longer allowed to access the Server.

Parameters:

username - the username of the UserServer

aoServer - the hostname of the Server

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Server or UserServer

See Also:

• UserServer.remove()
• addMysqlServerUser(com.aoindustries.aoserv.client.mysql.User.Name, com.aoindustries.aoserv.client.mysql.Server.Name, java.lang.String, java.lang.String)

removeMysqlUser

public void removeMysqlUser(User.Name username)
                     throws IllegalArgumentException,
IOException,
SQLException

Removes a User from a the system. All of the associated UserServers and DatabaseUsers are also removed.

Parameters:

username - the username of the User

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the User

See Also:

• User.remove()
• addMysqlUser(com.aoindustries.aoserv.client.mysql.User.Name)
• removeMysqlServerUser(com.aoindustries.aoserv.client.mysql.User.Name, com.aoindustries.aoserv.client.mysql.Server.Name, java.lang.String)

removeNetBind

public void removeNetBind(int pkey)
                   throws IllegalArgumentException,
IOException,
SQLException

Removes a Bind from a the system.

Parameters:

pkey - the primary key of the Bind

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Bind

See Also:

• Bind.remove()

removePostgresDatabase

public void removePostgresDatabase(Database.Name name,
 Server.Name postgresServer,
 String aoServer)
                            throws IllegalArgumentException,
IOException,
SQLException

Removes a Database from the system. All data is removed from the PostgreSQL server. The data is not dumped or backed-up during the removal, if a backup is desired, use dumpPostgresDatabase(com.aoindustries.aoserv.client.postgresql.Database.Name, com.aoindustries.aoserv.client.postgresql.Server.Name, java.lang.String, java.io.Writer).

Parameters:

name - the name of the database

postgresServer - the name of the PostgreSQL server

aoServer - the server the database is hosted on

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Server or Database

See Also:

• Database.remove()
• addPostgresDatabase(com.aoindustries.aoserv.client.postgresql.Database.Name, com.aoindustries.aoserv.client.postgresql.Server.Name, java.lang.String, com.aoindustries.aoserv.client.postgresql.User.Name, java.lang.String, boolean)
• dumpPostgresDatabase(com.aoindustries.aoserv.client.postgresql.Database.Name, com.aoindustries.aoserv.client.postgresql.Server.Name, java.lang.String, java.io.Writer)

removePostgresServerUser

public void removePostgresServerUser(User.Name username,
 Server.Name postgresServer,
 String aoServer)
                              throws IllegalArgumentException,
IOException,
SQLException

Removes a UserServer from a the system.. The User is no longer allowed to access the Server.

Parameters:

username - the username of the UserServer

postgresServer - the name of the PostgreSQL server

aoServer - the hostname of the Server

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the Server or UserServer

See Also:

• UserServer.remove()

removePostgresUser

public void removePostgresUser(User.Name username)
                        throws IllegalArgumentException,
IOException,
SQLException

Removes a User from a the system.. All of the associated UserServers are also removed.

Parameters:

username - the username of the User

Throws:

IOException - if unable to contact the server

SQLException - if unable to access the database or a data integrity violation occurs

IllegalArgumentException - if unable to find the User

See Also:

• User.remove()
• addPostgresUser(com.aoindustries.aoserv.client.postgresql.User.Name)
• removePostgresServerUser(com.aoindustries.aoserv.client.postgresql.User.Name, com.aoindustries.aoserv.client.postgresql.Server.Name, java.lang.String)

removeEmailDomain

public void removeEmailDomain(DomainName domain,
 String aoServer)
                       throws IllegalArgumentException,
IOException,
SQLException

Removes an Domain and all of its Addresses.

Parameters:

domain - the name of the Domain

aoServer - the server hosting this domain

Throws: