com.ibm.etill.kitcashcassette
Class KitCashCassette

java.lang.Object
  |
  +--com.ibm.etill.framework.cassette.Cassette
        |
        +--com.ibm.etill.kitcashcassette.KitCashCassette
All Implemented Interfaces:
com.ibm.etill.framework.payapi.FrameworkReturnCodes, KitCashConstants, com.ibm.etill.framework.payapi.PaymentAPIConstants

public class KitCashCassette
extends com.ibm.etill.framework.cassette.Cassette
implements KitCashConstants, com.ibm.etill.framework.payapi.PaymentAPIConstants

The Payment Manager framework creates a single instance of KitCashCassette at startup time. This instance handles all KitCash payments for all merchants configured for the IBM Payment Manager.

The naming convention for the cassette (including package name) is:

 com.<<company_name>>.ibmetill.<<lower_case_payment_system_name>>cassette.<<payment_system_name>>Cassette
 

where

For example, a valid cassette name would be:

 com.acme.acmecardcassette.ACMECardCassette
 

IBM developed cassettes use the following convention:

 com.ibm.etill.framework.<<lower_case_payment_system_name>>cassette.<<payment_system_name>>Cassette
 

The cassette is responsible for handling startup and shutdown processing, for creating cassette-specific order, payment and batch objects, and for handling requests that the framework has identified it should handle.


Field Summary
protected static java.lang.String lineSeparator
           
 
Fields inherited from class com.ibm.etill.framework.cassette.Cassette
myName, paymentSystem
 
Fields inherited from interface com.ibm.etill.kitcashcassette.test.card.KitCashConstants
BATCH_CLOSED_TOKEN, CASHMSG_TOKEN, END_TOKEN, ERROR_TOKEN, PD_ACCOUNTNUMBER, PD_BANKHOSTNAME, PD_BANKPORT, PD_PROTOCOLPORT, RC_BANKHOSTNAME, RC_BANKPORT, RC_PROTOCOLPORT
 
Fields inherited from interface com.ibm.etill.framework.payapi.PaymentAPIConstants
ABOUT, ABOUT_TOKEN, ACCEPT_PAYMENT, ACCEPTPAYMENT_TOKEN, ACCEPTPAYMENTAUTOAPPROVE, ACCEPTPAYMENTAUTOAPPROVE_TOKEN, ACCEPTPAYMENTAUTODEPOSIT, ACCEPTPAYMENTAUTODEPOSIT_TOKEN, ACCOUNTNUMBER, ACCOUNTNUMBER_TOKEN, ACCOUNTTITLE, ACCOUNTTITLE_TOKEN, ADMINHOSTNAME, ADMINHOSTNAME_TOKEN, AMOUNT, AMOUNT_TOKEN, AMOUNTEXP10, AMOUNTEXP10_TOKEN, APPROVALEXPIRATION, APPROVALEXPIRATION_TOKEN, APPROVE_PAYMENT, APPROVE_REVERSAL, APPROVE_TOKEN, APPROVEFLAG, APPROVEFLAG_TOKEN, APPROVEREVERSAL_TOKEN, ATTEMPT, ATTEMPT_ACTION, AVS_COMPLETE_MATCH, AVS_NO_MATCH, AVS_OTHER_RESPONSE, AVS_POSTALCODE_MATCH, AVS_STREETADDRESS_MATCH, BATCH_BALANCED, BATCH_CLOSED, BATCH_CLOSING, BATCH_NOT_YET_BALANCED, BATCH_OPEN, BATCH_OPENING, BATCH_OUT_OF_BALANCE, BATCH_PENDING_DEPRECATED, BATCHCLOSE_TOKEN, BATCHENTRY_DEPOSIT, BATCHENTRY_DEPOSITREVERSAL, BATCHENTRY_REFUND, BATCHENTRY_REFUNDREVERSAL, BATCHID, BATCHID_TOKEN, BATCHITEM_DEPOSIT, BATCHITEM_DEPOSITREVERSAL, BATCHITEM_REFUND, BATCHITEM_REFUNDREVERSAL, BATCHNUMBER, BATCHNUMBER_TOKEN, BATCHOPEN_TOKEN, BATCHPURGE_TOKEN, BECOME_MEMBER_TOKEN, CANCEL_ORDER, CANCELORDER_TOKEN, CANCELURL, CANCELURL_TOKEN, CASSETTECOMMAND, CASSETTECOMMAND_TOKEN, CASSETTECONTROL, CASSETTECONTROL_TOKEN, CASSETTENAME, CASSETTENAME_TOKEN, CHARSET, CHARSET_TOKEN, CLOSE_BATCH, CLOSE_ORDER, CLOSEORDER_TOKEN, COMMAND, COMMANDNAME_LENGTH, COMMTYPE, COMMTYPE_TOKEN, CREATE_ACCOUNT, CREATE_ACCOUNT_TOKEN, CREATE_MERCHANT, CREATE_MERCHANT_TOKEN, CREATE_MERCHANTCASSETTEOBJECT, CREATE_MERCHANTCASSETTEOBJECT_TOKEN, CREATE_MEREVENTLISTENER, CREATE_MEREVENTLISTENER_TOKEN, CREATE_PAYSYSTEM, CREATE_PAYSYSTEM_TOKEN, CREATE_SNMEVENTLISTENER, CREATE_SNMEVENTLISTENER_TOKEN, CREATE_SYSTEMCASSETTEOBJECT, CREATE_SYSTEMCASSETTEOBJECT_TOKEN, CREDIT_CLOSED, CREDIT_DECLINED, CREDIT_PENDING, CREDIT_REFUNDED, CREDIT_RESET, CREDIT_VOID, CREDITNUMBER, CREDITNUMBER_TOKEN, CURRENCY, CURRENCY_TOKEN, DEFAULT_SOCKS_PORT, DELETE_ACCOUNT, DELETE_ACCOUNT_TOKEN, DELETE_BATCH, DELETE_MERCHANT, DELETE_MERCHANT_TOKEN, DELETE_MERCHANTCASSETTEOBJECT, DELETE_MERCHANTCASSETTEOBJECT_TOKEN, DELETE_MEREVENTLISTENER, DELETE_MEREVENTLISTENER_TOKEN, DELETE_PAYSYSTEM, DELETE_PAYSYSTEM_TOKEN, DELETE_SNMEVENTLISTENER, DELETE_SNMEVENTLISTENER_TOKEN, DELETE_SYSTEMCASSETTEOBJECT, DELETE_SYSTEMCASSETTEOBJECT_TOKEN, DELETE_USER, DELETE_USER_TOKEN, DELETEBATCH_TOKEN, DELETEORDER, DELETEORDER_TOKEN, DEPOSIT_PAYMENT, DEPOSIT_REVERSAL, DEPOSIT_TOKEN, DEPOSITFLAG, DEPOSITFLAG_TOKEN, DEPOSITREVERSAL_TOKEN, DO_NOT_ATTEMPT, DO_NOT_ATTEMPT_ACTION, ENABLED, ENABLED_TOKEN, ETAPIVERSION, ETAPIVERSION_TOKEN, ETILLHOSTNAME, ETILLHOSTNAME_TOKEN, ETORDER_CTYPECHARSET_LENGTH, EVENTTYPE, EVENTTYPE_TOKEN, FAILUREURL, FAILUREURL_TOKEN, FINANCIALINSTITUTION, FINANCIALINSTITUTION_TOKEN, flagValuesSupported, FORCE, FORCE_TOKEN, ISO8859_1, LISTENERURL, LISTENERURL_TOKEN, LOCALHOST, LOGPATH, MAX_ACCOUNT_TITLE_LENGTH, MAX_AMOUNT_EXP10_LENGTH, MAX_AMOUNT_LENGTH, MAX_APPROVEFLAG_LENGTH, MAX_COMMAND_LENGTH, MAX_CTYPECHARSET_LENGTH, MAX_ETILLHOSTNAME_LENGTH, MAX_FILTER_LENGTH, MAX_FINANCIALINSTITUTION_LENGTH, MAX_FLAG_VALUE, MAX_GENERAL_API_NUMBER_LENGTH, MAX_MERCHANT_NUMBER_LENGTH, MAX_MERCHANT_TITLE_LENGTH, MAX_NUMERICTOKEN_LENGTH, MAX_NUMERICTOKEN_VALUE, MAX_ORDERDATA1_LENGTH, MAX_ORDERDATA2_LENGTH, MAX_ORDERDATA3_LENGTH, MAX_ORDERDATA4_LENGTH, MAX_ORDERDATA5_LENGTH, MAX_ORDERDESCRIPTION_LENGTH, MAX_ORDERNUMBER_LENGTH, MAX_PARAMETER_LENGTH, MAX_PATH_LENGTH, MAX_PAYMENT_SYSTEM_LENGTH, MAX_PROTOCOLDATA_LENGTH, MAX_TRANSACTIONID_LENGTH, MAX_URL_LENGTH, MAX_USER_NAME_LENGTH, MERCHANTNUMBER, MERCHANTNUMBER_TOKEN, MERCHANTNUMBERS, MERCHANTTITLE, MERCHANTTITLE_TOKEN, MIN_MERCHANT_NUMBER_LENGTH, MIN_NUMERICTOKEN_LENGTH, MIN_ORDERDESCRIPTION_LENGTH, MIN_ORDERNUMBER_LENGTH, MODIFY_ACCOUNT, MODIFY_ACCOUNT_TOKEN, MODIFY_CASSETTE, MODIFY_CASSETTE_TOKEN, MODIFY_MERCHANT, MODIFY_MERCHANT_TOKEN, MODIFY_MERCHANTCASSETTEOBJECT, MODIFY_MERCHANTCASSETTEOBJECT_TOKEN, MODIFY_MEREVENTLISTENER, MODIFY_MEREVENTLISTENER_TOKEN, MODIFY_PAYSERVER, MODIFY_PAYSERVER_TOKEN, MODIFY_PAYSYSTEM, MODIFY_PAYSYSTEM_TOKEN, MODIFY_SNMEVENTLISTENER, MODIFY_SNMEVENTLISTENER_TOKEN, MODIFY_SYSPLEX, MODIFY_SYSPLEX_TOKEN, MODIFY_SYSTEMCASSETTEOBJECT, MODIFY_SYSTEMCASSETTEOBJECT_TOKEN, MODIFY_USERSTATUS, MODIFY_USERSTATUS_TOKEN, NDHOSTNAME, NDHOSTNAME_TOKEN, NEWPASSWORD, NEWPASSWORD_TOKEN, OBJECTNAME, OBJECTNAME_TOKEN, OPEN_BATCH, ORDER_CANCELED, ORDER_CLOSED, ORDER_ORDERED, ORDER_PENDING, ORDER_REFUNDABLE, ORDER_REJECTED, ORDER_REQUESTED, ORDER_RESET, ORDERDATA1, ORDERDATA1_TOKEN, ORDERDATA2, ORDERDATA2_TOKEN, ORDERDATA3, ORDERDATA3_TOKEN, ORDERDATA4, ORDERDATA4_TOKEN, ORDERDATA5, ORDERDATA5_TOKEN, ORDERDESCRIPTION, ORDERDESCRIPTION_TOKEN, ORDERNUMBER, ORDERNUMBER_TOKEN, ORDERURL, ORDERURL_TOKEN, PARAMETERNAME_LENGTH, PASSWORD, PASSWORD_TOKEN, PAYMENT_APPROVALEXPIRED, PAYMENT_APPROVED, PAYMENT_CLOSED, PAYMENT_DECLINED, PAYMENT_DEPOSITED, PAYMENT_PENDING, PAYMENT_RESET, PAYMENT_VOID, PAYMENTAMOUNT, PAYMENTAMOUNT_TOKEN, PAYMENTGROUPNAME, PAYMENTGROUPNAME_TOKEN, PAYMENTNUMBER, PAYMENTNUMBER_TOKEN, PAYMENTTYPE, PAYMENTTYPE_TOKEN, PD_AUTHCODE, PD_AUXILIARY1, PD_AUXILIARY2, PD_AVS_CITY, PD_AVS_COUNTRYCODE, PD_AVS_LOCATIONID, PD_AVS_POSTALCODE, PD_AVS_PREFIX, PD_AVS_STATEPROV, PD_AVS_STATEPROVINCE, PD_AVS_STREETADDR, PD_AVS_STREETADDRESS, PD_AVSCODE, PD_BATCHCLOSETIME, PD_BILL_CITY, PD_BILL_COUNTRYCOD, PD_BILL_COUNTRYCODE, PD_BILL_POSTALCODE, PD_BILL_PREFIX, PD_BILL_STATEPROV, PD_BILL_STATEPROVINCE, PD_BILL_STREETADDR, PD_BILL_STREETADDRESS, PD_BRAND, PD_BUYERNAME, PD_CANCELURL, PD_CARDHOLDERNAME, PD_CARDVERIFYCODE, PD_CHARSET, PD_CHECKINGACCOUNTNUMBER, PD_CHECKROUTINGNUMBER, PD_CITY, PD_COUNTRYCODE, PD_CURRENCY, PD_DECLINECODE, PD_DECLINEREASON, PD_EMAILADDRESS, PD_EXPIRY, PD_FAILUREURL, PD_FIBATCHID, PD_ITEM_COMMODITYCODE, PD_ITEM_DESCRIPTOR, PD_ITEM_DISCOUNTAMOUNT, PD_ITEM_DISCOUNTINDICATOR, PD_ITEM_LOCALTAXAMOUNT, PD_ITEM_LOCALTAXRATE, PD_ITEM_NATIONALTAXAMOUNT, PD_ITEM_NATIONALTAXRATE, PD_ITEM_NATIONALTAXTYPE, PD_ITEM_NETCOST, PD_ITEM_OTHERTAXAMOUNT, PD_ITEM_PRODUCTCODE, PD_ITEM_QUANTITY, PD_ITEM_SKU, PD_ITEM_TOTALCOST, PD_ITEM_UNITCOST, PD_ITEM_UNITOFMEASURE, PD_MAXBATCHSIZE, PD_METHOD, PD_ORDERDESCRIPTION, PD_PAN, PD_PCARD_ALTERNATETAXID, PD_PCARD_CUSTOMERDUTYTARIFFREFERENCE, PD_PCARD_CUSTOMERREFERENCENUMBER, PD_PCARD_CUSTOMERSERVICEPHONE, PD_PCARD_DISCOUNTAMOUNT, PD_PCARD_DUTYAMOUNT, PD_PCARD_DUTYREFERENCE, PD_PCARD_LOCALTAXAMOUNT, PD_PCARD_MERCHANTCITYCODE, PD_PCARD_MERCHANTCOUNTRYCODE, PD_PCARD_MERCHANTDUTYTARIFFREFERENCE, PD_PCARD_MERCHANTLOCATIONID, PD_PCARD_MERCHANTNAME, PD_PCARD_MERCHANTORDERNUMBER, PD_PCARD_MERCHANTPOSTALCODE, PD_PCARD_MERCHANTSTATEPROVINCE, PD_PCARD_MERCHANTTAXID, PD_PCARD_MERCHANTTYPE, PD_PCARD_NATIONALTAXAMOUNT, PD_PCARD_NATIONALTAXINVOICEREFERENCE, PD_PCARD_NATIONALTAXRATE, PD_PCARD_ORDERSUMMARY, PD_PCARD_OTHERTAXAMOUNT, PD_PCARD_PRINTCUSTOMERSERVICEPHONENUMBER, PD_PCARD_SHIPFROMCITYCODE, PD_PCARD_SHIPFROMCOUNTRYCODE, PD_PCARD_SHIPFROMLOCATIONID, PD_PCARD_SHIPFROMPOSTALCODE, PD_PCARD_SHIPFROMSTATEPROVINCE, PD_PCARD_SHIPPINGAMOUNT, PD_PCARD_SHIPPINGNATIONALTAXAMOUNT, PD_PCARD_SHIPPINGNATIONALTAXRATE, PD_PCARD_SHIPTOCITYCODE, PD_PCARD_SHIPTOCOUNTRYCODE, PD_PCARD_SHIPTOLOCATIONID, PD_PCARD_SHIPTOPOSTALCODE, PD_PCARD_SHIPTOSTATEPROVINCE, PD_PCARD_SUMMARYCOMMODITYCODE, PD_PCARD_TAXEXEMPTINDICATOR, PD_PCARD_TOTALTAXAMOUNT, PD_PHONENUMBER, PD_POSTALCODE, PD_SERVICEURL, PD_SHIP_CITY, PD_SHIP_COUNTRYCOD, PD_SHIP_COUNTRYCODE, PD_SHIP_POSTALCODE, PD_SHIP_PREFIX, PD_SHIP_STATEPROV, PD_SHIP_STATEPROVINCE, PD_SHIP_STREETADDR, PD_SHIP_STREETADDRESS, PD_SPLITALLOWED, PD_STATEPROVINCE, PD_STREETADDRESS, PD_STREETADDRESS2, PD_SUCCESSURL, PLEXNAME, PLEXNAME_TOKEN, PURGE_BATCH, RECEIVE_PAYMENT, RECEIVEPAYMENT_TOKEN, RECEIVEPAYMENTAUTOAPPROVE, RECEIVEPAYMENTAUTOAPPROVE_TOKEN, RECEIVEPAYMENTAUTODEPOSIT, RECEIVEPAYMENTAUTODEPOSIT_TOKEN, REFUND_PAYMENT, REFUND_REVERSAL, REFUND_TOKEN, REFUNDREVERSAL_TOKEN, ROLE, ROLES, ROLES_TOKEN, SERVICEURL, SERVICEURL_TOKEN, SET_USERACCESSRIGHTS, SET_USERACCESSRIGHTS_TOKEN, SOCKSHOST, SOCKSHOST_TOKEN, SOCKSPORT, SOCKSPORT_TOKEN, SPLITALLOWED, SPLITALLOWED_TOKEN, START, START_ACCOUNT_TOKEN, START_CASSETTE_TOKEN, START_PAYSYSTEM_TOKEN, STOP, STOP_ACCOUNT_TOKEN, STOP_CASSETTE_TOKEN, STOP_PAYSYSTEM_TOKEN, STOP_TOKEN, SUCCESSURL, SUCCESSURL_TOKEN, SYSPLEXFLAG, SYSPLEXFLAG_TOKEN, TRACEFILESIZE, TRACELEVEL1_TOKEN, TRACELEVEL2_TOKEN, TRACELEVEL3_TOKEN, TRACEOFF_TOKEN, TRACEON_TOKEN, TRACESETTING, TRANSACTIONID, TRANSACTIONID_TOKEN, UNSPECIFIED, UNSPECIFIED_ACTION, USER, USER_TOKEN, UTF8, VALID_CURRENCY_LENGTH, xorBaseInteger
 
Fields inherited from interface com.ibm.etill.framework.payapi.FrameworkReturnCodes
PRC_AUTHENTICATION_ERROR, PRC_AUTHORIZATION_ERROR, PRC_AUTOAPPROVE_FAILED, PRC_AUTODEPOSIT_FAILED, PRC_BATCH_ERROR, PRC_CASSETTE_ERROR, PRC_CASSETTE_NOTRUNNING, PRC_CASSETTE_NOTVALID, PRC_COMMAND_NOT_SUPPORTED, PRC_COMMUNICATION_ERROR, PRC_COREQUISITE_PARAMETER_NOT_FOUND, PRC_CRYPTO_ERROR, PRC_DATABASE_ERROR, PRC_DELETE_ERROR, PRC_DUPLICATE_OBJECT, PRC_DUPLICATE_PARAMETER_VALUE_NOT_ALLOWED, PRC_FINANCIAL_FAILURE, PRC_INPUT_ERROR, PRC_INTERNAL_ETILL_ERROR, PRC_INVALID_PARAMETER_COMBINATION, PRC_NOT_ACTIVE, PRC_OBSOLETE_API_VERSION, PRC_OPERATION_PENDING, PRC_OPERATION_SUCCESS, PRC_PARAMETER_FORMAT_ERROR, PRC_PARAMETER_MISMATCH, PRC_PARAMETER_NOT_ALLOWED, PRC_PARAMETER_NOT_FOUND, PRC_PARAMETER_NULL_VALUE, PRC_PARAMETER_TOO_LONG, PRC_PARAMETER_TOO_SHORT, PRC_PARAMETER_VALUE_ERROR, PRC_REALM, PRC_SERVLET_INIT_ERROR, PRC_SUPPORTED_IN_SYSPLEX_ADMIN_ONLY, PRC_UNDEFINED_OBJECT, PRC_UNHANDLED_EXCEPTION, PRC_UNSUPPORTED_API_VERSION, PRC_UNSUPPORTED_IN_SYSPLEX, PRC_VERB_NOT_VALID_IN_PRESENT_STATE, PRC_WEBSPHERE, PRC_XML_ERROR, RC_ACCEPTPAYMENTAUTOAPPROVE, RC_ACCEPTPAYMENTAUTODEPOSIT, RC_ACCOUNT, RC_ACCOUNT_ADMIN, RC_ACCOUNTNUMBER, RC_ACCOUNTTITLE, RC_ADMINHOSTNAME, RC_AMOUNT, RC_AMOUNT_RANGE_INVALID, RC_AMOUNTEXP10, RC_AP_APPROVEFLAG, RC_AP_DEPOSITFLAG, RC_API_INITIALIZE_FAILURE, RC_APPEXPDELAY, RC_APPROVALEXPIRATION, RC_APPROVEFLAG, RC_APPROVESALLOWED, RC_ASYNCHAPPDELAY, RC_AUTHENTICATED_USER_NOT_GIVEN, RC_AUTOMATIC_CREATION, RC_BAD_REALM, RC_BATCH, RC_BATCH_EMPTY, RC_BATCHNUMBER, RC_BRAND, RC_CANCELURL, RC_CANNOT_FIND_PROPERTY_FILE, RC_CASSETTE_ADMIN, RC_CASSETTE_AMOUNT_WOULD_EXCEED_ORDER_AMOUNT, RC_CASSETTE_APPROVE_NO_DEPOSIT, RC_CASSETTE_AUTHCODE, RC_CASSETTE_AUTHCODE_AND_DECLINEREASON, RC_CASSETTE_AUXILIARY1, RC_CASSETTE_AUXILIARY2, RC_CASSETTE_AVS_CITY, RC_CASSETTE_AVS_COUNTRYCODE, RC_CASSETTE_AVS_LOCATIONID, RC_CASSETTE_AVS_POSTALCODE, RC_CASSETTE_AVS_STATEPROVINCE, RC_CASSETTE_AVS_STREETADDRESS, RC_CASSETTE_AVSCODE, RC_CASSETTE_AVSDATA, RC_CASSETTE_BATCH_AMOUNTEXP10, RC_CASSETTE_BATCH_BALANCE_ERROR, RC_CASSETTE_BATCH_CURRENCY, RC_CASSETTE_BATCH_ERROR, RC_CASSETTE_BATCH_ID, RC_CASSETTE_BATCHCLOSETIME, RC_CASSETTE_BILL_CITY, RC_CASSETTE_BILL_COUNTRYCODE, RC_CASSETTE_BILL_POSTALCODE, RC_CASSETTE_BILL_STATEPROVINCE, RC_CASSETTE_BILL_STREETADDRESS, RC_CASSETTE_BILLINGDATA, RC_CASSETTE_BRAND, RC_CASSETTE_BUYERNAME, RC_CASSETTE_CARDHOLDERNAME, RC_CASSETTE_CARDVERIFYCODE, RC_CASSETTE_CHECKINGACCOUNTNUMBER, RC_CASSETTE_CHECKROUTINGNUMBER, RC_CASSETTE_CITY, RC_CASSETTE_COMMUNICATION_ERROR, RC_CASSETTE_COUNTRYCODE, RC_CASSETTE_CURRENCY, RC_CASSETTE_DECLINECODE, RC_CASSETTE_DECLINED, RC_CASSETTE_DECLINED_APPROVAL_EXPIRED, RC_CASSETTE_DECLINED_EXPIRY, RC_CASSETTE_DECLINED_INSTRUMENT, RC_CASSETTE_DECLINEREASON, RC_CASSETTE_DECRYPTION_ERROR, RC_CASSETTE_DEPOSIT_AMOUNT_NOT_ZERO, RC_CASSETTE_EMAILADDRESS, RC_CASSETTE_ENCRYPTION_ERROR, RC_CASSETTE_EXPIRY, RC_CASSETTE_FIBATCHID, RC_CASSETTE_FUNCTION_NOT_SUPPORTED, RC_CASSETTE_HUMAN_INTERVENTION_REQUIRED, RC_CASSETTE_IMPLICIT_BATCHES_ONLY, RC_CASSETTE_INTERMEDIATE_RESPONSE_NULL, RC_CASSETTE_INTERMEDIATE_RESPONSE_UNEXPECTED, RC_CASSETTE_ITEM_COMMODITYCODE, RC_CASSETTE_ITEM_DESCRIPTOR, RC_CASSETTE_ITEM_DISCOUNTAMOUNT, RC_CASSETTE_ITEM_DISCOUNTINDICATOR, RC_CASSETTE_ITEM_LOCALTAXAMOUNT, RC_CASSETTE_ITEM_LOCALTAXRATE, RC_CASSETTE_ITEM_NATIONALTAXAMOUNT, RC_CASSETTE_ITEM_NATIONALTAXRATE, RC_CASSETTE_ITEM_NATIONALTAXTYPE, RC_CASSETTE_ITEM_NETCOST, RC_CASSETTE_ITEM_OTHERTAXAMOUNT, RC_CASSETTE_ITEM_PRODUCTCODE, RC_CASSETTE_ITEM_QUANTITY, RC_CASSETTE_ITEM_SKU, RC_CASSETTE_ITEM_TOTALCOST, RC_CASSETTE_ITEM_UNITCOST, RC_CASSETTE_ITEM_UNITOFMEASURE, RC_CASSETTE_MAXBATCHSIZE, RC_CASSETTE_METHOD, RC_CASSETTE_OPERATION_FAILED, RC_CASSETTE_PAN, RC_CASSETTE_PCARD_ALTERNATETAXID, RC_CASSETTE_PCARD_CUSTOMERDUTYTARIFFREFERENCE, RC_CASSETTE_PCARD_CUSTOMERREFERENCENUMBER, RC_CASSETTE_PCARD_CUSTOMERSERVICEPHONE, RC_CASSETTE_PCARD_DISCOUNTAMOUNT, RC_CASSETTE_PCARD_DUTYAMOUNT, RC_CASSETTE_PCARD_DUTYREFERENCE, RC_CASSETTE_PCARD_LOCALTAXAMOUNT, RC_CASSETTE_PCARD_MERCHANTCITYCODE, RC_CASSETTE_PCARD_MERCHANTCOUNTRYCODE, RC_CASSETTE_PCARD_MERCHANTDUTYTARIFFREFERENCE, RC_CASSETTE_PCARD_MERCHANTLOCATIONID, RC_CASSETTE_PCARD_MERCHANTNAME, RC_CASSETTE_PCARD_MERCHANTORDERNUMBER, RC_CASSETTE_PCARD_MERCHANTPOSTALCODE, RC_CASSETTE_PCARD_MERCHANTSTATEPROVINCE, RC_CASSETTE_PCARD_MERCHANTTAXID, RC_CASSETTE_PCARD_MERCHANTTYPE, RC_CASSETTE_PCARD_NATIONALTAXAMOUNT, RC_CASSETTE_PCARD_NATIONALTAXINVOICEREFERENCE, RC_CASSETTE_PCARD_NATIONALTAXRATE, RC_CASSETTE_PCARD_ORDERSUMMARY, RC_CASSETTE_PCARD_OTHERTAXAMOUNT, RC_CASSETTE_PCARD_PRINTCUSTOMERSERVICEPHONENUMBER, RC_CASSETTE_PCARD_SHIPFROMCITYCODE, RC_CASSETTE_PCARD_SHIPFROMCOUNTRYCODE, RC_CASSETTE_PCARD_SHIPFROMLOCATIONID, RC_CASSETTE_PCARD_SHIPFROMPOSTALCODE, RC_CASSETTE_PCARD_SHIPFROMSTATEPROVINCE, RC_CASSETTE_PCARD_SHIPPINGAMOUNT, RC_CASSETTE_PCARD_SHIPPINGNATIONALTAXAMOUNT, RC_CASSETTE_PCARD_SHIPPINGNATIONALTAXRATE, RC_CASSETTE_PCARD_SHIPTOCITYCODE, RC_CASSETTE_PCARD_SHIPTOCOUNTRYCODE, RC_CASSETTE_PCARD_SHIPTOLOCATIONID, RC_CASSETTE_PCARD_SHIPTOPOSTALCODE, RC_CASSETTE_PCARD_SHIPTOSTATEPROVINCE, RC_CASSETTE_PCARD_SUMMARYCOMMODITYCODE, RC_CASSETTE_PCARD_TAXEXEMPTINDICATOR, RC_CASSETTE_PCARD_TOTALTAXAMOUNT, RC_CASSETTE_PHONENUMBER, RC_CASSETTE_POSTALCODE, RC_CASSETTE_REFUND_AMOUNT_NOT_ZERO, RC_CASSETTE_SHIP_CITY, RC_CASSETTE_SHIP_COUNTRYCODE, RC_CASSETTE_SHIP_POSTALCODE, RC_CASSETTE_SHIP_STATEPROVINCE, RC_CASSETTE_SHIP_STREETADDRESS, RC_CASSETTE_SHIPPINGDATA, RC_CASSETTE_STATEPROVINCE, RC_CASSETTE_STREETADDRESS, RC_CASSETTE_STREETADDRESS2, RC_CASSETTE_UNSPECIFIED_ERROR, RC_CASSETTE_VERSION, RC_CASSETTECOMMAND, RC_CASSETTENAME, RC_CHARSET, RC_CHECK_CASSETTE_STATUS, RC_CLOSEALLOWED, RC_CLOSEBEGINTIME, RC_CLOSEENDTIME, RC_COMMTYPE, RC_COMMUNICATION_ERROR, RC_COMMUNICATION_ERROR_INPUT, RC_CONNECTION_TO_PAYMENT_SERVER_FAILED, RC_CREATEBEGINTIME, RC_CREATEENDTIME, RC_CREDIT, RC_CREDITNUMBER, RC_CURRENCY, RC_DATA_SOURCE, RC_DECRYPT_ENCRYPTION_KEY_FAILED, RC_DELETEORDER, RC_DEPOSITFLAG, RC_DOCUMENT_TOO_LARGE, RC_DTDPATH, RC_EMPTY_DOCUMENT, RC_ENABLED, RC_ENCODING_EXCEPTION, RC_ENCRYPT_ENCRYPTION_KEY_FAILED, RC_ENCRYPTION_KEY_TYPE_NOT_SUPPORTED, RC_ERROR_CHECKING_FOR_READ_DATA, RC_ERROR_CONNECTING_DATABASE_OR_EXEC_SQL, RC_ERROR_DBOWNER, RC_ERROR_DBPASSWORD, RC_ERROR_DBUSERID, RC_ERROR_HOSTNAME, RC_ERROR_INIT_ERROR_LOG, RC_ERROR_JDBCDRIVER_NAME, RC_ERROR_JDBCURL, RC_ERROR_LOADING_CASSETTE, RC_ERROR_LOADING_JDBCDRIVER, RC_ERROR_LOADING_PROPERTY_FILE, RC_ERROR_MAXDBCONNECTIONS, RC_ERROR_MINSENSITIVEACCESSROLE, RC_ERROR_PROTECTION_REALM_NOT_SPECIFIED, RC_ERROR_PSENGINE_PORTNUMBER, RC_ERROR_ROOT_PASSWORD, RC_ETAPIVERSION, RC_ETILLHOSTNAME, RC_EVENT_LISTENER, RC_EVENTTYPE, RC_FAILURL, RC_FILTER, RC_FINANCIALINSTITUTION, RC_FORCE, RC_GENERATE_ENCRYPTION_KEY_FAILED, RC_HANDLE_REQUIRED, RC_HOST_IP_ADDRESS_UNAVAILABLE, RC_HOSTNAME_NOT_VALID, RC_INITIALIZATION_MESSAGE, RC_INPUT_ERROR_TOO_LONG, RC_INPUT_ERROR_UNKNOWN_COMMAND, RC_INVALID_CHANGEPASSWORD_STATE, RC_KEY_NOT_EXIST, RC_KEY_TAMPERED, RC_KEYSONLY, RC_LAST_ACL_OWNER, RC_LISTENERURL, RC_MAXAMOUNT, RC_MAXAPPROVEAMOUNT, RC_MAXBATCHSIZE, RC_MAXDEPOSITAMOUNT, RC_MAXUNAPPROVEDAMOUNT, RC_MERCHANT_ADMIN, RC_MERCHANTNUMBER, RC_MERCHANTPAYSYS, RC_MERCHANTTITLE, RC_MESSAGES, RC_MINAMOUNT, RC_MINAPPROVEAMOUNT, RC_MINDEPOSITAMOUNT, RC_MINUNAPPROVEDAMOUNT, RC_MISSING_ORDER_COLLECTION, RC_MODIFYBEGINTIME, RC_MODIFYENDTIME, RC_MULTIPLE_BATCHES, RC_NDHOSTNAME, RC_NEW_PASSWORD, RC_NO_SUCH_ACL, RC_NO_SUCH_USER, RC_NONE, RC_NOT_ACL_OWNER, RC_OBJECTNAME, RC_OD, RC_OPENBEGINTIME, RC_OPENENDTIME, RC_OPERATION, RC_ORDER, RC_ORDERDATA1, RC_ORDERDATA2, RC_ORDERDATA3, RC_ORDERDATA4, RC_ORDERDATA5, RC_ORDERNUMBER, RC_ORDERURL, RC_ORDERURLS, RC_PAYMENT, RC_PAYMENTAMOUNT, RC_PAYMENTGROUPNAME, RC_PAYMENTNUMBER, RC_PAYMENTSYSTEM_ADMIN, RC_PAYMENTTYPE, RC_PAYSERVER_ADMIN, RC_PLEXNAME, RC_PROTOCOL_DATA_KEYWORD_INVALID, RC_PROTOCOL_POOL, RC_PROTOCOLDATA, RC_PURGEALLOWED, RC_REALM_INIT_ERROR, RC_REALM_OPERATION_ERROR, RC_REALMCLASS, RC_RECEIVE_OF_DATA_ON_SOCKET_FAILED, RC_RECEIVEPAYMENTAUTOAPPROVE, RC_RECEIVEPAYMENTAUTODEPOSIT, RC_REFERENCENUMBER, RC_RESERVED_BITS_SET_IN_FLAGS, RC_RETURNATMOST, RC_ROLE, RC_RP_APPROVEFLAG, RC_RP_DEPOSITFLAG, RC_SEND_OF_DATA_ON_SOCKET_FAILED, RC_SERVICE_POOL, RC_SERVICEURL, RC_SERVLET_INIT_EXCEPTION, RC_SOCKET_CLOSE_FAILED, RC_SOCKET_CREATION_FAILED, RC_SOCKET_STARTUP_FAILURE, RC_SOCKSHOST, RC_SOCKSPORT, RC_SPECIFIED_REALM_UNKNOWN, RC_SPLITFLAG, RC_STATE, RC_STATUS, RC_SUCCESSURL, RC_SYSPLEXFLAG, RC_TIME_PERIOD_INVALID, RC_TIMEREGISTERED, RC_TRANSACTIONID, RC_UNEXPECTED, RC_UNKNOWN_ETILL_HOST, RC_UNSUPPORTED_DOCUMENT_TYPE, RC_USER, RC_USER_MISCONFIGURED, RC_USER_NOT_AUTHORIZED, RC_USER_NOT_ENABLED, RC_USERNAME, RC_VALIDATE_ENCRYPTION_KEY_FAILED, RC_WITHCREDITS, RC_WITHORDERS, RC_WITHPAYMENTS
 
Constructor Summary
KitCashCassette()
           
 
Method Summary
 java.util.Vector createComPoints()
          Creates all the ComPoints needed by the KitCash cassette.
 com.ibm.etill.framework.cassette.ProtocolRequest createProtocolRequest(com.ibm.etill.framework.io.ETillConnection etc)
          Creates a protocol request object constructed from the information passed in the ETillConnection.
 void destroyComPoints()
          Destroys all the ComPoints that were previously created by the KitCash cassette.
 java.util.Hashtable getParameterValidationTable()
          Returns the the keyword mapping hashtable.
 void initializeCassette()
          Initializes the cassette.
 boolean isAcceptPaymentSupported()
          Returns whether the acceptPayment command is supported by this cassette.
 boolean isReceivePaymentSupported()
          Returns whether the receivePayment command is supported by this cassette.
 com.ibm.etill.framework.cassette.CassetteBatch newCassetteBatch(com.ibm.etill.framework.payapi.Batch batch, com.ibm.etill.framework.payapi.ParameterTable protocolData)
          Returns the CassetteTransaction object created by calling the KitCashBatch construction.
 com.ibm.etill.framework.cassette.CassetteTransaction newCassetteCredit(com.ibm.etill.framework.payapi.Credit credit, com.ibm.etill.framework.payapi.ParameterTable protocolData)
          Returns null since the KitCash payment system does not allow for credits (refunds).
 com.ibm.etill.framework.cassette.CassetteOrder newCassetteOrder(com.ibm.etill.framework.payapi.Order order, com.ibm.etill.framework.payapi.ParameterTable protocolData)
          Creates a new CassetteOrder object.
 com.ibm.etill.framework.cassette.CassetteTransaction newCassettePayment(com.ibm.etill.framework.payapi.Payment payment, com.ibm.etill.framework.payapi.ParameterTable protocolData)
          Creates a new KitCash cassette specific payment object.
 void readCassetteConfig()
          Reads the KitCash configuration information from the database.
 com.ibm.etill.framework.cassette.CassetteBatch resurrectCassetteBatch(com.ibm.etill.framework.payapi.Batch batch)
          Retrieves KitCash specific batch information for the provided framework batch.
 com.ibm.etill.framework.cassette.CassetteTransaction resurrectCassetteCredit(com.ibm.etill.framework.payapi.Credit credit)
          Returns null since the KitCash payment system does not allow for credits (refunds).
 com.ibm.etill.framework.cassette.CassetteOrder resurrectCassetteOrder(com.ibm.etill.framework.payapi.Order order)
          Retrieves KitCash specific order information from the KitCash database tables.
 com.ibm.etill.framework.cassette.CassetteTransaction resurrectCassettePayment(com.ibm.etill.framework.payapi.Payment payment)
          Retrieves KitCash specific payment information from the KitCash database tables.
 void service(com.ibm.etill.framework.cassette.CassetteRequest req, com.ibm.etill.framework.cassette.CassetteResponse resp)
          Services the request passed to the cassette.
 void setMessageID(java.lang.String id)
          This method is called by the Payment Manager framework to set the unique cassette name.
 void shutdown()
          Shuts down the KitCash cassette gracefully.
 void start()
          Starts the KitCash cassette.
 void verifyConfig()
          KitCashCassette requires no configuration verification, so this method returns with no action.
 
Methods inherited from class com.ibm.etill.framework.cassette.Cassette
getCassetteAdminObject, getName, getPaymentSystemName, getReaderWriterMonitor, initialize, isApprovalExpirationSupported
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

lineSeparator

protected static java.lang.String lineSeparator
Constructor Detail

KitCashCassette

public KitCashCassette()
Method Detail

createComPoints

public java.util.Vector createComPoints()
                                 throws com.ibm.etill.framework.payapi.ETillAbortOperation
Creates all the ComPoints needed by the KitCash cassette.

The Payment Manager framework calls createComPoints() when the the cassette is started.

KitCash requires only one ComPoint. This ComPoint is used to send and receive messages sent to and from KitCash wallets.

Overrides:
createComPoints in class com.ibm.etill.framework.cassette.Cassette
Returns:
a vector containing the single ComPoint needed by the KitCash cassette
Throws:
com.ibm.etill.framework.payapi.ETillAbortOperation - if the ComPoint cannot be created and opened.
See Also:
KitCashComPoint

createProtocolRequest

public com.ibm.etill.framework.cassette.ProtocolRequest createProtocolRequest(com.ibm.etill.framework.io.ETillConnection etc)
Creates a protocol request object constructed from the information passed in the ETillConnection.
Overrides:
createProtocolRequest in class com.ibm.etill.framework.cassette.Cassette
Returns:
the requested object contructed from the ETillConnection
See Also:
KitCashPaymentRequest.KitCashPaymentRequest(com.ibm.etill.framework.io.ETillConnection)

destroyComPoints

public void destroyComPoints()
                      throws com.ibm.etill.framework.payapi.ETillAbortOperation
Destroys all the ComPoints that were previously created by the KitCash cassette.

The Payment Manager framework calls destroyComPoints() when the cassette is stopped.

Overrides:
destroyComPoints in class com.ibm.etill.framework.cassette.Cassette
Throws:
com.ibm.etill.framework.payapi.ETillAbortOperation - if the ComPoint cannot be closed.
See Also:
KitCashComPoint

getParameterValidationTable

public java.util.Hashtable getParameterValidationTable()
Returns the the keyword mapping hashtable.

Payment Manager calls this method during cassette startup.

Overrides:
getParameterValidationTable in class com.ibm.etill.framework.cassette.Cassette
See Also:
getParameterValidationTable()

initializeCassette

public void initializeCassette()
                        throws com.ibm.etill.framework.payapi.ETillAbortOperation
Initializes the cassette.

The Payment Manager framework calls this method during the cassette start-up once the KitCash configuration has been read and successfully verified.

KitCash initializes its keyword mapping hashtable in this method to make it available for return when getParameterValidationTable is called.

Overrides:
initializeCassette in class com.ibm.etill.framework.cassette.Cassette
Throws:
com.ibm.etill.framework.payapi.ETillAbortOperation - if the KitCash configuration is not valid.
See Also:
readCassetteConfig(), verifyConfig()

newCassetteBatch

public com.ibm.etill.framework.cassette.CassetteBatch newCassetteBatch(com.ibm.etill.framework.payapi.Batch batch,
                                                                       com.ibm.etill.framework.payapi.ParameterTable protocolData)
Returns the CassetteTransaction object created by calling the KitCashBatch construction.

The Payment Manager framework will call newCassetteBatch() in response to a BATCHOPEN API request.

Overrides:
newCassetteBatch in class com.ibm.etill.framework.cassette.Cassette
Parameters:
batch - the framework batch object for which cassette specific information is required
The - hash table containing specialized parameters for this cassette.
Returns:
A new transaction object returned by KitCashBatch

newCassetteCredit

public com.ibm.etill.framework.cassette.CassetteTransaction newCassetteCredit(com.ibm.etill.framework.payapi.Credit credit,
                                                                              com.ibm.etill.framework.payapi.ParameterTable protocolData)
Returns null since the KitCash payment system does not allow for credits (refunds).

The Payment Manager framework will call newCassetteCredit() in response to a REFUND API request.

Overrides:
newCassetteCredit in class com.ibm.etill.framework.cassette.Cassette
Parameters:
credit - the framework credit object for which cassette specific information is required
Returns:
null

newCassetteOrder

public com.ibm.etill.framework.cassette.CassetteOrder newCassetteOrder(com.ibm.etill.framework.payapi.Order order,
                                                                       com.ibm.etill.framework.payapi.ParameterTable protocolData)
Creates a new CassetteOrder object.

The Payment Manager framework will call newCassetteOrder() in response to a RECEIVEPAYMENT or an ACCEPTPAYMENT API request.

Since the KitCashPurchase object is a conglomerate of both an order and a payment, this method creates the KitCashPurchase object, and KitCashCassette.newCassettePayment returns the same object.

Overrides:
newCassetteOrder in class com.ibm.etill.framework.cassette.Cassette
Parameters:
order - the framework order created by the Payment Manager framework
Returns:
the new KitCash specific order
See Also:
KitCashPurchase.KitCashPurchase(com.ibm.etill.framework.cassette.Cassette, com.ibm.etill.framework.payapi.Order), newCassettePayment(com.ibm.etill.framework.payapi.Payment, com.ibm.etill.framework.payapi.ParameterTable)

newCassettePayment

public com.ibm.etill.framework.cassette.CassetteTransaction newCassettePayment(com.ibm.etill.framework.payapi.Payment payment,
                                                                               com.ibm.etill.framework.payapi.ParameterTable protocolData)
Creates a new KitCash cassette specific payment object.

Since KitCash does not allow mutiple payments against a single order, the KitCashPurchase object holds the cassette specific information for both the order and the payment. This method simply returns the KitCashPurchase object already created by newCassetteOrder.

The Payment Manager framework will call newCassettePayment() in response to an APPROVE API request.

Overrides:
newCassettePayment in class com.ibm.etill.framework.cassette.Cassette
Parameters:
payment - the framework order object created by the Payment Manager framework
Returns:
the new KitCash specific order
See Also:
KitCashPurchase.KitCashPurchase(com.ibm.etill.framework.cassette.Cassette, com.ibm.etill.framework.payapi.Order)

readCassetteConfig

public void readCassetteConfig()
                        throws com.ibm.etill.framework.payapi.ETillAbortOperation
Reads the KitCash configuration information from the database. This method is called by the Payment Manager framework during cassette startup.
Overrides:
readCassetteConfig in class com.ibm.etill.framework.cassette.Cassette
Throws:
com.ibm.etill.framework.payapi.ETillAbortOperation - if the KitCash database tables cannot be read.
See Also:
verifyConfig(), initializeCassette()

resurrectCassetteBatch

public com.ibm.etill.framework.cassette.CassetteBatch resurrectCassetteBatch(com.ibm.etill.framework.payapi.Batch batch)
                                                                      throws com.ibm.etill.framework.payapi.ETillAbortOperation
Retrieves KitCash specific batch information for the provided framework batch.

The Payment Manager framework may call this method at any time in order to retrieve the cassette specific information associated with the framework batch object.

Overrides:
resurrectCassetteBatch in class com.ibm.etill.framework.cassette.Cassette
Parameters:
batch - the framework batch for which cassette specific data is required
Returns:
the retrieved KitCash specific batch object
Throws:
com.ibm.etill.framework.payapi.ETillAbortOperation - if the KitCashBatch object cannot be retrieved
See Also:
KitCashBatch.KitCashBatch(com.ibm.etill.framework.cassette.Cassette, com.ibm.etill.framework.payapi.Batch)

resurrectCassetteCredit

public com.ibm.etill.framework.cassette.CassetteTransaction resurrectCassetteCredit(com.ibm.etill.framework.payapi.Credit credit)
Returns null since the KitCash payment system does not allow for credits (refunds).

The Payment Manager framework may call this method at any time in order to retrieve the cassette specific information associated with the framework credit object.

Overrides:
resurrectCassetteCredit in class com.ibm.etill.framework.cassette.Cassette
Parameters:
credit - the framework credit object for which cassette specific information is required
Returns:
null

resurrectCassetteOrder

public com.ibm.etill.framework.cassette.CassetteOrder resurrectCassetteOrder(com.ibm.etill.framework.payapi.Order order)
                                                                      throws com.ibm.etill.framework.payapi.ETillAbortOperation
Retrieves KitCash specific order information from the KitCash database tables.

The Payment Manager framework may call this method at any time in order to retrieve the cassette specific information associated with the framework order object.

Overrides:
resurrectCassetteOrder in class com.ibm.etill.framework.cassette.Cassette
Parameters:
order - the framework order for which cassette specific data is required
Returns:
the retrieved KitCash specific order object
Throws:
com.ibm.etill.framework.payapi.ETillAbortOperation - if the KitCashPurchase object cannot be retrieved from the database
See Also:
KitCashPurchase.KitCashPurchase(com.ibm.etill.framework.cassette.Cassette, com.ibm.etill.framework.payapi.Order)

resurrectCassettePayment

public com.ibm.etill.framework.cassette.CassetteTransaction resurrectCassettePayment(com.ibm.etill.framework.payapi.Payment payment)
                                                                              throws com.ibm.etill.framework.payapi.ETillAbortOperation
Retrieves KitCash specific payment information from the KitCash database tables.

Since KitCash does not allow mutiple payments against a sigle order, the KitCashPurchase object holds the cassette specific information for both the order and the payment. This method simply returns the KitCashPurchase object already resurrected by resurrectCassetteOrder.

The Payment Manager framework may call this method at any time in order to retrieve the cassette specific information associated with the framework payment object.

Overrides:
resurrectCassettePayment in class com.ibm.etill.framework.cassette.Cassette
Parameters:
payment - the framework payment object for which cassette specific data is required
Returns:
the retrieved KitCash specific purchase object
Throws:
com.ibm.etill.framework.payapi.ETillAbortOperation - if the KitCashPurchase object cannot be retrieved from the database
See Also:
KitCashPurchase.KitCashPurchase(com.ibm.etill.framework.cassette.Cassette, com.ibm.etill.framework.payapi.Order)

service

public void service(com.ibm.etill.framework.cassette.CassetteRequest req,
                    com.ibm.etill.framework.cassette.CassetteResponse resp)
             throws com.ibm.etill.framework.payapi.ETillAbortOperation
Services the request passed to the cassette.

The request may be an APIRequest or a ProtocolRequest. This method will use the type of the request to determine what action to take:

Overrides:
service in class com.ibm.etill.framework.cassette.Cassette
Parameters:
apiRequest - the API command to be performed by the cassette
apiResponse - the response object
Throws:
com.ibm.etill.framework.payapi.ETillAbortOperation - if the API command cannot be successfully processed.
See Also:
KitCashPurchase#processEvent(com.ibm.etill.framework.cassette.OrderRequest, com.ibm.etill.framework.cassette.APIResponse), KitCashPurchase#processEvent(com.ibm.etill.framework.cassette.ProtocolRequest, com.ibm.etill.framework.cassette.ProtocolResponse), KitCashAccount.close(com.ibm.etill.framework.cassette.APIResponse)

setMessageID

public void setMessageID(java.lang.String id)
This method is called by the Payment Manager framework to set the unique cassette name.
Overrides:
setMessageID in class com.ibm.etill.framework.cassette.Cassette
Parameters:
id - the unique id assigned by the Payment Manager framework to this cassette

shutdown

public void shutdown()
Shuts down the KitCash cassette gracefully. This method is historical. Shutdown processing should now be done in response to a STOP_CASSETTE_TOKEN in processAdminRequest.

All protocol threads, service threads and timer threads allocated to this cassette will be shut down by the Payment Manager.

Since no special resources need to be freed, and no special actions need to be taken before stopping the KitCash cassette, this method does nothing.

Overrides:
shutdown in class com.ibm.etill.framework.cassette.Cassette

isAcceptPaymentSupported

public boolean isAcceptPaymentSupported()
Returns whether the acceptPayment command is supported by this cassette.
Overrides:
isAcceptPaymentSupported in class com.ibm.etill.framework.cassette.Cassette
Returns:
boolean - true is the command is supported

isReceivePaymentSupported

public boolean isReceivePaymentSupported()
Returns whether the receivePayment command is supported by this cassette.
Overrides:
isReceivePaymentSupported in class com.ibm.etill.framework.cassette.Cassette
Returns:
boolean - true is the command is supported

start

public void start()
Starts the KitCash cassette. This method is historical. Startup processing should be done in response to the START_CASSETTE_TOKEN in processAdminRequest.

The Payment Manager framework calls start() during cassette startup after the cassette has been initialized.

Overrides:
start in class com.ibm.etill.framework.cassette.Cassette
See Also:
KitCashCleanUp, KitCashAccount.recoverInvalidPurchases()

verifyConfig

public void verifyConfig()
KitCashCassette requires no configuration verification, so this method returns with no action.
Overrides:
verifyConfig in class com.ibm.etill.framework.cassette.Cassette
See Also:
readCassetteConfig(), initializeCassette()