All Classes and Interfaces

Class
Description
An Account is one distinct set of packages, resources, and permissions.
The unique, case-insensitive identifier for an Account.
An AccountHost grants an Account permission to access resources on a Server.
 
 
 
TicketActions represent a complete history of the changes that have been made to a ticket.
 
All of the types of ticket changes are represented by these TicketActionTypes.
The table containing all of the possible types of actions that may be performed on a ticket.
An EmailAddress represents a unique email address hosted on an AOServ server.
 
An Administrator is a username and password pair, usually representing an individual or an application, that has administrative control over all resources in an Account or any any of its child businesses.
Associates a permission with a business administrator.
 
 
The different alert levels in the system.
The default client configuration is stored in a properties resource named /com/aoindustries/aoserv/client/aoesrv-client.properties.
An AoservConnection is one stream of communication between the client and the server.
An AoservConnector provides the connection between the object layer and the data.
 
This is the preferred mechanism for providing custom requests that have a return value.
This is the preferred mechanism for providing custom requests.
An update request with a returned invalidation list.
An AoservObject is the lowest level object for all data in the system.
 
Constants used in communication between the client and server.
Since the ordinals are used in the protocol (for compatibility with older implementations), values must be added to the end of this enum.
The current version of the client/server protocol.
 
Something that can be read with a given version represented by AoservProtocol.Version.
Streamable with a given version represented by AoservProtocol.Version.
An AoservTable provides access to one set of AoservObjects.
 
Something that can be written with a given version represented by AoservProtocol.Version.
Aosh is a command interpreter and scripting language based on the Bourne shell.
Escapes arbitrary values for use in Apache directives.
A Protocol represents one type of application protocol used in NetBinds.
 
An Architecture is a simple wrapper for the type of computer architecture used in a server.
 
 
 
An EmailAttachmentBlock restricts one attachment type on one email inbox.
 
An EmailAttachmentType represents one extension that may be blocked by virus filters.
 
BackupPartition stores backup data.
 
A BackupReport is generated once per day per package and per server.
 
The possible backup retention values allowed in the system.
 
For AO Industries use only.
For AO Industries use only.
For AO Industries use only.
For AO Industries use only.
For AO Industries use only.
For AO Industries use only.
For AO Industries use only.
For AO Industries use only.
All listening network ports must be registered as a NetBind.
Each port may be independently associated with a specific set of Firewalld Zones.
 
 
Any email sent to a BlackholeEmailAddress is piped directly to /dev/null - the bit bucket - the email appears to have been delivered but is simply discarded.
 
A brand has separate website, packages, nameservers, and support.
 
 
 
A CachedObject is stored in a CachedTable for greater performance.
An object that is cached and uses an int as its primary key.
An object that is cached and uses Group.Name as its primary key.
An object that is cached and uses an int as its primary key.
An object that is cached and uses a long as its primary key.
An object that is cached and uses an int as its primary key.
An object that is cached and uses User.Name as its primary key.
An object that is cached and uses User.Name as its primary key.
An object that is cached and uses User.Name as its primary key.
An object that is cached and uses User.Name as its primary key.
A CachedTable stores all of the available CachedObjects and performs all subsequent data access locally.
 
 
 
 
 
 
 
 
 
Encapsulates a reason and optional dependent object.
 
 
 
 
 
 
 
 
 
The set of possible classes.
Meta-data for every field of every AoservObject is available as a SchemaColumn.
 
Information about every command in the Aosh is available through the use of Command.
 
Represents one context within a HttpdTomcatSite.
Represents one data source within a HttpdTomcatContext.
 
Represents one parameter within a HttpdTomcatContext.
 
 
A CountryCode is a simple wrapper for country code and name mappings.
 
A CreditCard stores credit card information.
 
A Currency represents one type supported Currency.
 
A CvsRepository represents on repository directory for the CVS pserver.
 
Each CyrusImapdServer may listen for network connections on multiple NetBinds.
 
An CyrusImapdServer represents one running instance of Cyrus IMAPD.
 
 
A limited number of hosts may connect to a server's daemon, each is configured as an AOServerDaemonHost.
 
A Database corresponds to a unique MySQL table space on one server.
A PostgresDatabase corresponds to a unique PostgreSQL table space on one server.
 
 
 
Represents a name that may be used for a Database.
Represents a name that may be used for a PostgreSQL database.
 
 
 
 
 
A MysqlDbUser grants a MysqlServerUser access to a MysqlDatabase.
 
Each server has multiple network devices, each listening on different IP addresses.
A DeviceId is a simple wrapper for the different names of network devices used in Linux servers.
 
 
Classes that are Disablable can be disable and enabled.
When a resource or resources are disabled, the reason and time is logged.
 
For AO Industries use only.
For AO Industries use only.
For AO Industries use only.
For AO Industries use only.
For AO Industries use only.
For AO Industries use only.
A EmailDomain is one hostname/domain of email addresses hosted on a Server.
 
Flags an AoservObject as being able to dump its contents into a PrintWriter.
Beginning with PostgreSQL 7.1, multiple character encoding formats are supported, the PostgresEncodings represent the possible formats.
 
Stores the list of encryption keys for a business.
 
For AO Industries use only.
For AO Industries use only.
Causes a server to replicate itself to another machine on a regular basis.
 
The entire contents of servers are periodically replicated to another server.
 
A FailoverFileSchedule controls which time of day (in server time zone) the failover file replications will occur.
 
A FileBackupSetting overrides the default backup behavior.
 
 
A FilesystemCachedObject is stored in a temporary file on disk for local-speed performance while using minimal heap space.
A FilesystemCachedTable stores all of the available FilesystemCachedObjects in a temporary file and performs all subsequent data access locally.
Defines a firewalld zone that exists on a Host.
Represents a name that may be used for a FirewallZone.
 
 
A DNSForbiddenZone is a zone that may not be hosted by AO Industries' name servers.
 
A SchemaForeignKey represents when a column in one AoservTable references a column in another AoservTable.
 
An EmailForwarding directs incoming mail to a different destination.
An Architecture wraps all the data for a single supported computer architecture.
 
A GlobalObject is stored in a GlobalTable and shared by all users for greater performance.
An object that is cached and uses a DomainName as its primary key.
An object that is cached and uses an int as its primary key.
An object that is cached and uses a PosixPath as its primary key.
An object that is cached and uses a String as its primary key.
A GlobalTable is shared between all users.
 
 
 
 
A LinuxGroup may exist on multiple Servers.
Represents a group ID that may be used by certain types of groups.
A LinuxServerGroup adds a LinuxGroup to a Server, so that LinuxServerAccount with access to the group may use the group on the server.
 
 
Each LinuxGroup's use is limited by which LinuxGroupType is associated with it.
 
Each LinuxGroup may be accessed by any number of LinuxAccounts.
 
If a LinuxAccount has a FtpGuestUser attached to it, FTP connections will be limited with their home directory as the root directory.
 
 
 
Each VirtualHost may have header configurations attached to it.
 
 
A Server stores the details about a single, physical server.
One host tracked by an IpReputationSet.
 
 
Each HttpdServer may listen for network connections on multiple NetBinds.
 
An HttpdServer represents one running instance of the Apache web server.
 
A LinuxAccount may have any number of email addresses routed to it to become an email inbox.
 
InboxAttributes stores all the details of a mail inbox.
Each IpAddress represents a unique IPv4 address.
 
 
 
A JDBCProvider provides connection information for a JDBC-enabled database.
Each Site has independently configured JkMount and JkUnMount directives.
 
Apache's mod_jk supports multiple versions of the Apache JServ Protocol.
 
 
 
An IpReputationLimiter rate-limits traffic by class and type.
The limit for one class of a IpReputationLimiter.
The set of possible units.
 
One set used by a IpReputationLimiter.
 
 
 
 
 
Several resources on a Server require a server-wide unique identifier.
 
 
Any incoming email addressed to a List is immediately forwarded on to all addresses contained in the list.
An List may receive email on multiple addresses, and then forward those emails to the list of destinations.
 
 
TODO: Make the authentication aspect optional since this now has an optional handler.
The set of expected handlers.
 
A MajordomoList is one list within a MajordomoServer.
 
A MajordomoServer provides Majordomo functionality for a EmailDomain.
 
Multiple versions of Majordomo are supported by the system.
 
 
Helper functions for Money.
Miscellaneous monthly charges may be applied to an Account.
 
 
Represents MySQL replication for one a FailoverFileReplication or Server.
 
 
 
 
 
A NestedInputStream reads data from within a StreamableInput as if it were a separate stream.
One network tracked by an IpReputationSet.
 
A NoticeLog entry is created when a client has been notified of either a failed credit card transaction or a past due debt.
A NoticeLog has the account balances at the time the notice was sent.
 
 
Each reason for notifying clients is represented by a NoticeType.
 
One type of operating system.
All of the operating systems referenced from other tables.
One version of a operating system.
All of the operating system versions referenced from other tables.
Stores an option for a sign-up request, each option has a unique name per sign-up request.
 
A Package is a set of resources and its associated price.
A PackageCategory represents one type of service.
 
A PackageDefinition stores one unique set of resources, limits, and prices.
A PackageDefinitionLimit stores one limit that is part of a PackageDefinition.
 
 
 
Static utilities for use in SQL parsing.
Performs password checking for all password protected services.
 
 
Generates easily remembered random passwords of at least 38 bits of entropy.
Classes that are PasswordProtected provide mechanisms for checking password strength.
A CreditCardTransaction stores the complete history of credit card transactions.
 
The system can process several different PaymentTypes.
 
All of the permissions within the system.
The possible permissions.
The table containing all of the possible permissions.
A PhysicalServer consumes space and electricity in a rack and provides resources.
 
 
Incoming email addressed to an EmailPipe is piped into a native process.
Any number of EmailAddresses may be directed to an EmailPipe.
 
 
 
Represents a full path in POSIX style.
 
 
 
Tickets are prioritized by both the client and support personnel.
 
When a PrivateFtpServer is attached to a NetBind, the FTP server reponds as configured in the PrivateFtpServer.
 
An HttpdStdTomcatSite indicates that a HttpdTomcatSite is configured in the standard layout of one Tomcat instance per Java virtual machine.
 
Each Thread on the master reports its activities so that a query on this table shows a snapshot of the currently running system.
A CreditCardProcessor represents on Merchant account used for credit card processing.
 
All of the types of processors.
The table containing all of the possible processor types.
 
Contact information associated with an Account.
The set of possible units.
 
Synchronously notified of table loading progress.
A Rack stores PhysicalServers.
 
A DNSRecord is one line of a DNSZone (name server zone file).
 
The DNSType associated with a DNSRecord provides details about which values should be used in the destination field, and whether a priority, weight, and port should exist.
 
Flags an AoservObjects as being able to be removed with a call to the remove() method.
Stores a single sign-up request.
 
A reseller may handle support tickets..
 
A Resource is a measurable hardware resource.
 
Each VirtualHost may have RewriteRule configurations attached to it.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
A parent container of Schema.
Each SendmailServer may listen for network connections on multiple NetBinds.
 
An SendmailServer represents one running instance of Sendmail.
 
A Server stores the details about a server that runs the AOServ distribution.
A MysqlServer corresponds to a unique MySQL install space on one server.
A PostgresServer corresponds to a unique PostgreSQL install space on one server.
 
 
Obtained from http://www.drbd.org/users-guide/ch-admin.html#s-connection-states
Obtained from http://www.drbd.org/users-guide/ch-admin.html#s-disk-states
Obtained from http://www.drbd.org/users-guide/ch-admin.html#s-roles
 
 
 
 
 
 
 
 
 
The results of the most recent weekly RAID check.
Represents a name that may be used for a MySQL installation.
Represents a name that may be used for a PostgreSQL installation.
 
Deprecated.
2019-07-14: Is this still used?
Deprecated.
2019-07-14: Is this still used?
AO Industries provides greater reliability through the use of multiple network locations.
For AO Industries use only.
To aid in system reliability, scalability, and debugging, many server runtime statistics are maintained.
 
 
 
 
An IpReputationSet stores network and host IP reputation fed from external sources.
 
 
 
 
An HttpdSharedTomcat stores configuration information about the Jakarta Tomcat JVM under which run one or more HttpdTomcatSharedSites.
An HttpdTomcatSharedSite is an HttpdTomcatSite running under an HttpdSharedTomcat.
 
 
All of the possible Linux login shells are provided as Shells.
 
SimpleAoservClient is a simplified interface into the client code.
Indicates that an object is contained in only one table.
An HttpdJbossSite indicates that an HttpdSite uses JBoss as its servlet engine.
An HttpdSite is one unique set of web content and resides in its own directory under /www.
An HttpdTomcatSite indicates that an HttpdSite uses the Jakarta Tomcat project as its servlet engine.
 
 
 
When a user successfully logs into either the POP3 or IMAP mail systems, access from their host is granted to the SMTP server via a EmailSmtpRelay.
 
The EmailSmtpRelayType of an EmailSmtpRelay controls the servers response.
 
Provides SMTP relay services for one or more non-managed servers.
Provides non-default per-domain smart host limits.
 
 
A SocketConnection is a single, persistent, plaintext connection to the server.
A TechnologyName represents one piece of software installed in the system.
A Technology associates a TechnologyClass with a TechnologyName.
 
A TechnologyClass is one type of software package installed on the servers.
 
 
Each TechnologyName may have multiple versions installed.
 
An EmailSpamAssassinIntegrationMode is a simple wrapper for the types of SpamAssassin integration modes.
 
Every SpamEmailMessage that causes an IP address to be blocked via a EmailSmtpRelay is logged in this table.
 
Casts one result type to another.
Gets the value for one column by following its reference to another table.
Gets the value for one column.
Compares columns.
An expression in used in select statements and internal sorting.
A SslConnector provides the connection between the client and server over secured SSL sockets.
An HttpdStaticSite indicates that an HttpdSite serves static content only.
 
The TicketStatus of a Ticket changes through each step of its life cycle.
 
Handles a response stream.
Each Server has several entries in /etc/aliases that do not belong to any particular EmailDomain or Package.
 
Systemd utilities.
 
Each set of tables in the protocol used by this client version.
Synchronously notified with each object as the table is being loaded.
Represents a name that may be used for a MySQL table.
 
A TcpConnector provides the connection between the object layer and the data over a pool of un-secured sockets.
Each server may perform TCP redirects via xinetd.
 
The Ticket system allows clients to submit support requests and monitor the progress of the work.
An implementation of Handler that logs to the ticket system.
 
Each Ticket is of a specific TicketType.
 
All of the time zones on a server.
The table containing all of the possible time zones.
A DNSTLD is a name server top level domain.
 
Each Account has an account of all the charges and payments processed.
A TransactionSearchCriteria stores all the parameters for a Transaction search.wraps all the different ways in which the transaction table may be searched.
 
A TransactionType is one type that may be used in a Transaction.
 
A Type is a unique data type used for Column.
 
Each Username is unique across all systems and must be allocated to a Package before use in any of the account types.
One user may have shell, FTP, and/or email access to any number of servers.
A MasterUser is an Administrator who has greater permissions.
A MysqlUser stores the details of a MySQL account that are common to all servers.
A PostgresUser may have access to multiple servers.
Used for the various user-provided fields in the /etc/passwd file.
Represents the most general form of a user name.
Represents a Linux username.
Represents a MySQL user ID.
Represents a PostgreSQL user ID.
A MasterHost controls which hosts a MasterUser is allowed to connect from.
 
MasterUsers are restricted to data based on a list of Servers they may access.
 
 
A LinuxServerAccount grants a LinuxAccount access to a Server.
A MysqlServerUser grants a MysqlUser access to a Server.
A PostgresServerUser grants a PostgresUser access to a Server.
 
 
 
 
 
 
 
 
The LinuxAccountType of a LinuxAccount controls which systems the account may access.
 
A USState represents State of the United States.
 
A PostgresVersion flags which TechnologyVersions are a version of PostgreSQL.
An HttpdJbossVersion flags which TechnologyVersions are a version of the JBoss EJB Container.
An HttpdTomcatVersion flags which TechnologyVersions are a version of the Jakarta Tomcat servlet engine.
 
 
 
A VirtualDisk is a block device for a VirtualServer.
 
 
Multiple HttpdSiteURLs may be attached to a unique combination of HttpdSite and HttpdBind, represented by an HttpdSiteBind.
 
 
A VirtualServer consumes physical resources within the virtualization layer.
 
Logs the whois history for each registrable domain.
Logs which accounts were associated with a registrable domain at the time of whois lookup.
 
 
An HttpdWorker represents a unique combination of HttpdJKCode and HttpdTomcatSite.
When using Apache's mod_jk, each connection to a servlet container is assigned a unique two-character identifier.
 
 
A DNSZone is one domain hosted in the name servers.