Module com.aoapps.payments.api

Package com.aoapps.payments

Class PropertiesPersistenceMechanism

java.lang.Object

com.aoapps.payments.PropertiesPersistenceMechanism

All Implemented Interfaces:

PersistenceMechanism

public class PropertiesPersistenceMechanism
extends Object
implements PersistenceMechanism

Stores everything in a simple on-disk properties file. This is not a scalable solution and is intended for debugging purposes only.

Author:

AO Industries, Inc.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<CreditCard>	internalCreditCards	The list of credit cards in the database.
protected List<Transaction>	internalTransactions	The list of transactions in the database.
protected final String	propertiesFilePath	The properties file path is obtained at creation time just in case the configuration mapping changes values.

Method Summary

Modifier and Type	Method	Description
void	authorizeCompleted(Principal principal, Transaction transaction)	Updates a transaction in the database after the authorize has completed.
void	deleteCreditCard(Principal principal, CreditCard creditCard)	Deletes the credit card from the credit card list.
CreditCard	getCreditCard(Principal principal, String persistenceUniqueId)	Gets a defensive copy of a stored card given its persistenceUniqueId.
Map<String,CreditCard>	getCreditCards(Principal principal)	Gets all the stored cards.
Map<String,CreditCard>	getCreditCards(Principal principal, String providerId)	Gets all the stored cards for a given providerId.
static PropertiesPersistenceMechanism	getInstance(String propertiesFilePath)	For intra-JVM reusability, only one instance is made per unique path.
String	insertTransaction(Principal principal, Group group, Transaction transaction)	Inserts a new transaction into the database and returns its persistenceUniqueId.
void	saleCompleted(Principal principal, Transaction transaction)	Updates a transaction in the database after the sale has completed.
String	storeCreditCard(Principal principal, CreditCard creditCard)	Stores a credit card and returns its persistenceUniqueId.
void	updateCardNumber(Principal principal, CreditCard creditCard, String cardNumber, byte expirationMonth, short expirationYear)	Card numbers are not persisted to the properties files - encrypted local storage not supported.
void	updateCreditCard(Principal principal, CreditCard creditCard)	Updates the stored credit card details, all except the card number, expiration, and card security code, for a credit card.
void	updateExpiration(Principal principal, CreditCard creditCard, byte expirationMonth, short expirationYear)	Encrypted local storage not supported.
void	voidCompleted(Principal principal, Transaction transaction)	Updates a transaction in the database after the void has completed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

propertiesFilePath

protected final String propertiesFilePath

The properties file path is obtained at creation time just in case the configuration mapping changes values. The properties file will remain the same.

internalCreditCards

protected List<CreditCard> internalCreditCards

The list of credit cards in the database.

internalTransactions

protected List<Transaction> internalTransactions

The list of transactions in the database.

Method Details

getInstance

public static PropertiesPersistenceMechanism getInstance(String propertiesFilePath)

For intra-JVM reusability, only one instance is made per unique path. However, different paths resolving to the same file (symlink in Unix is one example) or multiple processes accessing the same file are not guaranteed to interoperate properly. In fact, there are no mechanisms in this code to control that in any way. Once again, this is intended for development and debugging use only.

storeCreditCard

public String storeCreditCard(Principal principal,
 CreditCard creditCard)
                       throws SQLException

Description copied from interface: PersistenceMechanism

Stores a credit card and returns its persistenceUniqueId.

Specified by:

storeCreditCard in interface PersistenceMechanism

Throws:

SQLException

See Also:

• CreditCardProcessor.storeCreditCard(java.security.Principal, com.aoapps.lang.security.acl.Group, com.aoapps.payments.CreditCard)

getCreditCard

public CreditCard getCreditCard(Principal principal,
 String persistenceUniqueId)
                         throws SQLException

Description copied from interface: PersistenceMechanism

Gets a defensive copy of a stored card given its persistenceUniqueId.

Specified by:

getCreditCard in interface PersistenceMechanism

Parameters:

persistenceUniqueId - The card's persistenceUniqueId

Returns:

The stored CreditCard or null if not found.

Throws:

SQLException

getCreditCards

public Map<String,CreditCard> getCreditCards(Principal principal)
                                      throws SQLException

Description copied from interface: PersistenceMechanism

Gets all the stored cards.

Each element is a defensive copy. Modifications will not update the underling persistence.

The returned map must be modifiable. Modifications to the returned map will not update the underlying persistence.

Specified by:

getCreditCards in interface PersistenceMechanism

Returns:

The modifiable mapping from CreditCard.getPersistenceUniqueId() to defensive copies of the stored card

Throws:

SQLException

See Also:

• CreditCard.clone()

getCreditCards

public Map<String,CreditCard> getCreditCards(Principal principal,
 String providerId)
                                      throws SQLException

Description copied from interface: PersistenceMechanism

Gets all the stored cards for a given providerId.

Each element is a defensive copy. Modifications will not update the underling persistence.

The returned map must be modifiable. Modifications to the returned map will not update the underlying persistence.

Specified by:

getCreditCards in interface PersistenceMechanism

Parameters:

principal - The entity performing the query (person, software component, ...)

providerId - The ID of the provider to get all cards for

Returns:

The modifiable mapping from CreditCard.getProviderUniqueId() to defensive copies of the stored card

Throws:

SQLException

See Also:

• CreditCard.clone()
• CreditCardProcessor.synchronizeStoredCards(java.security.Principal, java.io.PrintWriter, java.io.PrintWriter, java.io.PrintWriter, boolean)

updateCreditCard

public void updateCreditCard(Principal principal,
 CreditCard creditCard)
                      throws SQLException

Updates the stored credit card details, all except the card number, expiration, and card security code, for a credit card.

Card numbers are not persisted to the properties files - encrypted local storage not supported.

Specified by:

updateCreditCard in interface PersistenceMechanism

Throws:

SQLException

See Also:

• CreditCardProcessor.sale(java.security.Principal, com.aoapps.lang.security.acl.Group, com.aoapps.payments.TransactionRequest, com.aoapps.payments.CreditCard)
• CreditCardProcessor.authorize(java.security.Principal, com.aoapps.lang.security.acl.Group, com.aoapps.payments.TransactionRequest, com.aoapps.payments.CreditCard)
• CreditCardProcessor.updateCreditCard(java.security.Principal, com.aoapps.payments.CreditCard)

updateCardNumber

public void updateCardNumber(Principal principal,
 CreditCard creditCard,
 String cardNumber,
 byte expirationMonth,
 short expirationYear)
                      throws SQLException

Card numbers are not persisted to the properties files - encrypted local storage not supported.

Specified by:

updateCardNumber in interface PersistenceMechanism

Throws:

SQLException

See Also:

• CreditCardProcessor.updateCreditCardNumberAndExpiration(java.security.Principal, com.aoapps.payments.CreditCard, java.lang.String, byte, short, java.lang.String)

updateExpiration

public void updateExpiration(Principal principal,
 CreditCard creditCard,
 byte expirationMonth,
 short expirationYear)
                      throws SQLException

Encrypted local storage not supported.

Specified by:

updateExpiration in interface PersistenceMechanism

Throws:

SQLException

See Also:

• CreditCardProcessor.sale(java.security.Principal, com.aoapps.lang.security.acl.Group, com.aoapps.payments.TransactionRequest, com.aoapps.payments.CreditCard)
• CreditCardProcessor.updateCreditCardExpiration(java.security.Principal, com.aoapps.payments.CreditCard, byte, short)

deleteCreditCard

public void deleteCreditCard(Principal principal,
 CreditCard creditCard)
                      throws SQLException

Description copied from interface: PersistenceMechanism

Deletes the credit card from the credit card list.

Specified by:

deleteCreditCard in interface PersistenceMechanism

Throws:

SQLException

See Also:

• CreditCardProcessor.deleteCreditCard(java.security.Principal, com.aoapps.payments.CreditCard)

insertTransaction

public String insertTransaction(Principal principal,
 Group group,
 Transaction transaction)
                         throws SQLException

Description copied from interface: PersistenceMechanism

Inserts a new transaction into the database and returns its persistenceUniqueId.

Specified by:

insertTransaction in interface PersistenceMechanism

Parameters:

principal - null is acceptable

group - null is acceptable

Throws:

SQLException

See Also:

• CreditCardProcessor.sale(java.security.Principal, com.aoapps.lang.security.acl.Group, com.aoapps.payments.TransactionRequest, com.aoapps.payments.CreditCard)
• CreditCardProcessor.authorize(java.security.Principal, com.aoapps.lang.security.acl.Group, com.aoapps.payments.TransactionRequest, com.aoapps.payments.CreditCard)

saleCompleted

public void saleCompleted(Principal principal,
 Transaction transaction)
                   throws SQLException

Description copied from interface: PersistenceMechanism

Updates a transaction in the database after the sale has completed. The following transaction fields have been updated and must be stored:

1. authorizationResult
2. captureTime
3. capturePrincipalName
4. captureResult
5. status

Specified by:

saleCompleted in interface PersistenceMechanism

Throws:

SQLException

See Also:

• CreditCardProcessor.sale(java.security.Principal, com.aoapps.lang.security.acl.Group, com.aoapps.payments.TransactionRequest, com.aoapps.payments.CreditCard)
• CreditCardProcessor.capture(java.security.Principal, com.aoapps.payments.Transaction)

authorizeCompleted

public void authorizeCompleted(Principal principal,
 Transaction transaction)
                        throws SQLException

Description copied from interface: PersistenceMechanism

Updates a transaction in the database after the authorize has completed. The following transaction fields have been updated and must be stored:

1. authorizationResult
2. status

Specified by:

authorizeCompleted in interface PersistenceMechanism

Throws:

SQLException

See Also:

• CreditCardProcessor.authorize(java.security.Principal, com.aoapps.lang.security.acl.Group, com.aoapps.payments.TransactionRequest, com.aoapps.payments.CreditCard)

voidCompleted

public void voidCompleted(Principal principal,
 Transaction transaction)
                   throws SQLException

Description copied from interface: PersistenceMechanism

Updates a transaction in the database after the void has completed.

Specified by:

voidCompleted in interface PersistenceMechanism

Throws:

SQLException

See Also:

• CreditCardProcessor.voidTransaction(java.security.Principal, com.aoapps.payments.Transaction)