| 
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectatg.nucleus.logging.VariableArgumentApplicationLoggingImpl
atg.nucleus.GenericService
atg.droplet.EmptyFormHandler
atg.droplet.GenericFormHandler
atg.userprofiling.ProfileForm
atg.userprofiling.ProfileFormHandler
atg.scenario.userprofiling.ScenarioProfileFormHandler
atg.commerce.profile.CommerceProfileFormHandler
atg.projects.store.profile.StoreProfileFormHandler
atg.projects.store.profile.CheckoutProfileFormHandler
public class CheckoutProfileFormHandler
This is an EStore's form handler to be used when logging in a user during the checkout process. This form handler supports three operations:
loginSuccessURL and loginErrorURL properties are being used by this form handler
 (though it can log out a user).
 emailAddress property. User's password must be specified with the
 value.password property.
| Nested Class Summary | 
|---|
| Nested classes/interfaces inherited from class atg.userprofiling.ProfileForm | 
|---|
atg.userprofiling.ProfileForm.ProfileFormHashtableWrapper | 
| Field Summary | |
|---|---|
static java.lang.String | 
CLASS_VERSION
Class version string.  | 
static java.lang.String | 
LOGIN_DURING_CHECKOUT_PARAMETER
The name of request parameter indicating whether user is logging in during checkout.  | 
protected static java.lang.String | 
NEW_EMAIL_ADDRESS
 | 
| Fields inherited from class atg.userprofiling.ProfileFormHandler | 
|---|
mClearValuesOnCreate, mClearValuesOnLogin, mClearValuesOnUpdate | 
| Fields inherited from class atg.userprofiling.ProfileForm | 
|---|
CONFIRMPASSWORD_PARAM, DEFAULT_CREATE_PROFILE_TYPE, DEFAULT_LOGIN_PROFILE_TYPE, DEFAULT_LOGOUT_PROFILE_TYPE, HANDLE_CREATE, HANDLE_CREATE_PARAM, HANDLE_FAILURE, HANDLE_LOGIN, HANDLE_LOGIN_PARAM, HANDLE_SUCCESS, ID_NAME, mAuthenticationMessageTrigger, mBadPasswordDelay, mChangePasswordErrorURL, mChangePasswordSuccessURL, mCheckForRequiredParameters, mCheckForRequiredProperties, mCheckForRequiredPropertiesAfterUpdate, mCompareValueInCopyPropertiesOnLogin, mConfirmOldPassword, mConfirmPassword, mCreateErrorURL, mCreateProfileType, mCreateSuccessURL, mDeleteErrorURL, mDeleteSuccessURL, mExpireSessionOnLogout, mExtractDefaultValuesFromProfile, mLoginErrorURL, mLoginProfileType, mLoginSuccessURL, mLogoutErrorURL, mLogoutProfileType, mLogoutSuccessURL, mProfileTools, mPropertiesToAddOnLogin, mPropertiesToCopyOnLogin, mRepositoryId, MSG_ERR_CREATING_PROFILE, MSG_ERR_DELETING_PROFILE, MSG_ERR_UPDATING_PROFILE, MSG_ILLEGAL_ARGUMENT, MSG_INVALID_ADD_PROPERTY, MSG_INVALID_LOGIN, MSG_MISSING_LOGIN, MSG_MISSING_OLD_PASSWORD, MSG_MISSING_PASSWORD, MSG_MISSING_PROFILE, MSG_MISSING_PROFILE_TOOLS, MSG_MISSING_REQUIRED_PROPERTY, MSG_NO_SUCH_PROFILE_PROPERTY, MSG_NO_TYPE_CONVERTER, MSG_PASSWORD_SAME_AS_OLD_PASSWORD, MSG_PASSWORDS_DO_NOT_MATCH, MSG_PERMISSION_DEFINED_PASSWORD_CHANGE, MSG_READ_ONLY_PROFILE_PROPERTY, MSG_TYPE_CONVERSION_ERR, MSG_USER_ALREADY_EXISTS, MSG_WARNING_PROFILE_TOOLS, mSwapEventListeners, mTrimProperties, mUpdateErrorURL, mUpdateSuccessURL, mUserLoginManager, mUsingLdapProfile, mValue, NULL_SENTINEL, OLDPASSWORD_PARAM, REPOSITORY_ID_PROPERTY_NAME, RESOURCE_BUNDLE_NAME, STATUS_ERROR_REDIRECT, STATUS_ERROR_STAY, STATUS_SUCCESS | 
| Fields inherited from class atg.droplet.GenericFormHandler | 
|---|
PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS | 
| Fields inherited from class atg.nucleus.GenericService | 
|---|
SERVICE_INFO_KEY | 
| Fields inherited from interface atg.scenario.ScenarioConstants | 
|---|
ATTR_SCENARIO_REDIRECT, PROPERTY_REFERENCE_TARGET, PROPERTY_REFERENCE_TYPE, PROPERTY_SCENARIO_INSTANCES, PROPERTY_SLOT_INSTANCES | 
| Fields inherited from interface atg.process.ProcessConstants | 
|---|
COLLECTIVE_CLONE_PROPERTIES, DEFAULT_INITIAL_TIME_DELAY, DEFAULT_MAX_BATCH_SIZE, DEFAULT_PROCESS_FILE_EXTENSION, DEFAULT_TEMPLATE_FILE_EXTENSION, INDIVIDUAL_CLONE_PROPERTIES, INPUT_PORT_BATCH_TIMER, INPUT_PORT_COLLECTIVE_TIMER, INPUT_PORT_DISABLE_PROCESS, INPUT_PORT_GLOBAL_EVENT, INPUT_PORT_INDIVIDUAL_EVENT, INPUT_PORT_INDIVIDUAL_TIMER, INPUT_PORT_MIGRATION_UPDATE, INPUT_PORT_PROCESS_UPDATE, INPUT_PORT_SEGMENT_START_TIMER, JMS_TYPE_BATCH_TIMER, JMS_TYPE_COLLECTIVE_TIMER, JMS_TYPE_DISABLE_PROCESS, JMS_TYPE_INDIVIDUAL_TIMER, JMS_TYPE_MIGRATION_DELETE, JMS_TYPE_MIGRATION_UPDATE, JMS_TYPE_PROCESS_UPDATE, MIGRATION_STATUS_DONE, MIGRATION_STATUS_IN_PROGRESS, OUTPUT_PORT_BATCH_TIMER, OUTPUT_PORT_COLLECTIVE_TIMER, OUTPUT_PORT_INDIVIDUAL_TIMER, OUTPUT_PORT_MIGRATION_UPDATE, OUTPUT_PORT_PROCESS_UPDATE, OUTPUT_PORT_SEGMENT_START_TIMER, PROPERTY_AUTHOR, PROPERTY_COLLECTIVE_INSTANCE, PROPERTY_CONTEXT_BOOLEANS, PROPERTY_CONTEXT_DATES, PROPERTY_CONTEXT_DOUBLES, PROPERTY_CONTEXT_LONGS, PROPERTY_CONTEXT_STRINGS, PROPERTY_COUNT, PROPERTY_CREATED_BY_RECURRING_EVENT, PROPERTY_CREATION_TIME, PROPERTY_CREATOR_ID, PROPERTY_EVENT_TYPE, PROPERTY_ID, PROPERTY_LAST_MODIFIED_BY, PROPERTY_LAST_QUERY_ID, PROPERTY_MESSAGE_BEAN, PROPERTY_MIGRATION_INFO, PROPERTY_MIGRATION_INFOS, PROPERTY_MIGRATION_STATUS, PROPERTY_MODIFICATION_TIME, PROPERTY_NEW_MODIFICATION_TIME, PROPERTY_NUM_TRANSITION_RETRIES, PROPERTY_OLD_MODIFICATION_TIME, PROPERTY_PDL, PROPERTY_PROCESS_INFO, PROPERTY_PROCESS_NAME, PROPERTY_PROCESS_STATUS, PROPERTY_SEGMENT_NAME, PROPERTY_SEGMENT_NAMES, PROPERTY_SERVER_ID, PROPERTY_SERVER_TYPE, PROPERTY_STATE, PROPERTY_STATE_MACHINE_VERSION, PROPERTY_STEP, PROPERTY_SUBJECT, PROPERTY_TEMPLATE_NAME, STEP_ACTIONS_1, STEP_ACTIONS_2, STEP_NEXT_STATE_1, STEP_NEXT_STATE_2, UNDEFINED_TIMESTAMP_VALUE, WILDCARD_MATCH_ALL | 
| Fields inherited from interface atg.scenario.targeting.SlotConstants | 
|---|
PROFILE_SLOT_TYPE, PROPERTY_ID, PROPERTY_SLOT_ITEMS, PROPERTY_SLOT_NAME, PROPERTY_SLOT_OFFSET, PROPERTY_SLOT_PRIORITIES, PROPERTY_SLOT_PROFILE, TRANS_MGR | 
| Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging | 
|---|
DEFAULT_LOG_TRACE_STATUS | 
| Fields inherited from interface atg.nucleus.logging.ApplicationLogging | 
|---|
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS | 
| Constructor Summary | |
|---|---|
CheckoutProfileFormHandler()
 | 
|
| Method Summary | |
|---|---|
 StoreProfileTools | 
getStoreProfileTools()
It's a getter method for the storeProfileTools read-only property. | 
 boolean | 
handleAnonymousCustomer(atg.servlet.DynamoHttpServletRequest pRequest,
                        atg.servlet.DynamoHttpServletResponse pResponse)
This is a Log In process for the anonymous customer.  | 
 boolean | 
handleNewCustomer(atg.servlet.DynamoHttpServletRequest pRequest,
                  atg.servlet.DynamoHttpServletResponse pResponse)
This is a Log In process for the new customer.  | 
 boolean | 
handleReturningCustomer(atg.servlet.DynamoHttpServletRequest pRequest,
                        atg.servlet.DynamoHttpServletResponse pResponse)
This is a Log In process for the returning customer.  | 
 void | 
postLogoutUser(atg.servlet.DynamoHttpServletRequest pRequest,
               atg.servlet.DynamoHttpServletResponse pResponse)
This implementation adds two checkout-specific request parameters, if no errors occurred during the logout process.  | 
| Methods inherited from class atg.commerce.profile.CommerceProfileFormHandler | 
|---|
addProperty, copyProperty, formatUserMessage, getAddCostCenterDescription, getAddCostCenterErrorURL, getAddCostCenterIdentifier, getAddCostCenterSuccessURL, getCatalogTools, getDefaultLocale, getEditCostCenterDescription, getEditCostCenterErrorURL, getEditCostCenterIdentifier, getEditCostCenterSuccessURL, getOrderManager, getPriceListManager, getPricingTools, getPromotionTools, getRemoveCostCenterErrorURL, getRemoveCostCenterIdentifier, getRemoveCostCenterSuccessURL, getShoppingCart, getUserLocale, getUserPricingModels, handleAddCostCenter, handleEditCostCenter, handleRemoveCostCenter, isDefaultCostCenter, isDetermineCatalog, isDeterminePriceList, processException, setAddCostCenterDescription, setAddCostCenterErrorURL, setAddCostCenterIdentifier, setAddCostCenterSuccessURL, setCatalogTools, setDefaultCostCenter, setDefaultLocale, setDetermineCatalog, setDeterminePriceList, setEditCostCenterDescription, setEditCostCenterErrorURL, setEditCostCenterIdentifier, setEditCostCenterSuccessURL, setOrderManager, setPriceListManager, setPricingTools, setPromotionTools, setRemoveCostCenterErrorURL, setRemoveCostCenterIdentifier, setRemoveCostCenterSuccessURL, setShoppingCart, setUserPricingModels | 
| Methods inherited from class atg.scenario.userprofiling.ScenarioProfileFormHandler | 
|---|
addScenarioInstances, addSlotInstances, getScenarioManager, handleCreate, handleDelete, handleLogin, handleLogout, handleUpdate, isOverrideFormHandlerRedirect, setOverrideFormHandlerRedirect, setScenarioManager | 
| Methods inherited from class atg.userprofiling.ProfileFormHandler | 
|---|
addProfileUpdateListener, checkFormError, createProfileItem, getClearValuesOnCreate, getClearValuesOnLogin, getClearValuesOnUpdate, getExpiredPasswordService, getProfile, getProfileUpdateEvent, getProfileUpdateTrigger, getRepositoryId, getRequestLocale, getTestPassword, getUpdateRepositoryId, getVerifyPasswordSuccessURL, handleCancel, handleVerifyPassword, isCreateNewUser, isGenerateProfileUpdateEvents, isSendCookie, preLogoutUser, propagateLocale, removeProfileUpdateListener, sendProfileUpdateEvent, setClearValuesOnCreate, setClearValuesOnLogin, setClearValuesOnUpdate, setCreateNewUser, setExpiredPasswordService, setGenerateProfileUpdateEvents, setProfile, setProfileUpdateEvent, setProfileUpdateTrigger, setRepositoryId, setRequestLocale, setTestPassword, setUpdateRepositoryId, setVerifyPasswordSuccessURL, shouldCreateNewUser | 
| Methods inherited from class atg.userprofiling.ProfileForm | 
|---|
addMulti, addPropertiesOnLogin, addSwapEventListener, addUser, changePassword, checkFormSuccess, checkForRequiredParameters, checkForRequiredProperties, checkForRequiredProperties, commitTransaction, copyPropertiesOnLogin, copyPropertyValue, createUser, doStartService, ensureTransaction, findUser, formatUserMessage, formatUserMessage, formatUserMessage, formatUserMessage, generatePropertyPath, getAddMultiPropertyName, getAddMultiPropertyValue, getAuthenticationMessageTrigger, getBadPasswordDelay, getChangePasswordErrorURL, getChangePasswordSuccessURL, getCheckForRequiredParameters, getCheckForRequiredProperties, getCheckForRequiredPropertiesAfterUpdate, getCreateErrorURL, getCreateProfileType, getCreateSuccessURL, getDeleteErrorURL, getDeleteSuccessURL, getDescriptor, getExpireSessionOnLogout, getLoginErrorURL, getLoginProfileType, getLoginSuccessURL, getLogoutErrorURL, getLogoutProfileType, getLogoutSuccessURL, getProcessPropertyNames, getProfileItem, getProfileRealmManager, getProfileTools, getPropertiesToAddOnLogin, getPropertiesToCopyOnLogin, getRealmSessionTracker, getRealmSessionTrackerName, getStringValueProperty, getTransactionDemarcation, getTransactionManager, getTrimProperties, getUpdateErrorURL, getUpdateSuccessURL, getUserLoginManager, getValue, getValueFromArrayString, getValueFromObject, getValueFromObjectArray, getValueFromString, getValueFromStringArray, getValueMap, getValueProperty, handleAddMulti, handleChangePassword, handleValueDictionaryByParameters, isCompareValueInCopyPropertiesOnLogin, isConfirmOldPassword, isConfirmPassword, isExtractDefaultValuesFromProfile, isInvalidateAllChildSessions, isTrimProperty, isUsingLdapProfile, postAddMulti, postDeleteUser, postValueDictionaryByParameters, preAddMulti, preChangePassword, preDeleteUser, preValueDictionaryByParameters, removeSwapEventListener, removeUser, sendProfileSwapEvent, setAuthenticationMessageTrigger, setBadPasswordDelay, setChangePasswordErrorURL, setChangePasswordSuccessURL, setCheckForRequiredParameters, setCheckForRequiredProperties, setCheckForRequiredPropertiesAfterUpdate, setCompareValueInCopyPropertiesOnLogin, setConfirmOldPassword, setConfirmPassword, setCreateErrorURL, setCreateProfileType, setCreateSuccessURL, setDeleteErrorURL, setDeleteSuccessURL, setExpireSessionOnLogout, setExtractDefaultValuesFromProfile, setInvalidateAllChildSessions, setLoginErrorURL, setLoginProfileType, setLoginSuccessURL, setLogoutErrorURL, setLogoutProfileType, setLogoutSuccessURL, setProfileTools, setPropertiesToAddOnLogin, setPropertiesToCopyOnLogin, setRealmSessionTrackerName, setTrimProperties, setUpdateErrorURL, setUpdateSuccessURL, setUserLoginManager, setUsingLdapProfile, setValueDictionaryByParameters, setValueProperty, updateLDAPProfileAttributes, updatePasswordValue, updateProfileAttributes, updateProfileAttributes, updateUser, updateUser, userAlreadyExists, valueIsEmpty | 
| Methods inherited from class atg.droplet.GenericFormHandler | 
|---|
addFormException, addUncheckedFormException, afterSet, beforeSet, checkFormRedirect, createFormSubmissionMessage, getCancelURL, getCheckForValidSession, getFormError, getFormExceptions, getFormName, getMessagePort, getMessageSource, getMessageType, getPropertyExceptions, getSendMessages, getUncheckedFormExceptions, handleFormException, handleUncheckedFormException, hasUncheckedFormExceptions, isDeferForwardsAndRedirects, isRestorableForm, isUseForwards, isValidSession, redirectOrForward, resetFormExceptions, setCancelURL, setCheckForValidSession, setDeferForwardsAndRedirects, setFormName, setMessagePort, setMessageSource, setMessageType, setRestorableForm, setSendMessages, setUseForwards | 
| Methods inherited from class atg.droplet.EmptyFormHandler | 
|---|
afterGet, beforeGet | 
| Methods inherited from class atg.nucleus.GenericService | 
|---|
addLogListener, createAdminServlet, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService | 
| Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl | 
|---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning | 
| Methods inherited from class java.lang.Object | 
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Field Detail | 
|---|
public static final java.lang.String CLASS_VERSION
protected static final java.lang.String NEW_EMAIL_ADDRESS
public static final java.lang.String LOGIN_DURING_CHECKOUT_PARAMETER
| Constructor Detail | 
|---|
public CheckoutProfileFormHandler()
| Method Detail | 
|---|
public StoreProfileTools getStoreProfileTools()
storeProfileTools read-only property.
 This method converts the value of the profileTools property to the StoreProfileTools type.
StoreProfileTools instance.
public boolean handleReturningCustomer(atg.servlet.DynamoHttpServletRequest pRequest,
                                       atg.servlet.DynamoHttpServletResponse pResponse)
                                throws javax.servlet.ServletException,
                                       java.io.IOException
emailAddress (will be used as user login) and value.password
 (user password). If loginSuccessURL and loginErrorURL properties are set, the user will be redirected
 to the specified URLs on login success or error correspondingly.
 
pRequest - current HTTP request.pResponse - current HTTP response.
javax.servlet.ServletException - if something goes wrong.
java.io.IOException - if something goes wrong.
public boolean handleNewCustomer(atg.servlet.DynamoHttpServletRequest pRequest,
                                 atg.servlet.DynamoHttpServletResponse pResponse)
                          throws javax.servlet.ServletException,
                                 java.io.IOException
emailAddress property (will be used as user login).
 If loginSuccessURL and loginErrorURL properties are set, the user will be redirected
 to the specified URLs on login success or error correspondingly.
 
pRequest - current HTTP request.pResponse - current HTTP response.
javax.servlet.ServletException - if something goes wrong.
java.io.IOException - if something goes wrong.
public boolean handleAnonymousCustomer(atg.servlet.DynamoHttpServletRequest pRequest,
                                       atg.servlet.DynamoHttpServletResponse pResponse)
                                throws javax.servlet.ServletException,
                                       java.io.IOException
loginSuccessURL and loginErrorURL properties are set, the user will be redirected
 to the specified URLs on login success or error correspondingly.
 
pRequest - current HTTP request.pResponse - current HTTP response.
javax.servlet.ServletException - if something goes wrong.
java.io.IOException - if something goes wrong.
public void postLogoutUser(atg.servlet.DynamoHttpServletRequest pRequest,
                           atg.servlet.DynamoHttpServletResponse pResponse)
                    throws javax.servlet.ServletException,
                           java.io.IOException
StoreOrderHolder.LOGOUT_ORDER_IDNEW_EMAIL_ADDRESS
postLogoutUser in class StoreProfileFormHandlerpRequest - current HTTP request.pResponse - current HTTP response.
javax.servlet.ServletException - if something goes wrong.
java.io.IOException - if something goes wrong.
  | 
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||