com.konakart.bl

Class SecurityMgrEE

java.lang.Object

com.konakart.bl.BaseMgr

com.konakart.bl.SecurityMgr

com.konakart.bl.SecurityMgrEE

All Implemented Interfaces:

SecurityMgrIf

Direct Known Subclasses:

SecurityMgrWond

public class SecurityMgrEE
extends SecurityMgr
implements SecurityMgrIf

Security Management

Nested Class Summary

Nested classes/interfaces inherited from class com.konakart.bl.SecurityMgr

SecurityMgr.LoginAttempt, SecurityMgr.StaticData

Field Summary

Fields inherited from class com.konakart.bl.SecurityMgr

availableChars, DEFAULT_PASSWORD_CHARACTERS, log, mutex, staticDataHM

Fields inherited from class com.konakart.bl.BaseMgr

templateBaseDir

Constructor Summary

Constructors

Constructor and Description
SecurityMgrEE(KKEngIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
void	addCustomDataToSession(java.lang.String sessionId, java.lang.String data, int position) A sessionId is created when a customer logs in to KonaKart using the login() API call.
protected com.konakart.app.KKException	createNotFoundException(java.lang.String username, int usernameType) Creates an exception depending on the usernameType
ExternalLoginResult	externalLogin(ExternalLoginInputIf loginInfo) Used for logging in customers using a mechanism outside of KonaKart such as social login using Facebook.
java.lang.String	getCustomDataFromSession(java.lang.String sessionId, int position) A sessionId is created when a customer logs in to KonaKart using the login() API call.
protected void	setCriteriaForUsernameType(java.lang.String username, int usernameType, KKCriteria c) Sets the criteria depending on the username type
CaptchaResultIf	validateCaptcha(CaptchaInputIf captchaInfo) Used for validate captcha

Methods inherited from class com.konakart.bl.SecurityMgr

byteToHex, changePassword, checkAdminSession, checkFileAccess, checkPassword, checkPassword, checkSession, createSessionId, enableCustomer, encrypt, externalCredentialsCheck, getAvailableChars, getExpiryTimeInSecs, getLDAPMgr, getLoginIntegrationMgr, getPermittedLocations, getRandomPassword, getSessionDurationInSecs, getSessionUpdateThresholdInSecs, getSSOToken, getStaticDataHM, getTimeInSecs, insertSessionId, isUserBlocked, login, login, loginByAdmin, loginWithOptions, logout, refreshConfigs, removeSession, removeUser, saveSSOToken, sendNewPassword, sendNewPassword1, setAvailableChars, setNewPassword, toHexChar, validatePassword

Methods inherited from class com.konakart.bl.BaseMgr

acquireLock, addInsertAttr, addInsertAttr, addStringRuleConstraint, addStringRuleConstraint, checkRequired, escapeHTML, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, getAdminEngMgr, getBasketMgr, getBillingMgr, getBookableProductMgr, getCacheMgr, getCatMgr, getConfigMgr, getCookieMgr, getCurrMgr, getCustMgr, getCustomerIdFromSession, getCustomerStatsMgr, getCustomerTagMgr, getEmailMgr, getEng, getEventMgr, getExportMgr, getHTMLEscaper, getKonaKartConfig, getKonaKartConfig, getKonaKartConfig, getLangMgr, getManuMgr, getMiscItemMgr, getMiscPriceMgr, getMode, getModeString, getMqMgr, getMultiStoreMgr, getNewCriteria, getNewCriteria, getOrderIntegrationMgr, getOrderMgr, getOrderTotalMgr, getPaymentMgr, getProdMgr, getProductsToCategoresCriteria, getPromMgr, getPunchOutMgr, getRewardPointMgr, getSecMgr, getShippingMgr, getSolrMgr, getStoreId, getStoreMgr, getStoreTime, getSuggestionMgr, getTaxMgr, getTemplate, getTemplateRoot, getVelocityContextMgr, getWishListMgr, init, insertKKEvent, insertKKEvent, isBusiness, isBusinessOrEnterprise, isClassPresent, isCommunity, isDeadlockException, isEnterprise, isMultiStoreShareCategories, isMultiStoreShareCustomers, isMultiStoreShareCustomersOrProducts, isMultiStoreSharedDb, isMultiStoreShareProducts, isMultiVendor, isUnix, manageThrowable, releaseLock, updateStaticVariablesNow

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.konakart.blif.SecurityMgrIf

changePassword, checkAdminSession, checkFileAccess, checkSession, enableCustomer, encrypt, getRandomPassword, getSSOToken, getTimeInSecs, login, login, loginByAdmin, loginWithOptions, logout, refreshConfigs, saveSSOToken, sendNewPassword, sendNewPassword1, setNewPassword, validatePassword

Constructor Detail

SecurityMgrEE

public SecurityMgrEE(KKEngIf eng)
              throws java.lang.Exception

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

addCustomDataToSession

public void addCustomDataToSession(java.lang.String sessionId,
                                   java.lang.String data,
                                   int position)
                            throws org.apache.torque.TorqueException,
                                   com.konakart.app.KKException

A sessionId is created when a customer logs in to KonaKart using the login() API call. This sessionId is persisted in the database in a table which has 5 custom fields. This method allows you to store data in these custom fields which can later be retrieved by using the sessionId as the key.

Specified by:

addCustomDataToSession in interface SecurityMgrIf

Overrides:

addCustomDataToSession in class SecurityMgr

Parameters:

sessionId - The sessionId

data - The data to be saved

position - This must be in the range of 1-5 to identify custom1 to custom5

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

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

getCustomDataFromSession

public java.lang.String getCustomDataFromSession(java.lang.String sessionId,
                                                 int position)
                                          throws com.konakart.app.KKException,
                                                 org.apache.torque.TorqueException,
                                                 com.workingdogs.village.DataSetException

A sessionId is created when a customer logs in to KonaKart using the login() API call. This sessionId is persisted in the database in a table which has 5 custom fields. This method allows you to retrieve the data in these custom fields by passing the sessionId as the key and a pointer to identify the custom field to be used.

Specified by:

getCustomDataFromSession in interface SecurityMgrIf

Overrides:

getCustomDataFromSession in class SecurityMgr

Parameters:

sessionId - The sessionId

position - This must be in the range of 1-5 to identify custom1 to custom5

Returns:

Returns the custom data

Throws:

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

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

externalLogin

public ExternalLoginResult externalLogin(ExternalLoginInputIf loginInfo)
                                  throws java.lang.Exception

Used for logging in customers using a mechanism outside of KonaKart such as social login using Facebook. The ExternalLoginInput parameter contains the class name of the module that will perform the login. This module ( which implements com.konakart.bl.modules.others.ExternalLoginInterface) must be present in the system and must have been installed and activated.

The function of this method is to instantiate the module, to call its externalLogin method and to return the result from the module which should contain a KonaKart sessionId if the login was successful.

Specified by:

externalLogin in interface SecurityMgrIf

Overrides:

externalLogin in class SecurityMgr

Parameters:

loginInfo - Contains the information required by the module to perform the login

Returns:

Returns an ExternalLoginResult method containing a KonaKart sessionId if the login was successful

Throws:

java.lang.Exception - an unexpected exception

setCriteriaForUsernameType

protected void setCriteriaForUsernameType(java.lang.String username,
                                          int usernameType,
                                          KKCriteria c)
                                   throws com.konakart.app.KKException

Sets the criteria depending on the username type

Overrides:

setCriteriaForUsernameType in class SecurityMgr

Parameters:

username - the username

usernameType - the usernameType

c - the c

Throws:

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

createNotFoundException

protected com.konakart.app.KKException createNotFoundException(java.lang.String username,
                                                               int usernameType)

Creates an exception depending on the usernameType

Overrides:

createNotFoundException in class SecurityMgr

Parameters:

username - the username

usernameType - the usernameType

Returns:

KKException

validateCaptcha

public CaptchaResultIf validateCaptcha(CaptchaInputIf captchaInfo)
                                throws java.lang.Exception

Used for validate captcha

Specified by:

validateCaptcha in interface SecurityMgrIf

Overrides:

validateCaptcha in class SecurityMgr

Parameters:

captchaInfo - Contains the information required by the module to perform the validation

Returns:

Returns an CaptchaResult if the validation was successful

Throws:

java.lang.Exception - an unexpected exception