cicsdev / cics-java-liberty-sqlj

CICS® Liberty SQLJ sample web application

cics-java-liberty-sqlj

Sample SQLJ Java EE web application demonstrating how to use SQLJ in a web servlet to access Db2.

Repository structure

• projects/ - Eclipse projects suitable for importing into a CICS Explorer environment.
• etc/ - Liberty server configuration file samples

Samples overview

• com.ibm.cicsdev.sqlj.web - Dynamic web project containing the SimpleSQLJServlet servlet. The servlet uses the DoSQLJ class which connects to Db2 by obtaining a DataSource via a JNDI lookup. It then uses SQLJ and returns the current Db2 timestamp from the Db2 SYSIBM.SYSDUMMY1 table
• com.ibm.cicsdev.sqlj.web.cicsbundle - CICS bundle project that references the WAR (Dynamic web project) bundle part for deployment in a CICS bundle

Pre-requisites

• CICS TS V5.3 with APAR PI77502, or CICS TS V5.4
• Java SE 1.8 or later on the workstation
• IBM Db2 for z/OS
• CICS Explorer V5.4 with the IBM CICS SDK for Java EE and Liberty feature installed available here and IBM Data Studio Version 4.1.3 available here with APAR1 installed, available here

Configuration

The sample code can be deployed as a WAR file into a CICS Liberty JVM server. CICS Liberty can be configured to use either a local Db2 database with JDBC type 2 connectivity, or a remote database with a JDBC type 4 connectivity. The SimpleSQLJServlet servlet can then be used to display the current timestamp from Db2

To import the samples into Eclipse

1. Import the projects into CICS Explorer using File -> Import -> General -> Existing projects into workspace
2. Add SQLJ support to the dynamic web project com.ibm.cicsdev.sqlj.web using the context menu Add SQLJ support. This will add the DataStudio sqlj.zip file to the build path, and create a SQLJJavaSource folder containing the Java source and serialized profile (.ser) file which are generated automatically by the Data Studio tooling from the .sqlj source.
3. Resolve the remaining build path errors on the Dynamic web project using the following menu: Build Path -> Configure Build Path -> Libraries -> Add Library -> CICS with Java EE and Liberty and select the version of CICS TS for deployment (either CICS TS V5.3 or CICS TS V5.4)

To configure CICS for JDBC type 2 connectivity to Db2

1. Create a Liberty JVM server as described in 4 easy steps

2. Update the CICS STEPLIB with the Db2 SDSNLOAD and SDSNLOD2 libraries

3. Configure CICS DB2CONN, DB2TRAN and DB2ENTRY resource definitions as required in How you can define the CICS Db2 connection

4. Bind the Db2 plan that is specified in the CICS DB2CONN or DB2ENTRY definition with a PKLIST of NULLID.*

5. Add the following properties in the JVM profile to set the location of the Db2 drivers to allow CICS to automatically configure the default data source

   -Dcom.ibm.cics.jvmserver.wlp.autoconfigure=true
   -Dcom.ibm.cics.jvmserver.wlp.jdbc.driver.location=/usr/lpp/db2v12/jdbc
   

   where /usr/lpp/db2v12/jdbc is the location of the Db2 JDBC and SQLJ drivers

6. Edit the server.xml and add the Db2 JCC driver to the Liberty global library as shown in the supplied sample server.xml. This enables Web applications to access the required SQLJ Java packages.

   <library id="global">
       <fileset dir="/usr/lpp/db2v12/jdbc/classes" includes="db2jcc4.jar"/>
   </library>

An example Liberty server configuration of a data source with a type 2 connection is supplied in etc/config/type-2-server.xml. Configuration with a data source and a type 4 connection is in etc/config/type-4-server.xml

To deploy the sample into a CICS region

1. Optionally, change the name of the JVMSERVER in the .warbundle file in the com.ibm.cicsdev.sqlj.web.cicsbundle project from DFHWLP to the name of the JVMSERVER resource defined in CICS

2. Using the CICS Explorer export the com.ibm.cicsdev.jdbc.web.cicsbundle project to a zFS directory

3. Define and install a CICS BUNDLE resource definition referring to the deployed bundle directory on zFS in step 2, and ensure all resources are enabled

Running the sample

• The servlet is accessed with the following URL: http://host:port/com.ibm.cicsdev.sqlj.web/

If the test is successful, you will see the a response similar to the following written to the browser:

SimpleSQLJServlet: Db2 CurrentTimeStamp = 2017-08-02 11:28:46.18055

Reference

• Sample JDBC Git repository cics-java-liberty-jdbc
• CICS Knowledge Center Configuring a Liberty JVM server
• CICS Knowledge Center Configuring a JVM server to support Db2

License

This project is licensed under Apache License Version 2.0.