WebLogic Server 7.0 Examples: Package examples.jdbc.oracle.extensions

Package

Class

WebLogic Server 7.0 Code Examples, BEA Systems, Inc.

Package examples.jdbc.oracle.extensions

This example demonstrates the usage of SQL3 datatypes in server-side applications with an Oracle database.

Interface Summary

Extensions

ExtensionsHome

Class Summary

AddressBO This class represents an address.

ArraysClient This client is the starting point to demonstrate Oracle ARRAY.

ArraysDAO This simple example shows how to use Oracle ARRAYs.

BaseClient Common client functions.

BaseDAO This class provides common database methods.

EmployeeBO This class represents an employee.

ExtensionsBean This class contains logic for the extension ejb.

RefsClient This client is the starting point to demonstrate Oracle REF.

RefsDAO This simple example shows how to use Oracle REFs.

StructsClient This client is the starting point to demonstrate Oracle STRUCT.

StructsDAO This simple example shows how to use Oracle STRUCTs.

Package examples.jdbc.oracle.extensions Description

This example demonstrates the usage of SQL3 datatypes in server-side applications with an Oracle database. The sample applications use the supported Oracle extension methods for STRUCTs, REFs, and ARRAYs. To run this example, you must use a connection pool and the Oracle Thin driver.

Note: You can use STRUCTs, REFs, and ARRAYs in server-side applications only.

Additional Resources for examples.jdbc.oracle.extensions

build.xml The Java Ant build script, which assembles and deploys required EJBs and client applications for this example. It also includes targets for preparing your database and running the example.

table.ddl SQL code used by the Java Ant db_setup_oracle script to create tables and objects in your database.

This example uses three client applications to demonstrate retrieving and inserting STRUCTs, and retrieving REFs and ARRAYs:

The STRUCTs client retrieves employee data, including addresses stored as objects and cast as STRUCTs, and then inserts records containing address objects as STRUCTs.
The REFs client retrieves employee records containing REF objects that reference objects in an object table of addresses.
The ARRAY client retrieves student records containing ARRAYs of test scores.

You compile this example with a single script and then run each client individually. Before you run the example, read through the source code files to get familiar with what actually happens in the example.

To facilitate this example, you create a connection pool and datasource to connect to your Oracle database. You also create the following object types and tables in your database via an ant script:

For the STRUCTs example:
- address_objtyp as an object type
- employees table with an address column that uses the address_objtyp
For the REFs example:
- address2_objtyp as an object type
- address_objtab as an object table based on address2_objtyp
- people table with an address_ref column that references values in the address_objtab table
For the ARRAYs example:
- scores datatype as a VARRAY(5) of VARCHAR(3)
- students table with a test_scores column that uses the scores datatype.

The following sections describe how to build and run the example.

Prerequisites
Configure the Server
Build the Example
Prepare the Database
Run the Example
Check the Output

Prerequisites

Before you run this example, you need:

WebLogic Server Version 7.0
JDK Version 1.3.1_01 (installed with WebLogic Server Version 7.0)
Oracle 8.1.7 or Oracle 9.0.1 DBMS
Oracle Thin Driver for your version of the DBMS (Shipped and configured with WebLogic Server 7.0)

Configure the Server

The following procedure shows how to set up a connection pool and Tx datasource to use to connect to your Oracle database.

Start the server with the examples configuration in a new command shell.
Start the Administration Console. Refer to Configuring JDBC Connectivity Using the Administration Console for detailed information on configuring connection pools and transaction datasources.
Configure the oraclePool connection pool and assign it to the examplesServer:
- Set the attributes for the connection pool:
  URL: jdbc:oracle:thin:@<server>:<port>:<sid> (port is typically 1521 for Oracle.)
  DriverName: oracle.jdbc.driver.OracleDriver
  User=<user name to connect to the database>
  Password=<password>
  
  Assign the oraclePool connection pool to the examplesServer.
Configure the examples-dataSource-oracleXAPool transaction datasource and assign it to the examplesServer:
- Set the attributes for the transaction datasource:
  Name: examples-dataSource-oracleXAPool
  JNDI Name: examples-dataSource-oracleXAPool
  Pool Name: oraclePool
  
  Assign the examples-dataSource-oracleXAPool transaction datasource to the examplesServer.

Build the Example

To build the example, follow these steps:

Open a command shell.
Set up the command shell as described in Setting up Your Environment.
Add the path to your BEA_HOME and to the Oracle Thin Driver classes (classes12.zip) to your CLASSPATH. For example:
```
set CLASSPATH=c:\bea;%WL_HOME%\server\lib\classes12.zip;%CLASSPATH%
```
Add the path to the WebLogic jDriver for Oracle classes (e.g., oci817_8 folder) to your PATH. For example:
```
set PATH=%WL_HOME%\server\bin\oci817_8;%PATH%
```
Change to the %SAMPLES_HOME%\server\src\examples\jdbc\oracle\extensions directory.
Execute the following command:
```
  ant
```

When you run the ant script to build the example, it builds all three clients in the example.

Prepare the Database

In the %SAMPLES_HOME%\server\src\examples.properties file, specify a value for the following properties:
- DBSERVER - The name of the server that hosts the Oracle database.
- SID - The Oracle sid.
- USER - The user name to use to connect to the database and create tables.
- PASSWORD - The password to use when connecting to the database.
The Ant db_setup_oracle script uses these properties when creating tables and objects in your database.
Note: You must have a matching entry for the database in tnsnames.ora. See Setting Up Examples to Run with an Oracle DBMS for more details.
Open a command shell.
Set up the command shell as described in Setting up Your Environment.
Change to the %SAMPLES_HOME%server\src\examples\jdbc\oracle\extensions directory.
Execute the following command:
```
 ant db_setup_oracle
```
The script creates the required object types and tables in your database.

For more information about setting up your database, see Setting Up Examples to Run with an Oracle DBMS.

Run the Example

Open a command shell.
Set up the command shell as described in Setting up Your Environment.
Add the path to your BEA_HOME and to the Oracle Thin Driver classes (classes12.zip) to your CLASSPATH. For example:
```
set CLASSPATH=c:\bea;%WL_HOME%\server\lib\classes12.zip;%CLASSPATH%
```
Add the path to the WebLogic jDriver for Oracle classes (e.g., oci817_8 folder) to your PATH. For example:
```
set PATH=%WL_HOME%\server\bin\oci817_8;%PATH%
```
Change to the %SAMPLES_HOME%\server\src\examples\jdbc\oracle\extensions directory.
Execute the following commands:
- To run the STRUCTs client:
```
ant run_structs
```
- To run the REFs client:
```
ant run_refs
```
- To run the ARRAYs client:
```
ant run_arrays
```

Check the Output

STRUCTs

When you run the STRUCTs client, you should see the following output in the command shell:

Buildfile: build.xml

run_structs:
     [java] Getting employees from database...
     [java] Employee#: 100
     [java] Name:      Alfred Chuang
     [java] Address: 1234 Post St
     [java]          San Francisco, CA
     [java]
     [java] Employee#: 101
     [java] Name:      Joe Walker
     [java] Address: 3321 Grand Ave
     [java]          San Diego, CA
     [java]
     [java] Employee#: 102
     [java] Name:      Tina Potter
     [java] Address: 7111 Ocala St
     [java]          Tallahassee, FL
     [java]
     [java] Employee#: 103
     [java] Name:      Fred Couples
     [java] Address: 9201 Park St
     [java]          Alexandria, VA
     [java]
     [java]
     [java] Inserting employee to database...
     [java]
     [java] Getting employees from database...
     [java] Employee#: 100
     [java] Name:      Alfred Chuang
     [java] Address: 1234 Post St
     [java]          San Francisco, CA
     [java]
     [java] Employee#: 101
     [java] Name:      Joe Walker
     [java] Address: 3321 Grand Ave
     [java]          San Diego, CA
     [java]
     [java] Employee#: 102
     [java] Name:      Tina Potter
     [java] Address: 7111 Ocala St
     [java]          Tallahassee, FL
     [java]
     [java] Employee#: 103
     [java] Name:      Fred Couples
     [java] Address: 9201 Park St
     [java]          Alexandria, VA
     [java]
     [java] Employee#: 105
     [java] Name:      David David
     [java] Address: 4431 Canal Street
     [java]          New Orleans, LA
     [java]

BUILD SUCCESSFUL

If you check the command shell running the server, you should see the following:

StructsDAO.getEmployees() -- Number of rows selected: 4
BaseDAO.getNextId() -- Next employees_seq id is 105
StructsDAO.insertEmployee() -- Number of rows inserted: 1
StructsDAO.getEmployees() -- Number of rows selected: 5

REFs

When you run the REFs client, you should see the following output in the command shell:

Buildfile: build.xml

run_refs:
     [java] Getting refs from database...
     [java]
     [java] See server output for results.

BUILD SUCCESSFUL

Check the command shell running the server to see the following:

RefsDAO.getAddresses() -- Id = 1001, Name = Alfred Chuang, Address Id = 100, Street = 1234 Post St, City = San Francisco, State = CA
RefsDAO.getAddresses() -- Id = 1002, Name = Joe Walker, Address Id = 101, Street = 3321 Grand Ave, City = San Diego, State = CA
RefsDAO.getAddresses() -- Id = 1003, Name = Fred Couples, Address Id = 102, Street = 9201 Park St, City = Alexandria, State = VA

ARRAYs

When you run the ARRAYs client, you should see the following output in the command shell:

Buildfile: build.xml

run_arrays:
     [java] Getting arrays from database...
     [java]
     [java] See server output for results.

BUILD SUCCESSFUL