Corporate Info  |  News  |  Solutions  |  Products  |  Partners  |  Services  |  Events  |  Download  |  How To Buy
	http://www.oracle.com/technology/documentation/index.html   |   Search   |   PDF Files   |   Contact   |   Glossary
WLCS Doc Home   |   Registering Customers   |   Previous Topic   |   Next Topic   |   Contents   |   Index

For customers who plan on frequenting your e-business, it is beneficial to provide a way for them to store some personal information. In doing so, the ordering process will require less time because your customers will not need to reenter their name, address, payment information, and so on. For security, privacy, and management, however, this feature requires customers to log into your site with a username/password combination. This topic describes the JavaServer Pages (JSPs) and associated components that allow customers to register and log into your site by creating a customer profile.

This topic includes the following sections:

• JavaServer Pages (JSPs)

  • login.jsp Template

  • badlogin.jsp Template

  • newuser.jsp Template

  • newusercreation.jsp Template

  • newuserforward.jsp Template

  • usercreationforward.jsp Template

• Input Processors

  • CustomerProfileIP

  • LoginCustomerIP
    
    

• Pipeline Components

  • RegisterUserPC

  • EncryptCreditCardPC

The Registering Customers and Managing Customer services contain a number of JavaServer Pages (JSPs) that handle customer registration (initial customer profile creation) and customer login. Remember, you can always use these templates for your Web site, or you can adapt them to meet your specific needs. This section describes each of these pages in detail.

Note: For a description of the complete set of JSPs used in the WebLogic Commerce Server Web application and a listing of their locations in the directory structure, see the "Template Summary" documentation.

The login.jsp template (shown in Figure 2-1) allows a customer who has previously created a profile to log into your e-commerce site by providing a valid username/password combination. Since this page is the entry point to the checkout process, it also establishes mechanisms (such as sessions) that will allow customers to continue their shopping experience.

For customers who have not yet registered with your site, the login.jsp template provides customers with an entry point into a page that allows them to register (create their initial customer profile) for subsequent use on the site.

Figure 2-1 shows an annotated version of the login.jsp template. The black lines and callout text are not part of the template; they are explanations of the template components.

Location in the WebLogic Commerce Server Directory Structure

You can find the login.jsp template file at the following location, where $WL_COMMERCE_HOME is the directory in which you installed WebLogic Commerce Server:

%WL_COMMERCE_HOME\config\wlcsDomain\applications\wlcsApp\wlcs\
commerce\login.jsp (Windows)

$WL_COMMERCE_HOME/config/wlcsDomain/applications/wlcsApp/wlcs/
commerce/login.jsp (UNIX)

The login.jsp template does not use any custom JSP tags. Therefore, the template does not include imports of any JSP tag libraries.

The login.jsp template uses Java classes in the following packages and therefore includes these import statements:

The login.jsp template itself is not part of the default Webflow. Rather, it is automatically loaded into the browser when a protected page is referenced by the WebLogic Server.

Note: All JSP templates in the /order and /user subdirectories are protected and are accessible only by registered and authenticated customers.

If the customer already has a username/password combination from prior registration and the customer's login is successful, the next page is the protected page the customer was attempting to access. If the customer's login is unsuccessful, the badlogin.jsp template is loaded.

If the customer is not yet registered and clicks on the Create button, the next page loaded allows the customer to create a profile and a username/password combination (newuser.jsp). After the customer has registered, the customer is automatically logged in and forwarded to the newusercreation.jsp template, which allows customers to continue shopping, view their shopping carts, or check out. If the auto-login is unsuccessful, the login.jsp template is loaded for the customer to enter their username and password. If the customer's login attempt is unsuccessful, the badlogin.jsp is loaded.

Notes: The option to proceed to checkout is only provided on the newusercreation.jsp template if there are items in the customer's shopping cart.

For a detailed description of the main.jsp template, see " Product Catalog JSP Templates" in the Guide to Building a Product Catalog.

For a detailed description of the shoppingcart.jsp and shipping.jsp templates, see "Shopping Cart Management Services" or "Shipping Services" in the Guide to Managing Purchases and Processing Orders.

For more information about the default Webflow, see the Guide to Managing Presentation and Business Logic:Using Webflow and Pipeline.

The following JSP templates are included in the login.jsp template:

• admin.inc, which shows the name of the current template and contains links to its About information, the JSP Template Index, and the Administration Tools. The admin.inc template should be removed from the production pages before they are moved to your live server.

• stylesheet.inc, which is a cascading stylesheet that defines global paragraph and text styles for the site. The import call is:
  <%@ include file="/commerce/includes/stylesheet.inc" %>

• header.inc, which creates the page header. It is standard across many of the JSP templates provided by WebLogic Commerce Server. The import call is:
  <%@ include file="/commerce/includes/header.inc" %>

• leftside.inc, which creates the left column and secondary placeholder for advertising. It is standard across many of the JSP templates provided by WebLogic Commerce Server. The import call is:
  <%@ include file="/commerce/includes/leftside.inc" %>

• footer.inc, which creates the page footer. It is standard across many of the JSP templates provided by WebLogic Commerce Server. The import call is:
  <%@ include file="/commerce/includes/footer.inc" %>

Events

The login.jsp template presents a customer with two buttons, only one of which is considered an event. The event triggers a particular response in the default Webflow that allows customers to continue. The other button is a standard HTML Submit button that posts the page back to the WebLogic Server for authentication. Table 2-1 provides information about the event and the business logic it invokes.

Note: The Login button is not an event that would trigger a Webflow response. Rather, when a customer clicks the button, control is turned over to the WebLogic Server (specifically, the RDBMS realm of the WebLogic Personalization Server). The WebLogic Server remembers the HTTP request, determines whether the customer's username and password combination is correct, and then reinvokes the Webflow using the request. Since this authentication follows the WebLogic Server and J2EE specifications, more information on this topic can be found in documents at the BEA WebLogic Server 6.0 Documentation Center.

No dynamic data is presented on the login.jsp template.

The primary purpose of the login.jsp template is to allow customers to enter their username and password using two HTML form fields. It is also used to pass needed information to the Webflow.

The form fields used in the login.jsp template, and a description for each of these form fields are listed in Table 2-2.

Note: Parameters that are literals in the JSP code are shown in quotes, while non-literals will require scriptlet syntax (such as
<%= HttpRequestConstants.USER_NAME %>) for use in the JSP.

The badlogin.jsp template (shown in Figure 2-2) informs a customer that they have entered an invalid username/password combination, and allows the customer to try logging into your e-commerce site again by providing a valid username/password combination. Except for the error message, it behaves exactly as the login.jsp template previously described.

Figure 2-2 shows an annotated version of the badlogin.jsp template. The black lines and callout text are not part of the template; they are explanations of the template components.

You can find the badlogin.jsp template file at the following location, where $WL_COMMERCE_HOME is the directory in which you installed WebLogic Commerce Server:

%WL_COMMERCE_HOME\config\wlcsDomain\applications\wlcsApp\wlcs\
commerce\badlogin.jsp (Windows)

$WL_COMMERCE_HOME/config/wlcsDomain/applications/wlcsApp/wlcs/
commerce/badlogin.jsp (UNIX)

The badlogin.jsp template does not use any custom JSP tags. Therefore, the template does not include imports of any JSP tag libraries.

The badlogin.jsp template does not use any Java classes and therefore does not include any package import statements.

Customers arrive at the badlogin.jsp template when they fail to provide a valid username/password combination on the login.jsp template. If the customer is registered and the customer's second attempt at logging in is successful, the next page is the protected page the customer was attempting to access. If the customer's login is unsuccessful, the badlogin.jsp template is reloaded.

If the customer is not yet registered and clicks on the Create button, the next page loaded allows the customer to create a profile and obtain a username/password combination (newuser.jsp). After the customer has registered, the customer is automatically logged in and forwarded to the newusercreation.jsp template, which allows customers to continue shopping, view their shopping carts, or check out. If the auto-login is unsuccessful, the login.jsp template is loaded for the customer to enter their username and password. If the customer's login attempt is unsuccessful, the badlogin.jsp is loaded.

Note: For more information about the default Webflow, see the Guide to Managing Presentation and Business Logic:Using Webflow and Pipeline.

The following JSP template is included in the badlogin.jsp template:

• login.jsp, which creates the entire page with the exception of the error message at the top.

Events

Because the badlogin.jsp template includes the login.jsp template, the badlogin.jsp template uses the same events. For more information about these events, see login.jsp Template.

No dynamic data is presented on the badlogin.jsp template.

Because the badlogin.jsp template includes the login.jsp template, the badlogin.jsp template uses the same form fields. For more information about these form fields, see login.jsp Template.

The newuser.jsp template (shown in Figure 2-3 through Figure 2-6) allows a new customer to register with your e-commerce site by creating their customer profile, which includes personal information, shipping address information, payment information (optional), and account information.

Figure 2-3 through Figure 2-6 show annotated versions of the newuser.jsp template. Although there are four figures, together these screen shots form the single newuser.jsp template. The black lines and callout text are not part of the template; they are explanations of the template components.

Figure 2-4 Annotated newuser.jsp Template - Demographic Information

Figure 2-5 Annotated newuser.jsp Template - Shipping Address and Payment Information (Optional)

Figure 2-6 Annotated newuser.jsp Template - Account Information

Note: The maximum number of characters allowed for usernames and passwords is set to 50. There are no other restrictions. If you want to impose other restrictions, such as required character types, disallowed character types, or length requirements, you must set up your own Input Processor.

You can find the newuser.jsp template file at the following location, where $WL_COMMERCE_HOME is the directory in which you installed WebLogic Commerce Server:

%WL_COMMERCE_HOME\config\wlcsDomain\applications\wlcsApp\wlcs\
commerce\register\newuser.jsp (Windows)

$WL_COMMERCE_HOME/config/wlcsDomain/applications/wlcsApp/wlcs/
commerce/register/newuser.jsp (UNIX)

The newuser.jsp template makes use of the Webflow JSP tags. Therefore, the template includes the following JSP tag library:

Note: For more information about the Webflow JSP tags, see the Guide to Managing Presentation and Business Logic:Using Webflow and Pipeline.

This file resides in the following directory for the WebLogic Commerce Server Web application:

%WL_COMMERCE_HOME\config\wlcsDomain\applications\wlcsApp\wlcs\
WEB-INF (Windows)

$WL_COMMERCE_HOME/config/wlcsDomain/applications/wlcsApp/wlcs/
WEB-INF (UNIX)

The newuser.jsp template uses Java classes in the following packages and therefore includes these import statements:

The page prior to newuser.jsp is the customer login page (login.jsp). If no errors are found after a customer enters their initial profile information, customers are auto-logged in and forwarded to a welcome page where they can select from the various links to continue shopping or check out (newusercreation.jsp). If errors are found, the newuser.jsp is reloaded with an appropriate message next to the invalid form fields.

Note: For more information about the default Webflow, see the Guide to Managing Presentation and Business Logic:Using Webflow and Pipeline.

The following JSP templates are included in the newuser.jsp template:

• admin.inc, which shows the name of the current template and contains links to its About information, the JSP Template Index, and the Administration Tools. The admin.inc template should be removed from the production pages before they are moved to your live server.

• stylesheet.inc, which is a cascading stylesheet that defines global paragraph and text styles for the site. The import call is:
  <%@ include file="/commerce/includes/stylesheet.inc" %>

• header.inc, which creates the page header. It is standard across many of the JSP templates provided by WebLogic Commerce Server. The import call is:
  <%@ include file="/commerce/includes/header.inc" %>

• leftside.inc, which creates the left column and secondary placeholder for advertising. It is standard across many of the JSP templates provided by WebLogic Commerce Server. The import call is:
  <%@ include file="/commerce/includes/leftside.inc" %>

• states.inc, which contains a list of states as part of an address. The state is only required for U.S. citizens. The import call is:
  <%@ include file="/commerce/includes/states.inc" %>

• countries.inc, which contains a list of countries as part of an address. The import call is:
  <%@ include file="/commerce/includes/countries.inc" %>

• newaddresstemplate.inc, which also uses the states.inc and the countries.inc templates.

• newdemographictemplate.inc, which contains formatting for the demographic data.

• newcctemplate.inc, which also uses the states.inc and the countries.inc templates.

• footer.inc, which creates the page footer. It is standard across many of the JSP templates provided by WebLogic Commerce Server. The import call is:
  <%@ include file="/commerce/includes/footer.inc" %>

About the Included newaddresstemplate.inc Template

The newaddresstemplate.inc template provides a standardized format for both the form field presentation and error handling included in all JSP templates that prompt customers for a shipping address, except addaddress.jsp. The form fields are organized in a table, and upon form submission, the Input Processors associated with the newaddresstemplate.inc template will validate the form to ensure that all required fields contain values. If errors are detected, the newaddresstemplate.inc template will be redisplayed, with an error message at the top and the invalid field labels shown in a red (as opposed to the original black) font. Previously entered correct information will still be displayed in the form.

The behavior described above is accomplished on the newaddresstemplate.inc template using the getValidatedValue JSP tag, as shown in Listing 2-1.

Notes: For more information about the getValidatedValue JSP tag, see the Guide to Managing Presentation and Business Logic:Using Webflow and Pipeline.

The newcctemplate.inc template provides a standardized format for both the form presentation and error handling in all JSP templates that prompt customers for credit card/payment information. The form fields are organized in a table, and upon form submission, the Input Processors associated with the newcctemplate.inc template will validate the form to ensure that all required fields contain values. If errors are detected, the newcctemplate.inc template will be redisplayed, with an error message at the top and the invalid field labels shown in a red (as opposed to the original black) font. Previously entered correct information will still be displayed in the form.

The behavior described above is accomplished on the newcctemplate.inc template using the getValidatedValue JSP tag, as shown in Listing 2-2.

Notes: For more information about the getValidatedValue JSP tag, see the Guide to Managing Presentation and Business Logic:Using Webflow and Pipeline.

The newdemographictemplate.inc template provides a standardized format for both the form presentation and error handling in all JSP templates that prompt customers for demographic information. The radio buttons are organized in a table, and upon form submission, the Input Processors associated with the newdemographictemplate.inc template will validate the form to ensure that all required fields contain values. If errors are detected, the newdemographictemplate.inc template will be redisplayed, with an error message at the top of the including page and the invalid field labels shown in a red (as opposed to the original black) font. Previously entered correct information will still be displayed in the form.

The behavior described above is accomplished on the newdemographictemplate.inc template using the getValidatedValue JSP tag, as shown in Listing 2-3.

Notes: For more information about the getValidatedValue JSP tag, see the Guide to Managing Presentation and Business Logic:Using Webflow and Pipeline.

The newuser.jsp template presents a customer with two buttons, each of which is considered an event. These events trigger a particular response in the default Webflow that allows customers to continue. While this response can be to load another JSP, it is usually the case that an Input Processor or Pipeline is invoked first. Table 2-3 provides information about these events and the business logic they invoke.

Table 2-4 briefly describes each of the Pipelines from Table 2-3, as they are defined in the pipeline.properties file. For more information about individual Pipeline components, see Pipeline Components.

No dynamic data is presented on the newuser.jsp template.

The primary purpose of the newuser.jsp template is to allow customers to enter their profile information using various HTML form fields. It is also used to pass needed information to the Webflow.

The form fields used in the newuser.jsp template, most of which are imported from other templates, and a description for each of these form fields are listed in Table 2-5.

Note: If a form field is imported from another template, it is indicated in the description. Form fields without import information are in the newuser.jsp template.

Note: Parameters that are literals in the JSP code are shown in quotes, while non-literals will require scriptlet syntax (such as
<%= HttpRequestConstants.USER_NAME %>) for use in the JSP.

The newusercreation.jsp template (shown in Figure 2-7) informs a customer who has just created a new user profile that they have been logged in and that registration was successful. It also provides the customer with the opportunity to return to their shopping experience through several navigation options.

Figure 2-7 shows an annotated version of the newusercreation.jsp template. The black lines and callout text are not part of the template; they are explanations of the template components.

Notes: For a detailed description of the main.jsp template, see "Product Catalog JSP Templates" in the Guide to Building a Product Catalog book. For a detailed description of the shoppingcart.jsp and shipping.jsp templates, see "Shopping Cart Management Services" or "Shipping Services" in the Guide to Managing Purchases and Processing Orders book.

The option to proceed to checkout is only provided on the newusercreation.jsp template if there are items in the customer's shopping cart. Otherwise, the newusercreation.jsp template will leave out this option as shown in Figure 2-8.

Location in the WebLogic Commerce Server Directory Structure

You can find the newusercreation.jsp template file at the following location, where $WL_COMMERCE_HOME is the directory in which you installed WebLogic Commerce Server:

%WL_COMMERCE_HOME\config\wlcsDomain\applications\wlcsApp\wlcs\
commerce\user\newusercreation.jsp (Windows)

$WL_COMMERCE_HOME/config/wlcsDomain/applications/wlcsApp/wlcs/
commerce/user/newusercreation.jsp (UNIX)

The newusercreation.jsp template uses Pipeline JSP tags. Therefore, the template includes the following JSP tag library:

Note: For more information about the Pipeline JSP tags, see the Guide to Managing Presentation and Business Logic:Using Webflow and Pipeline.

This file resides in the following directory for the WebLogic Commerce Server Web application:

%WL_COMMERCE_HOME\config\wlcsDomain\applications\wlcsApp\wlcs\
WEB-INF (Windows)

$WL_COMMERCE_HOME/config/wlcsDomain/applications/wlcsApp/wlcs/
WEB-INF (UNIX)

The newusercreation.jsp template uses Java classes in the following packages and therefore includes these import statements:

Customers arrive at the newusercreation.jsp template when they have successfully created a new user profile and the auto-login using JAAS (Java Authentication and Authorization Service) has completed. If the customer creates a new profile, but the auto-login does not complete successfully, the customer is routed to the login.jsp template and will not see the newusercreation.jsp template. After manual login, the customer is routed to the main.jsp template.

Note: If a customer had created a profile on a previous visit and logged in using the login.jsp template, the customer would simply be taken to the protected page the customer was trying to access.

Note: The option to proceed to checkout is only provided on the newusercreation.jsp template if there are items in the customer's shopping cart.

For more information about the default Webflow, see the Guide to Managing Presentation and Business Logic:Using Webflow and Pipeline.

The following JSP templates are included in the newusercreation.jsp template:

• admin.inc, which shows the name of the current template and contains links to its About information, the JSP Template Index, and the Administration Tools. The admin.inc template should be removed from the production pages before they are moved to your live server.

• stylesheet.inc, which is a cascading stylesheet that defines global paragraph and text styles for the site. The import call is:
  <%@ include file="/commerce/includes/stylesheet.inc" %>

• header.inc, which creates the page header. It is standard across many of the JSP templates provided by WebLogic Commerce Server. The import call is:
  <%@ include file="/commerce/includes/header.inc" %>

• leftside.inc, which creates the left column and secondary placeholder for advertising. It is standard across many of the JSP templates provided by WebLogic Commerce Server. The import call is:
  <%@ include file="/commerce/includes/leftside.inc" %>

• footer.inc, which creates the page footer. It is standard across many of the JSP templates provided by WebLogic Commerce Server. The import call is:
  <%@ include file="/commerce/includes/footer.inc" %>

Events

Every time a customer clicks a button to view more detail about an order, it is considered an event. Each event triggers a particular response in the default Webflow that allows them to continue. While this response can be to load another JSP, it is usually the case that an Input Processor and/or Pipeline is invoked first. Table 2-6 provides information about these events and the business logic they invoke.

Note: For more information about the GetTopCategoriesIP and GetTopCategories Pipeline, see the Guide to Building a Product Catalog.

One purpose of the newusercreation.jsp template is to display navigation options that allow customers to continue their shopping experience after logging in. However, if there are no items in the customer's shopping cart, then checkout is not an option that should be displayed. The decision of whether or not to display this option is accomplished on newusercreation.jsp using a combination of Pipeline JSP tags and accessor methods/attributes.

First, the getPipelineProperty JSP tag retrieves the SHOPPING_CART attribute from the Pipeline session. Table 2-7 provides more detailed information on this attribute.

Listing 2-4 illustrates how this attribute is retrieved from the Pipeline session using the getPipelineProperty JSP tag.

Note: For more information on the getPipelineProperty JSP tag, see the Guide to Managing Presentation and Business Logic:Using Webflow and Pipeline.

The data stored within the Pipeline session attribute is then accessed by using accessor methods/attributes within Java scriptlets. Table 2-8 provides more detailed information about these methods/attributes for shoppingCart.

The presence of items in the shopping cart is evaluated using this method in a Java scriptlet, as shown in Listing 2-5.

No form fields are used in the newusercreation.jsp template.

The newuserforward.jsp template is used to direct unregistered users to the newuser.jsp because dynamic URIs are not supported in placeholders. This page is accessed when an unregistered user clicks an ad placeholder that contains a static URI. The newuserforward.jsp template then forwards the user to newuser.jsp. Additionally, the newuserforward.jsp bridges the transition from a non-secure to a secure connection (http to https).

Because this page is never seen by the end user and uses no includes, instead of a figure, the code for this page is shown in Listing 2-6.

You can find the newuser.jsp template file at the following location, where $WL_COMMERCE_HOME is the directory in which you installed WebLogic Commerce Server:

%WL_COMMERCE_HOME\config\wlcsDomain\applications\wlcsApp\wlcs\
commerce\newuserforward.jsp (Windows)

$WL_COMMERCE_HOME/config/wlcsDomain/applications/wlcsApp/wlcs/
commerce/newuserforward.jsp (UNIX)

The newuserforward.jsp template does not use any tag libraries.

The newuserforward.jsp template uses Java classes in the following package and therefore includes the import statement:

The page prior to newuserforward.jsp can be any page that an anonymous user can access. However, this template is only needed if an unregistered user clicks the ad placeholder that prompts them to register. The static URI in the placeholder accesses the newuserforward.jsp which then forwards the user to the newuser.jsp template.

Note: For more information about the default Webflow, see the Guide to Managing Presentation and Business Logic:Using Webflow and Pipeline.

No JSP templates are included in the newuserforward.jsp template.

The newuserforward.jsp template has one event. This event triggers a particular response in the default Webflow that allows customers to continue. While this response can be to load another JSP, it is usually the case that an Input Processor or Pipeline is invoked first. Table 2-9 provides information about this event and the business logic it invokes.

No dynamic data is presented on the newuserforward.jsp template.

No form fields are used in the newuserforward.jsp template.

The usercreationforward.jsp template is used to forward new users to the newusercreation.jsp template after the registration and auto-login process using JAAS is completed by the Webflow. Once the user is created, the request must be flushed and the usercreationforward.jsp template allows that to happen.

Because this page is never seen by the end user and uses no includes, instead of a figure, the code for this page is shown in Listing 2-7.

You can find the newuser.jsp template file at the following location, where $WL_COMMERCE_HOME is the directory in which you installed WebLogic Commerce Server:

%WL_COMMERCE_HOME\config\wlcsDomain\applications\wlcsApp\wlcs\
commerce\user\usercreationforward.jsp (Windows)

$WL_COMMERCE_HOME/config/wlcsDomain/applications/wlcsApp/wlcs/
commerce/user/usercreationforward.jsp (UNIX)

The usercreationforward.jsp template does not use any tag libraries.

The usercreationforward.jsp template uses Java classes in the following package and therefore includes the import statement:

The page prior to usercreationforward.jsp is the newuser.jsp template. When new users save their profiles, they are auto-logged in using JAAS and if the login is successful, because the old request must be flushed, the usercreationforward.jsp is needed to redirect the user to the newusercreation.jsp template.

Note: For more information about the default Webflow, see the Guide to Managing Presentation and Business Logic:Using Webflow and Pipeline.

No JSP templates are included in the usercreationforward.jsp template.

The usercreationforward.jsp template has one event. This event triggers a particular response in the default Webflow that allows customers to continue. While this response can be to load another JSP, it is usually the case that an Input Processor or Pipeline is invoked first. Table 2-10 provides information about this event and the business logic it invokes.

No dynamic data is presented on the newuserforward.jsp template.

No form fields are used in the usercreationforward.jsp template.

This section provides a brief description of each Input Processor associated with the Customer Login and Registration Services JSP template(s).

Note: For more information about the GetTopCategoriesIP Input Processor, see the Guide to Building a Product Catalog.

This section provides a brief description of each Pipeline component associated with the Customer Login and Registration Services JSP template(s).

Note: Some Pipeline components extend other, base Pipeline components. For more information on the base classes, see the Javadoc.