Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.payment

Class CreditCard

java.lang.Object

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

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

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

com.aoindustries.aoserv.client.payment.CreditCard

All Implemented Interfaces:

Streamable, StreamReadable, StreamWritable, Row, AoservReadable, AoservStreamable, AoservWritable, Removable, SingleTableObject<Integer,CreditCard>

public final class CreditCard
extends CachedObjectIntegerKey<CreditCard>
implements Removable

A CreditCard stores credit card information.

Author:

AO Industries, Inc.

Field Summary

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
CreditCard()	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	declined(String reason)	Flags a card as declined.
Account	getAccount()
Account.Name	getAccount_name()
List<CannotRemoveReason<?>>	getCannotRemoveReasons()	Lists the reasons an object may not be removed.
String	getCardInfo()
static String	getCardInfo(String cardNumber)	Deprecated. Please use com.aoapps.payments.CreditCard#maskCardNumber(String) instead.
String	getCardNumber(String passphrase)	Gets the card number or null if not stored.
String	getCity()
protected Object	getColumnImpl(int i)
String	getCompanyName()
CountryCode	getCountryCode()
UnmodifiableTimestamp	getCreated()
Administrator	getCreatedBy()
Processor	getCreditCardProcessor()	Gets the processor that is storing the credit card numbers.
String	getCustomerId()
String	getCustomerTaxId()
UnmodifiableTimestamp	getDeactivatedOn()
String	getDeactivatedOnString()
String	getDeactivateReason()
String	getDescription()
Email	getEmail()
EncryptionKey	getEncryptionCardNumberFrom()
EncryptionKey	getEncryptionCardNumberRecipient()
Byte	getExpirationMonth()
Short	getExpirationYear()
String	getFax()
String	getFirstName()
String	getGroupName()	Gets the application-specific grouping for this credit card.
int	getId()
boolean	getIsActive()
String	getLastName()
String	getPhone()
String	getPostalCode()
String	getPrincipalName()	Gets the application-provided principal name that stored this credit card.
String	getProviderUniqueId()	Gets the unique identifier that represents the CISP - compliant storage mechanism for the card number and expiration date.
String	getState()
String	getStreetAddress1()
String	getStreetAddress2()
Table.TableId	getTableId()
boolean	getUseMonthly()
void	init(ResultSet result)	Initializes this object from the raw database contents.
void	reactivate()	Reactivates a credit card.
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	remove()	Removes this object, and all dependant objects, from the system.
String	toStringImpl()	AoservObject.toString() implementation that is allowed to throw exceptions.
void	update(String cardInfo, 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 description)	Updates the credit card information (not including the card number or expiration).
void	updateCardExpiration(byte expirationMonth, short expirationYear)	Updates the credit card expiration.
void	updateCardNumberAndExpiration(String maskedCardNumber, String cardNumber, byte expirationMonth, short expirationYear)	Updates the credit card number and expiration, including the masked card number.
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

Constructor Details

CreditCard

@Deprecated(forRemoval=true)
public CreditCard()

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

getCannotRemoveReasons

public List<CannotRemoveReason<?>> getCannotRemoveReasons()

Description copied from interface: Removable

Lists the reasons an object may not be removed.

Specified by:

getCannotRemoveReasons in interface Removable

Returns:

an empty List<CannotRemoveReason> if this object may be removed, or a list of descriptions

declined

public void declined(String reason)
              throws IOException,
SQLException

Flags a card as declined.

Throws:

IOException

SQLException

getId

public int getId()

getCreditCardProcessor

public Processor getCreditCardProcessor()
                                 throws SQLException,
IOException

Gets the processor that is storing the credit card numbers.

Throws:

SQLException

IOException

getAccount_name

public Account.Name getAccount_name()

getAccount

public Account getAccount()
                   throws SQLException,
IOException

Throws:

SQLException

IOException

getGroupName

public String getGroupName()

Gets the application-specific grouping for this credit card.

getCardInfo

public String getCardInfo()

getExpirationMonth

public Byte getExpirationMonth()

getExpirationYear

public Short getExpirationYear()

getProviderUniqueId

public String getProviderUniqueId()

Gets the unique identifier that represents the CISP - compliant storage mechanism for the card number and expiration date.

getCardInfo

@Deprecated
public static String getCardInfo(String cardNumber)

Deprecated.

Please use com.aoapps.payments.CreditCard#maskCardNumber(String) instead.

Gets the default card info for a credit card number.

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<Integer,CreditCard>

getFirstName

public String getFirstName()

getLastName

public String getLastName()

getCompanyName

public String getCompanyName()

getEmail

public Email getEmail()

getPhone

public String getPhone()

getFax

public String getFax()

getCustomerId

public String getCustomerId()

getCustomerTaxId

public String getCustomerTaxId()

getStreetAddress1

public String getStreetAddress1()

getStreetAddress2

public String getStreetAddress2()

getCity

public String getCity()

getState

public String getState()

getPostalCode

public String getPostalCode()

getCountryCode

public CountryCode getCountryCode()
                           throws SQLException,
IOException

Throws:

SQLException

IOException

getCreated

public UnmodifiableTimestamp getCreated()

getCreatedBy

public Administrator getCreatedBy()
                           throws SQLException,
IOException

Throws:

SQLException

IOException

getPrincipalName

public String getPrincipalName()

Gets the application-provided principal name that stored this credit card.

getDeactivatedOn

public UnmodifiableTimestamp getDeactivatedOn()

getDeactivatedOnString

public String getDeactivatedOnString()

getDeactivateReason

public String getDeactivateReason()

getDescription

public String getDescription()

getEncryptionCardNumberFrom

public EncryptionKey getEncryptionCardNumberFrom()
                                          throws SQLException,
IOException

Throws:

SQLException

IOException

getEncryptionCardNumberRecipient

public EncryptionKey getEncryptionCardNumberRecipient()
                                               throws SQLException,
IOException

Throws:

SQLException

IOException

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,CreditCard>

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,CreditCard>

Parameters:

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

Throws:

SQLException

getIsActive

public boolean getIsActive()

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,CreditCard>

Throws:

IOException

remove

public void remove()
            throws IOException,
SQLException

Description copied from interface: Removable

Removes this object, and all dependant objects, from the system.

Specified by:

remove in interface Removable

Throws:

IOException

SQLException

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<CreditCard>

getUseMonthly

public boolean getUseMonthly()

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,CreditCard>

Throws:

IOException

update

public void update(String cardInfo,
 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 description)
            throws IOException,
SQLException

Updates the credit card information (not including the card number or expiration).

Throws:

IOException

SQLException

updateCardNumberAndExpiration

public void updateCardNumberAndExpiration(String maskedCardNumber,
 String cardNumber,
 byte expirationMonth,
 short expirationYear)
                                   throws IOException,
SQLException

Updates the credit card number and expiration, including the masked card number. Encrypts the data if the processors has been configured to store card encrypted in the master database.

Throws:

IOException

SQLException

updateCardExpiration

public void updateCardExpiration(byte expirationMonth,
 short expirationYear)
                          throws IOException,
SQLException

Updates the credit card expiration. Encrypts the data if the processors has been configured to store card encrypted in the master database.

Throws:

IOException

SQLException

reactivate

public void reactivate()
                throws IOException,
SQLException

Reactivates a credit card.

Throws:

IOException

SQLException

getCardNumber

public String getCardNumber(String passphrase)
                     throws IOException,
SQLException

Gets the card number or null if not stored.

Throws:

IOException

SQLException