com.aoindustries.aoserv.client.billing.Package Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aoserv-client Show documentation
Show all versions of aoserv-client Show documentation
Java client for the AOServ Platform.
/*
* aoserv-client - Java client for the AOServ Platform.
* Copyright (C) 2000-2013, 2016, 2017, 2018, 2019, 2020 AO Industries, Inc.
* [email protected]
* 7262 Bull Pen Cir
* Mobile, AL 36695
*
* This file is part of aoserv-client.
*
* aoserv-client is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* aoserv-client is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with aoserv-client. If not, see Package is a set of resources and its associated price.
* An {@link 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 {@link Account accounts}. If intra-account security is
* required, please use child {@link Account accounts}.
*
* @see Account
* @see PackageDefinition
*
* @author AO Industries, Inc.
*/
final public class Package extends CachedObjectIntegerKey implements Disablable, Comparable {
static final int
COLUMN_PKEY = 0,
COLUMN_NAME = 1,
COLUMN_ACCOUNTING = 2,
COLUMN_PACKAGE_DEFINITION = 3
;
public static final String COLUMN_NAME_name = "name";
/**
* The default inbound email burst before rate limiting.
*/
public static final int DEFAULT_EMAIL_IN_BURST = 1000;
/**
* The default sustained inbound email rate in emails/second.
*/
public static final float DEFAULT_EMAIL_IN_RATE = 10f;
/**
* The default outbound email burst before rate limiting.
*/
public static final int DEFAULT_EMAIL_OUT_BURST = 200;
/**
* The default sustained outbound email rate in emails/second.
*/
public static final float DEFAULT_EMAIL_OUT_RATE = .2f;
/**
* The default relay email burst before rate limiting.
*/
public static final int DEFAULT_EMAIL_RELAY_BURST = 100;
/**
* The default sustained relay email rate in emails/second.
*/
public static final float DEFAULT_EMAIL_RELAY_RATE = .1f;
private Account.Name name;
private Account.Name account;
private int package_definition;
private UnmodifiableTimestamp created;
private com.aoindustries.aoserv.client.account.User.Name created_by;
private int disable_log;
private int email_in_burst;
private float email_in_rate;
private int email_out_burst;
private float email_out_rate;
private int email_relay_burst;
private float email_relay_rate;
public void addDNSZone(String zone, InetAddress ip, int ttl) throws IOException, SQLException {
table.getConnector().getDns().getZone().addDNSZone(this, zone, ip, ttl);
}
public int addEmailSmtpRelay(com.aoindustries.aoserv.client.linux.Server aoServer, HostAddress host, SmtpRelayType type, long duration) throws IOException, SQLException {
return table.getConnector().getEmail().getSmtpRelay().addEmailSmtpRelay(this, aoServer, host, type, duration);
}
public void addLinuxGroup(Group.Name name, GroupType type) throws IOException, SQLException {
addLinuxGroup(name, type.getName());
}
public void addLinuxGroup(Group.Name name, String type) throws IOException, SQLException {
table.getConnector().getLinux().getGroup().addLinuxGroup(name, this, type);
}
public void addUsername(com.aoindustries.aoserv.client.account.User.Name username) throws IOException, SQLException {
table.getConnector().getAccount().getUser().addUsername(this, username);
}
@Override
public boolean canDisable() throws IOException, SQLException {
// Is already disabled
if(disable_log!=-1) return false;
// Can only disabled when all dependent objects are already disabled
for(SharedTomcat hst : getHttpdSharedTomcats()) if(!hst.isDisabled()) return false;
for(Pipe ep : getEmailPipes()) if(!ep.isDisabled()) return false;
for(CvsRepository cr : getCvsRepositories()) if(!cr.isDisabled()) return false;
for(User un : getUsernames()) if(!un.isDisabled()) return false;
for(Site hs : getHttpdSites()) if(!hs.isDisabled()) return false;
for(com.aoindustries.aoserv.client.email.List el : getEmailLists()) if(!el.isDisabled()) return false;
for(SmtpRelay ssr : getEmailSmtpRelays()) if(!ssr.isDisabled()) return false;
return true;
}
@Override
public boolean canEnable() throws SQLException, IOException {
DisableLog dl=getDisableLog();
if(dl==null) return false;
else return dl.canEnable() && !getAccount().isDisabled();
}
@Override
public void disable(DisableLog dl) throws IOException, SQLException {
table.getConnector().requestUpdateIL(true, AoservProtocol.CommandID.DISABLE, Table.TableID.PACKAGES, dl.getPkey(), name);
}
@Override
public void enable() throws IOException, SQLException {
table.getConnector().requestUpdateIL(true, AoservProtocol.CommandID.ENABLE, Table.TableID.PACKAGES, name);
}
public List getBackupReports() throws IOException, SQLException {
return table.getConnector().getBackup().getBackupReport().getBackupReports(this);
}
public Account.Name getAccount_name() {
return account;
}
public Account getAccount() throws SQLException, IOException {
Account accountingObject = table.getConnector().getAccount().getAccount().get(account);
if (accountingObject == null) throw new SQLException("Unable to find Account: " + account);
return accountingObject;
}
@Override
protected Object getColumnImpl(int i) {
switch(i) {
case COLUMN_PKEY: return pkey;
case COLUMN_NAME: return name;
case COLUMN_ACCOUNTING: return account;
case COLUMN_PACKAGE_DEFINITION: return package_definition;
case 4: return created;
case 5: return created_by;
case 6: return getDisableLog_id();
case 7: return email_in_burst==-1 ? null : email_in_burst;
case 8: return Float.isNaN(email_in_rate) ? null : email_in_rate;
case 9: return email_out_burst==-1 ? null : email_out_burst;
case 10: return Float.isNaN(email_out_rate) ? null : email_out_rate;
case 11: return email_relay_burst==-1 ? null : email_relay_burst;
case 12: return Float.isNaN(email_relay_rate) ? null : email_relay_rate;
default: throw new IllegalArgumentException("Invalid index: " + i);
}
}
public UnmodifiableTimestamp getCreated() {
return created;
}
public Administrator getCreatedBy() throws SQLException, IOException {
Administrator obj = table.getConnector().getAccount().getUser().get(created_by).getAdministrator();
if (obj == null) throw new SQLException("Unable to find Administrator: " + created_by);
return obj;
}
public List getCvsRepositories() throws IOException, SQLException {
return table.getConnector().getScm().getCvsRepository().getCvsRepositories(this);
}
@Override
public boolean isDisabled() {
return disable_log!=-1;
}
public Integer getDisableLog_id() {
return disable_log == -1 ? null : disable_log;
}
@Override
public DisableLog getDisableLog() throws SQLException, IOException {
if(disable_log == -1) return null;
DisableLog obj = table.getConnector().getAccount().getDisableLog().get(disable_log);
if(obj == null) throw new SQLException("Unable to find DisableLog: " + disable_log);
return obj;
}
/**
* Gets the inbound burst limit for emails, the number of emails that may be sent before limiting occurs.
* A value of -1 indicates unlimited.
*/
public int getEmailInBurst() {
return email_in_burst;
}
/**
* Gets the inbound sustained email rate in emails/second.
* A value of Float.NaN indicates unlimited.
*/
public float getEmailInRate() {
return email_in_rate;
}
/**
* Gets the outbound burst limit for emails, the number of emails that may be sent before limiting occurs.
* A value of -1 indicates unlimited.
*/
public int getEmailOutBurst() {
return email_out_burst;
}
/**
* Gets the outbound sustained email rate in emails/second.
* A value of Float.NaN indicates unlimited.
*/
public float getEmailOutRate() {
return email_out_rate;
}
/**
* Gets the relay burst limit for emails, the number of emails that may be sent before limiting occurs.
* A value of -1 indicates unlimited.
*/
public int getEmailRelayBurst() {
return email_relay_burst;
}
/**
* Gets the relay sustained email rate in emails/second.
* A value of Float.NaN indicates unlimited.
*/
public float getEmailRelayRate() {
return email_relay_rate;
}
public List getDNSZones() throws IOException, SQLException {
return table.getConnector().getDns().getZone().getDNSZones(this);
}
public List getEmailLists() throws IOException, SQLException {
return table.getConnector().getEmail().getList().getEmailLists(this);
}
public List getEmailPipes() throws IOException, SQLException {
return table.getConnector().getEmail().getPipe().getEmailPipes(this);
}
public List getHttpdSharedTomcats() throws IOException, SQLException {
return table.getConnector().getWeb_tomcat().getSharedTomcat().getHttpdSharedTomcats(this);
}
public List getHttpdServers() throws IOException, SQLException {
return table.getConnector().getWeb().getHttpdServer().getHttpdServers(this);
}
public List getHttpdSites() throws IOException, SQLException {
return table.getConnector().getWeb().getSite().getHttpdSites(this);
}
public List getIPAddresses() throws IOException, SQLException {
return table.getConnector().getNet().getIpAddress().getIPAddresses(this);
}
public List getLinuxGroups() throws IOException, SQLException {
return table.getConnector().getLinux().getGroup().getLinuxGroups(this);
}
public List getMySQLDatabases() throws IOException, SQLException {
return table.getConnector().getMysql().getDatabase().getMySQLDatabases(this);
}
public List getFailoverMySQLReplications() throws IOException, SQLException {
return table.getConnector().getBackup().getMysqlReplication().getFailoverMySQLReplications(this);
}
public List getMySQLUsers() throws IOException, SQLException {
return table.getConnector().getMysql().getUser().getMySQLUsers(this);
}
public Account.Name getName() {
return name;
}
public List getNetBinds() throws IOException, SQLException {
return table.getConnector().getNet().getBind().getNetBinds(this);
}
public List getNetBinds(IpAddress ip) throws IOException, SQLException {
return table.getConnector().getNet().getBind().getNetBinds(this, ip);
}
public int getPackageDefinition_id() {
return package_definition;
}
public PackageDefinition getPackageDefinition() throws SQLException, IOException {
PackageDefinition pd = table.getConnector().getBilling().getPackageDefinition().get(package_definition);
if(pd == null) throw new SQLException("Unable to find PackageDefinition: "+package_definition);
return pd;
}
public List getPostgresDatabases() throws IOException, SQLException {
return table.getConnector().getPostgresql().getDatabase().getPostgresDatabases(this);
}
public List getPostgresUsers() throws SQLException, IOException {
return table.getConnector().getPostgresql().getUser().getPostgresUsers(this);
}
public List getSendmailServers() throws IOException, SQLException {
return table.getConnector().getEmail().getSendmailServer().getSendmailServers(this);
}
public Host getHost(String name) throws IOException, SQLException {
return table.getConnector().getNet().getHost().getHost(this, name);
}
public List getServers() throws IOException, SQLException {
return table.getConnector().getNet().getHost().getServers(this);
}
public List getEmailDomains() throws IOException, SQLException {
return table.getConnector().getEmail().getDomain().getEmailDomains(this);
}
public List getEmailSmtpRelays() throws IOException, SQLException {
return table.getConnector().getEmail().getSmtpRelay().getEmailSmtpRelays(this);
}
public List getSslCertificates() throws IOException, SQLException {
return table.getConnector().getPki().getCertificate().getSslCertificates(this);
}
@Override
public Table.TableID getTableID() {
return Table.TableID.PACKAGES;
}
public List getUsernames() throws IOException, SQLException {
return table.getConnector().getAccount().getUser().getUsernames(this);
}
@Override
public void init(ResultSet result) throws SQLException {
try {
int pos = 1;
pkey = result.getInt(pos++);
name = Account.Name.valueOf(result.getString(pos++));
account = Account.Name.valueOf(result.getString(pos++));
package_definition = result.getInt(pos++);
created = UnmodifiableTimestamp.valueOf(result.getTimestamp(pos++));
created_by = com.aoindustries.aoserv.client.account.User.Name.valueOf(result.getString(pos++));
disable_log=result.getInt(pos++);
if(result.wasNull()) disable_log = -1;
email_in_burst=result.getInt(pos++);
if(result.wasNull()) email_in_burst = -1;
email_in_rate=result.getFloat(pos++);
if(result.wasNull()) email_in_rate = Float.NaN;
email_out_burst=result.getInt(pos++);
if(result.wasNull()) email_out_burst = -1;
email_out_rate=result.getFloat(pos++);
if(result.wasNull()) email_out_rate = Float.NaN;
email_relay_burst=result.getInt(pos++);
if(result.wasNull()) email_relay_burst = -1;
email_relay_rate=result.getFloat(pos++);
if(result.wasNull()) email_relay_rate = Float.NaN;
} catch(ValidationException e) {
throw new SQLException(e);
}
}
@Override
public void read(StreamableInput in, AoservProtocol.Version protocolVersion) throws IOException {
try {
pkey=in.readCompressedInt();
name = Account.Name.valueOf(in.readUTF()).intern();
account = Account.Name.valueOf(in.readUTF()).intern();
package_definition = in.readCompressedInt();
created = in.readUnmodifiableTimestamp();
created_by = com.aoindustries.aoserv.client.account.User.Name.valueOf(in.readUTF()).intern();
disable_log = in.readCompressedInt();
email_in_burst = in.readCompressedInt();
email_in_rate = in.readFloat();
email_out_burst = in.readCompressedInt();
email_out_rate = in.readFloat();
email_relay_burst = in.readCompressedInt();
email_relay_rate = in.readFloat();
} catch(ValidationException e) {
throw new IOException(e);
}
}
@Override
public void write(StreamableOutput out, AoservProtocol.Version protocolVersion) throws IOException {
out.writeCompressedInt(pkey);
out.writeUTF(name.toString());
out.writeUTF(account.toString());
if(protocolVersion.compareTo(AoservProtocol.Version.VERSION_1_0_A_122)<=0) {
out.writeUTF("unknown");
out.writeCompressedInt(0);
}
if(protocolVersion.compareTo(AoservProtocol.Version.VERSION_1_0_A_123)>=0) {
out.writeCompressedInt(package_definition);
}
if(protocolVersion.compareTo(AoservProtocol.Version.VERSION_1_83_0) < 0) {
out.writeLong(created.getTime());
} else {
out.writeTimestamp(created);
}
out.writeUTF(created_by.toString());
if(protocolVersion.compareTo(AoservProtocol.Version.VERSION_1_0_A_122)<=0) {
out.writeCompressedInt(-1);
out.writeCompressedInt(200);
out.writeCompressedInt(-1);
out.writeCompressedInt(100);
}
if(protocolVersion.compareTo(AoservProtocol.Version.VERSION_1_30)<=0) {
out.writeCompressedInt(256);
out.writeLong(64*1024*1024);
out.writeCompressedInt(256);
out.writeLong(64*1024*1024);
}
out.writeCompressedInt(disable_log);
if(protocolVersion.compareTo(AoservProtocol.Version.VERSION_1_24)>=0) {
out.writeCompressedInt(email_in_burst);
out.writeFloat(email_in_rate);
out.writeCompressedInt(email_out_burst);
out.writeFloat(email_out_rate);
out.writeCompressedInt(email_relay_burst);
out.writeFloat(email_relay_rate);
}
}
@Override
public int compareTo(Package o) {
return name.compareTo(o.name);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy