Module com.aoapps.payments.api

Package com.aoapps.payments

Interface PersistenceMechanism

All Known Implementing Classes:

PropertiesPersistenceMechanism

public interface PersistenceMechanism

A persistence mechanism stores the credit card data and transaction history.

Author:

AO Industries, Inc.

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.
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)	Updates the stored card number and expiration for a credit card.
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)	Optionally updates the expiration for a credit card.
void	voidCompleted(Principal principal, Transaction transaction)	Updates a transaction in the database after the void has completed.

Method Details

storeCreditCard

String storeCreditCard(Principal principal,
 CreditCard creditCard)
                throws SQLException

Stores a credit card and returns its persistenceUniqueId.

Throws:

SQLException

See Also:

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

getCreditCard

CreditCard getCreditCard(Principal principal,
 String persistenceUniqueId)
                  throws SQLException

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

Parameters:

persistenceUniqueId - The card's persistenceUniqueId

Returns:

The stored CreditCard or null if not found.

Throws:

SQLException

getCreditCards

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

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.

Returns:

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

Throws:

SQLException

See Also:

• CreditCard.clone()

getCreditCards

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

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.

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

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.

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

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

Updates the stored card number and expiration for a credit card.

Throws:

SQLException

See Also:

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

updateExpiration

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

Optionally updates the expiration for a credit card.

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

void deleteCreditCard(Principal principal,
 CreditCard creditCard)
               throws SQLException

Deletes the credit card from the credit card list.

Throws:

SQLException

See Also:

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

insertTransaction

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

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

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

void saleCompleted(Principal principal,
 Transaction transaction)
            throws SQLException

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

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

void authorizeCompleted(Principal principal,
 Transaction transaction)
                 throws SQLException

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

Throws:

SQLException

See Also:

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

voidCompleted

void voidCompleted(Principal principal,
 Transaction transaction)
            throws SQLException

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

Throws:

SQLException

See Also:

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