anon.pay

Class PayAccountsFile

java.lang.Object

java.util.Observable

anon.pay.PayAccountsFile

All Implemented Interfaces:

IBIConnectionListener, IMessageListener, IXMLEncodable

public class PayAccountsFile
extends java.util.Observable
implements IXMLEncodable, IBIConnectionListener, IMessageListener

This class encapsulates a collection of accounts. One of the accounts in the collection is always active, except when the collection is empty. GUI classes can register a IPaymentListener with this class to be informed about all payment specific events. The class can be initialized from an XML structure and can also save all internal information in an XML structure before shutdown. For saving the accounts information, the following XML structure is used:

 <PayAccountsFile version="1.0">
    <MainAccountNumber>123465</MainAccountNumber>
    <Accounts>
       <Account version="1.0">
                    <AccountCertificate>...</AccountCertificate> // Kontozertiufkat von der BI unterschrieben
                    <RSAPrivateKey>...</RSAPrivateKey> //der geheime Schl?ssel zum Zugriff auf das Konto
                    <TransferCertificates> //offenen Transaktionsummern
                            ....
                    </TransferCertifcates>
                    <AccountInfo>...</AccountInfo> //Kontostand (siehe XMLAccountInfo)
       </Account>
        .
        .
        .
    </Accounts>
 </PayAccountsFile>
 

Version:

1.0

Author:

Bastian Voigt, Tobias Bayer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PayAccountsFile.AccountAlreadyExistingException Thrown if an account with same account number was already existing when trying to add it.
static interface	PayAccountsFile.IAffiliateOptOut

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	CHANGED_AUTO_UPDATE
static java.lang.String	METHOD_COUPON
static java.lang.String	MSG_ACTIVATING_COUPON
static java.lang.String	MSG_ACTIVATING_COUPON_ERROR
static java.lang.String	MSG_ACTIVATING_COUPON_NOT_A_NEW_USER
static java.lang.String	MSG_ACTIVATING_COUPON_NOT_ACCEPTED
static java.lang.String	MSG_CREATING_ACCOUNT
static java.lang.String	MSG_CREATING_ACCOUNT_ERROR
static java.lang.String	MSG_CREATING_ACCOUNT_ERROR_FORBIDDEN
static java.lang.String	MSG_CREATING_ACCOUNT_ERROR_UNREACHABLE
static java.lang.String	MSG_CREATING_KEY_PAIR
static java.lang.String	MSG_CREATING_KEY_PAIR_ERROR
static java.lang.String	MSG_DO_PREMIUM_PAYMENT
static java.lang.String	MSG_DO_PREMIUM_PAYMENT_ALTERNATIVE
static java.lang.String	MSG_ERROR_ALLOW_NON_ANONYMOUS_OR_CONNECT
static java.lang.String	MSG_ERROR_ALLOW_NON_ANONYMOUS_OR_CONNECT_INFOSERVICE
static java.lang.String	MSG_ERROR_DELETION_ACCOUNT_BLOCKED
static java.lang.String	MSG_GET_FREE_CODE
static java.lang.String	MSG_NO_PAYMENT_INSTANCE
static java.lang.String	MSG_PAY_CREATE_ACCOUNT
static java.lang.String	MSG_SAVING_CONFIG_FILE
static java.lang.String	MSG_SAVING_CONFIG_FILE_ERROR
static java.lang.String	MSG_UPDATING_ACCOUNT_DATA
static java.lang.String	MSG_UPDATING_ACCOUNT_DATA_ERROR
static java.lang.String	MSG_VERIFYING_COUPON
static java.lang.String	XML_ELEMENT_AFFILIATE
static java.lang.String	XML_ELEMENT_AFFILIATES
static java.lang.String	XML_ELEMENT_NAME

Fields inherited from interface anon.util.IXMLEncodable

FIELD_XML_ELEMENT_CONTAINER_NAME, FIELD_XML_ELEMENT_NAME, XML_ATTR_ID, XML_ATTR_LANGUAGE, XML_ATTR_VERSION

Method Summary

Modifier and Type	Method and Description
boolean	activateCouponCode(java.lang.String a_code, PayAccount a_account, boolean a_bPreCheckOnly)
void	addAccount(PayAccount newAccount) Adds a new account
void	addMessageListener(IMessageListener listener)
void	addPaymentListener(IPaymentListener listener)
PayAccount	createAccount(PaymentInstanceDBEntry a_bi, AsymmetricCryptoKeyPair a_keyPair, XMLGenericText a_terms) Creates a new Account.
PayAccount	createAccount(PaymentInstanceDBEntry a_bi, AsymmetricCryptoKeyPair a_keyPair, XMLGenericText a_terms, boolean a_bLock)
PayAccount	createAccount(PaymentInstanceDBEntry a_bi, XMLGenericText a_terms)
AsymmetricCryptoKeyPair	createAccountKeyPair()
AsymmetricCryptoKeyPair	createAccountKeyPair(int a_keyLengthForTesting)
void	deleteAccount(PayAccount a_account) Deletes the account from the accountsfile and saves the file to disk.
static void	fireKnownMessages() iterates over all accounts, and whenever there is a message it is sent to all MessageListeners reason for existence: JapNewView needs to load all messages at start-up (PayAccountsFile does already fire all message when it loads the accounts from the file, but that possibly happens before a MessageListener is initialized and added as a listener to PayAccountsFile)
PayAccount	getAccount(long accountNumber, java.lang.String a_piid) Liefert PayAccount zur angegebenen Kontonummer.
PayAccount	getAccountAt(int rowIndex) getAccountAt
java.util.Enumeration	getAccounts() Returns an enumeration of all accounts
java.util.Vector	getAccounts(java.lang.String a_piid)
PayAccount	getAccountWaitingForTransaction(java.lang.String a_piid)
PayAccount	getActiveAccount()
long	getActiveAccountNumber()
java.lang.String	getAffiliate(java.lang.String a_strPIID, boolean a_bForceAffiliate)
PayAccount	getAlternativeChargedAccount(java.lang.String a_piid)
PaymentInstanceDBEntry	getBI(java.lang.String a_piID)
PayAccount	getChargedAccount(java.lang.String a_piid)
PayAccount	getChargedAccount(java.lang.String a_piid, PayAccount a_excludeAccount)
static PayAccountsFile	getInstance() returns the one and only accountsfile.
int	getNumAccounts() getNumAccounts
java.util.Vector	getPaymentInstances()
java.util.Vector	getPaymentInstances(boolean a_bProductiveOnly)
void	gotCaptcha(ICaptchaSender a_source, IImageEncodedCaptcha a_captcha) This method is called whenever a captcha has been received from the Payment Instance.
boolean	hasActiveAccount()
boolean	importAccounts(org.w3c.dom.Element elemAccountsFile, IMiscPasswordReader a_passwordReader)
boolean	importAccounts(org.w3c.dom.Element elemAccountsFile, IMiscPasswordReader a_passwordReader, boolean a_bOnlyWithCorrectPassword)
static boolean	init(org.w3c.dom.Element elemAccountsFile, IMiscPasswordReader a_passwordReader, boolean a_bForceAIErrors, int a_keyPoolSize, PayAccountsFile.IAffiliateOptOut a_affiliateOptOut) Performs the initialization.
boolean	isAIAccountErrorIgnored() Returns if error messages from the AI should be ignored.
boolean	isBalanceAutoUpdateEnabled() Returns if account balances are automatically updated.
boolean	isInitialized() isInitialized
boolean	isNewUser()
boolean	isNewUserAllowed(java.lang.String a_code)
static boolean	isNewUserLetter(char a_startingLetter)
static boolean	isPromotionLetter(char a_startingLetter)
void	messageReceived(PayMessage message) just passes through a received message to the PayAccountsFile's MessageListeners
void	messageRemoved(PayMessage message)
void	removePaymentListener(IPaymentListener a_listener)
void	setActiveAccount(PayAccount a_account)
void	setBalanceAutoUpdateEnabled(boolean a_bEnable)
void	setIgnoreAIAccountError(boolean a_bIgnore) Defined if error messages from the AI should be ignored.
void	signalAccountError(XMLErrorMessage msg) signalAccountError
void	signalAccountRequest(MixCascade a_connectedCascade) signalAccountRequest
org.w3c.dom.Element	toXmlElement(org.w3c.dom.Document a_doc) constructs the xml structure
org.w3c.dom.Element	toXmlElement(org.w3c.dom.Document a_doc, java.lang.String a_password, boolean a_bDoNotDeactivate)

Methods inherited from class java.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

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

Field Detail

XML_ELEMENT_NAME

public static final java.lang.String XML_ELEMENT_NAME

See Also:

Constant Field Values

METHOD_COUPON

public static final java.lang.String METHOD_COUPON

See Also:

Constant Field Values

XML_ELEMENT_AFFILIATE

public static final java.lang.String XML_ELEMENT_AFFILIATE

See Also:

Constant Field Values

XML_ELEMENT_AFFILIATES

public static final java.lang.String XML_ELEMENT_AFFILIATES

See Also:

Constant Field Values

CHANGED_AUTO_UPDATE

public static final java.lang.Integer CHANGED_AUTO_UPDATE

MSG_DO_PREMIUM_PAYMENT

public static final java.lang.String MSG_DO_PREMIUM_PAYMENT

MSG_DO_PREMIUM_PAYMENT_ALTERNATIVE

public static final java.lang.String MSG_DO_PREMIUM_PAYMENT_ALTERNATIVE

MSG_GET_FREE_CODE

public static final java.lang.String MSG_GET_FREE_CODE

MSG_PAY_CREATE_ACCOUNT

public static final java.lang.String MSG_PAY_CREATE_ACCOUNT

MSG_NO_PAYMENT_INSTANCE

public static final java.lang.String MSG_NO_PAYMENT_INSTANCE

MSG_CREATING_KEY_PAIR

public static final java.lang.String MSG_CREATING_KEY_PAIR

MSG_CREATING_KEY_PAIR_ERROR

public static final java.lang.String MSG_CREATING_KEY_PAIR_ERROR

MSG_UPDATING_ACCOUNT_DATA

public static final java.lang.String MSG_UPDATING_ACCOUNT_DATA

MSG_UPDATING_ACCOUNT_DATA_ERROR

public static final java.lang.String MSG_UPDATING_ACCOUNT_DATA_ERROR

MSG_CREATING_ACCOUNT

public static final java.lang.String MSG_CREATING_ACCOUNT

MSG_CREATING_ACCOUNT_ERROR

public static final java.lang.String MSG_CREATING_ACCOUNT_ERROR

MSG_CREATING_ACCOUNT_ERROR_UNREACHABLE

public static final java.lang.String MSG_CREATING_ACCOUNT_ERROR_UNREACHABLE

MSG_CREATING_ACCOUNT_ERROR_FORBIDDEN

public static final java.lang.String MSG_CREATING_ACCOUNT_ERROR_FORBIDDEN

MSG_SAVING_CONFIG_FILE

public static final java.lang.String MSG_SAVING_CONFIG_FILE

MSG_SAVING_CONFIG_FILE_ERROR

public static final java.lang.String MSG_SAVING_CONFIG_FILE_ERROR

MSG_VERIFYING_COUPON

public static final java.lang.String MSG_VERIFYING_COUPON

MSG_ACTIVATING_COUPON

public static final java.lang.String MSG_ACTIVATING_COUPON

MSG_ACTIVATING_COUPON_ERROR

public static final java.lang.String MSG_ACTIVATING_COUPON_ERROR

MSG_ACTIVATING_COUPON_NOT_ACCEPTED

public static final java.lang.String MSG_ACTIVATING_COUPON_NOT_ACCEPTED

MSG_ACTIVATING_COUPON_NOT_A_NEW_USER

public static final java.lang.String MSG_ACTIVATING_COUPON_NOT_A_NEW_USER

MSG_ERROR_ALLOW_NON_ANONYMOUS_OR_CONNECT

public static final java.lang.String MSG_ERROR_ALLOW_NON_ANONYMOUS_OR_CONNECT

MSG_ERROR_ALLOW_NON_ANONYMOUS_OR_CONNECT_INFOSERVICE

public static final java.lang.String MSG_ERROR_ALLOW_NON_ANONYMOUS_OR_CONNECT_INFOSERVICE

MSG_ERROR_DELETION_ACCOUNT_BLOCKED

public static final java.lang.String MSG_ERROR_DELETION_ACCOUNT_BLOCKED

Method Detail

getInstance

public static PayAccountsFile getInstance()

returns the one and only accountsfile. Note: If init(BI, Element) was not yet called, you get an empty instance which is not really useful.

createAccountKeyPair

public AsymmetricCryptoKeyPair createAccountKeyPair()

createAccountKeyPair

public AsymmetricCryptoKeyPair createAccountKeyPair(int a_keyLengthForTesting)

setIgnoreAIAccountError

public void setIgnoreAIAccountError(boolean a_bIgnore)

Defined if error messages from the AI should be ignored. The connection might be closed, but the listeners will not get informed about the problem.

Parameters:

a_bIgnore - boolean

isNewUser

public boolean isNewUser()

isBalanceAutoUpdateEnabled

public boolean isBalanceAutoUpdateEnabled()

Returns if account balances are automatically updated.

Returns:

if account balances are automatically updated

setBalanceAutoUpdateEnabled

public void setBalanceAutoUpdateEnabled(boolean a_bEnable)

isAIAccountErrorIgnored

public boolean isAIAccountErrorIgnored()

Returns if error messages from the AI should be ignored.

Returns:

boolean

importAccounts

public boolean importAccounts(org.w3c.dom.Element elemAccountsFile,
                              IMiscPasswordReader a_passwordReader)
                       throws XMLParseException,
                              java.lang.Exception

Throws:

XMLParseException

java.lang.Exception

importAccounts

public boolean importAccounts(org.w3c.dom.Element elemAccountsFile,
                              IMiscPasswordReader a_passwordReader,
                              boolean a_bOnlyWithCorrectPassword)
                       throws XMLParseException,
                              java.lang.Exception

Throws:

XMLParseException

java.lang.Exception

init

public static boolean init(org.w3c.dom.Element elemAccountsFile,
                           IMiscPasswordReader a_passwordReader,
                           boolean a_bForceAIErrors,
                           int a_keyPoolSize,
                           PayAccountsFile.IAffiliateOptOut a_affiliateOptOut)

Performs the initialization.

Parameters:

a_passwordReader - a password reader for encrypted account files; message: AccountNumber

Returns:

boolean succeeded?

toXmlElement

public org.w3c.dom.Element toXmlElement(org.w3c.dom.Document a_doc)

constructs the xml structure

Specified by:

toXmlElement in interface IXMLEncodable

Parameters:

a_doc - a document

Returns:

Element

toXmlElement

public org.w3c.dom.Element toXmlElement(org.w3c.dom.Document a_doc,
                                        java.lang.String a_password,
                                        boolean a_bDoNotDeactivate)

hasActiveAccount

public boolean hasActiveAccount()

getActiveAccount

public PayAccount getActiveAccount()

setActiveAccount

public void setActiveAccount(PayAccount a_account)

getActiveAccountNumber

public long getActiveAccountNumber()

getAccount

public PayAccount getAccount(long accountNumber,
                             java.lang.String a_piid)

Liefert PayAccount zur angegebenen Kontonummer.

Parameters:

accountNumber - Kontonummer

Returns:

PayAccount oder null, wenn kein Konto unter der angebenen Kontonummer vorhanden ist

deleteAccount

public void deleteAccount(PayAccount a_account)

Deletes the account from the accountsfile and saves the file to disk. If the deleted account was the active account, the first remaining account will become the active account.

Parameters:

accountNumber - account number

getAffiliate

public java.lang.String getAffiliate(java.lang.String a_strPIID,
                                     boolean a_bForceAffiliate)

getAccounts

public java.util.Enumeration getAccounts()

Returns an enumeration of all accounts

Returns:

Enumeration of PayAccount

fireKnownMessages

public static void fireKnownMessages()

iterates over all accounts, and whenever there is a message it is sent to all MessageListeners reason for existence: JapNewView needs to load all messages at start-up (PayAccountsFile does already fire all message when it loads the accounts from the file, but that possibly happens before a MessageListener is initialized and added as a listener to PayAccountsFile)

getAlternativeChargedAccount

public PayAccount getAlternativeChargedAccount(java.lang.String a_piid)

getAccountWaitingForTransaction

public PayAccount getAccountWaitingForTransaction(java.lang.String a_piid)

getChargedAccount

public PayAccount getChargedAccount(java.lang.String a_piid)

getChargedAccount

public PayAccount getChargedAccount(java.lang.String a_piid,
                                    PayAccount a_excludeAccount)

getAccounts

public java.util.Vector getAccounts(java.lang.String a_piid)

addAccount

public void addAccount(PayAccount newAccount)
                throws PayAccountsFile.AccountAlreadyExistingException

Adds a new account

Parameters:

account - new account

Throws:

java.lang.Exception - If the same account was already added

PayAccountsFile.AccountAlreadyExistingException

getNumAccounts

public int getNumAccounts()

getNumAccounts

Returns:

int

getAccountAt

public PayAccount getAccountAt(int rowIndex)

getAccountAt

Parameters:

rowIndex - int

Returns:

PayAccount

isInitialized

public boolean isInitialized()

isInitialized

Returns:

boolean

addPaymentListener

public void addPaymentListener(IPaymentListener listener)

removePaymentListener

public void removePaymentListener(IPaymentListener a_listener)

addMessageListener

public void addMessageListener(IMessageListener listener)

createAccount

public PayAccount createAccount(PaymentInstanceDBEntry a_bi,
                                XMLGenericText a_terms)
                         throws java.lang.Exception

Throws:

java.lang.Exception

isNewUserLetter

public static boolean isNewUserLetter(char a_startingLetter)

isPromotionLetter

public static boolean isPromotionLetter(char a_startingLetter)

isNewUserAllowed

public boolean isNewUserAllowed(java.lang.String a_code)

activateCouponCode

public boolean activateCouponCode(java.lang.String a_code,
                                  PayAccount a_account,
                                  boolean a_bPreCheckOnly)
                           throws java.lang.Exception

Throws:

java.lang.Exception

createAccount

public PayAccount createAccount(PaymentInstanceDBEntry a_bi,
                                AsymmetricCryptoKeyPair a_keyPair,
                                XMLGenericText a_terms)
                         throws java.lang.Exception

Creates a new Account. Generates an RSA or DSA key pair and then registers a new account with the BI. This can take a while, so the user should be notified before calling this. At the moment, only DSA should be used, because RSA is not supported by the AI implementation

Parameters:

a_keyPair - RSA should not be used at the moment

Throws:

java.lang.Exception

createAccount

public PayAccount createAccount(PaymentInstanceDBEntry a_bi,
                                AsymmetricCryptoKeyPair a_keyPair,
                                XMLGenericText a_terms,
                                boolean a_bLock)
                         throws java.lang.Exception

Throws:

java.lang.Exception

signalAccountRequest

public void signalAccountRequest(MixCascade a_connectedCascade)
                          throws AccountEmptyException

signalAccountRequest

Throws:

AccountEmptyException

signalAccountError

public void signalAccountError(XMLErrorMessage msg)

signalAccountError

Parameters:

msg - XMLErrorMessage

getPaymentInstances

public java.util.Vector getPaymentInstances(boolean a_bProductiveOnly)

getPaymentInstances

public java.util.Vector getPaymentInstances()

getBI

public PaymentInstanceDBEntry getBI(java.lang.String a_piID)

gotCaptcha

public void gotCaptcha(ICaptchaSender a_source,
                       IImageEncodedCaptcha a_captcha)

This method is called whenever a captcha has been received from the Payment Instance.

Specified by:

gotCaptcha in interface IBIConnectionListener

Parameters:

a_source - Object

a_captcha - IImageEncodedCaptcha

messageReceived

public void messageReceived(PayMessage message)

just passes through a received message to the PayAccountsFile's MessageListeners

Specified by:

messageReceived in interface IMessageListener

messageRemoved

public void messageRemoved(PayMessage message)

Specified by:

messageRemoved in interface IMessageListener