com.aoindustries.aoserv.client.account.Account Maven / Gradle / Ivy
/*
* 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 implements Disablable, Comparable {
/**
* The unique, case-insensitive identifier for an {@link Account}. Account names must:
*
* - Be non-null
* - Be non-empty
* - Be between 2 and 32 characters
* - Must start with
[a-z,A-Z]
* - Must end with
[a-z,A-Z,0-9]
* - Must contain only
[a-z,A-Z,0-9,_]
* - May not have consecutive underscores
*
*
* @author AO Industries, Inc.
*/
final static public class Name implements
Comparable,
FastExternalizable,
ObjectInputValidation,
DtoFactory,
Internable
{
public static final int MIN_LENGTH = 2;
public static final int MAX_LENGTH = 32;
/**
* Validates a name.
*/
public static ValidationResult validate(String name) {
if(name==null) return new InvalidResult(accessor, "Account.Name.validate.isNull");
int len=name.length();
if(lenMAX_LENGTH) return new InvalidResult(accessor, "Account.Name.validate.tooLong", MAX_LENGTH, len);
char ch=name.charAt(0);
if(
(ch<'A' || ch>'Z')
&& (ch<'a' || ch>'z')
) return new InvalidResult(accessor, "Account.Name.validate.mustStartAlpha");
ch=name.charAt(len-1);
if(
(ch<'A' || ch>'Z')
&& (ch<'a' || ch>'z')
&& (ch<'0' || ch>'9')
) return new InvalidResult(accessor, "Account.Name.validate.mustEndAlphanumeric");
for(int pos=1;pos<(len-1);pos++) {
ch=name.charAt(pos);
if(ch=='_') {
if(name.charAt(pos-1)=='_') return new InvalidResult(accessor, "Account.Name.validate.consecutiveUnderscores", pos-1);
} else if(
(ch<'A' || ch>'Z')
&& (ch<'a' || ch>'z')
&& (ch<'0' || ch>'9')
) return new InvalidResult(accessor, "Account.Name.validate.invalidCharacter", ch, pos);
}
return ValidResult.getInstance();
}
private static final ConcurrentMap interned = new ConcurrentHashMap<>();
/**
* @param name when {@code null}, returns {@code null}
*/
public static Name valueOf(String name) throws ValidationException {
if(name == null) return null;
//Name existing = interned.get(name);
//return existing!=null ? existing : new Name(name);
return new Name(name);
}
/*
public static Name valueOfInterned(String name) throws ValidationException {
Name existing = interned.get(name);
return existing!=null ? existing : new Name(name).intern();
}*/
private String name;
private String upperName;
private Name(String name) throws ValidationException {
this.name = name;
this.upperName = name.toUpperCase(Locale.ROOT);
validate();
}
/**
* @param name Does not validate, should only be used with a known valid value.
* @param upperName Does not validate, should only be used with a known valid value.
*/
private Name(String name, String upperName) {
ValidationResult result;
assert (result = validate(name)).isValid() : result.toString();
assert name.toUpperCase(Locale.ROOT).equals(upperName);
this.name = name;
this.upperName = upperName;
}
private void validate() throws ValidationException {
ValidationResult result = validate(name);
if(!result.isValid()) throw new ValidationException(result);
}
@Override
public boolean equals(Object O) {
return
O!=null
&& O instanceof Name
&& upperName.equals(((Name)O).upperName)
;
}
@Override
public int hashCode() {
return upperName.hashCode();
}
@Override
public int compareTo(Name other) {
return this==other ? 0 : ComparatorUtils.compareIgnoreCaseConsistentWithEquals(name, other.name);
}
@Override
public String toString() {
return name;
}
/**
* Gets the upper-case form of the code. If two different names are
* interned and their toUpperCase is the same String instance, then they are
* equal in case-insensitive manner.
*/
public String toUpperCase() {
return upperName;
}
/**
* Interns this name much in the same fashion as String.intern().
*
* @see String#intern()
*/
@Override
public Name intern() {
Name existing = interned.get(name);
if(existing==null) {
String internedName = name.intern();
String internedUpperName = upperName.intern();
Name addMe = (name == internedName) && (upperName == internedUpperName) ? this : new Name(internedName, internedUpperName);
existing = interned.putIfAbsent(internedName, addMe);
if(existing==null) existing = addMe;
}
return existing;
}
@Override
public com.aoindustries.aoserv.client.dto.AccountName getDto() {
return new com.aoindustries.aoserv.client.dto.AccountName(name);
}
//
private static final long serialVersionUID = -4701364475901418693L;
public Name() {
}
@Override
public long getSerialVersionUID() {
return serialVersionUID;
}
@Override
public void writeExternal(ObjectOutput out) throws IOException {
FastObjectOutput fastOut = FastObjectOutput.wrap(out);
try {
fastOut.writeFastUTF(name);
} finally {
fastOut.unwrap();
}
}
@Override
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException {
if(name!=null) throw new IllegalStateException();
FastObjectInput fastIn = FastObjectInput.wrap(in);
try {
name = fastIn.readFastUTF();
upperName = name.toUpperCase(Locale.ROOT);
} finally {
fastIn.unwrap();
}
}
@Override
public void validateObject() throws InvalidObjectException {
try {
validate();
} catch(ValidationException err) {
InvalidObjectException newErr = new InvalidObjectException(err.getMessage());
newErr.initCause(err);
throw newErr;
}
}
//
}
static final int COLUMN_ACCOUNTING=0;
static final String COLUMN_ACCOUNTING_name = "accounting";
/**
* The maximum depth of the business tree.
*/
public static final int MAXIMUM_BUSINESS_TREE_DEPTH = 7;
String contractVersion;
private UnmodifiableTimestamp created;
private UnmodifiableTimestamp canceled;
private String cancelReason;
Name parent;
private boolean can_add_backup_server;
private boolean can_add_businesses;
private boolean can_see_prices;
int disable_log;
private String do_not_disable_reason;
private boolean auto_enable;
private boolean bill_parent;
public int addProfile(
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 billingEmail,
Profile.EmailFormat billingEmailFormat,
String technicalContact,
Set technicalEmail,
Profile.EmailFormat technicalEmailFormat
) throws IOException, SQLException {
return table.getConnector().getAccount().getProfile().addProfile(
this,
name,
isPrivate,
phone,
fax,
address1,
address2,
city,
state,
country,
zip,
sendInvoice,
billingContact,
billingEmail,
billingEmailFormat,
technicalContact,
technicalEmail,
technicalEmailFormat
);
}
public int addAccountHost(
Host server
) throws IOException, SQLException {
return table.getConnector().getAccount().getAccountHost().addAccountHost(this, server);
}
public int addCreditCard(
Processor processor,
String groupName,
String cardInfo,
byte expirationMonth,
short expirationYear,
String providerUniqueId,
String firstName,
String lastName,
String companyName,
Email email,
String phone,
String fax,
String customerId,
String customerTaxId,
String streetAddress1,
String streetAddress2,
String city,
String state,
String postalCode,
CountryCode countryCode,
String principalName,
String description,
String cardNumber
) throws IOException, SQLException {
return table.getConnector().getPayment().getCreditCard().addCreditCard(
processor,
this,
groupName,
cardInfo,
expirationMonth,
expirationYear,
providerUniqueId,
firstName,
lastName,
companyName,
email,
phone,
fax,
customerId,
customerTaxId,
streetAddress1,
streetAddress2,
city,
state,
postalCode,
countryCode,
principalName,
description,
cardNumber
);
}
/**
* Adds a transaction in the pending state.
*
* @deprecated Please use {@link PaymentTable#addPayment(com.aoindustries.aoserv.client.payment.Processor, com.aoindustries.aoserv.client.account.Account, java.lang.String, boolean, int, java.lang.String, com.aoindustries.util.i18n.Money, com.aoindustries.util.i18n.Money, boolean, com.aoindustries.util.i18n.Money, com.aoindustries.util.i18n.Money, java.lang.String, 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, com.aoindustries.net.Email, java.lang.String, java.lang.String, java.lang.String, com.aoindustries.aoserv.client.account.Administrator, java.lang.String, com.aoindustries.aoserv.client.account.Account, java.lang.String, java.lang.String, java.lang.String, java.lang.Byte, java.lang.Short, java.lang.String, java.lang.String, java.lang.String, com.aoindustries.net.Email, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, long, java.lang.String)} directly
*/
@Deprecated
public int addPayment(
Processor processor,
String groupName,
boolean testMode,
int duplicateWindow,
String orderNumber,
Money amount,
Money taxAmount,
boolean taxExempt,
Money shippingAmount,
Money dutyAmount,
String shippingFirstName,
String shippingLastName,
String shippingCompanyName,
String shippingStreetAddress1,
String shippingStreetAddress2,
String shippingCity,
String shippingState,
String shippingPostalCode,
String shippingCountryCode,
boolean emailCustomer,
Email merchantEmail,
String invoiceNumber,
String purchaseOrderNumber,
String description,
Administrator creditCardCreatedBy,
String creditCardPrincipalName,
Account creditCardAccount,
String creditCardGroupName,
String creditCardProviderUniqueId,
String creditCardMaskedCardNumber,
Byte creditCard_expirationMonth,
Short creditCard_expirationYear,
String creditCardFirstName,
String creditCardLastName,
String creditCardCompanyName,
Email creditCardEmail,
String creditCardPhone,
String creditCardFax,
String creditCardCustomerId,
String creditCardCustomerTaxId,
String creditCardStreetAddress1,
String creditCardStreetAddress2,
String creditCardCity,
String creditCardState,
String creditCardPostalCode,
String creditCardCountryCode,
String creditCardComments,
long authorizationTime,
String authorizationPrincipalName
) throws IOException, SQLException {
return table.getConnector().getPayment().getPayment().addPayment(
processor,
this,
groupName,
testMode,
duplicateWindow,
orderNumber,
amount,
taxAmount,
taxExempt,
shippingAmount,
dutyAmount,
shippingFirstName,
shippingLastName,
shippingCompanyName,
shippingStreetAddress1,
shippingStreetAddress2,
shippingCity,
shippingState,
shippingPostalCode,
shippingCountryCode,
emailCustomer,
merchantEmail,
invoiceNumber,
purchaseOrderNumber,
description,
creditCardCreatedBy,
creditCardPrincipalName,
creditCardAccount,
creditCardGroupName,
creditCardProviderUniqueId,
creditCardMaskedCardNumber,
creditCard_expirationMonth,
creditCard_expirationYear,
creditCardFirstName,
creditCardLastName,
creditCardCompanyName,
creditCardEmail,
creditCardPhone,
creditCardFax,
creditCardCustomerId,
creditCardCustomerTaxId,
creditCardStreetAddress1,
creditCardStreetAddress2,
creditCardCity,
creditCardState,
creditCardPostalCode,
creditCardCountryCode,
creditCardComments,
authorizationTime,
authorizationPrincipalName
);
}
public int addDisableLog(
String disableReason
) throws IOException, SQLException {
return table.getConnector().getAccount().getDisableLog().addDisableLog(this, disableReason);
}
/**
* @deprecated Please use {@link NoticeLogTable#addNoticeLog(com.aoindustries.aoserv.client.account.Account, java.lang.String, com.aoindustries.net.Email, com.aoindustries.aoserv.client.billing.NoticeType, com.aoindustries.aoserv.client.billing.Transaction)}
*/
@Deprecated
public void addNoticeLog(
String billingContact,
Email emailAddress,
String type,
int transid
) throws IOException, SQLException {
AOServConnector connector = table.getConnector();
NoticeType nt = connector.getBilling().getNoticeType().get(type);
if(nt == null) throw new IllegalArgumentException("Unable to find NoticeType: " + type);
Transaction trans;
if(transid != NoticeLog.NO_TRANSACTION) {
trans = connector.getBilling().getTransaction().get(transid);
if(trans == null) throw new IllegalArgumentException("Unable to find Transaction: " + transid);
} else {
trans = null;
}
connector.getBilling().getNoticeLog().addNoticeLog(
this,
billingContact,
emailAddress,
nt,
trans
);
}
public int addPackage(
Name name,
PackageDefinition packageDefinition
) throws IOException, SQLException {
return table.getConnector().getBilling().getPackage().addPackage(
name,
this,
packageDefinition
);
}
/**
* @deprecated Please use {@link TransactionTable#add(int, java.sql.Timestamp, com.aoindustries.aoserv.client.account.Account, com.aoindustries.aoserv.client.account.Account, com.aoindustries.aoserv.client.account.Administrator, com.aoindustries.aoserv.client.billing.TransactionType, java.lang.String, int, com.aoindustries.util.i18n.Money, com.aoindustries.aoserv.client.payment.PaymentType, java.lang.String, com.aoindustries.aoserv.client.payment.Processor, byte)}
*/
@Deprecated
public int addTransaction(
int timeType,
Timestamp time,
Account sourceAccount,
Administrator business_administrator,
TransactionType type,
String description,
int quantity,
Money rate,
PaymentType paymentType,
String paymentInfo,
Processor processor,
byte payment_confirmed
) throws IOException, SQLException {
return table.getConnector().getBilling().getTransaction().add(
timeType,
time,
this,
sourceAccount,
business_administrator,
type,
description,
quantity,
rate,
paymentType,
paymentInfo,
processor,
payment_confirmed
);
}
public boolean canAddBackupServer() {
return can_add_backup_server;
}
public boolean canAddAccounts() {
return can_add_businesses;
}
public void cancel(String cancelReason) throws IllegalArgumentException, IOException, SQLException {
// Automatically disable if not already disabled
if(disable_log==-1) {
new SimpleAOClient(table.getConnector()).disableAccount(pkey, "Account canceled");
}
// Now cancel the account
if(cancelReason!=null && (cancelReason=cancelReason.trim()).length()==0) cancelReason=null;
final String finalCancelReason = cancelReason;
table.getConnector().requestUpdate(
true,
AoservProtocol.CommandID.CANCEL_BUSINESS,
new AOServConnector.UpdateRequest() {
IntList invalidateList;
@Override
public void writeRequest(StreamableOutput out) throws IOException {
out.writeUTF(pkey.toString());
out.writeNullUTF(finalCancelReason);
}
@Override
public void readResponse(StreamableInput in) throws IOException, SQLException {
int code=in.readByte();
if(code==AoservProtocol.DONE) invalidateList=AOServConnector.readInvalidateList(in);
else {
AoservProtocol.checkResult(code, in);
throw new IOException("Unexpected response code: "+code);
}
}
@Override
public void afterRelease() {
table.getConnector().tablesUpdated(invalidateList);
}
}
);
}
public boolean canCancel() throws IOException, SQLException {
// Is already canceled
if(canceled != null) return false;
// Is ROOT account
if(isRootAccount()) return false;
// Has any active sub-account
for(Account child : getChildAccounts()) {
if(child.getCanceled() == null) return false;
}
return true;
}
public boolean isRootAccount() throws IOException, SQLException {
return pkey.equals(table.getConnector().getAccount().getAccount().getRootAccount_name());
}
@Override
public boolean canDisable() throws IOException, SQLException {
// already disabled
if(disable_log!=-1) return false;
if(isRootAccount()) return false;
// packages
for(Package pk : getPackages()) if(!pk.isDisabled()) return false;
return true;
}
@Override
public boolean canEnable() throws SQLException, IOException {
// Cannot enable a canceled business
if(canceled != null) return false;
// Can only enable if it is disabled
DisableLog dl=getDisableLog();
if(dl==null) return false;
else return dl.canEnable();
}
public boolean canSeePrices() {
return can_see_prices;
}
@Override
public void disable(DisableLog dl) throws IOException, SQLException {
table.getConnector().requestUpdateIL(true, AoservProtocol.CommandID.DISABLE, Table.TableID.BUSINESSES, dl.getPkey(), pkey.toString());
}
@Override
public void enable() throws IOException, SQLException {
table.getConnector().requestUpdateIL(true, AoservProtocol.CommandID.ENABLE, Table.TableID.BUSINESSES, pkey.toString());
}
/**
* @deprecated Please use {@link TransactionTable#getAccountBalance(com.aoindustries.aoserv.client.account.Account)} directly
*/
@Deprecated
public Monies getAccountBalance() throws IOException, SQLException {
return table.getConnector().getBilling().getTransaction().getAccountBalance(this);
}
/**
* @deprecated Please use {@link TransactionTable#getAccountBalance(com.aoindustries.aoserv.client.account.Account, java.sql.Timestamp)} directly
*/
@Deprecated
public Monies getAccountBalance(Timestamp before) throws IOException, SQLException {
return table.getConnector().getBilling().getTransaction().getAccountBalance(this, before);
}
/**
* Gets a comma-separated list of account balances.
*
* @see #getAccountBalance()
*
* @deprecated Please use {@link #getAccountBalance()} and {@link Monies#toString()} instead
*/
@Deprecated
public String getAccountBalanceString() throws IOException, SQLException {
return getAccountBalance().toString();
}
/**
* Gets a comma-separated list of account balances before a given time.
*
* @see #getAccountBalance(java.sql.Timestamp)
*
* @deprecated Please use {@link #getAccountBalance(java.sql.Timestamp)} and {@link Monies#toString()} instead
*/
@Deprecated
public String getAccountBalanceString(Timestamp before) throws IOException, SQLException {
return getAccountBalance(before).toString();
}
public Name getName() {
return pkey;
}
public boolean getAutoEnable() {
return auto_enable;
}
public boolean billParent() {
return bill_parent;
}
// TODO: Re-implement auto-enabled on payment forms, and preferrably on the master itself during add_transaction
public Monies getAutoEnableMinimumPayment() throws IOException, SQLException {
List minimums = new ArrayList<>();
for(Money accountBalance : getAccountBalance()) {
if(accountBalance.getUnscaledValue() >= 0) {
Currency currency = accountBalance.getCurrency();
BigDecimal balance = accountBalance.getValue();
BigDecimal minimum = balance.divide(BigDecimal.valueOf(2), RoundingMode.UP);
com.aoindustries.aoserv.client.billing.Currency billingCurrency = getTable().getConnector().getBilling().getCurrency().get(currency);
if(billingCurrency == null) throw new SQLException("billing.Currency not found: " + currency);
BigDecimal minimumPayment = billingCurrency.getAutoEnableMinimumPayment().getValue();
if(minimum.compareTo(minimumPayment) < 0) minimum = minimumPayment;
if(minimum.compareTo(balance) > 0) minimum = balance;
minimums.add(
new Money(currency, minimum)
);
}
}
return Monies.of(minimums);
}
public String getDoNotDisableReason() {
return do_not_disable_reason;
}
/**
* Gets the {@link Account} in the account tree that is one level down
* from the top level account.
*/
public Account getTopLevelAccount() throws IOException, SQLException {
Name rootAccount_name = table.getConnector().getAccount().getAccount().getRootAccount_name();
Account bu=this;
Account tempParent;
while((tempParent=bu.getParent())!=null && !tempParent.getName().equals(rootAccount_name)) bu=tempParent;
return bu;
}
/**
* Gets the {@link Account} that is responsible for paying the bills created by this business.
*/
public Account getBillingAccount() throws SQLException, IOException {
Account bu=this;
while(bu.bill_parent) {
bu=bu.getParent();
if(bu==null) throw new SQLException("Unable to find the billing account for '"+pkey+'\'');
}
return bu;
}
/**
* Gets the {@link Profile} with the highest priority.
*/
public Profile getProfile() throws IOException, SQLException {
return table.getConnector().getAccount().getProfile().getProfile(this);
}
/**
* Gets a list of all {@link Profile profiles} for this {@link Account}
* sorted with the highest priority profile at the zero index.
*/
public List getProfiles() throws IOException, SQLException {
return table.getConnector().getAccount().getProfile().getProfiles(this);
}
public AccountHost getAccountHost(Host host) throws IOException, SQLException {
return table.getConnector().getAccount().getAccountHost().getAccountHost(this, host);
}
public List getAccountHosts() throws IOException, SQLException {
return table.getConnector().getAccount().getAccountHost().getAccountHosts(this);
}
public UnmodifiableTimestamp getCanceled() {
return canceled;
}
public String getCancelReason() {
return cancelReason;
}
public List getChildAccounts() throws IOException, SQLException {
return table.getConnector().getAccount().getAccount().getChildAccounts(this);
}
@Override
protected Object getColumnImpl(int i) {
switch(i) {
case COLUMN_ACCOUNTING: return pkey;
case 1: return contractVersion;
case 2: return created;
case 3: return canceled;
case 4: return cancelReason;
case 5: return parent;
case 6: return can_add_backup_server;
case 7: return can_add_businesses;
case 8: return can_see_prices;
case 9: return disable_log== -1 ? null : disable_log;
case 10: return do_not_disable_reason;
case 11: return auto_enable;
case 12: return bill_parent;
default: throw new IllegalArgumentException("Invalid index: " + i);
}
}
/**
* @deprecated Please use {@link TransactionTable#getConfirmedAccountBalance(com.aoindustries.aoserv.client.account.Account)} directly
*/
@Deprecated
public Monies getConfirmedAccountBalance() throws IOException, SQLException {
return table.getConnector().getBilling().getTransaction().getConfirmedAccountBalance(this);
}
/**
* @deprecated Please use {@link TransactionTable#getConfirmedAccountBalance(com.aoindustries.aoserv.client.account.Account, java.sql.Timestamp)} directly
*/
@Deprecated
public Monies getConfirmedAccountBalance(Timestamp before) throws IOException, SQLException {
return table.getConnector().getBilling().getTransaction().getConfirmedAccountBalance(this, before);
}
public String getContractVersion() {
return contractVersion;
}
public UnmodifiableTimestamp getCreated() {
return created;
}
public List getCreditCardProcessors() throws IOException, SQLException {
return table.getConnector().getPayment().getProcessor().getCreditCardProcessors(this);
}
public List getCreditCards() throws IOException, SQLException {
return table.getConnector().getPayment().getCreditCard().getCreditCards(this);
}
public Host getDefaultHost() throws IOException, SQLException {
// May be null when the account is canceled or not using servers
return table.getConnector().getAccount().getAccountHost().getDefaultHost(this);
}
@Override
public boolean isDisabled() {
return disable_log!=-1;
}
@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;
}
public List getEmailForwarding() throws SQLException, IOException {
return table.getConnector().getEmail().getForwarding().getEmailForwarding(this);
}
public List getEmailLists() throws IOException, SQLException {
return table.getConnector().getEmail().getList().getEmailLists(this);
}
public GroupServer getLinuxServerGroup(Server aoServer) throws IOException, SQLException {
return table.getConnector().getLinux().getGroupServer().getLinuxServerGroup(aoServer, this);
}
public List getMailAccounts() throws IOException, SQLException {
return table.getConnector().getLinux().getUser().getMailAccounts(this);
}
public CreditCard getMonthlyCreditCard() throws IOException, SQLException {
return table.getConnector().getPayment().getCreditCard().getMonthlyCreditCard(this);
}
/**
* Gets all monthly charges from this account.
*
* @see #getMonthlyRate()
*/
public List getMonthlyCharges() throws SQLException, IOException {
return table.getConnector().getBilling().getMonthlyCharge().getMonthlyCharges(this, null);
}
/**
* Gets all monthly charges billed to this account.
*
* @see #getBillingMonthlyRate()
*/
public List getBillingMonthlyCharges() throws SQLException, IOException {
return table.getConnector().getBilling().getMonthlyCharge().getMonthlyCharges(null, this);
}
/**
* Gets an approximation of the monthly rate from this account. This is not guaranteed to
* be exactly the same as the underlying billing database processes.
*
* @return the total monthly rate of all {@link PackageDefinition} and {@link MonthlyCharge} from this account or {@code null} if unavailable.
*
* @see #getMonthlyCharges()
*/
public Monies getMonthlyRate() throws SQLException, IOException {
Monies totalMonthlyRate = Monies.of();
for(MonthlyCharge monthlyCharge : getMonthlyCharges()) {
if(monthlyCharge.isActive()) {
Money amount = monthlyCharge.getAmount();
if(amount == null) return null;
totalMonthlyRate = totalMonthlyRate.add(amount);
}
}
return totalMonthlyRate;
}
/**
* Gets an approximation of the monthly rate billed to this account. This is not guaranteed to
* be exactly the same as the underlying billing database processes.
*
* @return the total monthly rate of all {@link PackageDefinition} and {@link MonthlyCharge} billed to this account or {@code null} if unavailable.
*
* @see #getBillingMonthlyCharges()
*/
public Monies getBillingMonthlyRate() throws SQLException, IOException {
Monies totalMonthlyRate = Monies.of();
for(MonthlyCharge monthlyCharge : getBillingMonthlyCharges()) {
if(monthlyCharge.isActive()) {
Money amount = monthlyCharge.getAmount();
if(amount == null) return null;
totalMonthlyRate = totalMonthlyRate.add(amount);
}
}
return totalMonthlyRate;
}
public List getNoticeLogs() throws IOException, SQLException {
return table.getConnector().getBilling().getNoticeLog().getNoticeLogs(this);
}
public List getPackages() throws IOException, SQLException {
return table.getConnector().getBilling().getPackage().getPackages(this);
}
public Account.Name getParent_name() {
return parent;
}
public Account getParent() throws IOException, SQLException {
if(parent==null) return null;
// The parent business might not be found, even when the value is set. This is normal due
// to filtering.
return table.getConnector().getAccount().getAccount().get(parent);
}
public List getEmailDomains() throws SQLException, IOException {
return table.getConnector().getEmail().getDomain().getEmailDomains(this);
}
@Override
public Table.TableID getTableID() {
return Table.TableID.BUSINESSES;
}
/**
* Gets transactions that have this account as their applied-to.
*
* @deprecated Please use {@link TransactionTable#getTransactions(com.aoindustries.aoserv.client.account.Account)} directly
*/
@Deprecated
public List getTransactions() throws IOException, SQLException {
return table.getConnector().getBilling().getTransaction().getTransactions(this);
}
/**
* Gets transactions that have this account as their source.
*
* @deprecated Please use {@link TransactionTable#getTransactionsFrom(com.aoindustries.aoserv.client.account.Account)} directly
*/
@Deprecated
public List getTransactionsFrom() throws IOException, SQLException {
return table.getConnector().getBilling().getTransaction().getTransactionsFrom(this);
}
/**
* @see WhoisHistoryAccountTable#getWhoisHistoryAccounts(com.aoindustries.aoserv.client.account.Account)
*/
public List getWhoisHistoryAccounts() throws IOException, SQLException {
return table.getConnector().getBilling().getWhoisHistoryAccount().getWhoisHistoryAccounts(this);
}
/**
* @deprecated Please use {@link #isAccountOrParentOf(com.aoindustries.aoserv.client.account.Account)} instead.
*/
@Deprecated
public boolean isAccountOrParent(Account other) throws IOException, SQLException {
return isAccountOrParentOf(other);
}
/**
* Determines if this {@link Account} is the other account
* or a parent of it. This is often used for access control between
* accounts.
*/
public boolean isAccountOrParentOf(Account other) throws IOException, SQLException {
while(other!=null) {
if(equals(other)) return true;
other = other.getParent();
}
return false;
}
/**
* Determines if this {@link Account} is a parent of the other business.
* This is often used for access control between accounts.
*/
public boolean isParentOf(Account other) throws IOException, SQLException {
if(other!=null) {
other = other.getParent();
while(other!=null) {
if(equals(other)) return true;
other = other.getParent();
}
}
return false;
}
@SuppressWarnings("deprecation")
public void move(Server from, Server to, TerminalWriter out) throws IOException, SQLException {
if(true) throw new com.aoindustries.exception.NotImplementedException("TODO: Finish implementation");
if(from.equals(to)) throw new SQLException("Cannot move from Server "+from.getHostname()+" to Server "+to.getHostname()+": same Server");
AccountHost fromAccountHost = getAccountHost(from.getHost());
if(fromAccountHost == null) throw new SQLException("Unable to find AccountHost for Account="+pkey+" and Server="+from.getHostname());
// Grant the account access to the other server if it does not already have access
if(out!=null) {
out.boldOn();
out.println("Adding Account Privileges");
out.attributesOff();
out.flush();
}
AccountHost toAccountHost = getAccountHost(to.getHost());
if(toAccountHost == null) {
if(out!=null) {
out.print(" ");
out.println(to.getHostname());
out.flush();
}
addAccountHost(to.getHost());
}
// Add the LinuxServerGroups
if(out!=null) {
out.boldOn();
out.println("Adding Linux Groups");
out.attributesOff();
out.flush();
}
List fromLinuxServerGroups=new ArrayList<>();
List toLinuxServerGroups=new SortedArrayList<>();
{
for(GroupServer lsg : table.getConnector().getLinux().getGroupServer().getRows()) {
Package pk=lsg.getLinuxGroup().getPackage();
if(pk!=null && pk.getAccount_name().equals(pkey)) {
Server ao=lsg.getServer();
if(ao.equals(from)) fromLinuxServerGroups.add(lsg);
else if(ao.equals(to)) toLinuxServerGroups.add(lsg);
}
}
}
for (GroupServer lsg : fromLinuxServerGroups) {
if(!toLinuxServerGroups.contains(lsg)) {
if(out!=null) {
out.print(" ");
out.print(lsg.getLinuxGroup());
out.print(" to ");
out.println(to.getHostname());
out.flush();
}
lsg.getLinuxGroup().addLinuxServerGroup(to);
}
}
// Add the LinuxServerAccounts
if(out!=null) {
out.boldOn();
out.println("Adding Linux Accounts");
out.attributesOff();
out.flush();
}
List fromLinuxServerAccounts=new ArrayList<>();
List toLinuxServerAccounts=new SortedArrayList<>();
{
List lsas=table.getConnector().getLinux().getUserServer().getRows();
for (UserServer lsa : lsas) {
Package pk=lsa.getLinuxAccount().getUsername().getPackage();
if(pk!=null && pk.getAccount_name().equals(pkey)) {
Server ao=lsa.getServer();
if(ao.equals(from)) fromLinuxServerAccounts.add(lsa);
else if(ao.equals(to)) toLinuxServerAccounts.add(lsa);
}
}
}
for (UserServer lsa : fromLinuxServerAccounts) {
if(!toLinuxServerAccounts.contains(lsa)) {
if(out!=null) {
out.print(" ");
out.print(lsa.getLinuxAccount());
out.print(" to ");
out.println(to.getHostname());
out.flush();
}
lsa.getLinuxAccount().addLinuxServerAccount(to, lsa.getHome());
}
}
// Wait for Linux Account rebuild
if(out!=null) {
out.boldOn();
out.println("Waiting for Linux Account rebuild");
out.attributesOff();
out.print(" ");
out.println(to.getHostname());
out.flush();
}
to.waitForLinuxAccountRebuild();
// Copy the home directory contents
if(out!=null) {
out.boldOn();
out.println("Copying Home Directories");
out.attributesOff();
out.flush();
}
for (UserServer lsa : fromLinuxServerAccounts) {
if(!toLinuxServerAccounts.contains(lsa)) {
if(out!=null) {
out.print(" ");
out.print(lsa.getLinuxAccount());
out.print(" to ");
out.print(to.getHostname());
out.print(": ");
out.flush();
}
long byteCount=lsa.copyHomeDirectory(to);
if(out!=null) {
out.print(byteCount);
out.println(byteCount==1?" byte":" bytes");
out.flush();
}
}
}
// Copy the cron tables
if(out!=null) {
out.boldOn();
out.println("Copying Cron Tables");
out.attributesOff();
out.flush();
}
for (UserServer lsa : fromLinuxServerAccounts) {
if(!toLinuxServerAccounts.contains(lsa)) {
if(out!=null) {
out.print(" ");
out.print(lsa.getLinuxAccount());
out.print(" to ");
out.print(to.getHostname());
out.print(": ");
out.flush();
}
String cronTable=lsa.getCronTable();
lsa.getLinuxAccount().getLinuxServerAccount(to).setCronTable(cronTable);
if(out!=null) {
out.print(cronTable.length());
out.println(cronTable.length()==1?" byte":" bytes");
out.flush();
}
}
}
// Copy the passwords
if(out!=null) {
out.boldOn();
out.println("Copying Passwords");
out.attributesOff();
out.flush();
}
for (UserServer lsa : fromLinuxServerAccounts) {
if(!toLinuxServerAccounts.contains(lsa)) {
if(out!=null) {
out.print(" ");
out.print(lsa.getLinuxAccount());
out.print(" to ");
out.println(to.getHostname());
out.flush();
}
lsa.copyPassword(lsa.getLinuxAccount().getLinuxServerAccount(to));
}
}
// Move IP Addresses
if(out!=null) {
out.boldOn();
out.println("Moving IP Addresses");
out.attributesOff();
out.flush();
}
List ips=table.getConnector().getNet().getIpAddress().getRows();
for (IpAddress ip : ips) {
InetAddress inetAddress = ip.getInetAddress();
if(
ip.isAlias()
&& !inetAddress.isUnspecified()
&& !ip.getDevice().getDeviceId().isLoopback()
&& ip.getPackage().getAccount_name().equals(pkey)
) {
if(out!=null) {
out.print(" ");
out.println(ip);
}
ip.moveTo(to.getHost());
}
} // TODO: Continue development here
// Remove the LinuxServerAccounts
if(out!=null) {
out.boldOn();
out.println("Removing Linux Accounts");
out.attributesOff();
out.flush();
}
for (UserServer lsa : fromLinuxServerAccounts) {
if(out!=null) {
out.print(" ");
out.print(lsa.getLinuxAccount());
out.print(" on ");
out.println(from.getHostname());
out.flush();
}
lsa.remove();
}
// Remove the LinuxServerGroups
if(out!=null) {
out.boldOn();
out.println("Removing Linux Groups");
out.attributesOff();
out.flush();
}
for (GroupServer lsg : fromLinuxServerGroups) {
if(out!=null) {
out.print(" ");
out.print(lsg.getLinuxGroup());
out.print(" on ");
out.println(from.getHostname());
out.flush();
}
lsg.remove();
}
// Remove access to the old server
if(out!=null) {
out.boldOn();
out.println("Removing Account Privileges");
out.attributesOff();
out.print(" ");
out.println(from.getHostname());
out.flush();
}
fromAccountHost.remove();
}
@Override
public void init(ResultSet result) throws SQLException {
try {
pkey = Name.valueOf(result.getString(1));
contractVersion = result.getString(2);
created = UnmodifiableTimestamp.valueOf(result.getTimestamp(3));
canceled = UnmodifiableTimestamp.valueOf(result.getTimestamp(4));
cancelReason = result.getString(5);
parent = Name.valueOf(result.getString(6));
can_add_backup_server=result.getBoolean(7);
can_add_businesses=result.getBoolean(8);
can_see_prices=result.getBoolean(9);
disable_log=result.getInt(10);
if(result.wasNull()) disable_log=-1;
do_not_disable_reason=result.getString(11);
auto_enable=result.getBoolean(12);
bill_parent=result.getBoolean(13);
} catch(ValidationException e) {
throw new SQLException(e);
}
}
@Override
public void read(StreamableInput in, AoservProtocol.Version protocolVersion) throws IOException {
try {
pkey=Name.valueOf(in.readUTF()).intern();
contractVersion=InternUtils.intern(in.readNullUTF());
created = in.readUnmodifiableTimestamp();
canceled = in.readNullUnmodifiableTimestamp();
cancelReason=in.readNullUTF();
parent=InternUtils.intern(Name.valueOf(in.readNullUTF()));
can_add_backup_server=in.readBoolean();
can_add_businesses=in.readBoolean();
can_see_prices=in.readBoolean();
disable_log=in.readCompressedInt();
do_not_disable_reason=in.readNullUTF();
auto_enable=in.readBoolean();
bill_parent=in.readBoolean();
} catch(ValidationException e) {
throw new IOException(e);
}
}
public void setName(Name name) throws SQLException, IOException {
table.getConnector().requestUpdateIL(true, AoservProtocol.CommandID.SET_BUSINESS_ACCOUNTING, this.pkey.toString(), name.toString());
}
@Override
public void write(StreamableOutput out, AoservProtocol.Version protocolVersion) throws IOException {
out.writeUTF(pkey.toString());
out.writeBoolean(contractVersion!=null); if(contractVersion!=null) out.writeUTF(contractVersion);
if(protocolVersion.compareTo(AoservProtocol.Version.VERSION_1_83_0) < 0) {
out.writeLong(created.getTime());
} else {
out.writeTimestamp(created);
}
if(protocolVersion.compareTo(AoservProtocol.Version.VERSION_1_83_0) < 0) {
out.writeLong(canceled == null ? -1 : canceled.getTime());
} else {
out.writeNullTimestamp(canceled);
}
out.writeNullUTF(cancelReason);
out.writeNullUTF(Objects.toString(parent, null));
if(protocolVersion.compareTo(AoservProtocol.Version.VERSION_1_0_A_102)>=0) out.writeBoolean(can_add_backup_server);
out.writeBoolean(can_add_businesses);
if(protocolVersion.compareTo(AoservProtocol.Version.VERSION_1_0_A_122)<=0) out.writeBoolean(false);
if(protocolVersion.compareTo(AoservProtocol.Version.VERSION_1_0_A_103)>=0) out.writeBoolean(can_see_prices);
out.writeCompressedInt(disable_log);
out.writeNullUTF(do_not_disable_reason);
out.writeBoolean(auto_enable);
out.writeBoolean(bill_parent);
}
public List getTickets() throws SQLException, IOException {
return table.getConnector().getTicket().getTicket().getTickets(this);
}
/**
* Gets all of the encryption keys for this business.
*/
public List getEncryptionKeys() throws IOException, SQLException {
return table.getConnector().getPki().getEncryptionKey().getEncryptionKeys(this);
}
/**
* Sets the credit card that will be used monthly. Any other selected card will
* be deselected. If creditCard is null, none will be used automatically.
*/
public void setUseMonthlyCreditCard(CreditCard creditCard) throws IOException, SQLException {
table.getConnector().requestUpdateIL(
true,
AoservProtocol.CommandID.SET_CREDIT_CARD_USE_MONTHLY,
pkey.toString(),
creditCard==null ? -1 : creditCard.getPkey()
);
}
/**
* Gets the most recent credit card transaction.
*/
public Payment getLastCreditCardTransaction() throws IOException, SQLException {
return table.getConnector().getPayment().getPayment().getLastCreditCardTransaction(this);
}
/**
* Gets the Brand for this business or {@code null} if not a brand.
*/
public Brand getBrand() throws IOException, SQLException {
return table.getConnector().getReseller().getBrand().getBrand(this);
}
/**
* @deprecated Please use {@link PackageDefinitionTable#addPackageDefinition(com.aoindustries.aoserv.client.account.Account, com.aoindustries.aoserv.client.billing.PackageCategory, java.lang.String, java.lang.String, java.lang.String, java.lang.String, com.aoindustries.util.i18n.Money, com.aoindustries.aoserv.client.billing.TransactionType, com.aoindustries.util.i18n.Money, com.aoindustries.aoserv.client.billing.TransactionType)} directly.
*/
@Deprecated
public int addPackageDefinition(
PackageCategory category,
String name,
String version,
String display,
String description,
Money setupFee,
TransactionType setupFeeTransactionType,
Money monthlyRate,
TransactionType monthlyRateTransactionType
) throws IOException, SQLException {
return table.getConnector().getBilling().getPackageDefinition().addPackageDefinition(
this,
category,
name,
version,
display,
description,
setupFee,
setupFeeTransactionType,
monthlyRate,
monthlyRateTransactionType
);
}
public PackageDefinition getPackageDefinition(PackageCategory category, String name, String version) throws IOException, SQLException {
return table.getConnector().getBilling().getPackageDefinition().getPackageDefinition(this, category, name, version);
}
public List getPackageDefinitions(PackageCategory category) throws IOException, SQLException {
return table.getConnector().getBilling().getPackageDefinition().getPackageDefinitions(this, category);
}
/**
* Gets all active package definitions for this business.
*/
public Map> getActivePackageDefinitions() throws IOException, SQLException {
// Determine the active packages per category
List allCategories = table.getConnector().getBilling().getPackageCategory().getRows();
Map> categories = new LinkedHashMap<>(allCategories.size()*4/3+1);
for(PackageCategory category : allCategories) {
List allDefinitions = getPackageDefinitions(category);
List definitions = new ArrayList<>(allDefinitions.size());
for(PackageDefinition definition : allDefinitions) {
if(definition.isActive()) definitions.add(definition);
}
if(!definitions.isEmpty()) categories.put(category, Collections.unmodifiableList(definitions));
}
return Collections.unmodifiableMap(categories);
}
@Override
public int compareTo(Account o) {
return pkey.compareTo(o.pkey);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy