Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.billing

Class Package

java.lang.Object

com.aoindustries.aoserv.client.AoservObject<Integer,Package>

com.aoindustries.aoserv.client.CachedObject<Integer,Package>

com.aoindustries.aoserv.client.CachedObjectIntegerKey<Package>

com.aoindustries.aoserv.client.billing.Package

All Implemented Interfaces:

Streamable, StreamReadable, StreamWritable, Row, AoservReadable, AoservStreamable, AoservWritable, Disablable, SingleTableObject<Integer,Package>, Comparable<Package>

public final class Package
extends CachedObjectIntegerKey<Package>
implements Disablable, Comparable<Package>

A Package is a set of resources and its associated price. An Account may multiple Packages, each with their own monthly fee and sets of resources such as web sites, databases and users. Security is not maintained between Packages, only between accounts. If intra-account security is required, please use child accounts.

Author:

AO Industries, Inc.

See Also:

• Account
• PackageDefinition

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COLUMN_NAME_name
static final int	DEFAULT_EMAIL_IN_BURST	The default inbound email burst before rate limiting.
static final float	DEFAULT_EMAIL_IN_RATE	The default sustained inbound email rate in emails/second.
static final int	DEFAULT_EMAIL_OUT_BURST	The default outbound email burst before rate limiting.
static final float	DEFAULT_EMAIL_OUT_RATE	The default sustained outbound email rate in emails/second.
static final int	DEFAULT_EMAIL_RELAY_BURST	The default relay email burst before rate limiting.
static final float	DEFAULT_EMAIL_RELAY_RATE	The default sustained relay email rate in emails/second.

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

pkey

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

table

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

USE_ARRAY_OF_DOMAIN, USE_SQL_DATA, USE_SQL_DATA_WRITE

Constructor Summary

Constructors

Constructor	Description
Package()	Deprecated, for removal: This API element is subject to removal in a future version. Only required for implementation, do not use directly.

Method Summary

Modifier and Type	Method	Description
void	addDnsZone(String zone, InetAddress ip, int ttl)
int	addEmailSmtpRelay(Server aoServer, HostAddress host, SmtpRelayType type, long duration)
void	addLinuxGroup(Group.Name name, GroupType type)
void	addLinuxGroup(Group.Name name, String type)
void	addUsername(User.Name username)
boolean	canDisable()
boolean	canEnable()
int	compareTo(Package o)
void	disable(DisableLog dl)
void	enable()
Account	getAccount()
Account.Name	getAccount_name()
List<BackupReport>	getBackupReports()
protected Object	getColumnImpl(int i)
UnmodifiableTimestamp	getCreated()
Administrator	getCreatedBy()
List<CvsRepository>	getCvsRepositories()
DisableLog	getDisableLog()
Integer	getDisableLog_id()
List<Zone>	getDnsZones()
List<Domain>	getEmailDomains()
int	getEmailInBurst()	Gets the inbound burst limit for emails, the number of emails that may be sent before limiting occurs.
float	getEmailInRate()	Gets the inbound sustained email rate in emails/second.
List<List>	getEmailLists()
int	getEmailOutBurst()	Gets the outbound burst limit for emails, the number of emails that may be sent before limiting occurs.
float	getEmailOutRate()	Gets the outbound sustained email rate in emails/second.
List<Pipe>	getEmailPipes()
int	getEmailRelayBurst()	Gets the relay burst limit for emails, the number of emails that may be sent before limiting occurs.
float	getEmailRelayRate()	Gets the relay sustained email rate in emails/second.
List<SmtpRelay>	getEmailSmtpRelays()
List<MysqlReplication>	getFailoverMysqlReplications()
Host	getHost(String name)
List<HttpdServer>	getHttpdServers()
List<SharedTomcat>	getHttpdSharedTomcats()
List<Site>	getHttpdSites()
List<IpAddress>	getIpAddresses()
List<Group>	getLinuxGroups()
List<Database>	getMysqlDatabases()
List<User>	getMysqlUsers()
Account.Name	getName()
List<Bind>	getNetBinds()
List<Bind>	getNetBinds(IpAddress ip)
PackageDefinition	getPackageDefinition()
int	getPackageDefinition_id()
List<Database>	getPostgresDatabases()
List<User>	getPostgresUsers()
List<SendmailServer>	getSendmailServers()
List<Host>	getServers()
List<Certificate>	getSslCertificates()
Table.TableId	getTableId()
List<User>	getUsernames()
void	init(ResultSet result)	Initializes this object from the raw database contents.
boolean	isDisabled()	Checks if this object is disabled.
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
String	toStringImpl()	AoservObject.toString() implementation that is allowed to throw exceptions.
void	write(StreamableOutput out, AoservProtocol.Version protocolVersion)

Methods inherited from class com.aoindustries.aoserv.client.CachedObjectIntegerKey

equals, getKey, getPkey, hashCode

Methods inherited from class com.aoindustries.aoserv.client.CachedObject

getTable, setTable

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

compare, compare, compare, compare, compareIgnoreCaseConsistentWithEquals, compareTo, compareTo, compareTo, getAccountingCode, getColumn, getColumns, getColumns, getDomainLabel, getDomainLabels, getDomainName, getDto, getEmail, getGecos, getGroupId, getHashedKey, getHashedPassword, getHostname, getInetAddress, getLinuxId, getLinuxUserName, getMacAddress, getMysqlDatabaseName, getMysqlServerName, getMysqlUserName, getPort, getPostgresDatabaseName, getPostgresServerName, getPostgresUserId, getTableSchema, getTimeMillis, getTimeMillis, getUnixPath, getUserId, read, toString, write

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

COLUMN_NAME_name

public static final String COLUMN_NAME_name

See Also:

• Constant Field Values

DEFAULT_EMAIL_IN_BURST

public static final int DEFAULT_EMAIL_IN_BURST

The default inbound email burst before rate limiting.

See Also:

• Constant Field Values

DEFAULT_EMAIL_IN_RATE

public static final float DEFAULT_EMAIL_IN_RATE

The default sustained inbound email rate in emails/second.

See Also:

• Constant Field Values

DEFAULT_EMAIL_OUT_BURST

public static final int DEFAULT_EMAIL_OUT_BURST

The default outbound email burst before rate limiting.

See Also:

• Constant Field Values

DEFAULT_EMAIL_OUT_RATE

public static final float DEFAULT_EMAIL_OUT_RATE

The default sustained outbound email rate in emails/second.

See Also:

• Constant Field Values

DEFAULT_EMAIL_RELAY_BURST

public static final int DEFAULT_EMAIL_RELAY_BURST

The default relay email burst before rate limiting.

See Also:

• Constant Field Values

DEFAULT_EMAIL_RELAY_RATE

public static final float DEFAULT_EMAIL_RELAY_RATE

The default sustained relay email rate in emails/second.

See Also:

• Constant Field Values

Constructor Details

Package

@Deprecated(forRemoval=true)
public Package()

Deprecated, for removal: This API element is subject to removal in a future version.

Only required for implementation, do not use directly.

See Also:

• init(java.sql.ResultSet)
• read(com.aoapps.hodgepodge.io.stream.StreamableInput, com.aoindustries.aoserv.client.schema.AoservProtocol.Version)

Method Details

toStringImpl

public String toStringImpl()

Description copied from class: AoservObject

AoservObject.toString() implementation that is allowed to throw exceptions.

Implementation Note:
This default implementation calls AoservObject.toString() on the key (from AoservObject.getKey()). When the key is null, uses the default implementation from Object.toString().

Overrides:

toStringImpl in class CachedObjectIntegerKey<Package>

addDnsZone

public void addDnsZone(String zone,
 InetAddress ip,
 int ttl)
                throws IOException,
SQLException

Throws:

IOException

SQLException

addEmailSmtpRelay

public int addEmailSmtpRelay(Server aoServer,
 HostAddress host,
 SmtpRelayType type,
 long duration)
                      throws IOException,
SQLException

Throws:

IOException

SQLException

addLinuxGroup

public void addLinuxGroup(Group.Name name,
 GroupType type)
                   throws IOException,
SQLException

Throws:

IOException

SQLException

addLinuxGroup

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

Throws:

IOException

SQLException

addUsername

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

Throws:

IOException

SQLException

canDisable

public boolean canDisable()
                   throws IOException,
SQLException

Specified by:

canDisable in interface Disablable

Throws:

IOException

SQLException

canEnable

public boolean canEnable()
                  throws SQLException,
IOException

Specified by:

canEnable in interface Disablable

Throws:

SQLException

IOException

disable

public void disable(DisableLog dl)
             throws IOException,
SQLException

Specified by:

disable in interface Disablable

Throws:

IOException

SQLException

enable

public void enable()
            throws IOException,
SQLException

Specified by:

enable in interface Disablable

Throws:

IOException

SQLException

getBackupReports

public List<BackupReport> getBackupReports()
                                    throws IOException,
SQLException

Throws:

IOException

SQLException

getAccount_name

public Account.Name getAccount_name()

getAccount

public Account getAccount()
                   throws SQLException,
IOException

Throws:

SQLException

IOException

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<Integer,Package>

getCreated

public UnmodifiableTimestamp getCreated()

getCreatedBy

public Administrator getCreatedBy()
                           throws SQLException,
IOException

Throws:

SQLException

IOException

getCvsRepositories

public List<CvsRepository> getCvsRepositories()
                                       throws IOException,
SQLException

Throws:

IOException

SQLException

isDisabled

public boolean isDisabled()

Description copied from interface: Disablable

Checks if this object is disabled. This should execute very quickly (not incur any round-trip to any database) and thus does not throw any checked exceptions.

Specified by:

isDisabled in interface Disablable

getDisableLog_id

public Integer getDisableLog_id()

getDisableLog

public DisableLog getDisableLog()
                         throws SQLException,
IOException

Specified by:

getDisableLog in interface Disablable

Throws:

SQLException

IOException

getEmailInBurst

public int getEmailInBurst()

Gets the inbound burst limit for emails, the number of emails that may be sent before limiting occurs. A value of -1 indicates unlimited.

getEmailInRate

public float getEmailInRate()

Gets the inbound sustained email rate in emails/second. A value of Float.NaN indicates unlimited.

getEmailOutBurst

public int getEmailOutBurst()

Gets the outbound burst limit for emails, the number of emails that may be sent before limiting occurs. A value of -1 indicates unlimited.

getEmailOutRate

public float getEmailOutRate()

Gets the outbound sustained email rate in emails/second. A value of Float.NaN indicates unlimited.

getEmailRelayBurst

public int getEmailRelayBurst()

Gets the relay burst limit for emails, the number of emails that may be sent before limiting occurs. A value of -1 indicates unlimited.

getEmailRelayRate

public float getEmailRelayRate()

Gets the relay sustained email rate in emails/second. A value of Float.NaN indicates unlimited.

getDnsZones

public List<Zone> getDnsZones()
                       throws IOException,
SQLException

Throws:

IOException

SQLException

getEmailLists

public List<List> getEmailLists()
                         throws IOException,
SQLException

Throws:

IOException

SQLException

getEmailPipes

public List<Pipe> getEmailPipes()
                         throws IOException,
SQLException

Throws:

IOException

SQLException

getHttpdSharedTomcats

public List<SharedTomcat> getHttpdSharedTomcats()
                                         throws IOException,
SQLException

Throws:

IOException

SQLException

getHttpdServers

public List<HttpdServer> getHttpdServers()
                                  throws IOException,
SQLException

Throws:

IOException

SQLException

getHttpdSites

public List<Site> getHttpdSites()
                         throws IOException,
SQLException

Throws:

IOException

SQLException

getIpAddresses

public List<IpAddress> getIpAddresses()
                               throws IOException,
SQLException

Throws:

IOException

SQLException

getLinuxGroups

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

Throws:

IOException

SQLException

getMysqlDatabases

public List<Database> getMysqlDatabases()
                                 throws IOException,
SQLException

Throws:

IOException

SQLException

getFailoverMysqlReplications

public List<MysqlReplication> getFailoverMysqlReplications()
                                                    throws IOException,
SQLException

Throws:

IOException

SQLException

getMysqlUsers

public List<User> getMysqlUsers()
                         throws IOException,
SQLException

Throws:

IOException

SQLException

getName

public Account.Name getName()

getNetBinds

public List<Bind> getNetBinds()
                       throws IOException,
SQLException

Throws:

IOException

SQLException

getNetBinds

public List<Bind> getNetBinds(IpAddress ip)
                       throws IOException,
SQLException

Throws:

IOException

SQLException

getPackageDefinition_id

public int getPackageDefinition_id()

getPackageDefinition

public PackageDefinition getPackageDefinition()
                                       throws SQLException,
IOException

Throws:

SQLException

IOException

getPostgresDatabases

public List<Database> getPostgresDatabases()
                                    throws IOException,
SQLException

Throws:

IOException

SQLException

getPostgresUsers

public List<User> getPostgresUsers()
                            throws SQLException,
IOException

Throws:

SQLException

IOException

getSendmailServers

public List<SendmailServer> getSendmailServers()
                                        throws IOException,
SQLException

Throws:

IOException

SQLException

getHost

public Host getHost(String name)
             throws IOException,
SQLException

Throws:

IOException

SQLException

getServers

public List<Host> getServers()
                      throws IOException,
SQLException

Throws:

IOException

SQLException

getEmailDomains

public List<Domain> getEmailDomains()
                             throws IOException,
SQLException

Throws:

IOException

SQLException

getEmailSmtpRelays

public List<SmtpRelay> getEmailSmtpRelays()
                                   throws IOException,
SQLException

Throws:

IOException

SQLException

getSslCertificates

public List<Certificate> getSslCertificates()
                                     throws IOException,
SQLException

Throws:

IOException

SQLException

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,Package>

getUsernames

public List<User> getUsernames()
                        throws IOException,
SQLException

Throws:

IOException

SQLException

init

public void init(ResultSet result)
          throws SQLException

Description copied from class: AoservObject

Initializes this object from the raw database contents.

Specified by:

init in class AoservObject<Integer,Package>

Parameters:

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

Throws:

SQLException

read

public void read(StreamableInput in,
 AoservProtocol.Version protocolVersion)
          throws IOException

Specified by:

read in interface AoservReadable

Specified by:

read in interface AoservStreamable

Specified by:

read in class AoservObject<Integer,Package>

Throws:

IOException

write

public void write(StreamableOutput out,
 AoservProtocol.Version protocolVersion)
           throws IOException

Specified by:

write in interface AoservStreamable

Specified by:

write in interface AoservWritable

Specified by:

write in class AoservObject<Integer,Package>

Throws:

IOException

compareTo

public int compareTo(Package o)

Specified by:

compareTo in interface Comparable<Package>