com.konakart.actions.gateways

Class BaseGatewayAction

java.lang.Object

com.opensymphony.xwork2.ActionSupport

com.konakart.actions.BaseAction

com.konakart.actions.gateways.BaseGatewayAction

All Implemented Interfaces:

com.opensymphony.xwork2.Action, com.opensymphony.xwork2.LocaleProvider, com.opensymphony.xwork2.TextProvider, com.opensymphony.xwork2.Validateable, com.opensymphony.xwork2.ValidationAware, java.io.Serializable, org.apache.struts2.interceptor.ServletRequestAware, org.apache.struts2.interceptor.SessionAware

Direct Known Subclasses:

BarclaycardSmartPayApi3DResponseAction, BarclaycardSmartPayApiAction, BarclaycardSmartPayApiNotificationAction, BarclaycardSmartPayHostedNotificationAction, BarclaycardSmartPayHostedResponseAction, BluepayAction, CaledonAction, CommideaVanguardBaseAction, CyberSourceSAResponseAction, ElinkAction, Eway_auAction, GlobalCollectBaseAction, MoneyBookersAction, NetpayintlAction, PayflowProAction, PayjunctionAction, PayPalAction, UsaepayAction, WorldPayAction, WorldPayXMLRedirectAction, WorldPayXMLRedirectResponseAction

public class BaseGatewayAction
extends BaseAction

Base Gateway Action for KonaKart application.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	enableJsonExceptionHandling Set to true when using Json
protected JsonException	exception An object to return exception information when action class is called using Json
protected boolean	requiresLogin Set to true if request requires login

Fields inherited from class com.konakart.actions.BaseAction

ACTION_CONFIRM_ORDER, ACTION_CUSTOMER_LOGIN, ACTION_ENTER_CHECKOUT, ACTION_NEW_CUSTOMER_VISIT, ACTION_PAYMENT_METHOD_SELECTED, ACTION_PRODUCT_VIEWED, ACTION_REMOVE_FROM_CART, AGREED_COOKIES, appEng, COOKIE_MAX_AGE_IN_SECS, CUSTOMER_LOCALE, CUSTOMER_NAME, CUSTOMER_UUID, GUEST_CUSTOMER_ID, KKLOGIN, MY_ACCOUNT_URL, SEO_DELIM, SEO_DIRECTORY, SEO_OFF, SEO_PARAMETERS, SEO_PRODS_FOR_MANU, SEO_PRODS_FOR_MANU_CODE, SEO_SEARCH_BY_MANU_BY_LINK, SEO_SEARCH_BY_MANU_BY_LINK_CODE, SEO_SEL_CAT, SEO_SEL_CAT_CODE, SEO_SEL_PROD, SEO_SEL_PROD_CODE, SEO_TYPE, SEO_TYPE_LENGTH, strutsSession, TAG_BIRTH_DATE, TAG_CART_TOTAL, TAG_CATEGORIES_TIME_VIEWED, TAG_CATEGORIES_VIEWED, TAG_COUNTRY_CODE, TAG_IS_MALE, TAG_LOGIN_DATE, TAG_MANUFACTURERS_TIME_VIEWED, TAG_MANUFACTURERS_VIEWED, TAG_ORDER_PAGE_SIZE, TAG_PROD_PAGE_SIZE, TAG_PRODUCTS_IN_CART, TAG_PRODUCTS_IN_WISHLIST, TAG_PRODUCTS_TIME_IN_CART, TAG_PRODUCTS_TIME_IN_WISHLIST, TAG_PRODUCTS_TIME_VIEWED, TAG_PRODUCTS_VIEWED, TAG_REVIEW_PAGE_SIZE, TAG_SEARCH_STRING, TAG_WISHLIST_TOTAL, WELCOME

Fields inherited from class com.opensymphony.xwork2.ActionSupport

LOG

Fields inherited from interface com.opensymphony.xwork2.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor and Description
BaseGatewayAction()

Method Summary

Modifier and Type	Method and Description
protected void	addParameters(com.konakart.appif.PaymentDetailsIf pd, java.util.List<com.konakart.appif.NameValueIf> newParameters) Add more parameters to the PaymentDetails object.
protected void	customizeConnection(java.net.HttpURLConnection connection) Deprecated.
protected void	customizeConnection(java.net.HttpURLConnection connection, com.konakart.appif.PaymentDetailsIf pd, java.util.List<com.konakart.appif.NameValueIf> paramList) This method is normally specialized in the sub class to customize the connection
protected java.lang.String	getCustomerIPAddress(javax.servlet.http.HttpServletRequest request)
java.lang.String	getData(com.konakart.appif.PaymentDetailsIf pd, java.util.List<com.konakart.appif.NameValueIf> ccParmList) Sends data to the payment gateway via a GET.
JsonException	getException()
protected java.lang.StringBuffer	getGatewayRequest(com.konakart.appif.PaymentDetailsIf pd, java.util.List<com.konakart.appif.NameValueIf> ccParmList) This method can be specialized in the super class to customize the format of the request
java.lang.String	getLogFileDirectory(KKAppEng kkAppEng)
protected java.lang.String	getParameterFromPaymentDetails(java.lang.String paramName, com.konakart.appif.PaymentDetailsIf pd) Get the value of the parameter with the specified name from the PaymentDetails object
protected java.net.Proxy	getProxy(KKAppEng kkAppEng)
protected java.lang.String	handleException(javax.servlet.http.HttpServletRequest request, java.lang.Exception e) A common method that contains the code to deal with exceptions
protected java.util.HashMap<java.lang.String,java.lang.String>	hashParameters(com.konakart.appif.PaymentDetailsIf pd, java.util.List<com.konakart.appif.NameValueIf> ccParmList) This method is optionally called from the sub class to load up the parameters into a HashTable for efficient subsequent processing
boolean	isEnableJsonExceptionHandling()
java.lang.String	postData(com.konakart.appif.PaymentDetailsIf pd, java.util.List<com.konakart.appif.NameValueIf> ccParmList) Sends data to the payment gateway via a POST.
java.lang.String	postData(java.lang.StringBuffer postData, com.konakart.appif.PaymentDetailsIf pd, java.util.List<com.konakart.appif.NameValueIf> ccParmList) Sends data to the payment gateway via a POST.
protected void	saveIPNrecord(KKAppEng kkAppEng, int orderId, java.lang.String moduleCode, java.lang.String gatewayFullResponse, java.lang.String gatewayResult, java.lang.String gatewayTransactionId, java.lang.String konakartResultDescription, int konakartResultId) Saves an IPN History record.
protected void	saveIPNrecord(KKAppEng kkAppEng, int orderId, java.lang.String moduleCode, java.lang.String gatewayFullResponse, java.lang.String gatewayResult, java.lang.String gatewayTransactionId, java.lang.String konakartResultDescription, int konakartResultId, java.lang.String txType, java.math.BigDecimal txAmount) Saves an IPN History record.
protected void	sendOrderConfirmationMail(KKAppEng kkAppEng, int orderId, boolean success) Send an order confirmation eMail.
protected void	sendOrderConfirmationMail(KKAppEng kkAppEng, java.lang.String sessionId, java.lang.String countryCode, int orderId, boolean success) Send an order confirmation eMail.
java.lang.String	sendPaymentData(com.konakart.appif.PaymentDetailsIf pd, java.util.List<com.konakart.appif.NameValueIf> parmList) Send the payment data.
void	setEnableJsonExceptionHandling(boolean enableJsonExceptionHandling)
void	setException(JsonException exception)
protected java.lang.String	translatePaymentInstrumentTypePaymentModuleSubCode(java.lang.String paymentInstrumentType) Get the paymentInstrumentType from the gateway and return the paymentModuleSubCode in order to indicate what type of payment has been used in the order.
protected void	validateOrder(com.konakart.appif.OrderIf order, java.lang.String code) Validate the order and ensure that we are using the correct payment gateway

Methods inherited from class com.konakart.actions.BaseAction

changeSession, checkSSL, escapeFormInput, getBaseURL, getCustomerEvent, getForward, getJspEng, getKKAppEng, getKKCookie, getKKCookie, getRedirectURL, insertCustomerEvent, insertCustomerEvent, insertCustomerEvent, insertCustomerEvent, insertCustomerEvent, kkURLEncode, loggedIn, loggedIn, loggedIn, login, manageCookieLogout, noNull, setJspEng, setKKCookie, setKKCookie, setServletRequest, setSession, setupResponseForSEORedirect, setupResponseForSSLRedirect, updateRecentlyViewedProducts

Methods inherited from class com.opensymphony.xwork2.ActionSupport

addActionError, addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, doDefault, execute, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getFormatted, getLocale, getText, getText, getText, getText, getText, getText, getText, getText, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, input, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors, validate

Methods inherited from class java.lang.Object

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

Field Detail

exception

protected JsonException exception

An object to return exception information when action class is called using Json

enableJsonExceptionHandling

protected boolean enableJsonExceptionHandling

Set to true when using Json

requiresLogin

protected boolean requiresLogin

Set to true if request requires login

Constructor Detail

BaseGatewayAction

public BaseGatewayAction()

Method Detail

validateOrder

protected void validateOrder(com.konakart.appif.OrderIf order,
                             java.lang.String code)
                      throws KKAppException

Validate the order and ensure that we are using the correct payment gateway

Parameters:

order - the order

code - the code

Throws:

KKAppException - an unexpected KKAppException exception

sendPaymentData

public java.lang.String sendPaymentData(com.konakart.appif.PaymentDetailsIf pd,
                                        java.util.List<com.konakart.appif.NameValueIf> parmList)
                                 throws java.io.IOException

Send the payment data. Either use a GET or a POST depending on the value in the PaymentDetails parameter.

Parameters:

pd - payment details

parmList - parameter list

Returns:

the response from the gateway as a string

Throws:

java.io.IOException - if we get an IOException communication with the gateway

postData

public java.lang.String postData(com.konakart.appif.PaymentDetailsIf pd,
                                 java.util.List<com.konakart.appif.NameValueIf> ccParmList)
                          throws java.io.IOException

Sends data to the payment gateway via a POST. Parameters are received from the PaymentDetails object and the credit card parameters that have just been input by the customer are sent in a separate list; the ccParmList. Any miscellaneous parameters can also be added to the ccParmList if required.

Parameters:

pd - the PaymentDetails object

ccParmList - the ccParmList

Returns:

The response to the post

Throws:

java.io.IOException - an unexpected IOException exception

postData

public java.lang.String postData(java.lang.StringBuffer postData,
                                 com.konakart.appif.PaymentDetailsIf pd,
                                 java.util.List<com.konakart.appif.NameValueIf> ccParmList)
                          throws java.io.IOException

Sends data to the payment gateway via a POST. Parameters are received from the PaymentDetails object and the credit card parameters that have just been input by the customer are sent in a separate list; the ccParmList. Any miscellaneous parameters can also be added to the ccParmList if required. If postData is not null, then the data it contains is used instead of the data from the PaymentDetails and ccParmList.

Parameters:

postData - The data to be posted. Can be null.

pd - the PaymentDetails object

ccParmList - the ccParmList

Returns:

The response to the post

Throws:

java.io.IOException - an unexpected IOException exception

getData

public java.lang.String getData(com.konakart.appif.PaymentDetailsIf pd,
                                java.util.List<com.konakart.appif.NameValueIf> ccParmList)
                         throws java.io.IOException

Sends data to the payment gateway via a GET. Parameters are received from the PaymentDetails object and the credit card parameters that have just been input by the customer are send in a separate list; the ccParmList

Parameters:

pd - the payment details

ccParmList - the ccParmList

Returns:

The response to the post

Throws:

java.io.IOException - an unexpected IOException exception

getGatewayRequest

protected java.lang.StringBuffer getGatewayRequest(com.konakart.appif.PaymentDetailsIf pd,
                                                   java.util.List<com.konakart.appif.NameValueIf> ccParmList)

This method can be specialized in the super class to customize the format of the request

Parameters:

pd - the PaymentDetails

ccParmList - the credit card parameters

Returns:

a StringBuffer containing the gateway request

getLogFileDirectory

public java.lang.String getLogFileDirectory(KKAppEng kkAppEng)

Parameters:

kkAppEng - the kkAppEng

Returns:

Returns the logFileDirectory. We look it up every time.

hashParameters

protected java.util.HashMap<java.lang.String,java.lang.String> hashParameters(com.konakart.appif.PaymentDetailsIf pd,
                                                                              java.util.List<com.konakart.appif.NameValueIf> ccParmList)

This method is optionally called from the sub class to load up the parameters into a HashTable for efficient subsequent processing

Parameters:

pd - PaymentDetails object

ccParmList - name value pair list of CC parameters

Returns:

a hash map containing the parameters for rapid lookup

getParameterFromPaymentDetails

protected java.lang.String getParameterFromPaymentDetails(java.lang.String paramName,
                                                          com.konakart.appif.PaymentDetailsIf pd)

Get the value of the parameter with the specified name from the PaymentDetails object

Parameters:

paramName - parameter name to look up

pd - PaymentDetails object

Returns:

value of the parameter or null if the parameter is not found

customizeConnection

protected void customizeConnection(java.net.HttpURLConnection connection,
                                   com.konakart.appif.PaymentDetailsIf pd,
                                   java.util.List<com.konakart.appif.NameValueIf> paramList)

This method is normally specialized in the sub class to customize the connection

Parameters:

connection - the HTTP connection object

pd - the Payment Details

paramList - Additional parameters (typically credit card details but can also be any miscellaneous extra parameters that may be required)

customizeConnection

@Deprecated
protected void customizeConnection(java.net.HttpURLConnection connection)

Deprecated.

This method is normally specialized in the sub class to customize the connection

Parameters:

connection - the connection

sendOrderConfirmationMail

protected void sendOrderConfirmationMail(KKAppEng kkAppEng,
                                         int orderId,
                                         boolean success)
                                  throws com.konakart.app.KKException

Send an order confirmation eMail. The template used is different if the order is successful or not.

Parameters:

kkAppEng - the kkAppEng

orderId - the orderId

success - the success

Throws:

com.konakart.app.KKException - an unexpected KKException exception

sendOrderConfirmationMail

protected void sendOrderConfirmationMail(KKAppEng kkAppEng,
                                         java.lang.String sessionId,
                                         java.lang.String countryCode,
                                         int orderId,
                                         boolean success)
                                  throws com.konakart.app.KKException

Send an order confirmation eMail. The template used is different if the order is successful or not.

Parameters:

kkAppEng - the kkAppEng

sessionId - the sessionId

countryCode - the countryCode

orderId - the orderId

success - the success

Throws:

com.konakart.app.KKException - an unexpected KKException exception

saveIPNrecord

protected void saveIPNrecord(KKAppEng kkAppEng,
                             int orderId,
                             java.lang.String moduleCode,
                             java.lang.String gatewayFullResponse,
                             java.lang.String gatewayResult,
                             java.lang.String gatewayTransactionId,
                             java.lang.String konakartResultDescription,
                             int konakartResultId)
                      throws com.konakart.app.KKException

Saves an IPN History record. The KKAppEng should have a logged-in user with a valid sessionId.

Parameters:

kkAppEng - the KKAppEng application engine which should contain a valid sessionId

orderId - the orderId involved in the transaction

moduleCode - the code of the module

gatewayFullResponse - full response from the gateway

gatewayResult - summary gateway response

gatewayTransactionId - an Id from the gateway that identifies the transaction

konakartResultDescription - KonaKart result description

konakartResultId - KonaKart result code

Throws:

com.konakart.app.KKException - an unexpected KKException exception

saveIPNrecord

protected void saveIPNrecord(KKAppEng kkAppEng,
                             int orderId,
                             java.lang.String moduleCode,
                             java.lang.String gatewayFullResponse,
                             java.lang.String gatewayResult,
                             java.lang.String gatewayTransactionId,
                             java.lang.String konakartResultDescription,
                             int konakartResultId,
                             java.lang.String txType,
                             java.math.BigDecimal txAmount)
                      throws com.konakart.app.KKException

Saves an IPN History record. The KKAppEng should have a logged-in user with a valid sessionId.

Parameters:

kkAppEng - the KKAppEng application engine which should contain a valid sessionId

orderId - the orderId involved in the transaction

moduleCode - the code of the module

gatewayFullResponse - full response from the gateway

gatewayResult - summary gateway response

gatewayTransactionId - an Id from the gateway that identifies the transaction

konakartResultDescription - KonaKart result description

konakartResultId - KonaKart result code

txType - Transaction Type

txAmount - Transaction Amount

Throws:

com.konakart.app.KKException - an unexpected KKException exception

addParameters

protected void addParameters(com.konakart.appif.PaymentDetailsIf pd,
                             java.util.List<com.konakart.appif.NameValueIf> newParameters)

Add more parameters to the PaymentDetails object. Normally this method would be on the PaymentDetails class but it's placed here instead because of the automatic code generation that occurs on the PaymentDetails class for web services, JSON and RMI etc.

Parameters:

pd - the PaymentDetails object

newParameters - The parameters to set.

getCustomerIPAddress

protected java.lang.String getCustomerIPAddress(javax.servlet.http.HttpServletRequest request)

Parameters:

request - the request

Returns:

Returns the IP address

getProxy

protected java.net.Proxy getProxy(KKAppEng kkAppEng)

Parameters:

kkAppEng - the KKAppEng application engine which should contain a valid sessionId

Returns:

Returns the IP address

handleException

protected java.lang.String handleException(javax.servlet.http.HttpServletRequest request,
                                           java.lang.Exception e)

A common method that contains the code to deal with exceptions

Overrides:

handleException in class BaseAction

Parameters:

request - the HttpServletRequest request

e - Exception to handle

Returns:

Returns a string

getException

public JsonException getException()

Returns:

the exception

setException

public void setException(JsonException exception)

Parameters:

exception - the exception to set

isEnableJsonExceptionHandling

public boolean isEnableJsonExceptionHandling()

Returns:

the enableJsonExceptionHandling

setEnableJsonExceptionHandling

public void setEnableJsonExceptionHandling(boolean enableJsonExceptionHandling)

Parameters:

enableJsonExceptionHandling - the enableJsonExceptionHandling to set

translatePaymentInstrumentTypePaymentModuleSubCode

protected java.lang.String translatePaymentInstrumentTypePaymentModuleSubCode(java.lang.String paymentInstrumentType)

Get the paymentInstrumentType from the gateway and return the paymentModuleSubCode in order to indicate what type of payment has been used in the order.

Parameters:

paymentInstrumentType - the paymentInstrumentType received from the gateway

Returns:

the paymentModuleSubCode