com.konakart.actions.gateways

Class CommideaVanguardBaseAction

java.lang.Object

com.opensymphony.xwork2.ActionSupport

com.konakart.actions.BaseAction

com.konakart.actions.gateways.BaseGatewayAction

com.konakart.actions.gateways.CommideaVanguardBaseAction

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:

CommideaVanguard1Action, CommideaVanguard2Action, CommideaVanguardAction

public class CommideaVanguardBaseAction
extends BaseGatewayAction

This class is a Base Action class for sending the Generate Session Request to Commidea. It contains methods that manage the various messages that are sent to Commidea.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	log The Log instance for this application.
protected java.util.HashMap<java.lang.String,java.lang.String>	parmMap
protected static int	RET0
protected static java.lang.String	RET0_DESC
protected static int	RET1
protected static java.lang.String	RET1_DESC
protected static java.lang.String	RET3_DESC
protected static int	RET4
protected static java.lang.String	RET4_DESC

Fields inherited from class com.konakart.actions.gateways.BaseGatewayAction

enableJsonExceptionHandling, exception, requiresLogin

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
CommideaVanguardBaseAction()

Method Summary

Modifier and Type	Method and Description
protected com.konakart.appif.IpnHistoryIf	clearIpnHistory(com.konakart.appif.IpnHistoryIf in) Clears the IpnHistory object
protected void	customizeConnection(java.net.HttpURLConnection connection, com.konakart.appif.PaymentDetailsIf pd, java.util.List<com.konakart.appif.NameValueIf> paramList) Add things specific to Commidea Vanguard to the connection
protected void	finishUp(KKAppEng kkAppEng, com.konakart.appif.OrderIf order, boolean approved, java.lang.String transactionId) Common code to finish up after the transaction request to Commidea
protected java.lang.String	getFooter() Returns the footer which is common for all requests
protected java.lang.String	getHeader(java.lang.String msgType, com.konakart.appif.OrderIf order, int sendAttempt) Returns the header which is common for all requests
protected java.lang.String	getProcessingDB(java.lang.String encodedDB) Get the processingDB from the encoded String
protected java.lang.String	getResultDescription(java.lang.String desc) Use this to truncate the result description so that it fits in the database column OK
protected java.lang.String	getSessionId(java.lang.String encodedSession) Get the sessionId from the encoded String
protected java.lang.String	vggeneratesessionrequest(KKAppEng kkAppEng, com.konakart.appif.OrderIf order, com.konakart.appif.IpnHistoryIf ipnHistory) Method that manages the VGGENERATESESSIONREQUEST and the VGGENERATESESSIONRESPONSE.
protected java.lang.String	vggetcarddetailsrequest(KKAppEng kkAppEng, com.konakart.appif.OrderIf order, com.konakart.appif.IpnHistoryIf ipnHistory) Method that manages the VGGETCARDDETAILSREQUEST and the VGGETCARDDETAILSRESPONSE.
protected java.lang.String	vgpayerauthauthenticationcheckrequest(KKAppEng kkAppEng, com.konakart.appif.OrderIf order, com.konakart.appif.IpnHistoryIf ipnHistory, java.lang.String paRes, java.lang.String enrolled) Method that manages the VGPAYERAUTHAUTHENTICATIONCHECKREQUEST and the VGPAYERAUTHAUTHENTICATIONCHECKRESPONSE.
protected java.lang.String	vgpayerauthenrollmentcheckrequest(KKAppEng kkAppEng, com.konakart.appif.OrderIf order, com.konakart.appif.IpnHistoryIf ipnHistory) Method that manages the VGPAYERAUTHENROLLMENTCHECKREQUEST and the VGPAYERAUTHENROLLMENTCHECKRESPONSE.
protected java.lang.String	vgtokenregistrationrequest(KKAppEng kkAppEng, com.konakart.appif.OrderIf order, com.konakart.appif.IpnHistoryIf ipnHistory) Method that manages the VGTOKENREGISTRATIONREQUEST and the VGTOKENREGISTRATIONRESPONSE.
protected java.lang.String	vgtransactionrequest(KKAppEng kkAppEng, com.konakart.appif.OrderIf order, com.konakart.appif.IpnHistoryIf ipnHistory) Method that manages the VGTRANSACTIONREQUEST and the VGTRANSACTIONRESPONSE.

Methods inherited from class com.konakart.actions.gateways.BaseGatewayAction

addParameters, customizeConnection, getCustomerIPAddress, getData, getException, getGatewayRequest, getLogFileDirectory, getParameterFromPaymentDetails, getProxy, handleException, hashParameters, isEnableJsonExceptionHandling, postData, postData, saveIPNrecord, saveIPNrecord, sendOrderConfirmationMail, sendOrderConfirmationMail, sendPaymentData, setEnableJsonExceptionHandling, setException, translatePaymentInstrumentTypePaymentModuleSubCode, validateOrder

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

log

protected org.apache.commons.logging.Log log

The Log instance for this application.

RET0

protected static final int RET0

See Also:

Constant Field Values

RET0_DESC

protected static final java.lang.String RET0_DESC

See Also:

Constant Field Values

RET1

protected static final int RET1

See Also:

Constant Field Values

RET1_DESC

protected static final java.lang.String RET1_DESC

See Also:

Constant Field Values

RET3_DESC

protected static final java.lang.String RET3_DESC

See Also:

Constant Field Values

RET4

protected static final int RET4

See Also:

Constant Field Values

RET4_DESC

protected static final java.lang.String RET4_DESC

See Also:

Constant Field Values

parmMap

protected java.util.HashMap<java.lang.String,java.lang.String> parmMap

Constructor Detail

CommideaVanguardBaseAction

public CommideaVanguardBaseAction()

Method Detail

finishUp

protected void finishUp(KKAppEng kkAppEng,
                        com.konakart.appif.OrderIf order,
                        boolean approved,
                        java.lang.String transactionId)
                 throws java.lang.Exception

Common code to finish up after the transaction request to Commidea

Parameters:

kkAppEng - the kkAppEng

order - the order

approved - the approved

transactionId - the transactionId

Throws:

java.lang.Exception - an unexpected exception

getResultDescription

protected java.lang.String getResultDescription(java.lang.String desc)

Use this to truncate the result description so that it fits in the database column OK

Parameters:

desc - the result description (which may be too long)

Returns:

a truncated result description

getHeader

protected java.lang.String getHeader(java.lang.String msgType,
                                     com.konakart.appif.OrderIf order,
                                     int sendAttempt)

Returns the header which is common for all requests

Parameters:

msgType - the msgType

order - the order

sendAttempt - the sendAttempt

Returns:

Returns the client header which is common for all requests

getFooter

protected java.lang.String getFooter()

Returns the footer which is common for all requests

Returns:

Returns the footer which is common for all requests

vggeneratesessionrequest

protected java.lang.String vggeneratesessionrequest(KKAppEng kkAppEng,
                                                    com.konakart.appif.OrderIf order,
                                                    com.konakart.appif.IpnHistoryIf ipnHistory)
                                             throws java.lang.Exception

Method that manages the VGGENERATESESSIONREQUEST and the VGGENERATESESSIONRESPONSE. The method places the following data in the custom fields of the PaymentDetails object so that they can be picked up by the JSP that posts the credit card details to Commidea.

• Custom1 - sessionguid + ";" + processingDB
• Custom2 - sessionpasscode
• Custom4 - ccDetailPostUrl

Parameters:

kkAppEng - the kkAppEng

order - the order

ipnHistory - the ipnHistory

Returns:

Returns the Commidea error code

Throws:

java.lang.Exception - an unexpected exception

vggetcarddetailsrequest

protected java.lang.String vggetcarddetailsrequest(KKAppEng kkAppEng,
                                                   com.konakart.appif.OrderIf order,
                                                   com.konakart.appif.IpnHistoryIf ipnHistory)
                                            throws java.lang.Exception

Method that manages the VGGETCARDDETAILSREQUEST and the VGGETCARDDETAILSRESPONSE.

Parameters:

kkAppEng - the kkAppEng

order - the order

ipnHistory - the ipnHistory

Returns:

Returns "1" or "0" depending on whether the authentication enrollment check request should be made. i.e. Should be "0" for AMEX cards

Throws:

java.lang.Exception - an unexpected exception

vgpayerauthenrollmentcheckrequest

protected java.lang.String vgpayerauthenrollmentcheckrequest(KKAppEng kkAppEng,
                                                             com.konakart.appif.OrderIf order,
                                                             com.konakart.appif.IpnHistoryIf ipnHistory)
                                                      throws java.lang.Exception

Method that manages the VGPAYERAUTHENROLLMENTCHECKREQUEST and the VGPAYERAUTHENROLLMENTCHECKRESPONSE. The method places the following data in the custom fields of the PaymentDetails object.

• Custom2 - payerauthrequestid
• Custom3 - acsurl
• Custom4 - pareq
• Custom5 - TermUrl

Parameters:

kkAppEng - the kkAppEng

order - the order

ipnHistory - the ipnHistory

Returns:

Returns the Commidea error code if there is an error, otherwise returns "Y" or "N" depending whether the customer is enrolled or not

Throws:

java.lang.Exception - an unexpected exception

vgpayerauthauthenticationcheckrequest

protected java.lang.String vgpayerauthauthenticationcheckrequest(KKAppEng kkAppEng,
                                                                 com.konakart.appif.OrderIf order,
                                                                 com.konakart.appif.IpnHistoryIf ipnHistory,
                                                                 java.lang.String paRes,
                                                                 java.lang.String enrolled)
                                                          throws java.lang.Exception

Method that manages the VGPAYERAUTHAUTHENTICATIONCHECKREQUEST and the VGPAYERAUTHAUTHENTICATIONCHECKRESPONSE.

Parameters:

kkAppEng - the kkAppEng

order - the order

ipnHistory - the ipnHistory

paRes - the paRes

enrolled - the enrolled

Returns:

Returns the Commidea error code if there is an error, otherwise returns "Y" or "N" or some other value depending whether the customer was authenticated or not

Throws:

java.lang.Exception - an unexpected exception

vgtransactionrequest

protected java.lang.String vgtransactionrequest(KKAppEng kkAppEng,
                                                com.konakart.appif.OrderIf order,
                                                com.konakart.appif.IpnHistoryIf ipnHistory)
                                         throws java.lang.Exception

Method that manages the VGTRANSACTIONREQUEST and the VGTRANSACTIONRESPONSE. The method places the following data in the custom fields of the PaymentDetails object.

• Custom2 - authcode

Parameters:

kkAppEng - the kkAppEng

order - the order

ipnHistory - the ipnHistory

Returns:

Returns the Commidea error code

Throws:

java.lang.Exception - an unexpected exception

customizeConnection

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

Add things specific to Commidea Vanguard to the connection

Overrides:

customizeConnection in class BaseGatewayAction

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)

clearIpnHistory

protected com.konakart.appif.IpnHistoryIf clearIpnHistory(com.konakart.appif.IpnHistoryIf in)

Clears the IpnHistory object

Parameters:

in - the in

Returns:

Returns the cleared IpnHistory object

getSessionId

protected java.lang.String getSessionId(java.lang.String encodedSession)

Get the sessionId from the encoded String

Parameters:

encodedSession - the encodedSession

Returns:

Returns the sessionId from the encoded String

getProcessingDB

protected java.lang.String getProcessingDB(java.lang.String encodedDB)

Get the processingDB from the encoded String

Parameters:

encodedDB - the encodedDB

Returns:

Returns the processingDB from the encoded String

vgtokenregistrationrequest

protected java.lang.String vgtokenregistrationrequest(KKAppEng kkAppEng,
                                                      com.konakart.appif.OrderIf order,
                                                      com.konakart.appif.IpnHistoryIf ipnHistory)
                                               throws java.lang.Exception

Method that manages the VGTOKENREGISTRATIONREQUEST and the VGTOKENREGISTRATIONRESPONSE.

Parameters:

kkAppEng - the kkAppEng

order - the order

ipnHistory - the ipnHistory

Returns:

Returns "1" or "0" depending on whether the authentication enrollment check request should be made. i.e. Should be "0" for AMEX cards

Throws:

java.lang.Exception - an unexpected exception