Object-Relational Mapping (ORM) with Okta 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 Okta to generate an ORM of your Okta repository with Hibernate.

Though Eclipse is the IDE of choice for this article, the CData JDBC Driver for Okta works in any product that supports the Java Runtime Environment. In the Knowledge Base you will find tutorials to connect to Okta 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.okta.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 Okta 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.okta.OktaDriver

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

     To connect to Okta, set the Domain connection string property to your Okta domain.

     You will use OAuth to authenticate with Okta, so you need to create a custom OAuth application.

     Creating a Custom OAuth Application

     From your Okta account:

     1. Sign in to your Okta developer edition organization with your administrator account.
     2. In the Admin Console, go to Applications > Applications.
     3. Click Create App Integration.
     4. For the Sign-in method, select OIDC - OpenID Connect.
     5. For Application type, choose Web Application.
     6. Enter a name for your custom application.
     7. Set the Grant Type to Authorization Code. If you want the token to be automatically refreshed, also check Refresh Token.
     8. Set the callback URL:
        • For desktop applications and headless machines, use http://localhost:33333 or another port number of your choice. The URI you set here becomes the CallbackURL property.
        • For web applications, set the callback URL to a trusted redirect URL. This URL is the web location the user returns to with the token that verifies that your application has been granted access.
     9. In the Assignments section, either select Limit access to selected groups and add a group, or skip group assignment for now.
     10. Save the OAuth application.
     11. The application's Client Id and Client Secret are displayed on the application's General tab. Record these for future use. You will use the Client Id to set the OAuthClientId and the Client Secret to set the OAuthClientSecret.
     12. Check the Assignments tab to confirm that all users who must access the application are assigned to the application.
     13. On the Okta API Scopes tab, select the scopes you wish to grant to the OAuth application. These scopes determine the data that the app has permission to read, so a scope for a particular view must be granted for the driver to have permission to query that view. To confirm the scopes required for each view, see the view-specific pages in Data Model < Views in the Help documentation.

     Built-in Connection String Designer

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

     java -jar cdata.jdbc.okta.jar

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

     A typical JDBC URL is below:

     jdbc:okta:Domain=dev-44876464.okta.com;InitiateOAuth=GETANDREFRESH

Connect Hibernate to Okta 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 Okta 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 Okta 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:

Execute SQL

Using the entity you created from the last step, you can now search Okta 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 Users U WHERE Status = :Status"; Query q = session.createQuery(SELECT, Users.class); q.setParameter("Status","Active"); List<Users> resultList = (List<Users>) q.list(); for(Users s: resultList){ System.out.println(s.getId()); System.out.println(s.getProfileFirstName()); } } }