Bloomreach Commerce Accelerator Login Component
Synopsis
LoginFormComponent is a built-in HstComponent to support customer login in Bloomreach Commerce Accelerator applications.
If a visitor is not authenticated, a login link can be provided for the visitor, who can fill in the credentials to sign in as a customer for the commerce backend service.
LoginFormComponent processes the login by invoking the commerce backend REST APIs.
Component Overview
Rendering phase
In rendering phase, its template is supposed to display input fields for the visitor's login form, such as e-mail address and password.
Action phase
On visitor's login form submission, LoginFormComponent first validates the inputs, displaying errors if validation fails; or it invokes CRISP API with the corresponding CommerceConnector and CommerceConnectorComponent (id: "authenticateCustomer") models, which ends up exchanging data with the commerce backend service. For details on the "authenticateCustomer" connector component configuration, have a look at the different commerce platform configuration pages supported in Bloomreach Accelerator: B2C Commerce Boot.
If successful to login, it keeps the authenticated user's info in HttpSession by default through StarterStoreUserSessionAccess#setStoreUserInSession(HttpServletRequest, StoreUser), and it redirects the visitor to the previously visited page before the login page.
Component Details
Below are the details of the component and the related configurations.
Component class | com.bloomreach.commercedxp.starterstore.components.LoginFormComponent |
Template configuration | /hst:hst/hst:configurations/starterstoreboot/hst:templates/starterstore-login-form |
Template resource | webfile:/freemarker/hstdefault/starterstore-login-form.ftl |
Page configuration | /hst:hst/hst:configurations/starterstoreboot/hst:pages/signin-contentpage |
Sitemap Item configuration | /hst:hst/hst:configurations/starterstoreboot/hst:sitemap/signin |