Home > Articles > Programming > Java

Like this article? We recommend

Visit the Java Resource 

Center

To demonstrate JPA, I'll use a simple example of a user authentication, where the credentials are stored in a database. For this example, I'm using the following technologies in the following table.

Type Product
IDE Eclipse Helios
Servlet Container Tomcat 7
Database Apache Derby
Persistence Provider EclipseLink JPA
Architecture Java Server Faces

For purposes of this discussion, I'll assume that you have some experience working with J2EE. However, I'll point out any special configurations needed to work with the example.

To get started, follow these steps:

  1. Create a Dynamic Web Project in Eclipse. I called my project Webbeans, but you can use any name you like.
  2. Add Java Server Faces to the project's facets.
  3. Add standard.jar and jstl.jar to the Tomcat lib directory. Without these JAR files, Tomcat will not compile Java Server Faces (JSF) applications.

Now that you've set up your project, you'll need a database for the example application. We'll take care of that requirement in the next section.

Configuring Apache Derby to Work with Eclipse

Apache Derby is a lightweight, all-Java database that's good for development. To configure Derby to work with Eclipse, do the following:

  1. Download the Eclipse Derby plug-in from the Apache Derby site. You'll need both of the following files:
    Once you've downloaded the zip files, unzip them and copy the plug-in files for each into the Eclipse plug-in directory.
  2. Restart Eclipse so the plug-in will register, defining a driver definition for Derby.
  3. Create a Java project called data to hold the database files. Right-click the data project and select Apache Derby > Add Apache Derby Nature. Then right-click the data project again and select Apache Derby > Start Derby Network Server.

    After you perform the steps above, your database should be ready to accept connections.
  4. For the example in this article, switch to the Data Source Explorer view in Eclipse. Create a new database connection using the Connection Profile wizard. Choose the Derby client driver (10.2) and accept the profile property defaults.

    You should be able to connect to Derby now, and the sample database will be visible.
  5. Right-click your new connection and select Open SQL Scrapbook. Type or paste the following database operation into the Scrapbook window:
  6. CREATE TABLE app.users (
      id INTEGER PRIMARY KEY GENERATED ALWAYS AS IDENTITY (START WITH 1, INCREMENT BY 1),
      name VARCHAR(120),
      login VARCHAR(75) NOT NULL,
      password VARCHAR(75) NOT NULL
     );
  7. Make sure that the sample database is selected. Then right-click inside the Scrapbook pane and select Execute All.

    The table for this example should now appear under the App Schema for the sample database.

Configuring for Your Application

Now you need to configure EclipseLink and persistence.xml specifically for your application. Follow these steps:

  1. Go to the Eclipse.org EclipseLink download site and download the EclipseLink implementation.
  2. The download contains several JAR files. For this example, find the following files and add them to Tomcat's lib directory:
    • eclipselink.jar
    • javax.persistence_2.0.X.jar
  3. Create the file persistence.xml and add it to your project's WebContent/META-INF folder.
    Your file's contents should look something like this:
    <?xml version="1.0" encoding="UTF-8" ?>
    <persistence xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://java.sun.com/xml/ns/persistence http://java.sun.com/xml/ns/persistence/persistence_2_0.xsd"
         version="2.0" xmlns="http://java.sun.com/xml/ns/persistence">
         <persistence-unit name="User" transaction-type="RESOURCE_LOCAL">
              <class>logon.User</class>
              <properties>
                   <property name="javax.persistence.jdbc.driver" value="org.apache.derby.jdbc.ClientDriver" />
                   <property name="javax.persistence.jdbc.url"
                        value="jdbc:derby://localhost:1527/sample;create=true" />
                   <property name="javax.persistence.jdbc.user" value="test" />
                   <property name="javax.persistence.jdbc.password" value="test" />
    
              </properties>
    
         </persistence-unit>
    </persistence>

In persistence.xml, we define a Persistence Unit for each of our domain (business) model classes. In this example, the User class is defined. The remaining properties define our database location and credentials.

Adding the User Entity Class, Login, and Welcome Pages

The User class has all the getters/setters for the Users table. At the top, we tell the compiler that the table name is Users. By default, the table name is the name of the entity class. We declare the class an Entity by using the @Entity annotation, as I mentioned earlier. Then we use the @Id annotation to generate an ID for the Id column of the table.

package logon;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;

@Entity
@Table(name="App.Users")
public class User {

     @Id
     @GeneratedValue(strategy = GenerationType.IDENTITY)
     private int id;
     
 String Name = null;
 String Login = null;
 String Password = null;

public int get_Id(){
     return id;
}
public void set_Id(int id){
this.id = id;
}
public String getName(){
return Name;
}
public void setName(String Name){
this.Name = Name;
}
public String getLogin(){     
return Login;
}
public void setLogin(String Login){
     this.Login = Login;
}
public String getPassword(){
     return Password;
}
public void setPassword(String Password){
     this.Password = Password;
}
     
}

Now we can test JPA by adding a record to our table:

  1. Create a META-INF folder in your src directory; then copy the persistence.xml file to your source/META-INF folder.
  2. Create the logon package and add the following Java class to this package. The class name should be LogonTest.
    package logon;
    
    import java.util.List;
    
    import javax.persistence.EntityManager;
    import javax.persistence.EntityManagerFactory;
    import javax.persistence.Persistence;
    import javax.persistence.Query;
    
    public class LogonTest {
         private static final String PERSISTENCE_UNIT_NAME = "User";
         private static EntityManagerFactory factory;
    
         public static void main(String[] args) {
              factory = Persistence.createEntityManagerFactory(PERSISTENCE_UNIT_NAME);
              EntityManager em = factory.createEntityManager();
              // Read the existing entries and write to console
              Query q = em.createQuery("SELECT u FROM User u");
              List<User> userList = q.getResultList();
              for (User user : userList) {
                   System.out.println(user.Name);
              }
              System.out.println("Size: " + userList.size());
    
              // Create new user
              em.getTransaction().begin();
              User user = new User();
              user.setName("Tom Johnson");
              user.setLogin("tomj");
              user.setPassword("pass");
              em.persist(user);
              em.getTransaction().commit();
    
              em.close();
         }
    }
  3. To test JPA, right-click the class and select Run As Java Application. On your console, you should see the output of the user that was just added. The user record should now be in the Users table.

To finish this example, you'll need a backing bean for the Login page. To create the backing bean, follow these steps:

  1. Double-click your faces-config.xml file to bring up the Faces editor.
  2. Click the Managed Bean tab and create a new Bean with the name logonBean1 that will be used to reference a new class called LogonBean.java, which will be a member of a new package called logon (in your project's src folder). The editor should create the new package and class for you.
  3. Copy the following code into your class to handle user authentication:
    package logon;
    import java.util.*;
    
    import javax.persistence.EntityManager;
    import javax.persistence.EntityManagerFactory;
    import javax.persistence.Persistence;
    import javax.persistence.Query;
    public class LogonBean {
         
          private static final String PERSISTENCE_UNIT_NAME = "User";
          private static EntityManagerFactory factory;
         
         private String userName;
         private String password;
         public LogonBean() { }
         public String getUserName() { return userName; }
         public void setUserName(String userName) { this.userName=userName; }
         public String getPassword() { return password; }
         public void setPassword(String password) { this.password=password; }
         public String validate() {
              String flag="failure";
                  factory = Persistence.createEntityManagerFactory(PERSISTENCE_UNIT_NAME);
                EntityManager em = factory.createEntityManager();
                Query q = em.createQuery("SELECT u FROM User u WHERE u.Login = :login AND u.Password = :pass");
               q.setParameter("login", userName);
               q.setParameter("pass", password);
               try{
                   User user = (User) q.getSingleResult();
                 if (userName.equalsIgnoreCase(user.Login)&&password.equals(user.Password)) {
                    flag="success";
                 }
               }catch(Exception e){      
                   return null;
               }
    
              return flag;
         }
    }
  4. Create the login.jsp page and place it in your WebContent folder:
    <%@ taglib uri="http://java.sun.com/jsf/html" prefix="h" %>
    <%@ taglib uri="http://java.sun.com/jsf/core" prefix="f" %>
    <html>
    <head>
    <title>Login Page</title>
    </head>
    <body>
    <f:view>
    <h:form id="helloForm">
    <Center>
    <H2>Logon Page</H2>
    </Br></Br>
    <table>
    <tr>
    <td>
    <h:outputLabel for="input1">
    <h:outputText id="nameLabel" value="User Name"/>
    </h:outputLabel>
    </td>
    <td>
    <h:inputText id="input1" value="#{logonBean1.userName}" size="20"/>
    </td>
    </tr>
    <tr>
    <td>
    <h:outputLabel for="input2">
    <h:outputText id="passwordLabel" value="Password"/>
    </h:outputLabel>
    </td>
    <td>
    <h:inputSecret id="input2" value="#{logonBean1.password}" size="20"/>
    </td>
    </tr>
    <tr>
    <td></td>
    <td>
    <h:commandButton id="logon" action="#{logonBean1.validate}" value="Logon">
    </h:commandButton>
    </td>
    </tr>
    </table>
    </Center>
    </h:form>
    </f:view>
    </body>
    </html>
  5. Create the welcome.jsp page and place it in your WebContent folder:
    <%@ taglib uri="http://java.sun.com/jsf/core" prefix="f" %>
    <%@ taglib uri="http://java.sun.com/jsf/html" prefix="h" %>
    <html>
    <head>
    <title>Greeting Page</title>
    </head>
    <body>
    <f:view>
    <h:form id="greetingForm">
    <Center>
    <H2>Greeting Page</H2>
    </Br></Br>
    <H4>Hello <h:outputText value="#{logonBean1.userName}"/>! You have been successfully
    authenticated.
    </H4>
    </Br></Br>
    <h:commandLink id="link" action="logout">
    <h:outputText value="Logout"/>
    </h:commandLink>
    </Center>
    </h:form>
    </f:view>
    </body>
    </html>
  6. Copy the code below into your faces-config.xml file. It establishes the navigation rule to the welcome page from the login page, based on a successful outcome.
    <?xml version="1.0" encoding="UTF-8"?>
    
    <faces-config
        xmlns="http://java.sun.com/xml/ns/javaee"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-facesconfig_2_0.xsd"
        version="2.0">
         <managed-bean>
              <managed-bean-name>logonBean1</managed-bean-name>
              <managed-bean-class>logon.LogonBean</managed-bean-class>
              <managed-bean-scope>session</managed-bean-scope>
         </managed-bean>
            <navigation-rule>
                   <display-name>login</display-name>
                   <from-view-id>/login.jsp</from-view-id>
    
                   <navigation-case>
                             <from-outcome>success</from-outcome>
                             
                        <to-view-id>/welcome.jsp</to-view-id>
                   </navigation-case>
            </navigation-rule>
    
    </faces-config>

Before running the example, verify that your web.xml file looks like the one below (substituting your project's name for Webbeans):

<?xml version="1.0" encoding="ASCII"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" version="3.0">
  <display-name>Webbeans</display-name>
  <servlet>
    <servlet-name>Faces Servlet</servlet-name>
    <servlet-class>javax.faces.webapp.FacesServlet</servlet-class>
    <load-on-startup>1</load-on-startup>
  </servlet>
  <servlet-mapping>
    <servlet-name>Faces Servlet</servlet-name>
    <url-pattern>/faces/*</url-pattern>
  </servlet-mapping>
  <context-param>
    <description>State saving method: 'client' or 'server' (=default). See JSF Specification 2.5.2</description>
    <param-name>javax.faces.STATE_SAVING_METHOD</param-name>
    <param-value>client</param-value>
  </context-param>
  <context-param>
    <param-name>javax.servlet.jsp.jstl.fmt.localizationContext</param-name>
    <param-value>resources.application</param-value>
  </context-param>
  <listener>
    <listener-class>com.sun.faces.config.ConfigureListener</listener-class>
  </listener>
  <servlet-mapping>
    <servlet-name>Faces Servlet</servlet-name>
    <url-pattern>*.jsf</url-pattern>
  </servlet-mapping>
  <servlet-mapping>
    <servlet-name>Faces Servlet</servlet-name>
    <url-pattern>*.faces</url-pattern>
  </servlet-mapping>
</web-app>

The example should now be ready to run. Your path should look like this (again, substituting your project's name):

http://localhost:8080/Webbeans/faces/login.jsp

You can change the faces context in the faces-config.xml file to whatever you like.

Testing the Example

Enter tomj as the username and pass as the password, click Submit, and you should get the welcome screen. If your credentials are incorrect, you'll stay at the login screen.

That's it! You've mastered authentication with JPA using a database.

In a later article I'll expand on this example, demonstrating the other CRUD operations, along with some JPQL queries.

Happy coding!

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