All Packages Class Hierarchy This Package Previous Next Index
Class semper.payment.mandate.mandatePurse
java.lang.Object
|
+----semper.payment.Purse
|
+----semper.payment.AccountBasedPurse
|
+----semper.payment.ChequePurse
|
+----semper.payment.mandate.mandatePurse
- public class mandatePurse
- extends ChequePurse
- implements Serializable
Mandate Purse - part of the adapter for the "Mandate" payment module
- Version:
- $Revision: 1.14 $ $Date: 1998/10/13 12:57:54 $
- Author:
- K. L¨ders-Jensen ([email protected]), Bjarke Dahl Ebert ([email protected])
- See Also:
- mandateTransaction
-
DEF_PORT
- Default parameters for purse configuration: local communication port for
value transfer transactions
-
DEF_PROT
- Default parameters for purse configuration: communication protocol
-
mandatePurse()
- Constructor
-
disable()
- Disable an active purse by killing its listener service point
thread, if one exists
- Pre-conditions: The purse must have been already initiated
during PaymentManager.init
- Post-condition: The purse is disabled and can be safely
deleted if necessary
- Used-by: PurseReference#deactivate
-
doPurseOp(TinguinSession, String)
-
-
getAccountNumber()
- Get the account number
-
getAmount()
- Get the current amount in the purse
Implemented from abstract method defined in Purse
-
getCertificate()
- Retrieve the certificate of the DC
-
getNumberOfCheques()
- Return the number of blank cheques in purse
-
getPasswd()
-
-
getPaymentSystemName()
- Get the Payment System Name which is represented by this purse
Access to the attribute _paymentSystemName.
-
getPrintableStatusInfo()
- Return a hash table containing "attribute-value" pairs describing
the status of the purse.
-
getPurseAddress()
- We override getPurseAddress() so that it always contains the current host
address.
-
getPurseOpsList()
- Returns a vector containing names of supported special purse
operations.
-
getUnlockedAmount()
- Get the unlocked amount
Implemented from abstract method defined in Purse
-
getUserID()
-
-
init()
- Initialise.
-
isCurrencySupported(Currency)
- Check if a given currency is supported
Implemented from abstract method defined in Purse
-
isEnabled()
- This adapter is always available for use.
-
isRegistered()
- Has this purse been registered with its "bank"?
-
isSecurityServiceOffered(SecurityOption)
- Check if a specific security service is offered
Implemented from abstract method defined in Purse
-
issueCheque(byte[], Amount, int, int, String, String)
-
-
issueCheque(byte[], Amount, String, String)
- Issue a cheque valid from now and 20 days ahead
-
offeredSecurityServices()
- Get the list of security services offered
Implemented from abstract method defined in Purse
-
receiveCheque(Cheque)
-
-
registerWithBank()
- Register or re-register a purse with the bank.
-
retrieveCheques()
- Return a list of cheques in purse
-
setUnlockedAmount(Amount)
- Set the unlocked amount
Implemented from abstract method defined in Purse
-
setup(TinguinSession)
- Setup the purse.
-
startTransaction()
- Starts a new Transaction.
-
startTransaction(PaymentTransactionRecord)
- Resume an existing transaction
-
supportedCurrency()
- Return the list of supported currencies
Implemented from abstract method defined in Purse
DEF_PROT
protected static final String DEF_PROT
- Default parameters for purse configuration: communication protocol
DEF_PORT
protected static final String DEF_PORT
- Default parameters for purse configuration: local communication port for
value transfer transactions
mandatePurse
public mandatePurse()
- Constructor
getPasswd
public String getPasswd() throws mandateModuleException
getNumberOfCheques
public int getNumberOfCheques() throws mandateModuleException
- Return the number of blank cheques in purse
- Returns:
- number of blank cheques in purse
- Overrides:
- getNumberOfCheques in class ChequePurse
- See Also:
- getNumberOfCheques
retrieveCheques
public Vector retrieveCheques() throws mandateModuleException
- Return a list of cheques in purse
- Returns:
- a list of cheques in purse
- Overrides:
- retrieveCheques in class ChequePurse
- See Also:
- retrieveCheques
startTransaction
public PaymentTransaction startTransaction() throws PaymentServiceException
- Starts a new Transaction.
The invoker of this method should explicitly cast the returned
object to mandateTransaction
- Throws: PaymentServiceException
- if a transaction cannot be started.
- Overrides:
- startTransaction in class Purse
- See Also:
- startTransaction
startTransaction
public PaymentTransaction startTransaction(PaymentTransactionRecord pr) throws PaymentServiceException
- Resume an existing transaction
- Parameters:
- pr - Existing payment transaction record
- Returns:
- a new PaymentTransaction object
- Throws: PaymentServiceException
- in case of exceptions
- Overrides:
- startTransaction in class Purse
issueCheque
public Cheque issueCheque(byte certificate[],
Amount amount,
int validStart,
int validEnd,
String payee,
String ext_ref) throws mandateModuleException
issueCheque
public Cheque issueCheque(byte certificate[],
Amount amount,
String payee,
String ext_ref) throws mandateModuleException
- Issue a cheque valid from now and 20 days ahead
getPaymentSystemName
public String getPaymentSystemName()
- Get the Payment System Name which is represented by this purse
Access to the attribute _paymentSystemName. Overriding default
method defined in Purse.java
The first part of the payment system name is a static class-wide
constant that is unique to a payment system (MANDATE). The second
part is the brand name (e.g. EuroCard).
- Overrides:
- getPaymentSystemName in class Purse
- See Also:
- getPaymentSystemName
registerWithBank
public void registerWithBank() throws PaymentServiceException
- Register or re-register a purse with the bank.
Implemented from abstract method defined in Purse
For MANDATE, this is a no-op, since a MANDATE document carrier is
always registered with the bank
- Throws: PaymentServiceException
- if
registration failed
- Overrides:
- registerWithBank in class Purse
- See Also:
- registerWithBank
getAccountNumber
public String getAccountNumber()
- Get the account number
- Returns:
- string containing the account number for this purse
supportedCurrency
public Vector supportedCurrency()
- Return the list of supported currencies
Implemented from abstract method defined in Purse
- Overrides:
- supportedCurrency in class Purse
- See Also:
- supportedCurrency
getCertificate
public byte[] getCertificate() throws mandateModuleException
- Retrieve the certificate of the DC
receiveCheque
public void receiveCheque(Cheque c) throws mandateModuleException
isCurrencySupported
public boolean isCurrencySupported(Currency currency)
- Check if a given currency is supported
Implemented from abstract method defined in Purse
- Overrides:
- isCurrencySupported in class Purse
- See Also:
- isCurrencySupported
offeredSecurityServices
public Vector offeredSecurityServices()
- Get the list of security services offered
Implemented from abstract method defined in Purse
- Overrides:
- offeredSecurityServices in class Purse
- See Also:
- offeredSecurityServices
isSecurityServiceOffered
public boolean isSecurityServiceOffered(SecurityOption service)
- Check if a specific security service is offered
Implemented from abstract method defined in Purse
- Overrides:
- isSecurityServiceOffered in class Purse
- See Also:
- isSecurityServiceOffered
getAmount
public Amount getAmount() throws AmountNotApplicable
- Get the current amount in the purse
Implemented from abstract method defined in Purse
- Throws: AmountNotApplicable
- always because
current amount does not make sense in this system
- Overrides:
- getAmount in class Purse
- See Also:
- getAmount
setUnlockedAmount
public synchronized void setUnlockedAmount(Amount amount)
- Set the unlocked amount
Implemented from abstract method defined in Purse
- Overrides:
- setUnlockedAmount in class Purse
- See Also:
- setUnlockedAmount
getUnlockedAmount
public Amount getUnlockedAmount()
- Get the unlocked amount
Implemented from abstract method defined in Purse
- Overrides:
- getUnlockedAmount in class Purse
- See Also:
- getUnlockedAmount
getPurseAddress
public PaymentEntity getPurseAddress()
- We override getPurseAddress() so that it always contains the current host
address. TODO: Check if this is a reasonable thing to do
- Returns:
- PaymentEntity object indicating the address
- Overrides:
- getPurseAddress in class Purse
isEnabled
public boolean isEnabled()
- This adapter is always available for use. Indicate it by always
returning true.
- Returns:
- s true
- Overrides:
- isEnabled in class Purse
isRegistered
public boolean isRegistered()
- Has this purse been registered with its "bank"?
- Returns:
- s Always returns true, since a DC is already registered.
- Overrides:
- isRegistered in class Purse
disable
protected void disable() throws PaymentServiceException
- Disable an active purse by killing its listener service point
thread, if one exists
- Pre-conditions: The purse must have been already initiated
during PaymentManager.init
- Post-condition: The purse is disabled and can be safely
deleted if necessary
- Used-by: PurseReference#deactivate
- Throws: PaymentServiceException
- if service point thread cannot
be killed
- Overrides:
- disable in class Purse
getPrintableStatusInfo
public Hashtable getPrintableStatusInfo()
- Return a hash table containing "attribute-value" pairs describing
the status of the purse. Overrides the default implementation in
the parent class.
- Used-by: PurseManagementApp during purse configuration
- Returns:
- Hashtable containing attr-value pairs
- Overrides:
- getPrintableStatusInfo in class Purse
- See Also:
- getPrintableStatusInfo
getUserID
public String getUserID()
init
public synchronized void init() throws PaymentServiceException
- Initialise. The following actions are currently taken:
([bde] the following is from genericPurse:)
- Register a place to receive payments
- [tbd] read in preferences (initialise with defaults if needed)
- Throws: PaymentServiceException
- on init failure
- Overrides:
- init in class Purse
setup
public void setup(TinguinSession dis) throws PaymentServiceException
- Setup the purse.
- Parameters:
- dis - an active Tinguin session
- Returns:
- nothing
- Throws: PaymentServiceException
- on misc. errors
- Overrides:
- setup in class Purse
- See Also:
- setup
getPurseOpsList
public Vector getPurseOpsList()
- Returns a vector containing names of supported special purse
operations.
- Overrides:
- getPurseOpsList in class AccountBasedPurse
doPurseOp
public boolean doPurseOp(TinguinSession dis,
String userchoice) throws PaymentServiceException
- Returns:
- s true if user cancelled
- Overrides:
- doPurseOp in class AccountBasedPurse
All Packages Class Hierarchy This Package Previous Next Index