BaseAction (KonaKart Client Engine API Documentation (Struts 2 Storefront))

java.lang.Object
- com.opensymphony.xwork2.ActionSupport
- - com.konakart.actions.BaseAction

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:

AboutUsAction, AddressBookAction, AddToCartOrWishListBaseAction, AdminLoginSubmitAction, AdvancedSearchAction, AdvancedSearchSubmitAction, AgreeToCookiesSubmitAction, ApproveOrderSubmitAction, B2BBaseAction, B2BDeleteAddressAction, B2BDeleteAddressSubmitAction, B2BEditAddressAction, B2BEditAddressSubmitAction, B2BNewAddressAction, B2BNewAddressSubmitAction, BaseGatewayAction, CatalogAfterLoginAction, CatalogMainPageAction, ChangeGiftRegistryAddrAction, ChangeGiftRegistryAddrSubmitAction, ChangePasswordAction, ChangePasswordSubmitAction, CheckoutAction, CheckoutAwaitBankTransferAction, CheckoutConfirmationSubmitAction, CheckoutFinishedAction, CheckoutFinishedSubmitAction, CheckoutOnePageRefreshAction, CheckoutPaymentErrorAction, CheckoutServerPaymentAction, CheckoutServerPaymentSubmitAction, ContactUsAction, CreateGiftRegistryAction, CreateGiftRegistrySubmitAction, CustomCookieAction, CustomerRegistrationAction, CustomerRegistrationSubmitAction, DefaultAction, DeleteAddrAction, DeleteAddrSubmitAction, DeleteGiftRegistryAction, DigitalDownloadAction, DoubleOptInReturnAction, DownloadInvoiceAction, EditAddrAction, EditAddrSubmitAction, EditCartSubmitAction, EditCustomerAction, EditCustomerSubmitAction, EditEmailAction, EditEmailSubmitAction, EditGiftRegistryAction, EditGiftRegistrySubmitAction, EditNewsletterAction, EditNewsletterSubmitAction, EditNotifiedProductsAction, EditNotifiedProductsSubmitAction, EditOrderAction, EditWishListSubmitAction, EnableCustomerSubmitAction, FilterReviewAction, FilterSearchByCategoryAction, FilterSearchByManufacturerAction, FilterSearchByPriceAction, FilterSearchByTagsAction, FilterVendorReviewAction, FirstAddrAction, FirstAddrSubmitAction, ForgotPasswordAction, ForgotPasswordSubmitAction, GiftRegistryListSubmitAction, GiftRegistrySearchAction, GiftRegistrySearchSubmitAction, HelpAction, InitFromTokenSubmitAction, InternationalOrdersAction, LoginAction, LoginSubmitAction, LogoutAction, ManagePreferencesAction, ManagePreferencesSubmitAction, ManufacturerBaseAction, MyAccountAction, NavigateAllOrdersAction, NavigateGiftRegistryItemsAction, NavigateProductAction, NavigateReviewAction, NavigateRewardPointsAction, NavigateVendorReviewAction, NavigateWishListAction, NewAddrAction, NewAddrSubmitAction, OrderPageSizeAction, PrivacyNoticeAction, ProdPageSizeAction, PunchOutCheckoutAction, PunchOutEntryAction, QuickSearchAction, RemoveAllTagsFromFilterAction, RepeatOrderAction, ResetNotificationAction, ReturnsAction, RevPageSizeAction, SelectCategoryAction, SetLocaleAction, SetNotificationAction, ShippingAndHandlingAction, ShowAllNewProdsAction, ShowAllOrdersAction, ShowAllSpecialsAction, ShowCartItemsAction, ShowGiftRegistryItemsAction, ShowHomepageAction, ShowImageAction, ShowOrderDetailsAction, ShowProductDetailsAction, ShowReviewDetailsAction, ShowRewardPointsAction, ShowSpecialsAction, ShowWishListItemsAction, SortGiftRegistryItemsAction, SortProductAction, SortReviewAction, SortVendorReviewAction, StoreDetailsAction, SubscribeNewsletterConfirmSubmitAction, SubscribeNewsletterSubmitAction, SuggestedSearch, TermsOfUseAction, WriteReviewAction, WriteReviewSubmitAction, WriteVendorReviewAction, WriteVendorReviewSubmitAction, XMLOverHTTPAction
```
public class BaseAction
extends com.opensymphony.xwork2.ActionSupport
implements org.apache.struts2.interceptor.ServletRequestAware, org.apache.struts2.interceptor.SessionAware
```
Base Action for KonaKart application. All of the other action classes extend this class.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`ACTION_CONFIRM_ORDER`
`protected static int`	`ACTION_CUSTOMER_LOGIN`
`protected static int`	`ACTION_ENTER_CHECKOUT`
`protected static int`	`ACTION_NEW_CUSTOMER_VISIT`
`protected static int`	`ACTION_PAYMENT_METHOD_SELECTED`
`protected static int`	`ACTION_PRODUCT_VIEWED`
`protected static int`	`ACTION_REMOVE_FROM_CART`
`protected static java.lang.String`	`AGREED_COOKIES`
`protected static KKAppEng`	`appEng` Copy of the KKAppEng
`protected static int`	`COOKIE_MAX_AGE_IN_SECS`
`protected static java.lang.String`	`CUSTOMER_LOCALE`
`protected static java.lang.String`	`CUSTOMER_NAME`
`protected static java.lang.String`	`CUSTOMER_UUID`
`protected static java.lang.String`	`GUEST_CUSTOMER_ID`
`protected static java.lang.String`	`KKLOGIN`
`protected org.apache.commons.logging.Log`	`log` The `Log` instance for this application.
`protected static java.lang.String`	`MY_ACCOUNT_URL` To set the url in the breadcrumb for My Account
`protected static java.lang.String`	`SEO_DELIM`
`protected static int`	`SEO_DIRECTORY`
`protected static int`	`SEO_OFF`
`protected static int`	`SEO_PARAMETERS`
`protected static java.lang.String`	`SEO_PRODS_FOR_MANU`
`protected static int`	`SEO_PRODS_FOR_MANU_CODE`
`protected static java.lang.String`	`SEO_SEARCH_BY_MANU_BY_LINK`
`protected static int`	`SEO_SEARCH_BY_MANU_BY_LINK_CODE`
`protected static java.lang.String`	`SEO_SEL_CAT`
`protected static int`	`SEO_SEL_CAT_CODE`
`protected static java.lang.String`	`SEO_SEL_PROD`
`protected static int`	`SEO_SEL_PROD_CODE`
`protected static java.lang.String`	`SEO_TYPE`
`protected static int`	`SEO_TYPE_LENGTH`
`java.util.Map<java.lang.String,java.lang.Object>`	`strutsSession` Struts session
`protected static java.lang.String`	`TAG_BIRTH_DATE`
`static java.lang.String`	`TAG_CART_TOTAL` Customer tag
`protected static java.lang.String`	`TAG_CATEGORIES_TIME_VIEWED`
`protected static java.lang.String`	`TAG_CATEGORIES_VIEWED`
`protected static java.lang.String`	`TAG_COUNTRY_CODE`
`protected static java.lang.String`	`TAG_IS_MALE`
`protected static java.lang.String`	`TAG_LOGIN_DATE`
`protected static java.lang.String`	`TAG_MANUFACTURERS_TIME_VIEWED`
`protected static java.lang.String`	`TAG_MANUFACTURERS_VIEWED`
`protected static java.lang.String`	`TAG_ORDER_PAGE_SIZE`
`protected static java.lang.String`	`TAG_PROD_PAGE_SIZE`
`static java.lang.String`	`TAG_PRODUCTS_IN_CART` Customer tag
`static java.lang.String`	`TAG_PRODUCTS_IN_WISHLIST` Customer tag
`static java.lang.String`	`TAG_PRODUCTS_TIME_IN_CART` Customer tag
`static java.lang.String`	`TAG_PRODUCTS_TIME_IN_WISHLIST` Customer tag
`protected static java.lang.String`	`TAG_PRODUCTS_TIME_VIEWED`
`protected static java.lang.String`	`TAG_PRODUCTS_VIEWED`
`protected static java.lang.String`	`TAG_REVIEW_PAGE_SIZE`
`protected static java.lang.String`	`TAG_SEARCH_STRING`
`static java.lang.String`	`TAG_WISHLIST_TOTAL` Customer tag
`protected static java.lang.String`	`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

BaseAction()

Constructors
Constructor and Description
`BaseAction()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`changeSession(javax.servlet.http.HttpServletRequest request)` Creates a new session when we switch to SSL to avoid hackers using the current session id (which may have been visible on the URL) to log into the application
`protected java.lang.String`	`checkSSL(KKAppEng eng, javax.servlet.http.HttpServletRequest request, int custId, boolean forceSSL)` Determines whether we are using SSL or not.
`protected java.lang.String`	`escapeFormInput(java.lang.String inputStr)` Common method used to encode certain characters.
`java.lang.String`	`getBaseURL(javax.servlet.http.HttpServletRequest request, boolean addContext)` Returns the base URL
`protected com.konakart.appif.CustomerEventIf`	`getCustomerEvent(KKAppEng kkAppEng, int action)` Returns a customer event object with the action and customer id attributes populated.
`protected java.lang.String`	`getForward(javax.servlet.http.HttpServletRequest request, java.lang.Exception e, java.lang.String cause, java.lang.String message, java.lang.String forward)` If the application sends us a KKException with the cause equal to a more detailed exception such as KKPasswordDoesntMatchException, sometimes the application has to be able to detect this so that it can handle the exception by sending an error message back to the screen.
`KKAppEng`	`getJspEng()`
`protected KKAppEng`	`getKKAppEng(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)` Sets the variable kkAppEng to the KKAppEng instance saved in the session.
`protected java.lang.String`	`getKKCookie(java.lang.String attrId, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, KKAppEng kkAppEng)` Utility method to read a KKCookie.
`protected java.lang.String`	`getKKCookie(java.lang.String customerUuid, java.lang.String attrId, KKAppEng kkAppEng)` Utility method to read a KKCookie when we have the CustomerUuid
`java.lang.String`	`getRedirectURL(javax.servlet.http.HttpServletRequest request)` Returns the base redirect URL used in AJAX calls
`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 void`	`insertCustomerEvent(KKAppEng kkAppEng, int action)` Shortcut method for inserting a customer event passing no custom event data
`protected void`	`insertCustomerEvent(KKAppEng kkAppEng, int action, java.math.BigDecimal dec1)` Shortcut method for inserting a customer event passing a decimal as event data
`protected void`	`insertCustomerEvent(KKAppEng kkAppEng, int action, int int1)` Shortcut method for inserting a customer event passing an integer as event data
`protected void`	`insertCustomerEvent(KKAppEng kkAppEng, int action, java.lang.String str1)` Shortcut method for inserting a customer event passing a string as event data
`protected void`	`insertCustomerEvent(KKAppEng kkAppEng, int action, java.lang.String str1, java.lang.String str2, int int1, int int2, java.math.BigDecimal dec1, java.math.BigDecimal dec2)` Inserts a customer event where all of the available parameters are passed
`protected java.lang.String`	`kkURLEncode(java.lang.String in)` A URL encoder which converts spaces to "-" and doesn't encode forward or back slashes since many app servers don't accept these because of security issues.
`protected int`	`loggedIn(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, KKAppEng kkAppEng, java.lang.String forwardAfterLogin)` Checks to see whether we are logged in.
`protected int`	`loggedIn(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, KKAppEng kkAppEng, java.lang.String forwardAfterLogin, boolean checkXSRF, java.lang.String xsrfToken)` Checks to see whether we are logged in.
`protected int`	`loggedIn(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, KKAppEng kkAppEng, java.lang.String forwardAfterLogin, java.lang.String xsrfToken)` Checks to see whether we are logged in.
`protected com.konakart.appif.LoginResultIf`	`login(KKAppEng kkAppEng, javax.servlet.http.HttpServletRequest request, java.lang.String loginUsername, java.lang.String password)` Method changes the session before performing the login in order to avoid a Session Fixation attack.
`protected void`	`manageCookieLogout(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, KKAppEng kkAppEng)` When we log out, ensure that the new guest customer that is created has the id saved in the browser cookie.
`java.lang.String`	`noNull(java.lang.String in)` Utility method called from JSPs to return an empty string when the value of the input string is null.
`void`	`setJspEng(KKAppEng jspEng)`
`protected void`	`setKKCookie(java.lang.String attrId, java.lang.String attrValue, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, KKAppEng kkAppEng)` Utility method that can be used to set a KKCookie.
`protected void`	`setKKCookie(java.lang.String customerUuid, java.lang.String attrId, java.lang.String attrValue, KKAppEng kkAppEng)` Utility method to set a KKCookie when we have the customerUuid
`void`	`setServletRequest(javax.servlet.http.HttpServletRequest arg0)` Required for implementing ServletRequestAware interface
`void`	`setSession(java.util.Map<java.lang.String,java.lang.Object> session)` Required for implementing SessionAware interface
`protected void`	`setupResponseForSEORedirect(javax.servlet.http.HttpServletResponse response)` Common code for setting up the redirect response.
`protected void`	`setupResponseForSSLRedirect(javax.servlet.http.HttpServletResponse response, java.lang.String redirForward)` Common code for setting up the redirect response when switching from HTTP to HTTPS and vice versa
`protected void`	`updateRecentlyViewedProducts(KKAppEng kkAppEng, com.konakart.appif.CustomerTagIf oldTag, com.konakart.appif.CustomerTagIf newTag)` Method called when a customer logs in or logs out.

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.
  - KKLOGIN
```
protected static final java.lang.String KKLOGIN
```
    See Also:
    
    Constant Field Values
  - WELCOME
```
protected static final java.lang.String WELCOME
```
    See Also:
    
    Constant Field Values
  - GUEST_CUSTOMER_ID
```
protected static final java.lang.String GUEST_CUSTOMER_ID
```
    See Also:
    
    Constant Field Values
  - CUSTOMER_LOCALE
```
protected static final java.lang.String CUSTOMER_LOCALE
```
    See Also:
    
    Constant Field Values
  - CUSTOMER_NAME
```
protected static final java.lang.String CUSTOMER_NAME
```
    See Also:
    
    Constant Field Values
  - CUSTOMER_UUID
```
protected static final java.lang.String CUSTOMER_UUID
```
    See Also:
    
    Constant Field Values
  - AGREED_COOKIES
```
protected static final java.lang.String AGREED_COOKIES
```
    See Also:
    
    Constant Field Values
  - COOKIE_MAX_AGE_IN_SECS
```
protected static final int COOKIE_MAX_AGE_IN_SECS
```
    See Also:
    
    Constant Field Values
  - ACTION_NEW_CUSTOMER_VISIT
```
protected static final int ACTION_NEW_CUSTOMER_VISIT
```
    See Also:
    
    Constant Field Values
  - ACTION_CUSTOMER_LOGIN
```
protected static final int ACTION_CUSTOMER_LOGIN
```
    See Also:
    
    Constant Field Values
  - ACTION_ENTER_CHECKOUT
```
protected static final int ACTION_ENTER_CHECKOUT
```
    See Also:
    
    Constant Field Values
  - ACTION_CONFIRM_ORDER
```
protected static final int ACTION_CONFIRM_ORDER
```
    See Also:
    
    Constant Field Values
  - ACTION_PAYMENT_METHOD_SELECTED
```
protected static final int ACTION_PAYMENT_METHOD_SELECTED
```
    See Also:
    
    Constant Field Values
  - ACTION_REMOVE_FROM_CART
```
protected static final int ACTION_REMOVE_FROM_CART
```
    See Also:
    
    Constant Field Values
  - ACTION_PRODUCT_VIEWED
```
protected static final int ACTION_PRODUCT_VIEWED
```
    See Also:
    
    Constant Field Values
  - TAG_PRODUCTS_TIME_VIEWED
```
protected static final java.lang.String TAG_PRODUCTS_TIME_VIEWED
```
    See Also:
    
    Constant Field Values
  - TAG_PRODUCTS_VIEWED
```
protected static final java.lang.String TAG_PRODUCTS_VIEWED
```
    See Also:
    
    Constant Field Values
  - TAG_CATEGORIES_VIEWED
```
protected static final java.lang.String TAG_CATEGORIES_VIEWED
```
    See Also:
    
    Constant Field Values
  - TAG_CATEGORIES_TIME_VIEWED
```
protected static final java.lang.String TAG_CATEGORIES_TIME_VIEWED
```
    See Also:
    
    Constant Field Values
  - TAG_MANUFACTURERS_VIEWED
```
protected static final java.lang.String TAG_MANUFACTURERS_VIEWED
```
    See Also:
    
    Constant Field Values
  - TAG_MANUFACTURERS_TIME_VIEWED
```
protected static final java.lang.String TAG_MANUFACTURERS_TIME_VIEWED
```
    See Also:
    
    Constant Field Values
  - TAG_SEARCH_STRING
```
protected static final java.lang.String TAG_SEARCH_STRING
```
    See Also:
    
    Constant Field Values
  - TAG_COUNTRY_CODE
```
protected static final java.lang.String TAG_COUNTRY_CODE
```
    See Also:
    
    Constant Field Values
  - TAG_BIRTH_DATE
```
protected static final java.lang.String TAG_BIRTH_DATE
```
    See Also:
    
    Constant Field Values
  - TAG_LOGIN_DATE
```
protected static final java.lang.String TAG_LOGIN_DATE
```
    See Also:
    
    Constant Field Values
  - TAG_IS_MALE
```
protected static final java.lang.String TAG_IS_MALE
```
    See Also:
    
    Constant Field Values
  - TAG_PROD_PAGE_SIZE
```
protected static final java.lang.String TAG_PROD_PAGE_SIZE
```
    See Also:
    
    Constant Field Values
  - TAG_ORDER_PAGE_SIZE
```
protected static final java.lang.String TAG_ORDER_PAGE_SIZE
```
    See Also:
    
    Constant Field Values
  - TAG_REVIEW_PAGE_SIZE
```
protected static final java.lang.String TAG_REVIEW_PAGE_SIZE
```
    See Also:
    
    Constant Field Values
  - SEO_DELIM
```
protected static final java.lang.String SEO_DELIM
```
    See Also:
    
    Constant Field Values
  - SEO_TYPE
```
protected static final java.lang.String SEO_TYPE
```
    See Also:
    
    Constant Field Values
  - SEO_TYPE_LENGTH
```
protected static final int SEO_TYPE_LENGTH
```
  - SEO_SEL_CAT_CODE
```
protected static final int SEO_SEL_CAT_CODE
```
    See Also:
    
    Constant Field Values
  - SEO_SEL_CAT
```
protected static final java.lang.String SEO_SEL_CAT
```
    See Also:
    
    Constant Field Values
  - SEO_SEL_PROD_CODE
```
protected static final int SEO_SEL_PROD_CODE
```
    See Also:
    
    Constant Field Values
  - SEO_SEL_PROD
```
protected static final java.lang.String SEO_SEL_PROD
```
    See Also:
    
    Constant Field Values
  - SEO_SEARCH_BY_MANU_BY_LINK_CODE
```
protected static final int SEO_SEARCH_BY_MANU_BY_LINK_CODE
```
    See Also:
    
    Constant Field Values
  - SEO_SEARCH_BY_MANU_BY_LINK
```
protected static final java.lang.String SEO_SEARCH_BY_MANU_BY_LINK
```
    See Also:
    
    Constant Field Values
  - SEO_PRODS_FOR_MANU_CODE
```
protected static final int SEO_PRODS_FOR_MANU_CODE
```
    See Also:
    
    Constant Field Values
  - SEO_PRODS_FOR_MANU
```
protected static final java.lang.String SEO_PRODS_FOR_MANU
```
    See Also:
    
    Constant Field Values
  - SEO_OFF
```
protected static final int SEO_OFF
```
    See Also:
    
    Constant Field Values
  - SEO_PARAMETERS
```
protected static final int SEO_PARAMETERS
```
    See Also:
    
    Constant Field Values
  - SEO_DIRECTORY
```
protected static final int SEO_DIRECTORY
```
    See Also:
    
    Constant Field Values
  - TAG_PRODUCTS_IN_CART
```
public static final java.lang.String TAG_PRODUCTS_IN_CART
```
    Customer tag
    
    See Also:
    
    Constant Field Values
  - TAG_PRODUCTS_TIME_IN_CART
```
public static final java.lang.String TAG_PRODUCTS_TIME_IN_CART
```
    Customer tag
    
    See Also:
    
    Constant Field Values
  - TAG_PRODUCTS_IN_WISHLIST
```
public static final java.lang.String TAG_PRODUCTS_IN_WISHLIST
```
    Customer tag
    
    See Also:
    
    Constant Field Values
  - TAG_PRODUCTS_TIME_IN_WISHLIST
```
public static final java.lang.String TAG_PRODUCTS_TIME_IN_WISHLIST
```
    Customer tag
    
    See Also:
    
    Constant Field Values
  - TAG_CART_TOTAL
```
public static final java.lang.String TAG_CART_TOTAL
```
    Customer tag
    
    See Also:
    
    Constant Field Values
  - TAG_WISHLIST_TOTAL
```
public static final java.lang.String TAG_WISHLIST_TOTAL
```
    Customer tag
    
    See Also:
    
    Constant Field Values
  - strutsSession
```
public java.util.Map<java.lang.String,java.lang.Object> strutsSession
```
    Struts session
  - appEng
```
protected static KKAppEng appEng
```
    Copy of the KKAppEng
  - MY_ACCOUNT_URL
```
protected static final java.lang.String MY_ACCOUNT_URL
```
    To set the url in the breadcrumb for My Account
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BaseAction
```
public BaseAction()
```
- Method Detail
  - getKKAppEng
```
protected KKAppEng getKKAppEng(javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response)
                        throws KKAppException,
                               com.konakart.app.KKException
```
    Sets the variable kkAppEng to the KKAppEng instance saved in the session. If cannot be found, then it is instantiated and attached.
    
    Parameters:
    
    request - the HttpServletRequest request
    
    response - the HttpServletResponse response
    
    Returns:
    
    Returns a KonaKart client engine instance
    
    Throws:
    
    com.konakart.app.KKException - unexpected exception in KonaKart
    
    KKAppException - unexpected exception in the application engine
  - 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
    
    Parameters:
    
    request - the HttpServletRequest request
    
    e - Exception to handle
    
    Returns:
    
    Returns a string
  - loggedIn
```
protected int loggedIn(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response,
                       KKAppEng kkAppEng,
                       java.lang.String forwardAfterLogin)
                throws com.konakart.app.KKException,
                       KKAppException
```
    Checks to see whether we are logged in.
    
    Parameters:
    
    kkAppEng - The KonaKart client engine instance
    
    forwardAfterLogin - tells us which page to forward to after login.
    
    request - the HttpServletRequest request
    
    response - the HttpServletResponse response
    
    Returns:
    
    Returns the CustomerId if logged in. Otherwise a negative number.
    
    Throws:
    
    com.konakart.app.KKException - unexpected exception in KonaKart
    
    KKAppException - unexpected exception in the application engine
  - loggedIn
```
protected int loggedIn(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response,
                       KKAppEng kkAppEng,
                       java.lang.String forwardAfterLogin,
                       java.lang.String xsrfToken)
                throws com.konakart.app.KKException,
                       KKAppException
```
    Checks to see whether we are logged in.
    
    Parameters:
    
    kkAppEng - The KonaKart client engine instance
    
    forwardAfterLogin - tells us which page to forward to after login.
    
    request - the HttpServletRequest request
    
    response - the HttpServletResponse response
    
    xsrfToken - XSRF token
    
    Returns:
    
    Returns the CustomerId if logged in. Otherwise a negative number.
    
    Throws:
    
    com.konakart.app.KKException - unexpected exception in KonaKart
    
    KKAppException - unexpected exception in the application engine
  - loggedIn
```
protected int loggedIn(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response,
                       KKAppEng kkAppEng,
                       java.lang.String forwardAfterLogin,
                       boolean checkXSRF,
                       java.lang.String xsrfToken)
                throws com.konakart.app.KKException,
                       KKAppException
```
    Checks to see whether we are logged in.
    
    Parameters:
    
    kkAppEng - The KonaKart client engine instance
    
    forwardAfterLogin - tells us which page to forward to after login.
    
    request - the HttpServletRequest request
    
    response - the HttpServletResponse response
    
    checkXSRF - whether or not to check the XSRF token
    
    xsrfToken - XSRF token
    
    Returns:
    
    Returns the CustomerId if logged in. Otherwise a negative number.
    
    Throws:
    
    com.konakart.app.KKException - unexpected exception in KonaKart
    
    KKAppException - unexpected exception in the application engine
  - getForward
```
protected java.lang.String getForward(javax.servlet.http.HttpServletRequest request,
                                      java.lang.Exception e,
                                      java.lang.String cause,
                                      java.lang.String message,
                                      java.lang.String forward)
```
    If the application sends us a KKException with the cause equal to a more detailed exception such as KKPasswordDoesntMatchException, sometimes the application has to be able to detect this so that it can handle the exception by sending an error message back to the screen.
    
    Parameters:
    
    request - the HttpServletRequest request
    
    e - The exception that has been captured
    
    cause - The name of the cause Exception to look for i.e. KKPasswordDoesntMatchException
    
    message - The message to send out to the application
    
    forward - The forward if we detect the cause
    
    Returns:
    
    ActionForward
  - checkSSL
```
protected java.lang.String checkSSL(KKAppEng eng,
                                    javax.servlet.http.HttpServletRequest request,
                                    int custId,
                                    boolean forceSSL)
                             throws com.konakart.app.KKException
```
    Determines whether we are using SSL or not. If we are logged in, then we should be using SSL. SSL can also be forced by setting the forceSSL boolean. If we should be using SSL but aren't (or vice versa) we do a redirect by returning an action forward with the correct URL to redirect to. Otherwise we return null
    
    Parameters:
    
    eng - a KonaKart Application engine
    
    request - the HttpServletRequest request
    
    custId - The customer id
    
    forceSSL - Set to true if we should force SSL.
    
    Returns:
    
    ActionForward
    
    Throws:
    
    com.konakart.app.KKException - unexpected exception in KonaKart
  - setKKCookie
```
protected void setKKCookie(java.lang.String attrId,
                           java.lang.String attrValue,
                           javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response,
                           KKAppEng kkAppEng)
                    throws com.konakart.app.KKException
```
    Utility method that can be used to set a KKCookie. It attempts to get the UUID from the browser cookie and creates a new browser cookie if it doesn't find one.
    
    Parameters:
    
    attrId - the attrId
    
    attrValue - the attrValue
    
    request - the HttpServletRequest request
    
    response - the HttpServletResponse response
    
    kkAppEng - the kkAppEng
    
    Throws:
    
    com.konakart.app.KKException - unexpected exception in KonaKart
  - setKKCookie
```
protected void setKKCookie(java.lang.String customerUuid,
                           java.lang.String attrId,
                           java.lang.String attrValue,
                           KKAppEng kkAppEng)
                    throws com.konakart.app.KKException
```
    Utility method to set a KKCookie when we have the customerUuid
    
    Parameters:
    
    customerUuid - the customerUuid
    
    attrId - the attrId
    
    attrValue - the attrValue
    
    kkAppEng - the kkAppEng
    
    Throws:
    
    com.konakart.app.KKException - unexpected exception in KonaKart
  - getKKCookie
```
protected java.lang.String getKKCookie(java.lang.String attrId,
                                       javax.servlet.http.HttpServletRequest request,
                                       javax.servlet.http.HttpServletResponse response,
                                       KKAppEng kkAppEng)
                                throws com.konakart.app.KKException
```
    Utility method to read a KKCookie. It attempts to get the UUID from the browser cookie and creates a new browser cookie if it doesn't find one.
    
    Parameters:
    
    attrId - the attrId
    
    request - the HttpServletRequest request
    
    response - the HttpServletResponse response
    
    kkAppEng - the kkAppEng
    
    Returns:
    
    the value of the cookie
    
    Throws:
    
    com.konakart.app.KKException - unexpected exception in KonaKart
  - getKKCookie
```
protected java.lang.String getKKCookie(java.lang.String customerUuid,
                                       java.lang.String attrId,
                                       KKAppEng kkAppEng)
                                throws com.konakart.app.KKException
```
    Utility method to read a KKCookie when we have the CustomerUuid
    
    Parameters:
    
    customerUuid - the customerUuid
    
    attrId - the attrId
    
    kkAppEng - the kkAppEng
    
    Returns:
    
    the value of the cookie
    
    Throws:
    
    com.konakart.app.KKException - unexpected exception in KonaKart
  - manageCookieLogout
```
protected void manageCookieLogout(javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response,
                                  KKAppEng kkAppEng)
                           throws com.konakart.app.KKException,
                                  KKAppException
```
    When we log out, ensure that the new guest customer that is created has the id saved in the browser cookie.
    
    Parameters:
    
    request - the HttpServletRequest request
    
    response - the HttpServletResponse response
    
    kkAppEng - the kkAppEng
    
    Throws:
    
    com.konakart.app.KKException - unexpected exception in KonaKart
    
    KKAppException - unexpected exception in the application engine
  - getCustomerEvent
```
protected com.konakart.appif.CustomerEventIf getCustomerEvent(KKAppEng kkAppEng,
                                                              int action)
```
    Returns a customer event object with the action and customer id attributes populated. If events aren't enabled, then null is returned.
    
    Parameters:
    
    kkAppEng - App eng instance
    
    action - Event action
    
    Returns:
    
    Returns a customer event object or null if events aren't enabled
  - insertCustomerEvent
```
protected void insertCustomerEvent(KKAppEng kkAppEng,
                                   int action,
                                   java.lang.String str1,
                                   java.lang.String str2,
                                   int int1,
                                   int int2,
                                   java.math.BigDecimal dec1,
                                   java.math.BigDecimal dec2)
                            throws com.konakart.app.KKException
```
    Inserts a customer event where all of the available parameters are passed
    
    Parameters:
    
    kkAppEng - App eng instance
    
    action - Event action
    
    str1 - the str1
    
    str2 - the str2
    
    int1 - the int1
    
    int2 - the int2
    
    dec1 - the dec1
    
    dec2 - the dec2
    
    Throws:
    
    com.konakart.app.KKException - unexpected exception in KonaKart
  - insertCustomerEvent
```
protected void insertCustomerEvent(KKAppEng kkAppEng,
                                   int action)
                            throws com.konakart.app.KKException
```
    Shortcut method for inserting a customer event passing no custom event data
    
    Parameters:
    
    kkAppEng - the kkAppEng
    
    action - the action
    
    Throws:
    
    com.konakart.app.KKException - unexpected exception in KonaKart
  - insertCustomerEvent
```
protected void insertCustomerEvent(KKAppEng kkAppEng,
                                   int action,
                                   int int1)
                            throws com.konakart.app.KKException
```
    Shortcut method for inserting a customer event passing an integer as event data
    
    Parameters:
    
    kkAppEng - the kkAppEng
    
    action - the action
    
    int1 - the int1
    
    Throws:
    
    com.konakart.app.KKException - unexpected exception in KonaKart
  - insertCustomerEvent
```
protected void insertCustomerEvent(KKAppEng kkAppEng,
                                   int action,
                                   java.lang.String str1)
                            throws com.konakart.app.KKException
```
    Shortcut method for inserting a customer event passing a string as event data
    
    Parameters:
    
    kkAppEng - the kkAppEng
    
    action - the action
    
    str1 - the str1
    
    Throws:
    
    com.konakart.app.KKException - unexpected exception in KonaKart
  - insertCustomerEvent
```
protected void insertCustomerEvent(KKAppEng kkAppEng,
                                   int action,
                                   java.math.BigDecimal dec1)
                            throws com.konakart.app.KKException
```
    Shortcut method for inserting a customer event passing a decimal as event data
    
    Parameters:
    
    kkAppEng - the kkAppEng
    
    action - the action
    
    dec1 - the dec1
    
    Throws:
    
    com.konakart.app.KKException - unexpected exception in KonaKart
  - updateRecentlyViewedProducts
```
protected void updateRecentlyViewedProducts(KKAppEng kkAppEng,
                                            com.konakart.appif.CustomerTagIf oldTag,
                                            com.konakart.appif.CustomerTagIf newTag)
                                     throws KKAppException,
                                            com.konakart.app.KKException
```
    Method called when a customer logs in or logs out. When logging in we need to decide whether to update the customer's PRODUCTS_TIME_VIEWED tag value from the value of the guest customer's tag. When logging out we need to make the same decision in the opposite direction. We only do the updates if the tag value of the "oldTag" is more recent than the tag value of the "newTag".
    
    Parameters:
    
    kkAppEng - the KonaKart Application engine
    
    oldTag - When logging in, it is the tag of the guest customer. When logging out, it is the tag of the logged in customer.
    
    newTag - When logging in, it is the tag of the logged in customer. When logging out, it is the tag of the guest customer.
    
    Throws:
    
    com.konakart.app.KKException - unexpected exception in KonaKart
    
    KKAppException - unexpected exception in the application engine
  - login
```
protected com.konakart.appif.LoginResultIf login(KKAppEng kkAppEng,
                                                 javax.servlet.http.HttpServletRequest request,
                                                 java.lang.String loginUsername,
                                                 java.lang.String password)
                                          throws com.konakart.app.KKException,
                                                 KKAppException
```
    Method changes the session before performing the login in order to avoid a Session Fixation attack.
    
    Parameters:
    
    kkAppEng - the kkAppEng
    
    request - the HttpServletRequest request
    
    loginUsername - the loginUsername
    
    password - the password
    
    Returns:
    
    Return a LoginResult object containing the session id if successful
    
    Throws:
    
    com.konakart.app.KKException - unexpected exception in KonaKart
    
    KKAppException - unexpected exception in the application engine
  - changeSession
```
protected void changeSession(javax.servlet.http.HttpServletRequest request)
```
    Creates a new session when we switch to SSL to avoid hackers using the current session id (which may have been visible on the URL) to log into the application
    
    Parameters:
    
    request - the HttpServletRequest request
  - setupResponseForSEORedirect
```
protected void setupResponseForSEORedirect(javax.servlet.http.HttpServletResponse response)
```
    Common code for setting up the redirect response. A few headers are set to stop the browser from caching the permanent redirect.
    
    Parameters:
    
    response - the HttpServletResponse response
  - setupResponseForSSLRedirect
```
protected void setupResponseForSSLRedirect(javax.servlet.http.HttpServletResponse response,
                                           java.lang.String redirForward)
```
    Common code for setting up the redirect response when switching from HTTP to HTTPS and vice versa
    
    Parameters:
    
    response - the HttpServletResponse response
    
    redirForward - the redirect forward to set in the Location parameter in the header of the response
  - kkURLEncode
```
protected java.lang.String kkURLEncode(java.lang.String in)
                                throws java.io.UnsupportedEncodingException
```
    A URL encoder which converts spaces to "-" and doesn't encode forward or back slashes since many app servers don't accept these because of security issues.
    
    Parameters:
    
    in - the in
    
    Returns:
    
    Returns an encoded string
    
    Throws:
    
    java.io.UnsupportedEncodingException - an unexpected UnsupportedEncodingException exception
  - setServletRequest
```
public void setServletRequest(javax.servlet.http.HttpServletRequest arg0)
```
    Required for implementing ServletRequestAware interface
    
    Specified by:
    
    setServletRequest in interface org.apache.struts2.interceptor.ServletRequestAware
  - setSession
```
public void setSession(java.util.Map<java.lang.String,java.lang.Object> session)
```
    Required for implementing SessionAware interface
    
    Specified by:
    
    setSession in interface org.apache.struts2.interceptor.SessionAware
  - noNull
```
public java.lang.String noNull(java.lang.String in)
```
    Utility method called from JSPs to return an empty string when the value of the input string is null.
    
    Parameters:
    
    in - the in
    
    Returns:
    
    Returns an empty string if the input string is null
  - getRedirectURL
```
public java.lang.String getRedirectURL(javax.servlet.http.HttpServletRequest request)
```
    Returns the base redirect URL used in AJAX calls
    
    Parameters:
    
    request - the HttpServletRequest request
    
    Returns:
    
    Returns the base redirect URL used in AJAX calls
  - getBaseURL
```
public java.lang.String getBaseURL(javax.servlet.http.HttpServletRequest request,
                                   boolean addContext)
```
    Returns the base URL
    
    Parameters:
    
    request - the HttpServletRequest request
    
    addContext - If true the result looks like http://localhost:8780/konakart otherwise it's like http://localhost:8780
    
    Returns:
    
    Returns the base URL
  - getJspEng
```
public KKAppEng getJspEng()
```
    Returns:
    
    the jspEng
  - setJspEng
```
public void setJspEng(KKAppEng jspEng)
```
    Parameters:
    
    jspEng - the jspEng to set
  - escapeFormInput
```
protected java.lang.String escapeFormInput(java.lang.String inputStr)
```
    Common method used to encode certain characters. The default is now to use the Guava Escaper that only escapes the following five dangerous ASCII characters '"&<> since most people use UTF-8 encoding. If you want to encode many more HTML characters you can use the Apache StringEscapeUtils as follows
    return StringEscapeUtils.escapeHtml4(inputStr);
    
    Parameters:
    
    inputStr - the inputStr
    
    Returns:
    
    Returns the cleaned string

Class BaseAction

Field Summary

Fields inherited from class com.opensymphony.xwork2.ActionSupport

Fields inherited from interface com.opensymphony.xwork2.Action

Constructor Summary

Method Summary

Methods inherited from class com.opensymphony.xwork2.ActionSupport

Methods inherited from class java.lang.Object

Field Detail

log

KKLOGIN

WELCOME

GUEST_CUSTOMER_ID

CUSTOMER_LOCALE

CUSTOMER_NAME

CUSTOMER_UUID

AGREED_COOKIES

COOKIE_MAX_AGE_IN_SECS

ACTION_NEW_CUSTOMER_VISIT

ACTION_CUSTOMER_LOGIN

ACTION_ENTER_CHECKOUT

ACTION_CONFIRM_ORDER

ACTION_PAYMENT_METHOD_SELECTED

ACTION_REMOVE_FROM_CART

ACTION_PRODUCT_VIEWED

TAG_PRODUCTS_TIME_VIEWED

TAG_PRODUCTS_VIEWED

TAG_CATEGORIES_VIEWED

TAG_CATEGORIES_TIME_VIEWED

TAG_MANUFACTURERS_VIEWED

TAG_MANUFACTURERS_TIME_VIEWED

TAG_SEARCH_STRING

TAG_COUNTRY_CODE

TAG_BIRTH_DATE

TAG_LOGIN_DATE

TAG_IS_MALE

TAG_PROD_PAGE_SIZE

TAG_ORDER_PAGE_SIZE

TAG_REVIEW_PAGE_SIZE

SEO_DELIM

SEO_TYPE

SEO_TYPE_LENGTH

SEO_SEL_CAT_CODE

SEO_SEL_CAT

SEO_SEL_PROD_CODE

SEO_SEL_PROD

SEO_SEARCH_BY_MANU_BY_LINK_CODE

SEO_SEARCH_BY_MANU_BY_LINK

SEO_PRODS_FOR_MANU_CODE

SEO_PRODS_FOR_MANU

SEO_OFF

SEO_PARAMETERS

SEO_DIRECTORY

TAG_PRODUCTS_IN_CART

TAG_PRODUCTS_TIME_IN_CART

TAG_PRODUCTS_IN_WISHLIST

TAG_PRODUCTS_TIME_IN_WISHLIST

TAG_CART_TOTAL

TAG_WISHLIST_TOTAL

strutsSession

appEng

MY_ACCOUNT_URL

Constructor Detail

BaseAction

Method Detail

getKKAppEng

handleException

loggedIn

loggedIn

loggedIn

getForward

checkSSL

setKKCookie

setKKCookie

getKKCookie

getKKCookie

manageCookieLogout

getCustomerEvent

insertCustomerEvent

insertCustomerEvent