Home > Articles > Programming > Java

Using a Controller for JSP Pages

The Model-View-Controller, or MVC, method of programming is widely used in object-oriented programming and using J2EE. According to Drew Falkman, your JSP applications will be easy to update, easy to break up (for the purpose of scaling), and easier to maintain when you use this method.
Like this article? We recommend

Like this article? We recommend

The Model-View-Controller, or MVC, method of programming is well-known as a scalable and modular approach for object-oriented programming. This method breaks up programs into three sections: the Model, the View, and the Controller. Figure 1 shows a basic diagram of the MVC method.

Figure 1 The Model-View-Controller (MVC) method of programming is both modular and scalable.

The Model is where the true logic of a program is—including the data Model and any proprietary processing that must be done to this data.

The View is what the application user sees. This is the layout or GUI (graphical user interface), in which the user can enter data into the program and see results.

The Controller is the core of the program that controls all interactions within the application. For example, if a user enters data, it is first sent to the Controller, which sends the information to the appropriate area to be processed. The results are then sent back to the Controller, which finally returns the results to the appropriate display. The Controller is the nerve center of an application.

By breaking up an application in this way, a programmer can easily make changes to one section of the code without having to affect any of the others. If you need to change some logic, simply change the Model. If you need a new GUI, edit the View. If you want to add a more granular security construct, edit the Controller.

Often, JSP and other server-side scripting language programmers don't use this method, meaning that their code is all intertwined. If you want to change the GUI, you must maneuver around both the Controller and Model aspects of your JSP page. This can lead to unmanageable code (or spaghetti code, as we call it), and eventually requires a total redo of your code.

In the J2EE environment, it is generally recommended to use a servlet as the Controller. JavaBeans, Java classes, and Enterprise JavaBeans (EJB) components are then used for the Model. Then, JSP is reserved for the View. But as JSP programmers know, sometimes we don't have the Java know-how to create servlets or EJBs, or an application is simple enough that a JSP-only application is the simplest and best way to go.

So, what can you do to make your applications more modular and scalable? Well, what is a JSP page in the end but a servlet, anyway? So let's just use JSP as the Controller.

Planning Your JSP-MVC Application

The first step in using JSP-MVC, as with in any program, is to plan. Primarily, you will need to break up the design (View) logic (Model), and Controller issues. It might help to actually draw a flowchart of these pieces and how they will all work together.

The user interface is simple enough, and can be represented by simple HTML layout screens. It might be easiest to start with these. For example, in a shopping cart, you have the category display page, the search screen, the search results, and the form interfaces for the checkout process.

The Model section is a little more abstract, but can be done fairly easily. Your primary question in an all-JSP application is where to draw the lines. For example, querying the database to obtain the data for the product category display page in your shopping cart would technically be considered part of the Model. It might be easier (especially if you are using custom actions from your app server vendor) to simply include this in the View, however. Just be careful. If, for example, you want to change the database of product categories from Access to MS SQL Server, or even to data from a JavaBeans component, will this be difficult? If the answer is yes, then break it out. This is the whole point of the MVC method.

The Controller is probably the most abstract section of your code. This single JSP page controls everything in your application. The information passed from your users will always be sent to this page first. So you should make sure that this page is organized and well-commented. Remember, there should be no actual logic here, mostly just flow control. Checking for certain variables, checking security; then including files or redirecting to the appropriate display page.

Building the Controller

The actual Controller page is mostly made of if statements, includes, and forwards. Make sure to build this page in the correct order. First, ask yourself the following questions:

  1. What security is needed? Will certain users only be allowed to access this application?

  2. What will the different steps be? Are they linear? How does the flow look? Drawing out a decision tree, as shown in Figure 2, is a good idea.

  3. What data or pages need to be shown in every page? What will be in certain groups of pages (such as all the checkout)?

Figure 2 Drawing a decision-based flowchart can help plan the Controller page.

The name of your Controller page is irrelevant, but index.jsp usually works well because it is probably the default document.

In the beginning of this page, you perform any checks or include any files that will need to happen, no matter what part of the application the user is accessing. This includes performing security checks, setting cookies, setting the time the user started the application, and grabbing any application-wide variables. If all pages in the application have the same layout, you can also include the header file containing the HTML code for the top section of the page (up to the area in which the page-sensitive content will be placed).

So the top of your page might look like this:

<%-- check to see if user has logged in yet
   note: login is not part of this application, 
      so user is redirected to the login application
--%>
<% if (session.getAttribute("UserType") == null) { %>
 <jsp:forward url="/login.jsp" />
<% } %>

<%-- check to see if user can access this section,
   if not, then send user to Access Denied message
--%>
<% if (!session.getAttribute("UserType").equals("Customer") ||    
 !session.getAttribute("UserType").equals("Administrator")) { %>
 <jsp:forward url="/login.jsp">
  <jsp:param name="action" value="failed" />
 </jsp:forward>
<% } %>

<%-- include page with all application variables --%>
<%@include file="/Model/application.jsp" %>

<%-- include header template (design) --%>
<jsp:include page="/View/header.jsp" />

This file is fairly simple—as it should be. Notice that the comments are easy to read and widely used. This is always a good idea, but especially in this document. You also want to indent because you will likely have nested if statements as you move deeper into your application.

First, authentication is checked by looking at the value of a variable called UserType. If this variable doesn't exist, the user is forwarded to the /login.jsp page using a plain <jsp:forward> action. If the user gets past this, a second if block checks to see whether the user is a Customer or Administrator. If not, the user is forwarded to the /login.jsp, but this time, a variable is embedded in the <jsp:forward> using the <jsp:param> tag.

Using <jsp:param> is an important part of a Controller page because it allows you to forward request variables to be accessed in a receiving page—as if a form or URL variable were passed directly to it. This variable can now be available as a request variable in the receiving page using request.getParameter("action").

The action parameter is the next key component of your Controller page. This action can dictate the primary actions that will be performed in the application. For example, if there is no action, the first step of the application will execute—in our e-commerce application, this is probably the browse page, including the product categories. Then, you can pass action variables representing different actions. For example /index.jsp?action=updatecart will trigger the application to call on the shopping cart update functionality, /index.jsp?action=showcart will display the cart, and so on.

So, the next section of your Controller page will be made up of if/else blocks (or case blocks) that check this action variable:

<% // first check to make sure there is an action
  // if not, do default action 
  if (request.getParameter("action") == null) { %>

 <%-- display product categories --%>
 <jsp:include url="/View/productdisplay.jsp" />

<% } 
  // check to see if user is adding item to cart
  else if (request.getParameter("action").equals("additem")) { %>

 <%-- inlcude to add cart page --%>
 <jsp:include page="/Model/addtocart.jsp">
  <%-- include forwarding parameters
     note that this could be a loop that 
     autoincludes any form variables passed,
     thus protecting you from code changes --%>
  <jsp:param name="ProductID" 
     value="<%= request.getParameter(/"ProductID/") %>" />
  <jsp:param name="Quantity" 
     value="<%= request.getParameter(/"Quantity/") %>" />
 </jsp:include>

<% } %>
 
<%-- add more else ifs for all of your processes and a final else in case of an error --%>

You can see how this will work by checking what the action is. You can even have a number of substeps within a single action (just remember to indent your ifs, and comment your code well). The key to remember is to keep all display and data handling out of this template.

The final step will be to create your actual display and processing pages. For display (or View) pages, remember that you will have your header and footer already included, so only the actual interface of the application step needs to be designed in the page.

In the processing (Model) pages, you will handle your processes; then reforward to the Controller with a new action value. For example, when you are adding an item to the shopping cart, do so and then forward the user to /index.jsp?action=displaycart, so that this will display the contents of the cart. You can even include additional variables using <jsp:param>, which can trigger additional options—such as displaying a message confirming that the appropriate item has just been added to the cart.

Overall, you will find that using an organized approach such as the MVC method to your JSP application will enable you to develop Web applications that are scalable and highly modular. Using this method, your JSP applications will be easy to update, easy to break up (for the purpose of scaling), and easier to maintain overall.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020