com.konakart.actions.gateways

Class AuthorizeNetBaseAction

java.lang.Object

com.opensymphony.xwork2.ActionSupport

com.konakart.actions.BaseAction

com.konakart.actions.gateways.BaseGatewayAction

com.konakart.actions.gateways.AuthorizeNetBaseAction

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:

AuthorizenetAction, AuthorizeNetCIMPayAction, AuthorizeNetDPM1Action, AuthorizeNetManageCreditCardsAction

public class AuthorizeNetBaseAction
extends BaseGatewayAction

This is the base action class for AuthorizeNet containing some common code

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.lang.String	loginId
protected java.lang.String	transactionKey
protected java.lang.String	webServiceURL

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, COOKIE_MAX_AGE_IN_SECS, CUSTOMER_LOCALE, CUSTOMER_NAME, CUSTOMER_UUID, GUEST_CUSTOMER_ID, KKLOGIN, 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
AuthorizeNetBaseAction()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	customizeConnection(java.net.HttpURLConnection connection, com.konakart.appif.PaymentDetailsIf pd, java.util.List<com.konakart.appif.NameValueIf> paramList) Add things specific to AuthorizeNet to the connection
protected void	getAuthNetAuthentication(KKAppEng kkAppEng) Get information from the AuthorizeNet module
protected java.lang.String	getGatewayResponse(java.lang.StringBuffer msg, java.lang.String methodName) Get a response from the gateway
protected java.lang.String	getGatewayResultDescription(java.lang.String code) Adds a description to the Gateway Result
protected java.lang.StringBuffer	getMessage(java.lang.String name, java.lang.StringBuffer innerMsg) Create the full message
protected java.lang.StringBuffer	getMsgAuthentication() Create the authentication part of the message
protected java.lang.String	getRespDesc(int position) Authorize.net returns a response as delimiter separated variables.
protected java.lang.String	sendMsgToGateway(KKAppEng kkAppEng, java.lang.StringBuffer msg, java.lang.String methodName, java.lang.String retAttr, int custId, java.lang.String profileId) Common code to send a message and receive a response
protected boolean	validateGatewayResponse(KKAppEng kkAppEng, java.lang.StringBuffer msg, java.lang.String methodName, int custId, java.lang.String profileId, org.w3c.dom.Document doc) Common code to validate the gateway response.

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

addParameters, customizeConnection, getCustomerIPAddress, getData, getGatewayRequest, getLogFileDirectory, getParameterFromPaymentDetails, hashParameters, postData, postData, saveIPNrecord, saveIPNrecord, sendOrderConfirmationMail, sendOrderConfirmationMail, validateOrder

Methods inherited from class com.konakart.actions.BaseAction

changeSession, checkSSL, escapeFormInput, getBaseURL, getCustomerEvent, getForward, getJspEng, getKKAppEng, getKKCookie, getKKCookie, getRedirectURL, handleException, 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.

loginId

protected java.lang.String loginId

transactionKey

protected java.lang.String transactionKey

webServiceURL

protected java.lang.String webServiceURL

Constructor Detail

AuthorizeNetBaseAction

public AuthorizeNetBaseAction()

Method Detail

getAuthNetAuthentication

protected void getAuthNetAuthentication(KKAppEng kkAppEng)
                                 throws com.konakart.app.KKException

Get information from the AuthorizeNet module

Parameters:

kkAppEng - the kkAppEng

Throws:

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

sendMsgToGateway

protected java.lang.String sendMsgToGateway(KKAppEng kkAppEng,
                                java.lang.StringBuffer msg,
                                java.lang.String methodName,
                                java.lang.String retAttr,
                                int custId,
                                java.lang.String profileId)
                                     throws java.lang.Exception

Common code to send a message and receive a response

Parameters:

kkAppEng - the kkAppEng

msg - the msg

methodName - the methodName

retAttr - the retAttr

custId - the custId

profileId - the profileId

Returns:

Returns the value of the attribute called retAttr

Throws:

java.lang.Exception - an unexpected exception

validateGatewayResponse

protected boolean validateGatewayResponse(KKAppEng kkAppEng,
                              java.lang.StringBuffer msg,
                              java.lang.String methodName,
                              int custId,
                              java.lang.String profileId,
                              org.w3c.dom.Document doc)

Common code to validate the gateway response.

Parameters:

kkAppEng - the kkAppEng

msg - the msg

methodName - the methodName

custId - the custId

profileId - the profileId

doc - the doc

Returns:

Returns true if there were no gateway errors

getGatewayResponse

protected java.lang.String getGatewayResponse(java.lang.StringBuffer msg,
                                  java.lang.String methodName)
                                       throws java.lang.Exception

Get a response from the gateway

Parameters:

msg - the msg

methodName - the methodName

Returns:

Returns the gateway response

Throws:

java.lang.Exception - an unexpected exception

getMsgAuthentication

protected java.lang.StringBuffer getMsgAuthentication()

Create the authentication part of the message

Returns:

Returns the authentication part of the message

getMessage

protected java.lang.StringBuffer getMessage(java.lang.String name,
                                java.lang.StringBuffer innerMsg)

Create the full message

Parameters:

name - the name

innerMsg - the innerMsg

Returns:

Returns the full message

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 AuthorizeNet 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)

getRespDesc

protected java.lang.String getRespDesc(int position)

Authorize.net returns a response as delimiter separated variables. In order to make them readable, we tag each one with a description before saving in the ipnHistory table.

Parameters:

position - the position

Returns:

Response Description

getGatewayResultDescription

protected java.lang.String getGatewayResultDescription(java.lang.String code)

Adds a description to the Gateway Result

Parameters:

code - the code

Returns:

Returns a result with an added description