Object-Relational Mapping (ORM) with PingOne Data Entities in Java

You can use Hibernate to map object-oriented domain models to a traditional relational database. The tutorial below shows how to use the CData JDBC Driver for PingOne to generate an ORM of your PingOne repository with Hibernate.

Though Eclipse is the IDE of choice for this article, the CData JDBC Driver for PingOne works in any product that supports the Java Runtime Environment. In the Knowledge Base you will find tutorials to connect to PingOne data from IntelliJ IDEA and NetBeans.

Install Hibernate

Follow the steps below to install the Hibernate plug-in in Eclipse.

1. In Eclipse, navigate to Help -> Install New Software.
2. Enter "http://download.jboss.org/jbosstools/neon/stable/updates/" in the Work With box.
3. Enter "Hibernate" into the filter box.
4. Select Hibernate Tools.

Start A New Project

Follow the steps below to add the driver JARs in a new project.

1. Create a new project. Select Java Project as your project type and click Next. Enter a project name and click Finish.
2. Right-click the project and click Properties. Click Java Build Path and then open the Libraries tab.
3. Click Add External JARs to add the cdata.jdbc.pingone.jar library, located in the lib subfolder of the installation directory.

Add a Hibernate Configuration File

Follow the steps below to configure connection properties to PingOne data.

1. Right-click on the new project and select New -> Hibernate -> Hibernate Configuration File (cfg.xml).
2. Select src as the parent folder and click Next.

3. Input the following values:

   • Hibernate version:: 5.2
   • Database dialect: Derby
   • Driver class: cdata.jdbc.pingone.PingOneDriver

   • Connection URL: A JDBC URL, starting with jdbc:pingone: and followed by a semicolon-separated list of connection properties.

     To connect to PingOne, configure these properties:

     • : The region where the data for your PingOne organization is being hosted.
     • : The type of authentication to use when connecting to PingOne.
     • Either (required when using the default PingOne domain) or , configured as described below.

     Configuring WorkerAppEnvironmentId

     is the ID of the PingOne environment in which your Worker application resides. This parameter is used only when the environment is using the default PingOne domain (auth.pingone). It is configured after you have created the custom OAuth application you will use to authenticate to PingOne, as described in Creating a Custom OAuth Application in the Help documentation.

     First, find the value for this property:

     1. From the home page of your PingOne organization, move to the navigation sidebar and click Environments.
     2. Find the environment in which you have created your custom OAuth/Worker application (usually Administrators), and click Manage Environment. The environment's home page displays.
     3. In the environment's home page navigation sidebar, click Applications.
     4. Find your OAuth or Worker application details in the list.
     5. Copy the value in the Environment ID field. It should look similar to:
        

        WorkerAppEnvironmentId='11e96fc7-aa4d-4a60-8196-9acf91424eca'

     Now set to the value of the Environment ID field.

     Configuring AuthorizationServerURL

     is the base URL of the PingOne authorization server for the environment where your application is located. This property is only used when you have set up a custom domain for the environment, as described in the PingOne platform API documentation. See Custom Domains.

     Authenticating to PingOne with OAuth

     PingOne supports both OAuth and OAuthClient authentication. In addition to performing the configuration steps described above, there are two more steps to complete to support OAuth or OAuthCliet authentication:

     • Create and configure a custom OAuth application, as described in Creating a Custom OAuth Application in the Help documentation.
     • To ensure that the driver can access the entities in Data Model, confirm that you have configured the correct roles for the admin user/worker application you will be using, as described in Administrator Roles in the Help documentation.
     • Set the appropriate properties for the authscheme and authflow of your choice, as described in the following subsections.

     OAuth (Authorization Code grant)

     Set to OAuth.

     Desktop Applications

     Get and Refresh the OAuth Access Token

     After setting the following, you are ready to connect:

     • : GETANDREFRESH. To avoid the need to repeat the OAuth exchange and manually setting the each time you connect, use .
     • : The Client ID you obtained when you created your custom OAuth application.
     • : The Client Secret you obtained when you created your custom OAuth application.
     • : The redirect URI you defined when you registered your custom OAuth application. For example: https://localhost:3333

     When you connect, the driver opens PingOne's OAuth endpoint in your default browser. Log in and grant permissions to the application. The driver then completes the OAuth process:

     1. The driver obtains an access token from PingOne and uses it to request data.
     2. The OAuth values are saved in the location specified in , to be persisted across connections.

     The driver refreshes the access token automatically when it expires.

     For other OAuth methods, including Web Applications, Headless Machines, or Client Credentials Grant, refer to the Help documentation.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the PingOne JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     java -jar cdata.jdbc.pingone.jar
     

     Fill in the connection properties and copy the connection string to the clipboard.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     

     A typical JDBC URL is below:

     jdbc:pingone:AuthScheme=OAuth;WorkerAppEnvironmentId=eebc33a8-xxxx-4f3a-yyyy-d3e5262fd49e;Region=NA;OAuthClientId=client_id;OAuthClientSecret=client_secret;InitiateOAuth=GETANDREFRESH;

Connect Hibernate to PingOne Data

Follow the steps below to select the configuration you created in the previous step.

1. Switch to the Hibernate Configurations perspective: Window -> Open Perspective -> Hibernate.
2. Right-click on the Hibernate Configurations panel and click Add Configuration.
3. Set the Hibernate version to 5.2.
4. Click the Browse button and select the project.
5. For the Configuration file field, click Setup -> Use Existing and select the location of the hibernate.cfg.xml file (inside src folder in this demo).
6. In the Classpath tab, if there is nothing under User Entries, click Add External JARS and add the driver jar once more. Click OK once the configuration is done.
7. Expand the Database node of the newly created Hibernate configurations file.

Reverse Engineer PingOne Data

Follow the steps below to generate the reveng.xml configuration file. You will specify the tables you want to access as objects.

1. Switch back to the Package Explorer.
2. Right-click your project, select New -> Hibernate -> Hibernate Reverse Engineering File (reveng.xml). Click Next.
3. Select src as the parent folder and click Next.
4. In the Console configuration drop-down menu, select the Hibernate configuration file you created above and click Refresh.
5. Expand the node and choose the tables you want to reverse engineer. Click Finish when you are done.

Configure Hibernate to Run

Follow the steps below to generate plain old Java objects (POJO) for the PingOne tables.

1. From the menu bar, click Run -> Hibernate Code Generation -> Hibernate Code Generation Configurations.
2. In the Console configuration drop-down menu, select the Hibernate configuration file you created in the previous section. Click Browse by Output directory and select src.
3. Enable the Reverse Engineer from JDBC Connection checkbox. Click the Setup button, click Use Existing, and select the location of the hibernate.reveng.xml file (inside src folder in this demo).
4. In the Exporters tab, check Domain code (.java) and Hibernate XML Mappings (hbm.xml).
5. Click Run.

One or more POJOs are created based on the reverse-engineering setting in the previous step.

Insert Mapping Tags

For each mapping you have generated, you will need to create a mapping tag in hibernate.cfg.xml to point Hibernate to your mapping resource. Open hibernate.cfg.xml and insert the mapping tags as so:

 
 
 cdata.pingone.PingOneDriver
 
 
 jdbc:pingone:AuthScheme=OAuth;WorkerAppEnvironmentId=eebc33a8-xxxx-4f3a-yyyy-d3e5262fd49e;Region=NA;OAuthClientId=client_id;OAuthClientSecret=client_secret;InitiateOAuth=GETANDREFRESH;
 
 
 org.hibernate.dialect.SQLServerDialect
 
 
 
 

Execute SQL

Using the entity you created from the last step, you can now search PingOne data:

import java.util.*;
import org.hibernate.Session;
import org.hibernate.cfg.Configuration;
import org.hibernate.query.Query;

public class App {
 public static void main(final String[] args) {
 Session session = new
 Configuration().configure().buildSessionFactory().openSession();
 String SELECT = "FROM [CData].[Administrators].Users [ WHERE EmployeeType = :EmployeeType";
 Query q = session.createQuery(SELECT, [CData].[Administrators].Users.class);
 q.setParameter("EmployeeType","Contractor");
 List<[CData].[Administrators].Users> resultList = (List<[CData].[Administrators].Users>) q.list();

 for([CData].[Administrators].Users s: resultList){
 System.out.println(s.getId());
 System.out.println(s.getUsername());
 }
 }
}