com.ibm.etill.kitcashcassette
Class KitCashProfile

java.lang.Object
  |
  +--com.ibm.etill.kitcashcassette.KitCashProfile
All Implemented Interfaces:
com.ibm.etill.framework.archive.Archivable, com.ibm.etill.framework.payapi.FrameworkReturnCodes, KitCashCassetteAdminConstants, KitCashConstants

public class KitCashProfile
extends java.lang.Object
implements KitCashConstants, KitCashCassetteAdminConstants, com.ibm.etill.framework.payapi.FrameworkReturnCodes, com.ibm.etill.framework.archive.Archivable

The KitCashProfile class is used by the KitCash cassette to read and store its configuration information from the KITCASHCONFIG database table. It represents an extension to the framework cassette admin object.

The one piece of information needed by the KitCash cassette is the protocol port to be used when listening for incoming KitCash protocol messages from the consumer.


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.kitcashcassette.KitCashCassetteAdminConstants
COL_PROTOCOLPORT, KITCASHCASSETTE_TABLE, XDM_PROTOCOLPORT
 
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
 
Method Summary
 void createRecord(java.sql.Connection conn)
          Since cassette objects should never be created, this method should never be called.
 void deleteRecord(java.sql.Connection conn)
          Since cassette objects should never be deleted, this method should never be called.
static int getProtocolPort()
          Returns the protocol port that the KitCash cassette uses to listen for incoming KitCash protocol messages from the consumer.
protected  void modifyObject(com.ibm.etill.framework.cassette.AdminRequest request, com.ibm.etill.framework.payapi.ParameterTable protocolKeywords, com.ibm.etill.framework.cassette.APIResponse response)
          Modify this profile object with the information passed in the request.
protected static KitCashProfile obtainObject()
          Obtain Object
static void retrieveConfigRecords()
          Retrieves the KitCash configuration information from the KitCashConfig database table.
 java.lang.String toString()
          Returns a string representation of the KitCash configuration information.
 void updateRecord(java.sql.Connection conn)
          Updates the KitCash configuration information in the KitCashConfig database table.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

createRecord

public void createRecord(java.sql.Connection conn)
                  throws com.ibm.etill.framework.payapi.ETillAbortOperation
Since cassette objects should never be created, this method should never be called. It throws an exception if called. It is required by the Archivable interface.
Specified by:
createRecord in interface com.ibm.etill.framework.archive.Archivable
Throws:
com.ibm.etill.framework.payapi.ETillAbortOperation - if the method is called.

deleteRecord

public void deleteRecord(java.sql.Connection conn)
                  throws com.ibm.etill.framework.payapi.ETillAbortOperation
Since cassette objects should never be deleted, this method should never be called. It throws an exception if called. It is required by the Archivable interface.
Specified by:
deleteRecord in interface com.ibm.etill.framework.archive.Archivable
Throws:
com.ibm.etill.framework.payapi.ETillAbortOperation - if the method is called.

getProtocolPort

public static int getProtocolPort()
Returns the protocol port that the KitCash cassette uses to listen for incoming KitCash protocol messages from the consumer.
Returns:
the KitCash protocol port.

modifyObject

protected void modifyObject(com.ibm.etill.framework.cassette.AdminRequest request,
                            com.ibm.etill.framework.payapi.ParameterTable protocolKeywords,
                            com.ibm.etill.framework.cassette.APIResponse response)
                     throws com.ibm.etill.framework.payapi.ETillAbortOperation
Modify this profile object with the information passed in the request.
Throws:
com.ibm.etill.framework.payapi.ETillAbortOperation - if the update fails.

obtainObject

protected static KitCashProfile obtainObject()
Obtain Object

retrieveConfigRecords

public static void retrieveConfigRecords()
                                  throws com.ibm.etill.framework.payapi.ETillAbortOperation
Retrieves the KitCash configuration information from the KitCashConfig database table.

Only one configuration record is expected on the table. If more than one record exists, then all but one will be ignored.

Throws:
com.ibm.etill.framework.payapi.ETillAbortOperation - if the database table cannot be read or no configuration data is found.

toString

public java.lang.String toString()
Returns a string representation of the KitCash configuration information.
Overrides:
toString in class java.lang.Object
Returns:
a string representation of the KitCash configuration information.

updateRecord

public void updateRecord(java.sql.Connection conn)
                  throws com.ibm.etill.framework.payapi.ETillAbortOperation
Updates the KitCash configuration information in the KitCashConfig database table. It is required by the Archivable interface.
Specified by:
updateRecord in interface com.ibm.etill.framework.archive.Archivable
Parameters:
conn - the database connection to use
Throws:
com.ibm.etill.framework.payapi.ETillAbortOperation - if the database table cannot be updated.