JPublisher User's Guide
11g Release 2 (11.2)
E10587-05
August 2011
Oracle Database JPublisher User's Guide, 11g Release 2 (11.2)
E10587-05
Copyright © 1999, 2011, Oracle and/or its affiliates. All rights reserved.
Primary Author: Tulika Das, Brian Wright
Contributing Authors: Venkatasubramaniam Iyer, Janice Nygard, Thomas Pfaeffle, Ekkehard Rohwedder, P. Alan Thiesen
Contributor: Quan Wang, Kuassi Mensah, Deepa Aswani, Prabha Krishna, Ellen Siegal
This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:
U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle America, Inc., 500 Oracle Parkway, Redwood City, CA 94065.
This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.
This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.
This chapter describes the usage and syntax details of JPublisher option settings and input files to specify program behavior. It is organized into the following sections:
The following sections list and discuss JPublisher command-line options:
Table 6-1 summarizes JPublisher options. For default values, the abbreviation, NA, means not applicable. The Category column refers to the corresponding conceptual area, indicating the section of this chapter where the option is discussed.
Table 6-1 Summary of JPublisher Options
| Option Name | Description | Default Value | Category |
|---|---|---|---|
|
|
Determines the access modifiers that JPublisher includes in generated method definitions. |
|
Java code generation |
|
|
Appends an entry to the JPublisher default type map. |
NA |
Type maps |
|
|
Appends an entry to the JPublisher user type map. |
NA |
Type maps |
|
|
Specifies the data type mappings, |
|
Data type mappings |
|
|
Specifies the case of Java identifiers that JPublisher generates. |
|
Java code generation |
|
|
Adds to the Java classpath for JPublisher to resolve Java source and classes during translation and compilation. |
Empty |
Java environment |
|
|
Specifies a compatibility mode and modifies the behavior of See Also: "JPublisher Backward-Compatibility Modes and Settings" |
|
Backward compatibility |
|
|
Determines whether to proceed with Java compilation or suppress it. This option also affects SQLJ translation for backward-compatibility modes. |
|
Input/output |
|
|
Specifies a Java compiler version, in case you want a version other than the default. |
NA |
Java environment |
|
|
Specifies the class that JPublisher uses for SQLJ connection contexts. This can be the |
|
Connection |
|
|
Sets the default type map that JPublisher uses. |
Type maps | |
|
|
Specifies the root directory for placement of compiled class files. |
Empty (all files directly present in the current directory) |
Input/output |
|
|
Specifies the root directory for placement of generated source files. |
Empty (all files directly present in the current directory) |
Input/output |
|
|
Specifies the driver class that JPublisher uses for Java Database Connectivity (JDBC) connections to the database. |
|
Connection |
|
|
Specifies the Java encoding of JPublisher input and output files. |
The value of the system property |
Input/output |
|
|
Specifies a Web service endpoint. This option is used in conjunction with the |
NA |
Web services |
|
|
Filters code generation according to specified parameter modes. |
NA |
Java code generation |
|
|
Filters code generation according to specified parameter types. |
NA |
Java code generation |
|
|
Ensures that generated code conforms to the JavaBeans specification. |
|
Java code generation |
|
|
Defines naming patterns for generated code. |
NA |
Java code generation |
|
|
Specifies whether and how to generate stub code for user subclasses. |
|
Java code generation |
|
|
Specifies a proxy URL to resolve the URL of a Web Services Description Language (WSDL) document for access through a firewall. This option is used in conjunction with the |
NA |
Web services |
|
|
Specifies a file that lists the types and packages that JPublisher translates. |
NA |
Input files/items |
|
|
Specifies server-side Java classes for which JPublisher generates client-side classes. |
NA |
Input files/items |
|
|
Specifies the |
|
Data type mappings |
|
|
Specifies the mapping that generated methods support for object attribute types and method argument types. Note: This option is deprecated in favor of the " |
|
Data type mappings |
|
|
Determines whether JPublisher generates wrapper methods for stored procedures of translated SQL objects and PL/SQL packages. This option also determines whether JPublisher generates SQLJ classes or non-SQLJ classes, and whether it generates PL/SQL wrapper classes at all. There are settings to specify whether overloaded methods are allowed. |
|
Java code generation |
|
|
Specifies the data type mappings, such as |
|
Data type mappings |
|
|
Instructs JPublisher not to include the schema in SQL type name references in generated code. |
Disabled (schema included in type names) |
Java code generation |
|
|
Specifies the holder type, such as arrays, Java API for XML-based Remote Procedure Call (JAX-RPC) holders, or function returns, for Java implementation of PL/SQL output parameters. |
|
Java code generation |
|
|
Specifies whether to ignore naming conflicts when creating SQL types. |
|
PL/SQL code generation |
|
|
Specifies the name of the Java package into which JPublisher generates Java wrapper classes. |
NA |
Java code generation |
|
|
Specifies a wrapper script to create and a dropper script to drop SQL conversion types for PL/SQL types and the PL/SQL package that JPublisher will use for generated PL/SQL code. |
|
PL/SQL code generation |
|
|
Specifies whether to generate PL/SQL wrapper functions for stored procedures that use PL/SQL types. |
|
PL/SQL code generation |
|
|
Specifies the PL/SQL package into which JPublisher generates PL/SQL code, such as call specifications, conversion functions, and wrapper functions. |
|
PL/SQL code generation |
|
|
Specifies a file that contains JPublisher options in addition to those listed on the command line. |
NA |
Input files/items |
|
|
Specifies Java classes for which JPublisher generates wrapper classes and PL/SQL wrappers according to the |
NA |
Web services |
|
|
Specifies required layers of Java and PL/SQL wrappers and additional related settings. Is used as input for the |
|
Web services |
|
|
Specifies the URL of a WSDL document for which Web services client proxy classes and associated Java wrapper classes are generated along with PL/SQL wrappers. |
NA |
Web services |
|
|
Specifies whether the code generated for object types implements the |
|
Java code generation |
|
|
Specifies object types and packages, or subsets of packages, for which JPublisher generates Java classes, and optionally subclasses and interfaces. |
NA |
Input files/items |
|
|
Specifies SQLJ option settings for the JPublisher invocation of the SQLJ translator. |
NA |
SQLJ |
|
|
Specifies SQL queries or data manipulation language (DML) statements for which JPublisher generates Java classes, and optionally subclasses and interfaces, with appropriate methods. |
NA |
Input files/items |
|
|
Specifies the name of a "style file" for Java-to-Java type mappings. |
NA |
Data type mappings |
|
|
Specifies the name and password for a superuser account that can be used to grant permissions to execute wrappers that access Web services client proxy classes in the database. |
NA |
Web services |
|
|
Specifies whether to generate a |
|
Java code generation |
|
|
Specifies the JPublisher type map. |
Empty |
Type maps |
|
|
Specifies object types for which JPublisher generates code. Note: This option is deprecated in favor of |
NA |
Input files/items |
|
|
Specifies the URL that JPublisher uses to connect to the database. |
|
Connection |
|
|
Specifies an Oracle user name and password for connection. |
NA |
Connection |
|
|
Specifies the |
|
Data type mappings |
|
|
Specifies a Java version, in case you want a version other than the default. |
NA |
Java environment |
Be aware of the following usage notes for JPublisher options:
J Publisher always requires the -user option or its shorthand equivalent -u.
Options are processed in the order in which they appear. Options from an INPUT file are processed at the point where the -input or -i option occurs. Similarly, options from a properties file are processed at the point where the -props or -p option occurs.
As a rule, if a particular option appears more than once, JPublisher uses the value from the last occurrence. However, this is not true for the following options, which are cumulative:
-sql
-types, which is deprecated
-java
-addtypemap or -adddefaulttypemap
-style
In general, separate options and corresponding option values by an equal sign (=). However, when the following options appear on the command line, you can also use a space as a separator:
-sql or -s, -user or -u, -props or -p, and -input or -i
With the -sqlj option, you must use a space instead of an equal sign, because SQLJ settings following the -sqlj option use equal signs. Consider the following example, where each entry after "-sqlj" is a SQLJ option:
% jpub -user=scott -sql=PERSON:Person -sqlj -optcols=true -optparams=true -optparamdefaults=datatype1(size1),datatype2(size) Enter scott password: password
It is advisable to specify a Java package for generated classes with the -package option, either on the command line or in a properties file. For example, you could enter the following on the command line:
% jpub -sql=Person -package=e.f ...
Alternatively, you could enter the following in the properties file:
jpub.sql=Person jpub.package=e.f ...
These statements direct JPublisher to create the class Person in the Java package e.f, that is, to create the class e.f.Person.
If you do not specify a type or package in the INPUT file or on the command line, then JPublisher translates all types and packages in the user schema according to the options specified on the command line or in the properties file.
The JPublisher option syntax used in the following sections uses the following notational conventions:
Braces {...} enclose a list of possible values. Specify only one of the values within the braces.
A vertical bar | separates alternatives within braces.
Terms in italics are for user input. Specify an actual value or string.
Terms in boldface indicate default values.
Square brackets [...] enclose optional items. In some cases, however, square brackets or parentheses are part of the syntax and must be entered verbatim. In this case, this manual uses boldface: [...] or (...).
Ellipsis points ... immediately following an item, or items enclosed in brackets, mean that you can repeat the item any number of times.
Punctuation symbols other than those described in this section are entered as shown in this manual. These include "." and "@", for example.
This section documents the following JPublisher options that specify key input, either JPublisher input files, such as INPUT files or properties files, or items to publish, such as SQL objects, PL/SQL packages, SQL queries, SQL DML statements, or server-side Java classes:
Options for input files: -input, -props
Options for items to publish: -java, -sql, -sqlstatement, -types
These options are discussed in alphabetic order.
The -input option specifies the name of a file from which JPublisher reads the names of SQL or PL/SQL entities or server-side Java classes to publish, along with any related information or instructions. JPublisher publishes each item in the list. You can think of the INPUT file as a makefile for type declarations, which lists the types that need Java class definitions.
The syntax of the -input option is as follows:
-input=filename -i filename
Both formats are synonymous. The second one is a convenient command-line shortcut.
In some cases, JPublisher may find it necessary to translate some additional classes that do not appear in the INPUT file. This is because JPublisher analyzes the types in the INPUT file for dependencies before performing the translation and translates other types as necessary.
If you do not specify any items to publish in an INPUT file or on the command line, then JPublisher translates all user-defined SQL types and PL/SQL packages declared in the database schema to which it is connected.
The -java option enables you to create client-side stub classes to access server-side classes. This is an improvement over earlier JPublisher releases in which calling Java stored procedures and functions from a database client required JDBC calls to associated PL/SQL wrappers.
The syntax of the -java option is as follows:
-java=class_or_package_list
The functionality of the -java option mirrors that of the -sql option. It creates a client-side Java stub class to access a server-side Java class, in contrast to creating a client-side Java class to access a server-side SQL object or PL/SQL package.
When using the -java option, specify a comma-delimited list of server-side Java classes or packages.
|
Note:
|
For example:
-java=foo.bar.Baz,foo.baz.*
Or, to specify the client-side class name corresponding to Baz, instead of using the server-side name by default:
-java=foo.bar.Baz:MyBaz,foo.baz.*
This setting creates MyBaz and not foo.bar.MyBaz.
or:
-java=foo.bar.Baz:foo.bar.MyBaz,foo.baz.*
You can also specify a schema:
-java=foo.bar.Baz@SCOTT
If you specify the schema, then only that schema is searched. If you do not specify a schema, then the schema of the logged-in user, according to the -user option setting, is searched. This is the most likely scenario.
As an example, assume that you want to call the following method on the server:
public String oracle.sqlj.checker.JdbcVersion.to_string();
Use the following -java setting:
-java=oracle.sqlj.checker.JdbcVersion
|
Note: If JPublisher cannot find a specified class in the schema, a specified schema or the schema of the logged-in user, then it uses theClass.forName() method to search for the class among system classes in the Java Virtual Machine (JVM), typically Java run-time environment (JRE) or JDK classes. |
Code Generation for -java Option When you use the -java option, generated code uses the following API:
public class Client
{
public static String getSignature(Class[]);
public static Object invoke(Connection, String, String,
String, Object[]);
public static Object invoke(Connection, String, String,
Class[], Object[]);
}
Classes for the API are located in the oracle.jpub.reflect package, so client applications must import this package.
For a setting of -java=oracle.sqlj.checker.JdbcVersion, JPublisher-generated code includes the following call:
Connection conn = ...;
String serverSqljVersion = (String)
Client.invoke(conn, "oracle.sqlj.checker.JdbcVersion",
"to_string", new Class[]{}, new Object[]{});
The Class[] array is for the method parameter types, and the Object[] array is for the parameter values. In this case, because to_string has no parameters, the arrays are empty.
Note the following:
Any serializable type, such as int[] or String[], can be passed as an argument.
The semantics of this API are different from the semantics for invoking Java stored procedures or functions through a PL/SQL wrapper, in the following ways:
Arguments cannot be OUT or IN OUT. Returned values must be part of the function result.
Exceptions are properly returned.
Method invocation uses invoker's rights. There is no tuning to obtain definer's rights.
|
See Also: Oracle Database Java Developer's Guide for information about invoker's rights and definer's rights |
The related options for publishing a server-side Java class are:
-dbajva=class_list
-proxyopts=single|multiple|static|arrayin|arrayout|arrayinout |arrayall|noload
-compatible=10.1
-sysuser=user/password
-plsqlfile=wrapper[,dropper]
-plsqlpackage=name
Oracle Database 10g release 1 (10.1) introduced the -java option to publish server-side Java classes. Oracle Database 10g release 2 (10.2) introduced a new approach toward server-side Java class publishing. The -dbjava option publishes a server-side Java class into PL/SQL, or into client-side Java class. The class_list specification is a comma-delimited list of server-side classes at the specified server. The class_list item is of the form classname[:name[#interface]]. It can also be a package name. Consider the option:
-dbajva=classname[:name[#interface]]
If name is not specified, then the server-side Java class, classname, is published into PL/SQL, else into the client-side Java class, name. If interface is specified, then the interface file is generated for the client-side Java class.
When used with -dbjava, the -proxyopts option indicates whether to map instance methods using a singleton instance or using multiple instances, and also whether to map methods with array parameters assuming arrays as IN, OUT, IN OUT, or all the modes. The -proxyopts=static setting specifies that only static methods should be published. The default setting, -proxyopts=single,arrayin, indicates that instance methods are called using a singleton instance and array parameters are considered as input. The -proxyopts=noload setting forbids JPublisher from loading the generated PL/SQL and Java stored procedure wrappers.
The -compatible=10.1 option makes -dbjava equivalent to -java.
The related options for publishing server-side Java class are:
-proxyclasses=class_or_jar_list
-proxyopts=single|multiple|static|arrayin|arrayout|arrayinout |arrayall
-plsqlfile=wrapper[,dropper]
-plsqlpackage=name
The -proxyclasses option is similar to -dbjava. While -dbjava requires that the classes to be published exist in the database, -proxyclasses requires that the classes appear in the classpath. Typically, by using -proxyclasses, you can load the exposed classes and the generated wrappers into the database later.
The -proxyclasses option generates only a PL/SQL wrapper. Unlike -dbjava, it will not generate client-side Java code for a server-side Java class. Also, unlike -dbjava, -proxyclasses does not load the generated Java stored procedure into the database.
You can use the -proxyclasses option to specify a comma-delimited list of Java classes, either loose classes or Java Archive (JAR) files, for which JPublisher creates PL/SQL wrappers. Depending on the situation, JPublisher can also create Java wrapper classes to afford access from PL/SQL. Each of the classes processed must have either public, static methods or, for classes in which you want to publish instance methods, a public zero-argument constructor.
To summarize, the following are generated for each class being processed, depending on the -proxyopts option settings:
A PL/SQL wrapper to allow access from PL/SQL. This is always generated.
A wrapper class to expose Java instance methods as static methods, if there are any instance methods to publish.
Instance methods must be exposed as static methods to allow access from PL/SQL. A wrapper class is also necessary if the wrapped class uses anything other than Java primitive types in the method calling sequences.
While using the -proxyclasses option directly, you can specify JAR files and Java classes that exist in the classpath. Classes and JAR files can be specified as follows:
Class name, such as foo.bar.Baz or foo.bar.Baz.class
Package name, such as foo.bar.*, for @server mode only
JAR or ZIP file name, such as foo/bar/baz.jar or Baz.zip
JAR or ZIP file name followed by parenthesized list of classes or packages, such as baz.jar (foo.MyClass1, foo.bar.MyClass2, foo1.*)
The -proxyopts option is used as input by the -dbjava, -proxywsdl, and -proxyclasses options and specifies JPublisher behavior in generating wrapper classes and PL/SQL wrappers for server-side Java classes.
The syntax of the -proxyopts option is as follows:
-proxyopts=setting1,setting2,...
This option uses the basic settings, which can be used individually or in combinations. In this discussion, processed classes are the classes that are wrapped by using the -dbjava, -proxywsdl, or -proxyclasses options.
Where Java wrapper classes are generated, the wrapper class for a class foo.bar.MyClass would be foo.bar.MyClassJPub, unless the package is overridden by a setting of the -package option.
You can use the basic -proxyopts settings as follows:
Use the static setting to specify the treatment of static methods of processed classes.
With this setting, in the PL/SQL wrapper, a wrapper procedure is generated for each static method. Without this setting, static methods are ignored. For classes with only static methods, wrapper classes are not required for processed classes that use only Java primitive types in their method calling sequences.
Use the multiple or single setting to specify treatment of instance methods of processed classes, where you want instance methods exposed as static methods. In either case, for each processed class, JPublisher generates an intermediate Java class that wraps instance methods with static methods, in addition to generating a PL/SQL wrapper.
Use the instance setting to specify treatment of instance methods of processed classes, where you want instance methods maintained as instance methods.
These settings function as follows:
multiple
For each processed class, the Java wrapper class has a static equivalent for each instance method through the use of handles, which identify instances of wrapped classes.
single
Only a single default instance of each wrapped class is used during run time. For each processed class, the Java wrapper class has static wrapper methods for instance methods without requiring the use of handles. This is the singleton mechanism.
instance
Instance methods are wrapped as instance methods in the Java wrapper class.
|
Note: Theinstance setting is not appropriate for Web services. |
The instance methods are ignored if one of these settings or a jaxrpc or soap setting, which implies single, is not specified. For either of these settings, only classes that provide a public zero-argument constructor are processed. You can use both settings to generate wrapper classes of both styles.
Use the jaxrpc or soap setting to publish instance methods of Web services client proxy classes. These settings function as follows:
jaxrpc
This is the default setting. It is a convenient setting for wrapping JAX-RPC client proxy classes, which is appropriate for use with Oracle Application Server 10g 10.0.1 and later releases. JPublisher creates a Java wrapper class for each processed class and also creates the PL/SQL wrapper. Client proxy classes do not have static methods to be published, and instance methods are published using the singleton mechanism by default. Therefore, when processing JAX-RPC client proxy classes, -proxyopts=jaxrpc implies -proxyopts=single. The jaxrpc setting also results in generation of special code that is specific to JAX-RPC clients.
soap
This setting is equivalent to the jaxrpc setting, but is used for wrapping SOAP client proxy classes instead of JAX-RPC client proxy classes. This is appropriate for use with Oracle Application Server 10g 9.0.4 and earlier releases.
Here are some basic uses of the -proxyopts option:
-proxyopts=jaxrpc -proxyopts=soap -proxyopts=static -proxyopts=static,instance -proxyopts=single -proxyopts=single,multiple -proxyopts=static,multiple
The static,instance setting publishes static and instance methods. The single,multiple setting publishes only instance methods, using both the singleton mechanism and the handle mechanism. The static,multiple setting publishes static and instance methods, using the handle mechanism to expose instance methods as static methods.
|
Note: It is typical to explicitly use the-proxyopts option with the -proxyclasses option than with the -proxywsdl option. For the use of -proxywsdl with 10.0.x releases of Oracle Application Server 10g, the default -proxyopts=jaxrpc setting is sufficient. |
There are additional, advanced -proxyopts settings as well. The functionality of each setting is as follows:
noload
Use this to indicate that the generated code need not be loaded into the database. By default, the generated code is loaded.
recursive
Use this to indicate that when processing a class that extends another class, also create PL/SQL and Java wrappers, if appropriate, for inherited methods.
tabfun
Use this with the jaxrpc or soap setting for JPublisher to generate PL/SQL table functions for the PL/SQL package for each of the wrapped Web services operations. This exposes data through database tables rather than stored procedures or functions.
Do not use the -proxyopts=tabfun setting when the Web service operation contains array types as parameter types. In such cases, JPublisher generates PL/SQL stored procedure with SQL tables as parameter types. So, setting the -proxyopts=tabfun setting will result in compilation error for the generated PL/SQL wrapper.
deterministic
Use this to indicate in the generated PL/SQL wrapper that the wrapped methods are deterministic. This would typically be used with the tabfun setting. Deterministic is a PL/SQL annotation.
main(0,...)
Use this with the static setting to define the wrapper methods to be generated if there is a public void String main(String[]) method in the class. A separate method is generated for each number of arguments that you want to support. You can use commas or hyphens when indicating the number of arguments, as in the following examples:
main or main(0) produces a wrapper method only for zero arguments.
main(0,1) produces wrapper methods for zero arguments and one argument. This is the default setting.
main(0-3) produces wrapper methods for zero, one, two, and three arguments.
main(0,2-4) produces wrapper methods for zero, two, three, and four arguments.
The maximum number of arguments in the wrapper method for the main() method is according to PL/SQL limitations.
The following example uses the jaxrpc basic setting by default. It also uses table functions and indicates that wrapped methods are deterministic:
-proxyopts=tabfun,deterministic
The following example explicitly sets the static mode, processing classes that are not client proxy classes, and specifies that the generated code should not be loaded into the database:
-proxyopts=static,noload
The -props option specifies the name of a JPublisher properties file that specifies JPublisher option settings. JPublisher processes the properties file as if its contents were inserted in sequence on the command line where the -props option is specified.
The syntax of the -props option is as follows:
-props=filename -p filename
Both formats are synonymous. The second one is provided as a convenient command-line shortcut.
If more than one properties file appears on the command line, then JPublisher processes them with the other command-line options, in the order in which they appear.
|
Note: Encoding settings, either set through the JPublisher-encoding option or the Java file.encoding setting, do not apply to Java properties files. Properties files always use the 8859_1 encoding. This is a feature of Java in general, and not of JPublisher in particular. However, you can use Unicode escape sequences in a properties file. |
The -sql option is used to specify the user-defined SQL types, such as objects or collections, or the PL/SQL packages that need to be published. Optionally, you can specify the user subclasses or interfaces that should be generated. You can publish all or a specific subset of a PL/SQL package.
The syntax of the -sql option is as follows:
-sql={toplevel|object_type_and_package_translation_syntax}
-s {toplevel|object_type_and_package_translation_syntax}
The two formats of this option, -sql and -s, are synonymous. The -s format is provided as a convenient command-line shortcut.
You can use the -sql option when you do not need the generality of an INPUT file. The -sql option lets you list one or more database entities declared in SQL that you want JPublisher to translate. Alternatively, you can use several -sql options in the same command line, or several jpub.sql options in a properties file.
You can mix user-defined type names and package names in the same -sql declaration. JPublisher can detect whether each item is an object type or a package. You can also use the -sql option with the keyword toplevel to translate all top-level PL/SQL subprograms in a schema. The toplevel keyword is not case-sensitive.
If you do not specify any types or packages to translate in the INPUT file or on the command line, then JPublisher translates all the types and pa ckages in the schema to which you are connected. In this section, the -sql option is explained in terms of the equivalent INPUT file syntax.
You can use the any of the following syntax modes:
-sql=name_a
JPublisher publishes name_a, naming the generated class according to the default settings. In an INPUT file, you specify this options as follows:
SQL name_a
-sql=name_a:class_c
JPublisher publishes name_a as the generated Java class class_c. In an INPUT file, you specify this options as follows:
SQL name_a AS class_c
-sql=name_a:class_b:class_c
In this case, name_a must represent an object type. JPublisher generates the Java class, class_b, and a stub class, class_c, that extends class_b. You provide the code for class_c, which is used to represent name_a in your Java code. In an INPUT file, you specify this options as follows:
SQL name_a GENERATE class_b AS class_c
-sql=name_a:class_b#intfc_b
-sql=name_a:class_b:class_c#intfc_c
You can use either of these syntax formats to have JPublisher generate a Java interface. This feature is particularly useful for Web services. In the first case, class_b represents name_a and implements intfc_b. In the second case, class_c represents name_a, extends class_b, and implements intfc_c.
Specify an interface for either the generated class or the user subclass, but not both. In an INPUT file, this syntax is as follows:
SQL name_a [GENERATE class_b [ implements intfc_b] ] [AS class_c [ implements intfc_c ] ] ...
If you enter more than one item for translation, then the items must be separated by commas, without any white space. This example assumes that CORPORATION is a package and that EMPLOYEE and ADDRESS are object types:
-sql=CORPORATION,EMPLOYEE:OracleEmployee,ADDRESS:JAddress:MyAddress
JPublisher interprets this command as follows:
SQL CORPORATION SQL EMPLOYEE AS OracleEmployee SQL ADDRESS GENERATE JAddress AS MyAddress
JPublisher performs the following actions:
Creates a wrapper class for the CORPORATION package.
Translates the EMPLOYEE object type as OracleEmployee.
Generates an object reference class, OracleEmployeeRef.
Translates ADDRESS as JAddress, but generates code and references so that ADDRESS objects will be represented by the MyAddress class.
Generates a MyAddress stub, which extends JAddress, where you can write your custom code.
Generates an object reference class MyAddressRef.
If you want JPublisher to translate all the top-level PL/SQL subprograms in the schema to which JPublisher is connected, then enter the keyword toplevel following the -sql option. JPublisher treats the top-level PL/SQL subprograms as if they were in a package. For example:
-sql=toplevel
JPublisher generates a wrapper class, toplevel, for the top-level subprograms. If you want the class to be generated with a different name, you can declare the name as follows:
-sql=toplevel:MyClass
Note that this is synonymous with the following INPUT file syntax:
SQL toplevel AS MyClass
Similarly, if you want JPublisher to translate all the top-level PL/SQL subprograms in some other schema, then enter:
-sql=schema_name.toplevel
In this example, schema_name is the name of the schema containing the top-level subprograms. In addition, there are features to publish only a subset of stored procedures in a PL/SQL package or at the top level, using the following syntax:
-sql=plsql_package(proc1+proc2+proc3+...)
Use a plus sign (+) between stored procedure names. Alternatively, for the SQL top level, use:
-sql=toplevel(proc1+proc2+proc3+...)
The following syntax is for a JPublisher INPUT file, where commas are used between stored procedure names:
SQL plsql_package (proc1, proc2, proc3, ...) AS ...
|
Note:
|
You can also specify the subset according to stored procedure names and argument types by using the following syntax:
myfunc(sqltype1, sqltype2, ...)
In this case, only those stored procedures that match in name and the number and types of arguments will be published. For example:
-sql=mypackage(myfunc1(NUMBER, CHAR)+myfunc2(VARCHAR2))
The -sqlstatement option enables you to publish SELECT, INSERT, UPDATE, or DELETE statements as Java methods. JPublisher generates SQLJ classes for this functionality.
The syntax of the -sqlstatement option is as follows:
-sqlstatement.class=ClassName:UserClassName#UserInterfaceName -sqlstatement.methodName=sqlStatement -sqlstatement.return={both|resultset|beans}
Use -sqlstatement.class to specify the Java class in which the method will be published. In addition to the JPublisher-generated class, you can optionally specify a user subclass of the generated class, a user interface for the generated class or subclass, or both. Functionality for subclasses and interfaces is the same as for the -sql option. If you also use the JPublisher -package option, then the class you specify will be in the specified package. The default class is SQLStatements.
Use -sqlstatement.methodName to specify the desired Java method name and the SQL statement. For a SELECT statement, use -sqlstatement.return to specify whether JPublisher should generate a method that returns a generic java.sql.ResultSet instance, a method that returns an array of JavaBeans, or both. Generic implies that the column types of the result set are unknown or unspecified.
For queries, however, the column types are actually known. This provides the option of returning specific results through an array of beans. The name of the method returning ResultSet will be methodName(). The name of the method returning JavaBeans will be methodNameBeans().
|
Note: If your desired class and interface names follow a pattern, then you can use the-genpattern option for convenience. |
JPublisher INPUT file syntax is as follows:
SQLSTATEMENTS_TYPE ClassName AS UserClassName IMPLEMENTS UserInterfaceName SQLSTATEMENTS_METHOD aSqlStatement AS methodName
Here is a set of sample settings:
-sqlstatement.class=MySqlStatements
-sqlstatement.getEmp="select ename from emp
where ename=:{myname VARCHAR}"
-sqlstatement.return=both
These settings result in the generated code shown in "Generated Code: SQL Statement".
In addition, be aware that a style file specified through the -style option is relevant to the -sqlstatement option. If a SQL statement uses an Oracle data type X, which corresponds to a Java type Y, and type Y is mapped to a Java type Z in the style file, then methods generated as a result of the -sqlstatement option will use Z, and not Y.
For SELECT or DML statement results, you can use a style file to map the results to javax.xml.transform.Source, oracle.jdbc.rowset.OracleWebRowSet, or org.w3c.dom.Document.
The -types option lets you list one or more individual object types that you want JPublisher to translate. The syntax of the -types option is as follows:
-types=type_translation_syntax
|
Note: The-types option is currently supported for compatibility, but it is deprecated. Use the -sql option instead. |
You can use the -types option, for SQL object types only and when you do not need the generality of an INPUT file. Except for the fact that the -types option does not support PL/SQL packages, it is identical to the -sql option.
If you do not enter any types or packages to translate in the INPUT file or on the command line, then JPublisher translates all the types and packages in the schema to which you are connected. The command-line syntax lets you indicate three possible type translations.
-types=name_a
JPublisher interprets this syntax as:
TYPE name_a
-types=name_a:name_b
JPublisher interprets this syntax as:
TYPE name_a AS name_b
-types=name_a:name_b:name_c
JPublisher interprets this syntax as:
TYPE name_a GENERATE name_b AS name_c
TYPE, TYPE...AS, and TYPE...GENERATE...AS commands have the same functionality as SQL, SQL...AS, and SQL...GENERATE...AS syntax.
Enter -types=... on the command line, followed by one or more object type translations that you want JPublisher to perform. If you enter more than one item, then the items must be separated by commas without any white space. For example, if you enter:
-types=CORPORATION,EMPLOYEE:OracleEmployee,ADDRESS:JAddress:MyAddress
JPublisher interprets this command as:
TYPE CORPORATION TYPE EMPLOYEE AS OracleEmployee TYPE ADDRESS GENERATE JAddress AS MyAddress
This section documents options related to the database connection that JPublisher uses. The options are discussed in the alphabetic order.
The -context option specifies the connection context class that JPublisher uses, and possibly declares, for SQLJ classes that JPublisher produces. The syntax of the -context option is as follows:
-context={generated|DefaultContext|user_defined}
The -context=DefaultContext setting is the default and results in any JPublisher-generated SQLJ classes using the SQLJ default connection context class, sqlj.runtime.ref.DefaultContext, for all connection contexts. This is sufficient for most uses.
Alternatively, you can specify any user-defined class that implements the standard sqlj.runtime.ConnectionContext interface and exists in the classpath. The specified class will be used for all connection contexts.
|
Note: With a user-defined class, instances of that class must be used for output from thegetConnectionContext() method or for input to the setConnectionContext() method. Refer to "Connection Contexts and Instances in SQLJ Classes", for information about these methods. |
The -context=generated setting results in an inner class declaration for the _Ctx connection context class in all SQLJ classes generated by JPublisher. So, each class uses its own SQLJ connection context class. This setting may be appropriate for Oracle8i compatibility mode, but it is otherwise not recommended. Using the DefaultContext class or a user-defined class avoids the generation of additional connection context classes. You can specify the -context option on the command line or in a properties file.
Notes for -context Usage in Backward-Compatibility Modes
If you use a backward-compatibility mode and use .sqlj files and the SQLJ translator directly, then a -context=DefaultContext setting gives you greater flexibility if you translate and compile your .sqlj files in separate steps, translating with the SQLJ -compile=false setting. If you are not using JDK 1.2-specific types, such as java.sql.BLOB, CLOB, Struct, Ref, or Array, then you can compile the resulting .java files under JDK 1.1, JDK 1.2, or later. This is not the case with the -context=generated setting, because SQLJ connection context classes in JDK 1.1 use java.util.Dictionary instances for object type maps, while SQLJ connection context classes in JDK 1.2 or later use java.util.Map instances.
A benefit of using the -context=generated setting, if you are directly manipulating .sqlj files, is that it permits full control over the way the SQLJ translator performs online checking. Specifically, you can check SQL user-defined types and PL/SQL packages against an appropriate exemplar database schema. However, because JPublisher generates .sqlj files from an existing schema, the generated code is already verified as correct through construction from that schema.
You can use -datasource to specify the default data source for publishing SQL, PL/SQL, AQ, and server-side Java classes. With -datasource set, if the JDBC connection is not explicitly set by the application at run time, then the generated code will look up the specified Java Naming and Directory Interface (JNDI) location to get the data source and further get the JDBC connection from that data source.
The syntax of the -datasource option is as follows:
-datasource=jndi_location
The -driver option specifies the driver class that JPublisher uses for JDBC connections to the database. The syntax of this option is as follows:
-driver=driver_class_name
The default setting is:
-driver=oracle.jdbc.OracleDriver
This setting is appropriate for any Oracle JDBC driver.
You can use the -url option to specify the URL of the database to which you want to connect. The syntax of the -url option is as follows:
-url=URL
The default setting is:
-url=jdbc:oracle:oci:@
To specify the JDBC Thin driver, use a setting of the following form:
-url=jdbc:oracle:thin:@host:port/servicename
In this syntax, host is the name of the host on which the database is running, port is the port number, and servicename is the name of the database service.
|
Note: The use of system identifiers (SIDs) has been deprecated since Oracle Database 10g, but it is still supported for backward compatibility. Their use is of the formhost:port:sid.
For Oracle JDBC Oracle Call Interface (OCI) driver, use |
JPublisher requires the -user option, which specifies an Oracle user name and password, so that it can connect to the database. If you do not enter the -user option, then JPublisher prints an error message and stops execution.
The syntax of the -user option is as follows:
-user=username/password -u username/password
Both formats are equivalent. The second one is provided as a convenient command-line shortcut.
For example, the following command directs JPublisher to connect to the database with the user name scott:
% jpub -user=scott -input=demoin -dir=demo -mapping=oracle -package=corp
Enter scott password: password
The following options control the data type mappings that JPublisher uses to translate object types, collection types, object reference types, and PL/SQL packages to Java classes:
The -usertypes option controls JPublisher behavior for user-defined types, in conjunction with the -compatible option for oracle mapping. Specifically, it controls whether JPublisher implements the Oracle ORAData interface or the standard SQLData interface in generated classes, and whether JPublisher generates code for collection and object reference types.
The -numbertypes option controls data type mappings for numeric types.
The -lobtypes option controls data type mappings for the BLOB, CLOB, and BFILE types.
The -builtintypes option controls data type mappings for non-numeric, non-LOB, and predefined SQL and PL/SQL types.
These four options are known as the type-mapping options.
For an object type, JPublisher applies the mappings specified by the type-mapping options to the object attributes and the arguments and results of any methods included with the object. The mappings control the types that the generated accessor methods support. For example, they support the types the getXXX() methods return and the setXXX() methods take.
For a PL/SQL package, JPublisher applies the mappings to the arguments and results of the methods in the package. For a collection type, JPublisher applies the mappings to the element type of the collection.
In addition, there is a subsection here for the -style option, which you can use to specify Java-to-Java type mappings, typically to support Web services. This involves an extra JPublisher step. A SQL type is mapped to a Java type that is not supported by Web services, in the JPublisher-generated base class. Then this Java type is mapped to a Java type that is supported by Web services, in the JPublisher-generated user subclass.
The -builtintypes option controls data type mappings for all the built-in data types except the LOB types, which are controlled by the -lobtypes option, and the different numeric types, which are controlled by the -numbertypes option. The syntax of the -builtintypes option is as follows:
-builtintypes={jdbc|oracle}
Table 6-2 lists the data types affected by the -builtintypes option and shows their Java type mappings for -builtintypes=oracle and -builtintypes=jdbc, which is the default.
Table 6-2 Mappings for Types Affected by the -builtintypes Option
| SQL Data Type | Oracle Mapping Type | JDBC Mapping Type |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The -lobtypes option controls data type mappings for LOB types. The syntax of the -lobtypes option is as follows:
-lobtypes={jdbc|oracle}
Table 6-3 shows how these types are mapped for -lobtypes=oracle, which is the default, and for -lobtypes=jdbc.
Table 6-3 Mappings for Types Affected by the -lobtypes Option
| SQL Data Type | Oracle Mapping Type | JDBC Mapping Type |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
Note:
|
The -numbertypes option controls data type mappings for numeric SQL and PL/SQL types. The syntax of the -numbertypes option is as follows:
-numbertypes={jdbc|objectjdbc|bigdecimal|oracle}
The following choices are available:
In JDBC mapping, most numeric data types are mapped to Java primitive types, such as int and float, and DECIMAL and NUMBER are mapped to java.math.BigDecimal.
In Object JDBC mapping, which is the default, most numeric data types are mapped to Java wrapper classes, such as java.lang.Integer and java.lang.Float. DECIMAL and NUMBER are mapped to java.math.BigDecimal.
In BigDecimal mapping, all numeric data types are mapped to java.math.BigDecimal.
In Oracle mapping, all numeric data types are mapped to oracle.sql.NUMBER.
Table 6-4 lists the data types affected by the -numbertypes option and shows their Java type mappings for -numbertypes=jdbc and -numbertypes=objectjdbc, which is the default.
Table 6-4 Mappings for Types Affected by the -numbertypes Option
| SQL Data Type | JDBC Mapping Type | Object JDBC Mapping Type |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The -usertypes option controls whether JPublisher implements the Oracle ORAData interface or the standard SQLData interface in generated classes for user-defined types. The syntax of the -usertypes option is as follows:
-usertypes={oracle|jdbc}
When -usertypes=oracle, which is the default, JPublisher generates ORAData classes for object, collection, and object reference types.
When -usertypes=jdbc, JPublisher generates SQLData classes for object types. JPublisher does not generate classes for collection or object reference types in this case. You must use java.sql.Array for all collection types and java.sql.Ref for all object reference types.
|
Note:
|
The -mapping option specifies mapping for all data types, so offers little flexibility between types. The syntax of the -mapping option is as follows:
-mapping={jdbc|objectjdbc|bigdecimal|oracle}
|
Note: This option is deprecated in favor of the more specific type mapping options:-usertypes, -numbertypes, -builtintypes, and -lobtypes. However, it is still supported for backward compatibility. |
The -mapping=oracle setting is equivalent to setting all the type mapping options to oracle. The other -mapping settings are equivalent to setting -numbertypes equal to the value of -mapping and setting the other type mapping options to their defaults. This is summarized in Table 6-5.
Table 6-5 Relation of -mapping Settings to Other Mapping Option Settings
| -mapping Setting | -builtintypes= | -numbertypes= | -lobtypes= | -usertypes= |
|---|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Note: Options are processed in the order in which they appear on the command line. Therefore, if the-mapping option precedes one of the specific type mapping options, -builtintypes, -lobtypes, -numbertypes, or -usertypes, then the specific type mapping option overrides the -mapping option for the relevant types. If the -mapping option follows one of the specific type mapping options, then the specific type mapping option is ignored. |
JPublisher style files allow you to specify Java-to-Java type mappings. One use for this is to ensure that generated classes can be used in Web services. You use the -style option to specify the name of a style file. You can use the -style option multiple times. The settings accumulate in order. The syntax of the -style option is as follows:
-style=stylename
Typically, Oracle supplies the style files, but there may be situations in which you would edit or create your own. To use the Oracle style file for Web services in Oracle Database 11g, for example, use the following setting:
-style=webservices10
JPublisher code generation is influenced by entries in the JPublisher user type map or default type map, primarily to make signatures with PL/SQL types accessible to JDBC. A type map entry has one of the following formats:
-type_map_option=opaque_sql_type:java_type -type_map_option=numeric_indexed_by_table:java_numeric_type[max_length] -type_map_option=char_indexed_by_table:java_char_type[max_length](elem_size) -type_map_option=plsql_type:java_type:sql_type:sql_to_plsql_func:plsql_to_sql_func
In the type map syntax, sql_to_plsql_func and plsql_to_sql_func are for functions that convert between SQL and PL/SQL. Note that [...] and (...) are part of the syntax. Also note that some operating systems require you to quote command-line options that contain special characters.
The related options, which are discussed in alphabetic order in the following sections, are -addtypemap, -adddefaulttypemap, -defaulttypemap, and -typemap. The difference between -addtypemap and -typemap is that -addtypemap appends entries to the user type map, while -typemap replaces the existing user type map with the specified entries. Similarly, -adddefaulttypemap appends entries to the default type map, while -defaulttypemap replaces the existing default type map with the specified entries.
Here are some sample type map settings, from a properties file that uses the -defaulttypemap and -adddefaulttypemap options:
jpub.defaulttypemap=SYS.XMLTYPE:oracle.xdb.XMLType jpub.adddefaulttypemap=BOOLEAN:boolean:INTEGER: SYS.SQLJUTL.INT2BOOL:SYS.SQLJUTL.BOOL2INT jpub.adddefaulttypemap=INTERVAL DAY TO SECOND:String:CHAR: SYS.SQLJUTL.CHAR2IDS:SYS.SQLJUTL.IDS2CHAR jpub.adddefaulttypemap=INTERVAL YEAR TO MONTH:String:CHAR: SYS.SQLJUTL.CHAR2IYM:SYS.SQLJUTL.IYM2CHAR
Be aware that you must avoid conflicts between the default type map and user type map.
Use the -adddefaulttypemap option to append an entry or a comma-delimited list of entries to the JPublisher default type map. In addition, JPublisher uses this option internally. The syntax of this option is:
-adddefaulttypemap=list_of_typemap_entries
Use the -addtypemap option to append an entry or a comma-delimited list of entries to the JPublisher user type map. The syntax of this option is:
-addtypemap=list_of_typemap_entries
JPublisher uses the -defaulttypemap option internally to set up predefined type map entries in the default type map. The syntax of this option is:
-defaulttypemap=list_of_typemap_entries
The difference between the -adddefaulttypemap option and the -defaulttypemap option is that -adddefaulttypemap appends entries to the default type map, while -defaulttypemap replaces the existing default type map with the specified entries. To clear the default type map, use the following setting:
-defaulttypemap=
You may want to do this to avoid conflicts between the default type map and the user type map, for example.
|
See Also: "JPublisher User Type Map and Default Type Map" for additional information, including a caution about conflicts between the type maps. |
Use the -typemap option to specify an entry or a comma-delimited list of entries to set up the user type map. The syntax of this option is:
-typemap=list_of_typemap_entries
The difference between the -typemap option and the -addtypemap option is that -typemap replaces the existing user type map with the specified entries and -addtypemap appends entries to the user type map. To clear the user type map, use the following setting.
-typemap=
You may want to do this to avoid conflicts between the default type map and the user type map, for example.
This section documents options that specify JPublisher characteristics and behavior for Java code generation. For example, there are options to accomplish the following:
Filter generated code according to parameter modes or parameter types
Ensure that generated code conforms to the JavaBeans specification
Specify naming patterns
Specify how stubs are generated for user subclasses
Specify whether generated code is serializable
The following options are described in alphabetical order: -access, -case, -codegen, -filtermodes, -filtertypes, -generatebean, -genpattern, -gensubclass, -methods, -omit_schema_names, -outarguments, -package, -serializable, and -tostring.
The -access option determines the access modifier that JPublisher includes in generated constructors, attribute setter and getter methods, member methods on object wrapper classes, and methods on PL/SQL packages. The syntax of this option is:
-access={public|protected|package}
JPublisher uses the possible option settings as follows:
public
Methods are generated with the public access modifier. This is the default option setting.
protected
Methods are generated with the protected access modifier.
package
The access modifier is omitted, so generated methods are local to the package.
You may want to use a setting of -access=protected or -access=package if you want to control the usage of the generated JPublisher wrapper classes. For example, when you provide customized versions of the wrapper classes as subclasses of the JPublisher-generated classes, but do not want to provide access to the generated superclasses.
You can specify the -access option on the command line or in a properties file.
|
Note: Wrapper classes for object references andVARRAY and nested table types are not affected by the value of the -access option. |
For class or attribute names that you do not specify in an INPUT file or on the command line, the -case option affects the case of Java identifiers that JPublisher generates, including class names, method names, attribute names embedded within getXXX() and setXXX() method names, and arguments of generated method names. The syntax of this option is:
-case={mixed|same|lower|upper}
Table 6-6 describes the possible values for the -case option.
Table 6-6 Values for the -case Option
| -case Option Value | Description |
|---|---|
|
|
The first letter of every word unit of a class name or of every word unit after the first word unit of a method name is in uppercase. All other characters are in lowercase. An underscore (_), a dollar sign ($), or any character illegal in Java constitutes a word unit boundary and is removed without warning. A word unit boundary also occurs after |
|
|
JPublisher does not change the case of letters from the way they are represented in the database. Underscores and dollar signs are retained. JPublisher removes any other character illegal in Java and issues a warning message. |
|
|
JPublisher converts lowercase letters to uppercase and retains underscores and dollar signs. It removes any other character illegal in Java and issues a warning message. |
|
|
JPublisher converts uppercase letters to lowercase and retains underscores and dollar signs. It removes any other character illegal in Java and issues a warning message. |
For class or attribute names that you specify through JPublisher options or the INPUT file, JPublisher retains the case of the letters in the specified name and overrides the -case option.
The -codegen option determines whether the generated Java code uses SQLJ runtime or JDBC runtime. The syntax of this option is:
-codegen=jdbc|sqlj
The default value is sqlj.
The setting -codegen= jdbc indicates that JPublisher generates Java code using JDBC runtime. Generation of Java code purely relying on JDBC runtime is a new feature of JPublisher 11g release. The setting -codegen=sqlj indicates that JPublisher generates Java code using SQLJ runtime. This is the default behavior of JPublisher 11g release. All the earlier JPublisher releases use only SQLJ runtime to generate Java code.
In some cases, particularly for generating code for Web services, not all parameter modes are supported in method signatures or attributes for the target usage of your code. The -filtermodes option enables you to filter generated code according to parameter modes. The syntax of this option is:
-filtermodes=list_of_modes_to_filter_out_or_filter_in
You can specify the following for the -filtermodes option:
in
out
inout
return
Start the option setting with a 1 to include all possibilities by default, which would mean no filtering. Then list specific modes or types each followed by a minus sign (-), indicating that the mode or type should be excluded. Alternatively, start with a 0 to include no possibilities by default, which would mean total filtering, then list specific modes or types each followed by a plus sign (+), indicating that the mode or type should be allowed.
The following examples would have the same result, allowing only methods that have parameters of the in or return mode. Separate the entries by commas.
-filtermodes=0,in+,return+ -filtermodes=1,out-,inout-
In some cases, particularly for generating code for Web services, not all parameter types are supported in method signatures or attributes for the target usage of your code. The -filtertypes option enables you to filter generated code according to parameter types. The syntax of this option is:
-filtertypes=list_of_types_to_filter_out_or_filter_in
You can specify the following settings for the -filtertypes option:
Any qualified Java type name
Specify package and class, such as java.sql.SQLData, oracle.sql.ORAData.
.ORADATA
This setting indicates any ORAData or SQLData implementations.
.STRUCT, .ARRAY, .OPAQUE, .REF
Each of these settings indicates any types that implement ORAData or SQLData with the corresponding _SQL_TYPECODE specification.
.CURSOR
This setting indicates any SQLJ iterator types and java.sql.ResultSet.
.INDEXBY
This setting indicates any indexed-by table types.
.ORACLESQL
This setting indicates all oracle.sql.XXX types.
Start the option setting with a 1 to include all possibilities by default, indicating no filtering, then list specific modes or types each followed by a minus sign (-), indicating that the mode or type should be excluded. Alternatively, start with a 0 to include no possibilities by default, indicating total filtering, then list specific modes or types each followed by a plus sign (+), indicating that the mode or type should be allowed.
This first example filters out only .ORADATA and .ORACLESQL. The second example filters everything except .CURSOR and .INDEXBY:
-filtertypes=1,.ORADATA-,.ORACLESQL- -filtertypes=0,.CURSOR+,.INDEXBY+
The .STRUCT, .ARRAY, .OPAQUE, and .REF settings are subcategories of the .ORADATA setting. Therefore, you can have specifications, such as the following, which filters out all ORAData and SQLData types except those with a typecode of STRUCT:
-filtertypes=1,.ORADATA-,.STRUCT+
Alternatively, to allow ORAData or SQLData types in general, with the exception of those with a typecode of ARRAY or REF:
-filtertypes=0,.ORADATA+,.ARRAY-,.REF-
The -generatebean option is a flag that you can use to ensure that generated classes follow the JavaBeans specification. The syntax of this option is:
-generatebean={true|false}
The default setting is -generatebean=false. With the -generatebean=true setting, some generated methods are renamed so that they are not assumed to be JavaBean property getter or setter methods. This is accomplished by prefixing the method names with an underscore (_). For example, for classes generated from SQL table types, VARRAY, or indexed-by table, method names are changed as follows.
Method names are changed from:
public int getBaseType() throws SQLException; public int getBaseTypeName() throws SQLException; public int getDescriptor() throws SQLException;
to:
public int _getBaseType() throws SQLException; public String _getBaseTypeName() throws SQLException; public ArrayDecscriptor _getDescriptor() throws SQLException;
The changes in return types are necessary because the JavaBeans specification says that a getter method must return a bean property, but getBaseType(), getBaseTypeName(), and getDescriptor() do not return a bean property.
It is often desirable to follow a certain naming pattern for Java classes, user subclasses, and interfaces generated for user-defined SQL types or packages. The -genpattern option, which you can use in conjunction with the -sql or -sqlstatement option, enables you to define such patterns conveniently and generically. The syntax of this option is:
-genpattern=pattern_specifications
Consider the following explicit command-line options:
-sql=PERSON:PersonBase:PersonUser#Person -sql=STUDENT:StudentBase:StudentUser#Student -sql=GRAD_STUDENT:GradStudentBase:GradStudentUser#GradStudent
The following pair of options is equivalent to the preceding set of options:
-genpattern=%1Base:%1User#%1 -sql=PERSON,STUDENT,GRAD_STUDENT
By definition, %1 refers to the default base names that JPublisher would create for each SQL type. By default, JPublisher would create the Person Java type for the PERSON SQL type, the Student Java type for the STUDENT SQL type, and the GradStudent Java type for the GRAD_STUDENT SQL type. So %1Base becomes PersonBase, StudentBase, and GradStudentBase, respectively. Similar results are produced for %1User.
If the -sql option specifies the output names, then %2, by definition, refers to the specified names. For example, the following pair of options has the same effect as the earlier pair:
-genpattern=%2Base:%2User#%2 -sql=PERSON:Person,STUDENT:Student,GRAD_STUDENT:GradStudent
|
Note: This is the pattern expected for Web services. Specify an output name and use that as the interface name, and appendBase for the generated class and User for the user subclass. |
The following example combines the -genpattern option with the -sqlstatement option:
-sqlstatement.class=SqlStmts -genpattern=%2Base:%2User:%2
These settings are equivalent to the following:
-sqlstatement.class=SqlStmtsBase:SqlStmtsUser#SqlStmts
The value of the -gensubclass option determines whether JPublisher generates initial source files for user-provided subclasses and, if so, what format these subclasses should have. The syntax of this option is:
-gensubclass={true|false|force|call-super}
For -gensubclass=true, which is the default, JPublisher generates code for the subclass only if it finds that no source file is present for the user subclass. The -gensubclass=false setting results in JPublisher not generating any code for user subclasses.
For -gensubclass=force, JPublisher always generates code for user subclasses. It overwrites any existing content in the corresponding .java and .class files if they already exist. Use this setting with caution.
The setting -gensubclass=call-super is equivalent to -gensubclass=true, except that JPublisher generates slightly different code. By default, JPublisher generates only constructors and methods necessary for implementing an interface, for example, the ORAData interface. JPublisher indicates how superclass methods or attribute setter and getter methods can be called, but places this code inside comments. With the call-super setting, all getters, setters, and other methods are generated.
The idea is that you can specify this setting if you use Java development tools based on class introspection. Only methods relating to SQL object attributes and SQL object methods are of interest, and JPublisher implementation details remain hidden. In this case you can point the tool at the generated user subclass.
You can specify the -gensubclass option on the command line or in a properties file.
The -methods option determines whether:
JPublisher generates wrapper methods for methods, or stored procedures in SQL object types and PL/SQL packages.
Overloaded method names are allowed.
Methods will attempt to reestablish a JDBC connection if an SQLException is caught.
The syntax for the -methods option is:
-methods={all|none|named|always,overload|unique,noretry|retry}
For -methods=all, which is the default setting among the first group of settings, JPublisher generates wrapper methods for all the methods in the SQL object types and PL/SQL packages it processes. This results in generation of a SQLJ class if the underlying SQL object or package actually defines methods and if not, a non-SQLJ class. Prior to Oracle Database 10g, SQLJ classes were always generated for the all setting.
For -methods=none, JPublisher does not generate wrapper methods. In this case, JPublisher does not generate classes for PL/SQL packages, because they would not be useful without wrapper methods.
For -methods=named, JPublisher generates wrapper methods only for the methods explicitly named in the INPUT file.
The -methods=always setting also results in wrapper methods being generated. However, for backward compatibility with Oracle8i and Oracle9i JPublisher versions, this setting always results in SQLJ classes being generated for all SQL object types, regardless of whether the types define methods.
|
Note: For backward compatibility, JPublisher also supports the settingtrue as equivalent to all, the setting false as equivalent to none, and the setting some as equivalent to named. |
Among the overload and unique settings, -methods=overload is the default and specifies that method names in the generated code can be overloaded, such as the following:
int foo(int); int foo(String);
Alternatively, the -methods=unique setting specifies that all method names must be unique. This is required for Web services. Consider the following functions:
function foo (a VARCHAR2(40)) return VARCHAR2; function foo ( x int, y int) return int;
With the default -methods=overload setting, these functions are published as follows:
String foo(String a); java.math.BigDecimal foo(java.math.BigDecimal x, java.math.BigDecimal y);
With the -methods=unique setting, these functions are published using a method-renaming mechanism based on the first letter of the return type and argument types, as shown in the following example:
String foo(String a); java.math.BigDecimal fooBBB(java.math.BigDecimal x, java.math.BigDecimal y);
With the -methods=retry setting, JPublisher generates constructors with DataSource arguments and extra code for each method published. A JDBC operation in a method is enclosed within a try...catch block. If an SQLException is raised when the method is processed, then the extra code will attempt to reestablish the JDBC connection and process the SQL operation again. If the attempt to reconnect fails, then the original SQLException is thrown again.
For -methods=retry, JPublisher generates code different from that generated for -methods=noretry, in two respects:
An additional constructor, which takes a DataSource object as parameter, is generated. The DataSource object is used to get a new connection at operation invocation time.
A new JDBC connection is requested if an SQLException is thrown.
The -methods=retry setting takes effect only for PL/SQL stored procedures, SQL statements, AQ, and Web services call-ins for Java classes.
|
Note: The use oforacle.jdbc.pool.OracleDataSource requires JDK 1.3 or later. |
To specify a setting of all, none, named, or always at the same time as you specify a setting of overload or unique and a setting for retry or noretry, use a comma to separate the settings. This is shown in the following example:
-methods=always,unique,retry
You can specify the -methods option on the command line or in a properties file.
In publishing user-defined SQL types, such as objects and collections, when JPublisher references the type names in Java wrapper classes, it generally qualifies the type names with the database schema name, such as SCOTT.EMPLOYEE for the EMPLOYEE type in the SCOTT schema.
However, by specifying the -omit_schema_names option, you instruct JPublisher not to qualify SQL type names with schema names. The syntax of this option is:
-omit_schema_names
When this option is specified, names are qualified with a schema name only under the following circumstances:
You declare the user-defined SQL type in a schema other than the one to which JPublisher is connected. A type from another schema always requires a schema name to identify it.
You declare the user-defined SQL type with a schema name on the command line or in an INPUT file. The use of a schema name with the type name on the command line or INPUT file overrides the -omit_schema_names option.
Omitting the schema name makes it possible for you to use classes generated by JPublisher when you connect to a schema other than the one used when JPublisher is invoked, as long as the SQL types that you use are declared identically in the two schemas.
ORAData and SQLData classes generated by JPublisher include a static final String field that names the user-defined SQL type matching the generated class. When the code generated by JPublisher is processed, the SQL type name in the generated code is used to locate the SQL type in the database. If the SQL type name does not include the schema name, then the type is looked up in the schema associated with the current connection when the code generated by JPublisher is processed. If the SQL type name includes the schema name, then the type is looked up in that schema.
When the -omit_schema_names option is enabled, JPublisher generates the following code in the Java wrapper class for a SQL object type and similar code to wrap a collection type:
public Datum toDatum(Connection c) throws SQLException
{
if (__schemaName != null)
{
return _struct.toDatum(c, __schemaName + "." + _SQL_NAME);
}
return _struct.toDatum(c, typeName);
}
private String __schemaName = null;
public void __setSchemaName(String schemaName) { __schemaName = schemaName; }
}
The __setSchemaName() method enables you to explicitly set the schema name at run time so that SQL type names can be qualified by schema even if JPublisher was run with the -omit_schema_names option enabled. Being qualified by schema is necessary if a SQL type needs to be accessed from another schema.
|
Note: Although this option acts as a boolean option, you cannot specify-omit_schema_names=true or -omit_schema_names=false. Specify -omit_schema_names to enable it, and do nothing to leave it disabled. |
There are no OUT or IN OUT designations in Java, but values can be returned through holders. In JPublisher, you can specify one of three alternatives for holders:
Arrays, which is the default
JAX-RPC holder types
Function returns
The -outarguments option enables you to specify the mechanism to use, through a setting of array, holder, or return, respectively. This feature is particularly useful for Web services. The syntax of this option is:
-outarguments={array|holder|return}
The -package option specifies the name of the Java package that JPublisher generates. The name appears in a package declaration in each generated class. The syntax for this option is:
-package=package_name
If you use the -dir and -d options, the directory structure in which JPublisher places the generated files reflects the package name as well as the -dir and -d settings.
|
Note:
|
Example 1 Consider the following command:
% jpub -dir=/a/b -d=/a/b -package=c.d -sql=PERSON:Person ...
JPublisher generates the files /a/b/c/d/Person.java and /a/b/c/d/Person.class.
In addition, the Person class includes the following package declaration:
package c.d;
Example 2 Now consider the following command:
% jpub -dir=/a/b -d=/a/b -package=c.d -sql=PERSON:Person -input=myinputfile
Assume that myinputfile includes the following:
SQL PERSON AS e.f.Person
In this case, the package information in the INPUT file overrides the -package option on the command line. JPublisher generates the files /a/b/e/f/Person.java and /a/b/e/f/Person.class, with the Person class including the following package declaration:
package e.f;
If you do not specify a package name, then JPublisher does not generate any package declaration. The output .java files are placed directly into the directory specified by the -dir option or into the current directory by default. The output .class files are placed directly into the directory specified by the -d option or into the current directory.
Sometimes JPublisher translates a type that you do not explicitly request, because the type is required by another type that is translated. For example, it may be an attribute of the requested type. In this case, the .java and .class files declaring the required type are also placed into the package specified on the command line, in a properties file or the INPUT file.
By contrast, JPublisher never translates packages or stored procedures that you do not explicitly request, because packages or stored procedures are never strictly required by SQL types or by other packages or stored procedures.
The -serializable option specifies whether the Java classes that JPublisher generates for SQL object types implement the java.io.Serializable interface. The default setting is -serializable=false. The syntax for this option is:
-serializable={true|false}
Please note the following if you choose to set -serializable=true:
Not all object attributes are serializable. In particular, none of Oracle LOB types, such as oracle.sql.BLOB, oracle.sql.CLOB, or oracle.sql.BFILE, can be serialized. Whenever you serialize objects with such attributes, the corresponding attribute values are initialized to null after deserialization.
If you use object attributes of type java.sql.Blob or java.sql.Clob, then the code generated by JPublisher requires that the Oracle JDBC rowset implementation be available in the classpath. This is provided in the ocrs12.jar library at ORACLE_HOME/jdbc/lib. In this case, the underlying value of Clob and Blob objects is materialized, serialized, and subsequently retrieved.
Whenever you deserialize objects containing attributes that are object references, the underlying connection is lost, and you cannot issue setValue() or getValue() calls on the reference. For this reason, JPublisher generates the following method into your Java classes whenever you specify -serializable=true:
void restoreConnection(Connection)
After deserialization, call this method once for a given object or object reference to restore the current connection into the reference or, respectively, into all transitively embedded references.
You can use the -tostring flag to tell JPublisher to generate an additional toString() method for printing out an object value. The output resembles SQL code you would use to construct the object. The default setting is false. The syntax for this option is:
-tostring={true|false}
You can use -nomain=true to avoid generating Java methods with the signature main(String[]). This option applies to SQL publishing and server-side Java class publishing. The syntax for this option is:
-nomain[=true|false]
The -dbjava option automatically sets -nomain=true because of Java stored procedure limitation. In case a method with the signature main(String[]) is to be generated with the -nomain=true setting, then JPublisher will rename the method, for example, into main0(Stringp[]).
The default setting is:
-nomain=false
This section documents the following options that specify JPublisher behavior in generating PL/SQL code:
-overwritedbtypes
Specifies whether naming conflicts are checked before creating SQL types.
-plsqlfile
Specifies scripts to use in creating and dropping SQL types and PL/SQL packages.
-plsqlmap
Specifies whether PL/SQL wrapper functions are generated
-plsqlpackage
Specifies the name of the PL/SQL package in which JPublisher generates PL/SQL call specs, conversion functions, wrapper functions, and table functions.
These options are mostly used to support Java calls to stored procedures that use PL/SQL types. The options specify the creation and use of corresponding SQL types and the creation and use of PL/SQL conversion functions and PL/SQL wrapper functions that use the corresponding SQL types for input or output. This enables access through JDBC.
JPublisher may generate new SQL types when publishing PL/SQL types and generating PL/SQL wrappers for server-side Java classes. The -overwritedbtypes option determines how JPublisher names the generated SQL types. The syntax for this option is:
-overwritedbtypes={true|false}
Prior to Oracle Database 10g release 2 (10.2), JPublisher checked the database for naming conflicts and chose a name, which was not already in use, for the generated SQL type. Since Oracle Database 10g release 2 (10.2), JPublisher generates SQL type names by default, regardless of the existing type names in the database. The -overwritedbtypes=true setting, which is the default, overwrites the existing types if the type name is the same as that of the generated SQL type. This enables JPublisher to generate exactly the same PL/SQL wrappers over different runs.
To ensure that JPublisher does not overwrite any type inside the database while executing the generated PL/SQL wrapper, you must explicitly specify -overwritedbtypes=false.
A frequently reported problem in releases prior to Oracle Database 10g release 2 (10.2) is that after the generated PL/SQL wrapper is processed, rerunning the JPublisher command generates a different set of SQL types. A workaround for this problem is to run the PL/SQL dropper script before the JPublisher command is rerun.
The -plsqlfile option specifies the name of a wrapper script and a dropper script generated by JPublisher. The syntax for this option is:
-plsqlfile=plsql_wrapper_script,plsql_dropper_script
The wrapper script contains instructions to create SQL types to map to PL/SQL types and instructions to create the PL/SQL package that JPublisher uses for any PL/SQL wrappers or call specs, conversion functions, wrapper functions, and table functions. The dropper script contains instructions to drop these entities.
You must load the generated files into the database, using SQL*Plus, for example, and run the wrapper script to install the types and package in the database.
If the files already exist, then they are overwritten. If no file names are specified, then JPublisher writes to files named plsql_wrapper.sql and plsql_dropper.sql.
JPublisher writes a note about the generated scripts, such as the following:
J2T-138, NOTE: Wrote PL/SQL package JPUB_PLSQL_WRAPPER to file plsql_wrapper.sql. Wrote the dropping script to file plsql_dropper.sql.
The -plsqlmap option specifies whether JPublisher generates wrapper functions for stored procedures that use PL/SQL types. Each wrapper function calls the corresponding stored procedure and invokes the appropriate PL/SQL conversion functions for PL/SQL input or output of the stored procedure. Only the corresponding SQL types are exposed to Java. The syntax for this option is:
-plsqlmap={true|false|always}
The setting can be any of the following:
true
This is the default. JPublisher generates PL/SQL wrapper functions only as needed. For any given stored procedure, if the Java code to call it and convert its PL/SQL types directly is simple enough and the PL/SQL types are used only as IN parameters or for the function return, then the generated code calls the stored procedure directly. It processes the PL/SQL input or output through the appropriate conversion functions.
false
JPublisher does not generate PL/SQL wrapper functions. If it encounters a PL/SQL type in a signature that cannot be supported by direct call and conversion, then it skips generation of Java code for the particular stored procedure.
always
JPublisher generates a PL/SQL wrapper function for every stored procedure that uses a PL/SQL type. This is useful for generating a proxy PL/SQL package that complements an original PL/SQL package, providing Java-accessible signatures for those functions or procedures that are inaccessible from Java in the original package.
The -plsqlpackage option specifies the name of the PL/SQL package into which JPublisher places any generated PL/SQL code. This includes PL/SQL wrappers or call specifications, conversion functions to convert between PL/SQL and SQL types, wrapper functions to wrap stored procedures that use PL/SQL types, and table functions. The syntax for this option is:
-plsqlpackage=name_of_PLSQL_package
By default, JPublisher uses the package JPUB_PLSQL_WRAPPER.
|
Note: You must create this package in the database by running the SQL script generated by JPublisher. |
Use -plsqlindextable=array or -plsqlindextable=int to specify that PL/SQL index-by table of numeric and character types be mapped to Java array. The syntax for this option is:
-plsqlindextable=array|custom|int
The int specification defines the capacity of the Java array. The default capacity is 32768. The -plsqlindextable=custom setting specifies that PL/SQL index-by table be mapped to custom JDBC types, such as a class implementing ORAData.
The default setting is:
-plsqlindextable=custom
This section documents options related to JPublisher input and output files and locations. These are listed in the order in which they are discussed:
-compile
Use this option if you want to suppress compilation, and optionally, SQLJ translation, if JPublisher is in a backward-compatibility mode.
-dir
Use this option to specify where the generated source files are placed.
-d
Use this option to specify where the compiled class files are placed.
-encoding
Use this option to specify the Java character encoding of the INPUT file that JPublisher reads and the .sqlj and .java files that JPublisher writes.
Use the -compile option to suppress the compilation of the generated .java files and, for backward-compatibility modes, to optionally suppress the translation of generated .sqlj files. The syntax for this option is:
-compile={true|false|notranslate}
With the default true setting, all generated classes are compiled into .class files. If you are in a backward-compatibility mode, then you can use the -compile=notranslate setting to suppress SQLJ translation and Java compilation of generated source files. This leaves you with .sqlj output from JPublisher, which you can translate and compile manually by using either the JPublisher -sqlj option or the SQLJ command-line utility directly. You can also use the -compile=false setting to proceed with SQLJ translation, but skip Java compilation. This leaves you with .java output from JPublisher, which you can compile manually.
If you are not in a backward-compatibility mode, such as if you use the default -compatible=oradata setting, then you can use a setting of -compile=false to skip compilation. In this scenario, the notranslate setting is not supported, because visible .sqlj files are not produced if you are not in a backward-compatibility mode.
Use the -dir option to specify the root of the directory tree within which JPublisher places the .java source files or the .sqlj source files for backward-compatibility modes. The syntax for this option is:
-dir=directory_path -d=directory_path
A setting of a period (.) explicitly specifies the current directory as the root of the directory tree. Similarly, use the -d option to specify the root of the directory tree within which JPublisher places compiled .class files, with the same functionality for a period (.) setting.
For each option with any nonempty setting, JPublisher also uses package information from the -package option or any package name included in an SQL option setting in the INPUT file. This information is used to determine the complete directory hierarchy for generated files.
For example, consider the following JPublisher command:
% jpub -user=scott -d=myclasses -dir=mysource -package=a.b.c -sql=PERSON:Person,STUDENT:Student
Enter scott password: password
This results in the following output, relative to the current directory:
mysource/a/b/c/Person.java mysource/a/b/c/PersonRef.java mysource/a/b/c/Student.java mysource/a/b/c/StudentRef.java myclasses/a/b/c/Person.class myclasses/a/b/c/PersonRef.class myclasses/a/b/c/Student.class myclasses/a/b/c/StudentRef.class
By default, source and class files are placed directly into the current directory, with no package hierarchy, regardless of the -package setting or any package specification in the INPUT file.
You can also explicitly specify this behavior with empty settings:
%jpub ... -d= -dir=
You can set these options on the command line or in a properties file.
|
Note: SQLJ has-dir and -d options as well, with the same functionality. However, when you use the JPublisher -sqlj option to specify SQLJ settings, use the JPublisher -dir and -d options, which take precedence over any SQLJ -dir and -d settings. |
The -encoding option specifies the Java character encoding of the INPUT file that JPublisher reads and the source files that JPublisher writes. The default encoding is the value of the file.encoding system property or 8859_1 (ISO Latin-1), if this property is not set. The syntax for this option is:
-encoding=name_of_character_encoding
As a general rule, you do not have to set this option unless you specify an encoding for the SQLJ translator and Java compiler, which you can do with a SQLJ -encoding setting through the JPublisher -sqlj option. In this scenario, you should specify the same encoding for JPublisher as for SQLJ and the compiler.
You can use the -encoding option to specify any character encoding supported by your Java environment. If you are using the Sun Microsystems JDK, these options are listed in the native2ascii documentation, which you can find at the following URL:
http://java.sun.com/j2se/1.3/docs/tooldocs/solaris/native2ascii.html
|
Note: Encoding settings, either set through the JPublisher-encoding option or the Java file.encoding setting, do not apply to Java properties files, including those specified through the JPublisher -props option. Properties files always use the 8859_1 encoding. This is a feature of Java in general and not JPublisher in particular. However, you can use Unicode escape sequences in a properties file. |
This section documents options and related concepts for accessing Java classes from server-side Java or PL/SQL. In particular, these options may be used to access Web services client code from inside the database, referred to as Web services call-outs. This section comprises the following topics:
The following list is a summary of the options relevant to Web services call-outs and how they relate to each other:
-proxyclasses=class1,class2,...,classN
This option specifies Java classes for which Java and PL/SQL wrappers will be generated. For Web services, this option is used behind the scenes by the -proxywsdl option and is set automatically to process generated client proxy classes.
Alternatively, you can use this option directly, for general purposes, when you want to create Java and PL/SQL wrappers for Java classes.
The -proxyclasses option takes the -proxyopts setting as input.
-proxyopts=setting1,setting2,...
This option specifies JPublisher behavior in generating wrapper classes and PL/SQL wrappers. This is usually, but not necessarily, for Web services. For typical usage of the -proxywsdl option, the -proxyopts default setting is sufficient. If you directly use the -proxyclasses option, then you may want specific -proxyopts settings.
-proxywsdl=WSDL_URL
Use this option to generate Web services client proxy classes and appropriate Java and PL/SQL wrappers, given the WSDL document at the specified URL.
The -proxywsdl option uses the -proxyclasses option behind the scenes and takes the -proxyopts setting as input.
-endpoint=Web_services_endpoint
Use this option in conjunction with the -proxywsdl option to specify the Web services endpoint.
-httpproxy=proxy_URL
Where the WSDL document is accessed through a firewall, use this option to specify a proxy URL to use in resolving the URL of the WSDL document.
-sysuser=superuser_name/superuser_password
Use this option to specify the name and password for the superuser account used to grant permissions for the client proxy classes to access Web services using HTTP.
|
Note:
|
The syntax for the -proxywsdl option is:
-proxywsdl=WSDL_URL
This option is used as follows:
% jpub -proxywsdl=META-INF/HelloService.wsdl ...
Given the Web services WSDL document at the specified URL, JPublisher directs the generation of Web services client proxy classes and generates appropriate Java and PL/SQL wrappers for Web services call-outs from the database. Classes to generate and process are determined from the WSDL document. JPublisher automatically sets the -proxyclasses option, uses the -proxyopts setting as input, and executes the following steps:
Invokes Oracle Database Web services assembler tool to produce Web services client proxy classes based on the WSDL document. These classes use Oracle Database Web services client run time to access the Web services specified in the WSDL document.
Creates Java wrapper classes for the Web services client proxy classes as appropriate or necessary. For each proxy class that has instance methods, a wrapper class is necessary to expose the instance methods as static methods. Even if there are no instance methods, a wrapper class is necessary if methods of the proxy class use anything other than Java primitive types in their calling sequences.
Creates PL/SQL wrappers for the generated classes, to make them accessible from PL/SQL. PL/SQL supports only static methods, so this step requires the wrapping of instance methods by static methods, This is performed in the previous step.
Loads generated code into the database assuming you have specified -user and -url settings and JPublisher has established a connection, unless you specifically bypass loading through the -proxyopts=noload setting.
|
Note: When using-proxywsdl:
|
The -endpoint option is typically used in conjunction with the -proxywsdl option.
You can use the -endpoint option in conjunction with the -proxywsdl option to specify the Web services endpoint. The endpoint is the URL to which the Web service is deployed and from which the client accesses it. The syntax for this option is:
-endpoint=Web_services_endpoint
Use this option as follows:
% jpub -proxywsdl=META-INF/HelloService.wsdl ...
-endpoint=http://localhost:8888/javacallout/javacallout
With this command, the Java wrapper class generated by JPublisher includes the following code:
((Stub)m_port0)._setProperty(Stub.ENDPOINT_ADDRESS_PROPERTY,
"http://localhost:8888/javacallout/javacallout");
Without the -endpoint option, there would instead be the following commented code:
// Specify the endpoint and then uncomment the following statement:
// ((Stub)m_port0)._setProperty(Stub.ENDPOINT_ADDRESS_PROPERTY,
// "<endpoint not provided>");
If you do not specify the endpoint in the JPublisher command line, then you must manually alter the generated wrapper class to uncomment this code and specify the appropriate endpoint.
If a WSDL document used for Web services call-outs is accessed through a firewall, use the -httpproxy option in conjunction with the -proxywsdl option to specify a proxy URL to use in resolving the URL of the WSDL document. The syntax for this option is:
-httpproxy=proxy_URL
For example:
% jpub ... -httpproxy=http://www-proxy.oracle.com:80
Use the -sysuser option to specify the name and password of a superuser account. This account is used in running the JPublisher-generated PL/SQL script that grants permissions that allow client proxy classes to access Web services using HTTP. The syntax for this option is:
-sysuser=superuser_name/superuser_password
For example:
-sysuser=sys/change_on_install
Without a -sysuser setting, JPublisher does not load the generated script granting permissions. Instead, it asks you to execute the script separately.
If the -url setting specifies a thin driver, then you must set up a password file for SYS, which authorizes logon as SYS, through the thin driver. To set up a password file, you must:
Add the remote_login_passwordfile option to the database parameter file. You must use either of the following settings:
remote_login_passwordfile=shared remote_login_passwordfile=exclusive
Create a password file, if you have not already created one. You can do this by running the following command, where ORACLE_HOME/dbs/ is an existing directory:
orapwd file="ORACLE_HOME/dbs/orapwlsqlj1" entries=100 force=y Enter password: password
Grant remote logon privileges to a user. This can be done as follows:
% sqlplus /nolog SQL> CONN / AS sysdba Connected. SQL> GRANT sysdba TO scott; Grant succeeded.
This section documents the -sqlj option, which you can use to pass SQLJ options to the SQLJ translator through the JPublisher command line.
In Oracle Database 11g, SQLJ translation is automatic by default when you run JPublisher. Translation is transparent, with no visible .sqlj files resulting from JPublisher code generation.
However, you can still specify SQLJ settings for the JPublisher invocation of the SQLJ translator by using the JPublisher -sqlj option. The syntax for this option is:
-sqlj=sqlj_options
For example:
% jpub -user=scott -sqlj -optcols=true -optparams=true -optparamdefaults=datatype1(size1),datatype2(size) Enter scott password: password
|
Note:
|
You can also run JPublisher solely to translate .sqlj files that have already been produced explicitly, such as if you run JPublisher with the -compatible=sqlj setting, which skips the automatic SQLJ translation step and results in .sqlj output files from JPublisher. In this case, use no JPublisher options other than -sqlj. This is a way to accomplish manual SQLJ translation if the sqlj front-end script or executable is unavailable.
The commands following -sqlj are equivalent to the command you would give to the SQLJ translator utility directly. Here is an example:
% jpub -sqlj -d=outclasses -warn=none -encoding=SJIS Foo.sqlj
This is equivalent to the following, if the SQLJ command-line translator is available:
% sqlj -d=outclasses -warn=none -encoding=SJIS Foo.sqlj
|
Note:
|
This section documents the -compatible option, which you can use to specify any of the following:
The interface for JPublisher to implement in generated classes
Whether JPublisher should skip SQLJ translation, resulting in visible .sqlj output files
A backward-compatibility mode to use JPublisher output in an Oracle9i or Oracle8i environment
The -compatible option has two modes of operation:
Through a setting of oradata or customdatum, you can explicitly specify an interface to be implemented by JPublisher-generated custom Java classes.
Through a setting of sqlj, 8i, both8i, or 9i, you can specify a backward-compatibility mode.
You can select either of the two modes, but not both.
The syntax for this option is:
-compatible={oradata|customdatum|both8i|8i|9i|10.1|sqlj}
Using -compatible to Specify an Interface
If -usertypes=oracle, then you have the option of setting -compatible=customdatum, to implement the deprecated CustomDatum interface in your generated classes for user-defined types, instead of the default ORAData interface. CustomDatum was replaced by ORAData in Oracle9i Database, but is still supported for backward compatibility.
The default setting to use the ORAData interface is oradata. If you set -usertypes=jdbc, then a -compatible setting of customdatum or oradata is ignored.
If you use JPublisher in a pre-Oracle9i Database environment, in which the ORAData interface is not supported, then the CustomDatum interface is used automatically if -usertypes=oracle. You will receive an informational warning if -compatible=oradata, but the generation will take place.
Using -compatible to Specify a Backward-Compatibility Mode
Use the sqlj, 10.1, 9i, 8i, or both8i setting to specify a backward-compatibility mode.
The -compatible=sqlj setting instructs JPublisher to skip SQLJ translation and instead produce .sqlj files that you can work with directly. The sqlj setting has no effect on the generated code itself. To translate the resulting .sqlj files, you can use the SQLJ translator directly, if available, or use the JPublisher -sqlj option.
The -compatibility=10.1 setting specifies Oracle Database 10g release 1 (10.1) compatibility mode. In this mode, the JPublisher option -dbjava acts the same as -java in Oracle Database 10g release 1 (10.1).
The -compatibility=9i setting specifies Oracle9i compatibility mode. In this mode, JPublisher generates .sqlj files with the same code as would be generated by Oracle9i version.
The -compatible=8i setting specifies Oracle8i compatibility mode. This mode uses the CustomDatum interface, generating .sqlj files with the same code that would be generated by Oracle8i versions of JPublisher. The 8i setting is equivalent to setting several individual JPublisher options for backward compatibility to Oracle8i. For example, behavior of method generation is equivalent to that for -methods=always, and generation of connection context declarations is equivalent to that for -context=generated.
The -compatible=both8i setting is for an alternative Oracle8i compatibility mode. With this setting, wrapper classes are generated to implement both the ORAData and CustomDatum interfaces. Code is generated as it would have been by Oracle8i version of JPublisher. This setting is generally preferred over the -compatible=8i setting, because support for ORAData is required for programs running in the middle tier, such as in Oracle Application Server. However, using ORAData requires an Oracle9i release 1 (9.0.1) or later JDBC driver.
|
Note: In any compatibility mode that results in the generation of visible.sqlj files, remember that if you are generating Java wrapper classes for a SQL type hierarchy and any of the types contains stored procedures, then, by default, JPublisher generates .sqlj files for all the SQL types, and not just the types that have stored procedures. |
This section discusses JPublisher options that you can use to determine the Java environment:
The -classpath option specifies the Java classpath that JPublisher and SQLJ use to resolve classes during translation and compilation.
The -compiler-executable option specifies the Java compiler for compiling the code generated by JPublisher.
The -vm option specifies the JVM through which JPublisher is invoked.
In a UNIX environment, the jpub script specifies the location of the Java executable that runs JPublisher. This script is generated at the time you install your database or application server instance. If the jpub script uses a Java version prior to JDK 1.4, then some JPublisher functionality for Web services, such as call-outs and mapping to the SYS.XMLType, are unavailable.
Use the -classpath option to specify the Java classpath for JPublisher to use in resolving Java source and classes during translation and compilation. The syntax for this option is:
-classpath=path1:path2:...:pathN
The following command shows an example of its usage, adding new paths to the existing classpath:
% jpub -user=scott -sql=PERSON:Person,STUDENT:Student -classpath=.:$ORACLE_HOME/jdbc/lib/ocrs12.jar:$CLASSPATH
Enter scott password: password
|
Note: SQLJ also has a-classpath option. If you use the SQLJ -classpath option, following the JPublisher -sqlj option, then that setting is used for the classpath for translation and compilation, and any JPublisher -classpath option setting is ignored. It is more straightforward to use only the JPublisher -classpath option. |
Use the -compiler-executable option if you want Java code generated by JPublisher to be compiled by anything other than the compiler that JPublisher would use by default on your system. Specify the path to an alternative compiler executable file. The syntax for this option is:
-compiler-executable=path_to_compiler_executable
Use the -vm option if you want to use a JVM other than the JVM that JPublisher would use by default on your system. Specify the path to an alternative Java executable file. The syntax for this option is:
-vm=path_to_JVM_executable
As an example, assume that JDK 1.4 is installed on a UNIX system at the location JDK14, relative to the current directory. Run JPublisher with the following command to use the JDK 1.4 JVM and compiler when publishing Web services client proxy classes:
% jpub -vm=JDK14/bin/java -compiler-executable=JDK14/bin/java -proxywsdl=hello.wsdl
Starting from Oracle Database 10g release 2 (10.2), JPublisher provides the following command-line options to support migrating SQLJ to JDBC applications:
-migrate
This option enables you to turn on SQLJ migration. The syntax for setting this option is as follows:
-migrate[=true|false]
The -migrate and -migrate=true settings are equivalent. Both these settings indicate that JPublisher should migrate SQLJ programs specified on the command line to JDBC programs. The -migrate=false turns off the migration mode, and SQLJ programs are translated and compiled into a Java program that possibly depends on the SQLJ run time. By default, if this option is not specified, then JPublisher acts like -migrate=false.
-migconn
This option enables you to specify the default JDBC connection used by the migrated code. The default JDBC connection replaces the default DefaultContext instance in the SQLJ run time. The syntax for setting this option is as follows:
-migconn=getter:getter,setter:setter -migconn=name[[:datasource|modifier][,modifier]*]
In the first syntax, the getter and setter settings specify the getter and setter methods for the default connection. For example:
-migconn=getter:Test.getDefConn,setter:Test.setDefConn
In the second syntax, the name setting specifies the default JDBC connection. The optional datasource setting provides a JNDI data source location for initializing the default JDBC connection. The modifier settings add the modifiers for the default connection variable. You can specify more than one modifier by using multiple modifier settings. Examples of the usage of the second syntax are as follows:
-migconn=_defaultConn:public,static -migconn=Test._defaultConn -migconn=Test._defaultConn:jdbc/MyDataSource -migconn=_defaultConn:public,static,final
-migrsi
This option enables you to specify an interface for all ResultSet iterator classes. The syntax for setting this option is as follows:
-migrsi=java_interface_name
For example:
-migrsi=ResultSetInterface
-migsync
This option enables you to mark static variables as synchronized. The syntax for setting this option is as follows:
-migsync[=true|false]
The -migsync and -migsync=true settings mark static variables generated for migration purpose as synchronized. If you do not want the variables to be marked as synchronized, then set -migsync=false. By default, JPublisher acts like -migsync=true.
-migdriver
This option enables you to specify the JDBC driver registered by the migrated code. The syntax for setting this option is as follows:
-migdriver=class_name|no
For example:
-migdriver=oracle.jdbc.driver.OracleDriver
By default, JPublisher acts like -migdriver=oracle.jdbc.driver.OracleDriver. If you do not want the driver registration code to be generated during migration, then set this option as follows:
-migdriver=no
-migcodegen
This option enables you to specify whether the migrated code depends on an Oracle JDBC driver or a generic JDBC driver. The syntax for setting this option is as follows:
-migcodegen=oracle|jdbc
The default behavior is -migcodegen=oracle, indicating that Oracle-specific JDBC APIs are used in the migrated code.
-migserver
This option enables you to specify whether to migrate the program to be used on the server. The syntax for setting this option is as follows:
-migserver
The following sections describe the structure and contents of JPublisher input files:
A properties file is an optional text file in which you can specify frequently used options. Specify the name of the properties file on the JPublisher command line with the -props option.
|
Note: -props is the only option that you cannot specify in a properties file. |
On each line in a properties file, enter only one option with its associated value. Enter each option setting with the following prefix, including the period:
jpub.
The jpub. prefix is case-sensitive. White space is permitted only directly in front of jpub.. Any other white space within the option line is significant.
Alternatively, JPublisher permits you to specify options with a double-dash (--), which is the syntax for SQL comments, as part of the prefix:
-- jpub.
A line that does not start with either of the prefixes shown is simply ignored by JPublisher.
In addition, you can use line continuation to spread a JPublisher option over several lines in the properties file. A line to be continued must have a backslash character (\) as the last character, immediately after the text of the line. Any leading space or double dash (--) on the line that follows the backslash is ignored. Consider the following sample entries:
/* The next three lines represent a JPublisher option
jpub.sql=SQL_TYPE:JPubJavaType:MyJavaType,\
OTHER_SQL_TYPE:OtherJPubType:MyOtherJavaType,\
LAST_SQL_TYPE:My:LastType
*/
-- The next two lines represent another JPublisher option
-- jpub.addtypemap=PLSQL_TYPE:JavaType:SQL TYPE\
-- :SQL_TO_PLSQL_FUNCTION:PLSQL_TO_SQL_FUNCTION
Using this functionality, you can embed JPublisher options in SQL scripts, which may be useful when setting up PL/SQL-to-SQL type mappings.
JPublisher reads the options in the properties file in order, as if its contents were inserted on the command line at the point where the -props option is located. If you specify an option more than once, then the last value encountered by JPublisher overrides previous values, except for the following options, which are cumulative:
jpub.sql (or the deprecated jpub.types)
jpub.java
jpub.style
jpub.addtypemap
jpub.adddefaulttypemap
For example, consider the following command:
% jpub -user=scott -sql=employee -mapping=oracle -case=lower -package=corp -dir=demo
Enter scott password: password
Now consider the following:
% jpub -props=my_properties
This command is equivalent to the first example if you assume that my_properties has a definition such as the following:
-- jpub.user=scott/tiger
// jpub.user=cannot_use/java_line_comments
jpub.sql=employee
/*
jpub.mapping=oracle
*/
Jpub.notreally=a jpub option
jpub.case=lower
jpub.package=corp
jpub.dir=demo
You must include the jpub. prefix at the beginning of each option name. If you enter anything other than white space or double dash (--) before the option name, then JPublisher ignores the entire line.
The preceding example illustrates that white space before jpub. is okay. It also shows that the jpub. prefix must be all lowercase, otherwise it is ignored. Therefore the following line from the preceding example will be ignored:
Jpub.notreally=a jpub option
Specify the name of the INPUT file on the JPublisher command line with the -input option. This file identifies SQL user-defined types and PL/SQL packages that JPublisher should translate. It also controls the naming of the generated classes and packages. Although you can use the -sql command-line option to specify user-defined types and packages, an INPUT file allows you a finer degree of control over how JPublisher translates them.
If you do not specify types or packages to translate in an INPUT file or on the command line, then JPublisher translates all user-defined types and PL/SQL packages in the schema to which it connects.
The translation statement in the INPUT file identifies the names of the user-defined types and PL/SQL packages that you want JPublisher to translate. Optionally, the translation statement can also specify a Java name for the type or package, a Java name for attribute identifiers, and whether there are any extended classes.
One or more translation statements can appear in the INPUT file. The structure of a translation statement is as follows:
( SQL name | SQL [schema_name.]toplevel [(name_list)] | TYPE type_name) [GENERATE java_name_1] [AS java_name_2] [TRANSLATE database_member_name AS simple_java_name { , database_member_name AS simple_java_name}* ]
The following sections describe the components of the translation statement.
SQL name | TYPE type_name Enter SQL name to identify a SQL type or a PL/SQL package that you want JPublisher to translate. JPublisher examines the name, determines whether it is for a user-defined type or a PL/SQL package, and processes it appropriately. If you use the reserved word toplevel in place of name, JPublisher translates the top-level subprograms in the schema to which JPublisher is connected.
Instead of SQL, it is permissible to enter TYPE type_name if you are specifying only object types. However, the TYPE syntax is deprecated.
You can enter name as schema_name.name to specify the schema to which the SQL type or package belongs. If you enter schema_name.toplevel, JPublisher translates the top-level subprograms in schema schema_name. In conjunction with TOPLEVEL, you can also supply name_list, which is a comma-delimited list of names to be published, enclosed in parentheses. JPublisher considers only top-level functions and procedures that match this list. If you do not specify this list, JPublisher generates code for all top-level subprograms.
GENERATE java_name_1 AS java_name_2 The AS clause specifies the name of the Java class that represents the SQL user-defined type or PL/SQL package being translated.
When you use the AS clause without a GENERATE clause, JPublisher generates the class in the AS clause and maps it to the SQL type or PL/SQL package.
When you use both the GENERATE clause and the AS clause for a SQL user-defined type, the GENERATE clause specifies the name of the Java class that JPublisher generates, which is referred to as the base class. The AS clause specifies the name of a Java class that extends the generated base class, which is referred to as the user subclass. JPublisher produces an initial version of the user subclass, and you will typically add code for your desired functionality. JPublisher maps the SQL type to the user subclass, and not to the base class. If you later run the same JPublisher command to republish the SQL type, then the generated class is overwritten, but the user subclass is not.
The java_name_1 and java_name_2 can be any legal Java names and can include package identifiers. The case of the Java names overrides the -case option.
TRANSLATE database_member_name AS simple_java_name This clause optionally specifies a different name for an attribute or method. The database_member_name is the name of an attribute of a SQL object type or the name of a method of an object type or PL/SQL package. The attribute or method is to be translated to simple_java_name, which can be any legal Java name. The case of the Java name overrides the -case option. This name cannot have a package name.
If you do not use TRANSLATE...AS to rename an attribute or method, or if JPublisher translates an object type not listed in the INPUT file, then JPublisher uses the database name of the attribute or method as the Java name. If applicable, the Java name is modified according to the setting of the -case option. Reasons why you may want to rename an attribute or method include:
The name contains characters other than letters, digits, and underscores.
The name conflicts with a Java keyword.
The type name conflicts with another name in the same scope. This can happen, for example, if the program uses two types with the same name from different schemas.
Remember that your attribute names will appear embedded within getXXX() and setXXX() method names, so you may want to capitalize the first letter of your attribute names. For example, if you enter:
TRANSLATE FIRSTNAME AS FirstName
JPublisher generates a getFirstName() method and a setFirstName() method. In contrast, if you enter:
TRANSLATE FIRSTNAME AS firstName
JPublisher generates a getfirstName() method and a setfirstName() method.
|
Note: The Java keywordnull has special meaning when used as the target Java name for an attribute or method, such as in the following example:
TRANSLATE FIRSTNAME AS null When you map a SQL method to |
Package Naming Rules in the INPUT File You can specify a package name by using a fully qualified class name in the INPUT file. If you use a simple, unqualified class name in the INPUT file, then the fully qualified class name includes the package name from the -package option. This is demonstrated in the following examples:
Assume the following in the INPUT file:
SQL A AS B
And assume the setting -package=a.b. In this case, a.b is the package and a.b.B is the fully qualified class name.
Assume that you enter the following in the INPUT file and there is no -package setting:
SQL A AS b.C
The package is b, and b.C is the fully qualified class name.
|
Note: If there are conflicting package settings between a-package option setting and a package setting in the INPUT file, then the precedence depends on the order in which the -input and -package options appear on the command line. The -package setting takes precedence if that option is after the -input option, else the INPUT file setting takes precedence. |
Translating Additional Types It may be necessary for JPublisher to translate additional types that are not listed in the INPUT file. This is because JPublisher analyzes the types in the INPUT file for dependencies before performing the translation and translates any additional required types.
Consider the example in "Sample JPublisher Translation". Assume that the object type definition for EMPLOYEE includes an attribute called ADDRESS, and ADDRESS is an object with the following definition:
CREATE OR REPLACE TYPE address AS OBJECT
(
street VARCHAR2(50),
city VARCHAR2(50),
state VARCHAR2(30),
zip NUMBER
);
In this case, JPublisher would first translate ADDRESS, because that would be necessary to define the EMPLOYEE type. In addition, ADDRESS and its attributes would all be translated in the same case, because they are not specifically mentioned in the INPUT file. A class file would be generated for Address.java, which would be included in the package specified on the command line.
JPublisher does not translate PL/SQL packages you do not request, because user-defined types or other PL/SQL packages cannot have dependencies on PL/SQL packages.
To better illustrate the function of the INPUT file, consider an updated version of the example in "Sample JPublisher Translation".
Consider the following command:
% jpub -user=scott -input=demoin -numbertypes=oracle -usertypes=oracle -dir=demo -d=demo -package=corp -case=same
Enter scott password: password
And assume that the INPUT file demoin contains the following:
SQL employee AS Employee TRANSLATE NAME AS Name HIRE_DATE AS HireDate
The -case=same option specifies that generated Java identifiers maintain the same case as in the database, except where you specify otherwise. Any identifier in a CREATE TYPE or CREATE PACKAGE declaration is stored in uppercase in the database unless it is quoted. In this example, the -case option does not apply to the EMPLOYEE type, because EMPLOYEE is specified to be translated as the Java class Employee.
For attributes, attribute identifiers not specifically mentioned in the INPUT file remain in uppercase, but JPublisher translates NAME and HIRE_DATE as Name and HireDate, as specified.
The translated EMPLOYEE type is written to the following files, relative to the current directory, for UNIX systems in this example, reflecting the -package, -dir, and -d settings:
demo/corp/Employee.java demo/corp/Employee.class
This section describes possible INPUT file error conditions that JPublisher will currently not report. There is also a section for reserved terms.
If you request the same Java class name for two different object types, the second class overwrites the first without warning. Consider that the INPUT file contains:
type PERSON1 as Person type PERSON2 as Person
JPublisher creates the Person.java file for PERSON1 and then overwrites it for the PERSON2 type.
If you request the same attribute name for two different object attributes, JPublisher generates getXXX() and setXXX() methods for both attributes without issuing a warning message. The question of whether the generated class is valid in Java depends on whether the two getXXX() methods with the same name and the two setXXX() methods with the same name have different argument types so that they may be unambiguously overloaded.
If you specify a nonexistent object attribute in the TRANSLATE clause, then JPublisher ignores it without issuing a warning message.
Consider the following example from an INPUT file:
type PERSON translate X as attr1
A situation in which X is not an attribute of PERSON does not cause JPublisher to issue a warning message.
This chapter provides an overview of the JPublisher utility, a summary of JPublisher operations, and a sample translation. It covers the following topics:
JPublisher is a utility that generates Java classes to represent database entities, such as SQL objects and PL/SQL packages, in a Java client program. It also provides support for publishing from SQL, PL/SQL, and server-side Java to Web services and enabling the invocation of external Web services from inside the database. JPublisher is written in Java.
JPublisher can create classes to represent the following database entities types:
User-defined SQL objects
Object references
User-defined SQL collections
PL/SQL packages
Server-side Java classes
SQL queries and data manipulation language (DML) statements
JPublisher enables you to specify and customize the mapping of these entities to Java classes in a strongly typed paradigm.
|
Note: The term, strongly typed, indicates that a particular Java type is associated with a particular user-defined SQL type, such as an object type. For example, aPerson class is associated with a corresponding PERSON SQL type. In addition, there is a corresponding Java type for each attribute of the SQL object type. |
The utility generates the accessor methods, getXXX() and setXXX(), for each attribute of an object type. If the object type has stored procedures, then JPublisher can generate wrapper methods to invoke the stored procedures. In this scenario, a wrapper method is a Java method that invokes a stored procedure, which runs in Oracle Database.
JPublisher can also generate classes for PL/SQL packages. These classes have wrapper methods to call the stored procedures in a PL/SQL package.
Instead of directly using JPublisher-generated classes, you can:
Extend the generated classes. This process is straightforward. JPublisher generates initial versions of the subclasses, to which you can add any desired functionality.
Write your own Java classes. This approach is flexible, but time-consuming and error-prone.
Use generic, weakly typed classes of the oracle.sql package to represent object, object reference, and collection types. If these classes meet your requirements, then you do not need JPublisher. Use this approach if you need to generically process any SQL object, collection, reference, or OPAQUE type.
In addition, JPublisher simplifies access to PL/SQL types from Java. You can use predefined or user-defined mappings between PL/SQL and SQL types, as well as use PL/SQL conversion functions between such types. With these mappings in place, JPublisher can automatically generate all the required Java and PL/SQL code. It also enables you to publish server-side Java classes to client-side Java classes, allowing your application to make direct calls to Java classes in the database.
Several features enable the exposure of Java classes, which are generated from publishing SQL, PL/SQL, or server-side Java entities, as Web services.
The following sections provide an overview of JPublisher features and requirements. It also describes and how JPublisher uses SQLJ in its code generation:
There are no new features in this release of JPublisher.
This section describes the basic requirements for JPublisher. It also discusses situations with less stringent requirements.
When you use the JPublisher utility, you must also have classes for the Oracle SQLJ implementation, the Oracle JDBC implementation, and a Sun Microsystems JDK, among other things.
To use all features of JPublisher, you must have the following installed and set in the appropriate environment variables, as applicable:
Oracle Database 11g
JPublisher invocation script or executable
The jpub script for UNIX systems or the jpub.exe program for Microsoft Windows must be in your file path. These are typically in ORACLE_HOME/bin, or ORACLE_HOME/sqlj/bin for manual downloads. With proper setup, if you type just jpub on the command line, you will see information about common JPublisher options and input settings.
JPublisher and SQLJ translator classes
These classes are in the translator.jar library, typically in ORACLE_HOME/sqlj/lib.
|
Note: The translator library is also automatically loaded into the database intranslator-jserver.jar. |
SQLJ run time classes
The SQLJ run-time library is runtime12.jar for JDK 1.5 and later. It is typically located in ORACLE_HOME/sqlj/lib. It includes JPublisher client-side run-time classes, particularly oracle.jpub.reflect.Client, and JPublisher server-side run-time classes, particularly oracle.jpub.reflect.Server. These classes are used for Java call-ins to the database.
Oracle Database 11g or Oracle Database 10g JDBC drivers
If you are using JPublisher 11g with Oracle 11g JDBC, then the supported JDK versions are only JDK 1.5 and 1.6. However, if you are using JPublisher 11g with Oracle JDBC 10g driver, then you can also use JDK version 1.4.x. Oracle JDBC library is ojdbc14.jar for JDK 1.4, ojdbc5*.jar for JDK 1.5, and ojdbc6*.jar for JDK 1.6. It is typically located in ORACLE_HOME/jdbc/lib. Each JDBC library also includes the JPublisher run-time classes in the oracle.jpub.runtime package.
Web services classes
These classes are included in the dbwsa.jar and dbwsclient.jar libraries, which are typically located in ORACLE_HOME/sqlj/lib.
|
Note: These.jar files are not included in JPublisher distribution, but are included in the database Web services call-out utility, which can be downloaded from http://www.oracle.com/technetwork/database/database-083829.html. |
Additional PL/SQL packages and Java Archive (JAR) files in the database, as needed
There are packages and JAR files that must be in the database if you use JPublisher features for Web services call-ins, Web services call-outs, support for PL/SQL types, or support for invocation of server-side Java classes. Some of these packages and files are preloaded, but some must be loaded manually.
aurora.zip
When publishing a Web services client using -proxywsdl or publishing server-side Java classes using -dbjava, JPublisher may load generated Java wrapper into the database. In this case, the ORACLE_HOME/lib/aurora.zip file is required. On Microsoft Windows, add this file to CLASSPATH. On Unix systems, the jpub script picks up aurora.zip automatically. If the aurora.zip file is not available, then you can turn off the JPublisher loading behavior by specifying -proxyopt=noload on the command line.
JDK version 1.4 or later
For Web services call-outs or to map SYS.XMLType for Web services, you need JDK 1.4 or later.
In order to install JPublisher, you must install SQLJ in your system. Perform the following steps to install SQLJ:
Download and unzip the Oracle Database 11g Client CD.
Execute Oracle Universal Installer by running the setup.exe file.
The Welcome window appears as shown in Figure 1-8.
Figure 1-1 Oracle Universal Installer Welcome Screen
Click Next.
The Select Installation Type window appears as shown in Figure 1-2.
Figure 1-2 Oracle Universal Installer Select Installation Type Screen
Select Custom as the installation type and click Next.
The Install Location window appears as shown in Figure 1-3.
Figure 1-3 Oracle Universal Installer Install Location Screen
Verify whether your Oracle Database Home is correct or not and click Next.
The Product-Specific Prerequisite Checks window appears as shown in Figure 1-4.
Figure 1-4 Oracle Universal Installer Product-Specific Prerequisite Check Screen
The installer verifies that your system meets the pre-requisites. Click Next after the verification is complete.
The Available Product Components window appears as shown in Figure 1-5.
Figure 1-5 Oracle Universal Installer Available Product Components Screen
Select Oracle SQLJ from the Components column in the Oracle Client section and click Next.
The Summary window appears.
Figure 1-6 Oracle Universal Installer Summary Screen
Review your selections, and then click Install.
The Install window appears displaying the progress.
Figure 1-7 Oracle Universal Installer Install Screen
Click Exit and then click Yes.
Depending on the JPublisher features that you need to use, some or all of the following PL/SQL packages and JAR files must be present in the database:
The SQLJUTL package, to support PL/SQL types
The SQLJUTL2 package, to support invocation of server-side Java classes
The UTL_DBWS package, to support Web services call-outs
The dbwsclient.jar file, to support the Java API for XML-based Remote Procedure Call (JAX-RPC) or Simple Object Access Protocol (SOAP) client proxy classes for Web services call-outs from Oracle Database 11g or Oracle Database 10g.
JAR files to support SOAP client proxy classes for Web services call-outs from Oracle9i or Oracle8i Database
For Web services call-outs from Oracle9i Database or Oracle8i Database, there is no JAR file similar to dbwsclient.jar. You must load several JAR files instead. Also note that JPublisher does not yet support JAX-RPC client proxy classes in Oracle9i or Oracle8i.
This section covers the following topics:
In Oracle Database 11g, the PL/SQL packages SQLJUTL and SQLJUTL2 are automatically installed in the database SYS schema. To verify the installation, try to describe the packages as follows:
SQL> describe sys.sqljutl SQL> describe sys.sqljutl2
If JPublisher displays a message similar to the following, then the packages are missing:
Warning: Cannot determine what kind of type is <schema>.<type.> You likely need to install SYS.SQLJUTL. The database returns: ORA-06550: line 1, column 7: PLS-00201: identifier 'SYS.SQLJUTL' must be declared
To install the SQLJUTL and SQLJUTL2 packages, you must install one of the following files in the SYS schema:
ORACLE_HOME/sqlj/lib/sqljutl.sql for Oracle9i, Oracle Database 10g, or Oracle Database 11g
ORACLE_HOME/sqlj/lib/sqljutl8.sql for Oracle8i
In Oracle Database 11g release 2 (11.2), the UTL_DBWS PL/SQL package is not automatically installed in the database SYS schema due to security reasons. You must install this package by running the utl_dbws_decl.sql and utl_dbws_body.sql scripts included as callout utilities available on the following OTN page:
http://www.oracle.com/technetwork/database/database-083829.html
To verify the installation, try to describe the package as follows:
SQL> describe sys.utl_dbws
In Oracle Database 11g, the following file must be loaded into the database for Web services call-outs:
ORACLE_HOME/sqlj/lib/dbwsclient.jar
It is not preloaded, but you can verify whether it is already loaded by running the following query in the SYS schema:
SQL> select status, object_type from all_objects where
dbms_java.longname(object_name)='oracle/jpub/runtime/dbws/DbwsProxy$1';
The following result indicates that the file is already loaded:
STATUS OBJECT_TYPE ------- ------------------- VALID JAVA CLASS VALID SYNONYM
If it not loaded, then you can use the loadjava utility to load it as shown in the following example:
% loadjava -oci8 -u sys -r -v -f -s
-grant public dbwsclient.jar
Password: password
|
Note: Before loading this file, verify thatjava_pool_size is set to at least 80 MB and shared_pool_size is set to at least 96 MB. |
For Web services call-outs from an Oracle9i or Oracle8i database, use SOAP client proxy classes. For this, you must load a number of JAR files into the database. This can be accomplished with the following command:
% loadjava -u sys -r -v -s -f -grant public
ORACLE_HOME/soap/lib/soap.jar
ORACLE_HOME/dms/lib/dms.jar
J2EE_HOME/lib/servlet.jar
J2EE_HOME/lib/ejb.jar
J2EE_HOME/lib/mail.jar
Password: password
You can obtain these files from an Oracle Application Server installation. You would presumably run Web services in conjunction with Oracle Application Server Containers for J2EE (OC4J).
|
Note:
|
By default, if the -user and -sysuser options are set while publishing Web services client using -proxywsdl or publishing server-side Java classes using -dbjava, then JPublisher will load the generated Java and PL/SQL wrappers into the database. When the -url setting specifies a JDBC Thin driver, the loading process requires the database password file to be set up properly. You can set up the password file by performing the following steps:
On the command line, enter the following command:
orapwd file=$ORACLE_HOME/dbs/orapw entries=5
Enter password: password
In the preceding command, yourpass is the password of your choice.
From SQL*Plus, connect to the database as SYSDBA, as follows:
CONNECT / AS SYSDBA
Change the password of SYS to the password set in the previous step, as follows:
PASSWORD SYS
Changing password for SYS
New password: password
Retype new password: password
Edit the init.ora file and add the following line to it:
REMOTE_LOGIN_PASSWORDFILE=EXCLUSIVE
This enables remote login as SYSDBA.
Alternatively, with the password file set up, you can manually load JPublisher generated PL/SQL wrapper and Java wrapper into the database. To turn off automatic loading by JPublihser, specify -proxyopt=noload on the command line.
This section covers the following topics:
Oracle SQLJ translator and run-time libraries are supplied with the JPublisher product. The JPublisher utility uses the Oracle SQLJ implementation by generating SQLJ code as an intermediate step in most circumstances, such as the creation of wrapper methods. The wrapper methods are created either for classes representing PL/SQL packages or for classes representing SQL object types that define PL/SQL stored procedures. In these cases, JPublisher uses Oracle SQLJ translator during compilation and Oracle SQLJ run time during program execution.
In Oracle Database 11g, the usage of SQLJ by JPublisher is transparent by default. SQLJ source files that JPublisher generates are automatically translated and deleted, unless you specify otherwise in the JPublisher settings. This automatic translation saves you the effort of explicitly translating the files. The resulting .java files, which use the SQLJ functionality, and the associated .class files produced by compilation, define the SQLJ classes. These classes use the Oracle SQLJ run-time application programming interfaces (APIs) while running. Generated classes that do not use the SQLJ run time are referred to as non-SQLJ classes. Non-SQLJ classes are generated when JPublisher creates classes for SQL types that do not have stored procedures or when JPublisher is specifically set to not generate wrapper methods.
In Oracle Database 11g, it is possible to pass options to the SQLJ translator through the JPublisher -sqlj option.
JPublisher is included in translator.jar, which also contains the SQLJ translator library. JPublisher generated classes may rely on runtime12.jar, which is the SQLJ run-time library for Java Development Kit (JDK) 1.5 and later.
A SQLJ program is a Java program containing embedded SQL statements that comply with the International Standardization Organization (ISO) standard SQLJ Language Reference syntax. SQLJ source code contains a mixture of standard Java source, SQLJ class declarations, and SQLJ executable statements with embedded SQL operations.
SQLJ was chosen because it uses simplified code for database access as compared to JDBC code. In SQLJ, a SQL statement is embedded in a single #sql statement, but several JDBC statements may be required for the same operation.
This section briefly defines the following key concepts of SQLJ:
Connection contexts
A SQLJ connection context object is a strongly typed database connection object. You can use each connection context class for a particular set of interrelated SQL entities. This means that all the connections you define using a particular connection context class will use tables, views, and stored procedures that have names and data types in common. In theory, the advantage in tailoring connection context classes to sets of SQL entities is in the degree of online semantics-checking that is permitted during SQLJ translation. JPublisher does not use online semantics-checking when it invokes the SQLJ translator, but you can use this feature if you choose to work with .sqlj files directly.
The sqlj.runtime.ref.DefaultContext connection context class is used by default. The SQLJ default context is a default connection object and an instance of this class. The DefaultContext class or any custom connection context class implements the standard sqlj.runtime.ConnectionContext interface. You can use the JPublisher -context option to specify the connection context class that JPublisher instantiates for database connections.
Iterators
A SQLJ iterator is a strongly typed version of a JDBC result set and is associated with the underlying database cursor. SQLJ iterators are used for taking query results from a SELECT statement. The strong typing is based on the data type of each query column.
Execution contexts
A SQLJ execution context is an instance of the standard sqlj.runtime.ExecutionContext class and provides a context in which SQL operations are run. An execution context instance is associated either implicitly or explicitly with each SQL operation that is run through SQLJ code.
In Oracle8i Database and Oracle9i Database, JPublisher produces .sqlj source files as visible output, which you can translate by using the SQLJ command-line interface.
|
Note: On UNIX systems, you can access the SQLJ command-line interface by running thesqlj script. In Microsoft Windows, you use sqlj.exe. |
In Oracle Database 11g, JPublisher supports several backward-compatibility settings through the -compatible option. This option enables you to work with generated .sqlj files in a similar fashion. Some of the -compatible option settings are as follows:
-compatible=sqlj
This forces JPublisher skip the step of translating .sqlj files. You must translate the .sqlj files explicitly. To translate the files, you can either run JPublisher using only the -sqlj option or you can run the SQLJ translator directly through its own command-line interface.
-compatible=9i
This sets JPublisher to Oracle9i compatibility mode. In this mode, JPublisher generates .sqlj files with the same code as in Oracle9i versions. This enables you to work directly with .sqlj files.
-compatible=8i or -compatible=both8i
This sets JPublisher to Oracle8i compatibility mode. JPublisher then generates .sqlj files with the same code as in Oracle8i versions. As with Oracle9i compatibility mode, this mode enables you to work directly with .sqlj files.
Oracle8i and Oracle9i compatibility modes, particularly the former, result in significant differences in the code that JPublisher generates. If your only goal is to work directly with the .sqlj files, then use the sqlj setting.
If you do not use certain features of JPublisher, then your requirements may be less stringent. Some of the situations for reduced requirements are as follows:
If you never generate classes that implement the Oracle-specific oracle.sql.ORAData interface or the deprecated oracle.sql.CustomDatum interface, then you can use a non-Oracle JDBC driver and connect to a non-Oracle database. However, JPublisher must be able to connect to Oracle Database.
|
Note: Oracle does not test or support configurations that use non-Oracle components. |
If you instruct JPublisher to not generate wrapper methods by setting -methods=false, or if your object types do not define any methods, then JPublisher will not generate wrapper methods or produce any SQLJ classes. In these circumstances, there is no SQLJ translation step and the SQLJ translator is not required.
If you do not use JPublisher functionality to enable Web services call-outs, then you do not need dbwsa.jar or dbwsclient.jar to be loaded in the database.
You must be aware of the following limitations when you use JPublisher:
JPublisher support for PL/SQL RECORD and indexed-by table types is limited. An intermediate wrapper layer is used to map a RECORD or an indexed-by-table argument to a SQL type that JDBC supports. In addition, JPublisher cannot fully support the semantics of indexed-by tables. An indexed-by table is similar in structure to a Java hashtable, but information is lost when JPublisher maps this to a SQL TABLE type.
If you use an INPUT file to specify type mappings, then note that some potentially disruptive error conditions do not result in error or warning messages from JPublisher. Additionally, there are reserved terms that you are not permitted to use as SQL or Java identifiers.
The -omit_schema_names JPublisher option has a boolean logic, but does not use the same syntax as other boolean options. You can use this option to instruct JPublisher to not use schema names to qualify SQL names that are referenced in wrapper classes. By default, JPublisher uses schema names to qualify SQL names. To disable the use of schema names, enter the -omit_schema_names option on the command line, but do not attempt to set -omit_schema_names=true or -omit_schema_names=false.
|
Note: This chapter refers to the input file specified by the-input option as the INPUT file to distinguish from any other kinds of input files. |
You can use JPublisher to publish:
SQL user-defined types
PL/SQL packages
Server-side Java classes
SQL queries or DML statements
Proxy classes and wrappers for Web services call-outs
Oracle Streams AQ
The following sections provide a basic overview of JPublisher mappings and mapping categories:
JPublisher provides mappings from the following to Java classes:
User-defined SQL types
PL/SQL types
You can use an Oracle-specific implementation, a standard implementation, or a generic implementation in representing user-defined SQL types, such as objects, collections, object references, and OPAQUE types, in your Java program.
Following is a summary of these three approaches:
Use classes that implement the Oracle-specific ORAData interface.
JPublisher generates classes that implement the oracle.sql.ORAData interface. The ORAData interface supports SQL objects, object references, collections, and OPAQUE types in a strongly typed way. That is, for each specific object, object reference, collection, or OPAQUE type in the database, there is a corresponding Java type.
Use classes that implement the standard SQLData interface, as described in the JDBC specification.
JPublisher generates classes for SQL object types that implement the java.sql.SQLData interface. When you use the SQLData interface, all object reference types are represented generically as java.sql.Ref and all collection types are represented generically as java.sql.Array. In addition, when using SQLData, there is no mechanism for representing OPAQUE types.
Use oracle.sql.* classes.
You can use the oracle.sql.* classes to represent user-defined types generically. The oracle.sql.STRUCT class represents all object types, the oracle.sql.ARRAY class represents all the variable array (VARRAY) and nested table types, the oracle.sql.REF class represents all the object reference types, and the oracle.sql.OPAQUE class represents all OPAQUE types. These classes are immutable in the same way that java.lang.String is.
Choose this option for code that processes objects, collections, references, or OPAQUE types in a generic way. Unlike classes implementing ORAData or SQLData, oracle.sql.* classes are not strongly typed.
|
Note: You can create your own classes, but this is not recommended. If you create your own classes or generate classes for an inheritance hierarchy of object types, then your classes must be registered using a type map. |
In addition to strong typing, JPublisher-generated classes that implement ORAData or SQLData have the following advantages:
The classes are customized, rather than generic. You access attributes of an object using getXXX() and setXXX() methods named after the particular attributes of the object. Note that you must explicitly update the object in the database if there are any changes to its data.
The classes are mutable. You can modify attributes of an object or elements of a collection. An exception is that ORAData classes representing object reference types are not mutable, because an object reference does not have any subcomponents that can be modified. You can, however, use the setValue() method of a reference object to change the database value that the reference points to.
You can generate Java wrapper classes that are serializable or that have the toString() method to print out the object along with its attribute values.
Compared to classes that implement SQLData, classes that implement ORAData are fundamentally more efficient, because ORAData classes avoid unnecessary conversions to native Java types.
For Oracle ORAData implementations, JPublisher always generates strongly typed object reference classes, in contrast to using the weakly typed oracle.sql.REF class. This is to provide greater type safety and to mirror the behavior in SQL, in which object references are strongly typed. The strongly typed classes, for example, the PersonRef class for references to the PERSON object, are wrappers for the oracle.sql.REF class.
In these strongly typed REF wrappers, a getValue() method produces an instance of the SQL object that is referenced as of an instance of the corresponding Java class. In the case of inheritance, the method produces an instance of a subclass of the corresponding Java class.
For example, if there is a PERSON object type in the database with a corresponding Person Java class, then there will also be a PersonRef Java class. The getValue() method of the PersonRef class would return a Person instance containing the data for a PERSON object in the database. In addition, JPublisher also generates a static cast() method on the PersonRef class. This permits you to convert other typed references to a PersonRef instance.
Whenever a SQL object type has an attribute that is an object reference, the Java class corresponding to the object type would have an attribute that is an instance of a Java class corresponding to the appropriate reference type. For example, if there is a PERSON object with a MANAGER REF attribute, then the corresponding Person Java class will have a ManagerRef attribute.
JDBC does not support PL/SQL-specific types, such as the BOOLEAN type and PL/SQL RECORD types that are used in stored procedures or functions. JPublisher provides the following workarounds for PL/SQL types:
JPublisher has a type map that you can use to specify the mapping for a PL/SQL type unsupported by JDBC.
For PL/SQL RECORD types or indexed-by tables types, you have the choice of JPublisher automatically creating a SQL object type or SQL collection type, respectively, as an intermediate step in the mapping.
With either workaround, JPublisher creates PL/SQL conversion functions or uses predefined conversion functions that are typically found in the SYS.SQLJUTL package to convert between a PL/SQL type and a corresponding SQL type. The conversion functions can be used in generated Java code that calls a stored procedure directly, or JPublisher can create a wrapper function around the PL/SQL stored procedure, where the generated Java code calls the wrapper function, which calls the conversion functions. Either way, only SQL types are exposed to JDBC.
JPublisher offers different categories of data type mappings from SQL to Java. Each type mapping option has at least two possible values: jdbc or oracle. The -numbertypes option has two additional alternatives: objectjdbc and bigdecimal. The following sections describe these mappings categories.
In JDBC mapping:
Most numeric data types are mapped to Java primitive types, such as int and float.
The DECIMAL and NUMBER type are mapped to the java.math.BigDecimal.
Large object (LOB) type and other non-numeric built-in types are mapped to the standard JDBC types, such as java.sql.Blob and java.sql.Timestamp.
For object types, JPublisher generates SQLData classes. Because predefined data types that are Oracle extensions, such as BFILE and ROWID, do not have JDBC mappings, only the oracle.sql.* mapping is supported for these types.
The Java primitive types used in the JDBC mapping do not support NULL values and do not guard against integer overflow or floating-point loss of precision. If you are using the JDBC mapping and you attempt to call an accessor method to get an attribute of a primitive type whose value is NULL, then an exception is thrown. If the primitive type is short or int, then an exception is thrown if the value is too large to fit in a short or int variable.
In Object JDBC mapping, most numeric data types are mapped to Java wrapper classes, such as java.lang.Integer and java.lang.Float, and DECIMAL and NUMBER are mapped to java.math.BigDecimal. This differs from the JDBC mapping, which does not use primitive types.
Object JDBC is the default mapping for numeric types. When you use the Object JDBC mapping, all your returned values are objects. If you attempt to get an attribute whose value is NULL, then a NULL object is returned. The Java wrapper classes used in the Object JDBC mapping do not guard against integer overflow or floating-point loss of precision. If you call an accessor method to get an attribute that maps to java.lang.Integer, then an exception is thrown if the value is too large to fit.
In BigDecimal mapping, all numeric data types are mapped to java.math.BigDecimal. This supports NULL values and large values.
In Oracle mapping, the numeric, LOB, or other built-in types are mapped to classes in the oracle.sql package. For example, the DATE type is mapped to oracle.sql.DATE and all numeric types are mapped to oracle.sql.NUMBER. For object, collection, and object reference types, JPublisher generates ORAData classes.
Because the Oracle mapping uses no primitive types, it can represent a NULL value as a Java null in all cases. Also, it can represent the largest numeric values that can be stored in the database, because it uses the oracle.sql.NUMBER class for all numeric types.
To publish database entities, JPublisher connects to the database and retrieves descriptions of SQL types, PL/SQL packages, or server-side Java classes that you specify on the command line or in an INPUT file. By default, JPublisher connects to the database by using the JDBC Oracle Call Interface (OCI) driver, which requires an Oracle client installation, including Oracle Net Services and required support files. If you do not have an Oracle client installation, then JPublisher can use Oracle JDBC Thin driver.
JPublisher generates a Java class for each SQL type or PL/SQL package that it translates and each server-side Java class that it processes. Generated classes include code required to read and write objects in the database. When you deploy the generated JPublisher classes, your JDBC driver installation includes all the necessary run-time files. If JPublisher generates wrapper methods for stored procedures, then the classes that it produces use the SQLJ run time during execution. In this case, you must also have the SQLJ run-time library runtime12.jar.
When you call a wrapper method on an instance of a class that was generated for a SQL object, the SQL value for the corresponding object is sent to the server along with any IN or IN OUT arguments. Then the method is invoked, and the new object value is returned to the client along with any OUT or IN OUT arguments. Note that this results in a database round trip. If the method call only performs a simple state change on the object, then there will be better performance if you write and use equivalent Java that affects the state change locally.
The number of classes that JPublisher produces depends on whether you request ORAData classes or SQLData classes.
To publish external Web services for access from inside a database, JPublisher accesses a specified Web Service Description Language (WSDL) document and directs the generation of appropriate client proxy classes. It then generates wrapper classes, as necessary, and PL/SQL wrappers to allow Web services call-outs from PL/SQL.
The following subsections provide more detail:
You can specify input options on the command line and in a JPublisher properties file. In addition to producing Java classes for the translated entities, JPublisher writes the names of the translated objects and packages to the standard output.
You can use a file known as the JPublisher INPUT file to specify the SQL types, PL/SQL packages, or server-side Java classes that JPublisher should publish. It also controls the naming of the generated packages and classes.
To use a properties file to specify option settings, specify the name of the properties file on the command line by using the -props option. JPublisher processes a properties file as if its contents were inserted in sequence on the command line at the point of the -props option. For additional flexibility, properties files can also be SQL script files in which the JPublisher directives are embedded in SQL comments.
This section describes JPublisher output for user-defined object types, user-defined collection types, OPAQUE types, PL/SQL packages, server-side Java classes, SQL queries or DML statements, and AQs and streams.
|
Note: Be aware that when JPublisher publishes a database entity, such as a SQL type or PL/SQL package, it also generates classes for any types that are referenced by the entity. For example, if a stored procedure in a PL/SQL package that is being published uses a SQL object type as an argument, then a class will be generated to map to that SQL object type. |
For a user-defined object type, when you run JPublisher and request ORAData classes, JPublisher creates the following:
An object class that represents instances of Oracle object type in your Java program
For each object type, JPublisher generates a type.java file for the class code. For example, JPublisher generates Employee.java for Oracle object type EMPLOYEE.
A stub subclass (optional)
It is named as specified in your JPublisher settings. You can modify the generated stub subclass for custom functionality.
An interface for the generated class or subclass to implement (optional)
A related reference class for object references
JPublisher generates a typeRef.java file for the REF class associated with the object type. For example, JPublisher generates the EmployeeRef.java file for references of Oracle object type EMPLOYEE.
Java classes for any object or collection or OPAQUE attributes nested directly or indirectly within the top-level object
This is necessary so that attributes can be materialized in Java whenever an instance of the top-level class is materialized. If an attribute type, such as a SQL OPAQUE type or a PL/SQL type, has been premapped, then JPublisher uses the target Java type from the map.
|
Note: ForORAData implementations, a strongly typed reference class is always generated, regardless of whether the SQL object type uses references. |
If you request SQLData classes, then JPublisher does not generate the object reference class and classes for nested collection attributes or OPAQUE attributes.
When you run JPublisher for a user-defined collection type, you must request ORAData classes. JPublisher creates the following:
A collection class to act as a type definition that corresponds to Oracle collection type
For each collection type JPublisher translates, it generates a type.java file. For nested tables, the generated class has methods to get and set the nested table as an entire array and to get and set individual elements of the table. JPublisher translates collection types when generating ORAData classes, but not when generating SQLData classes.
If the elements of the collection are objects, then a Java class for the element type and Java classes for any object or collection attributes nested directly or indirectly within the element type
This is necessary so that object elements can be materialized in Java whenever an instance of the collection is materialized.
An interface that is implemented by the generated type (optional)
|
Note: Unlike for object types, you do not have the option of generating user subclasses for collection types. |
When you run JPublisher for an OPAQUE type, you must request ORAData classes. JPublisher creates a Java class that acts as a wrapper for the OPAQUE type, providing Java versions of the OPAQUE type methods as well as protected APIs to access the representation of the OPAQUE type in a subclass.
However, in most cases, Java wrapper classes for the SQL OPAQUE types are furnished by the provider of the OPAQUE types. For example, the oracle.xdb.XMLType class for the SYS.XMLTYPE SQL OPAQUE type. In such cases, ensure that the correspondence between the SQL type and the Java type is predefined to JPublisher through the type map.
When you run JPublisher for a PL/SQL package, it creates a Java class with wrapper methods that invoke the stored procedures of the package on the server. IN arguments for the methods are transmitted from the client to the server, and OUT arguments and results are returned from the server to the client.
When you run JPublisher for a server-side Java class used for general purposes, it creates the source code, type.java, for a client-side stub class that mirrors the server class. When you call the client-side methods, the corresponding server-side methods are called transparently.
For Web services call-outs, JPublisher typically generates wrapper classes for the server-side client proxy classes. These wrapper classes act as bridges to the corresponding PL/SQL wrappers. This is necessary to publish any proxy class instance method as a static method, because PL/SQL does not support instance methods.
When you run JPublisher for a SQL query or DML statement, it creates the following:
A Java class that implements the method that runs the SQL statement
A Java stub subclass, named as specified in your JPublisher settings (optional)
You can modify this stub subclass for custom functionality.
A Java interface for the generated class or subclass to implement (optional)
When you run JPublisher for an AQ or a topic, it creates the following:
A Java class for the queue or topic
A Java class for the payload type of the queue or topic
In the case of a stream, JPublisher generates a Java class for the stream. The payload is always SYS.ANYDATA, which is mapped to java.lang.Object.
Depending on your usage, JPublisher may generate a PL/SQL package and associated PL/SQL scripts.
PL/SQL Package
JPublisher typically generates a PL/SQL package with PL/SQL code for any of the following:
PL/SQL call specifications for generated Java methods
PL/SQL conversion functions and wrapper functions to support PL/SQL types
PL/SQL table functions
Conversion functions, and optionally wrapper functions, are employed to map PL/SQL types used in the calling sequences of any stored procedures that JPublisher translates. The functions convert between PL/SQL types and corresponding SQL types, given that JDBC does not generally support PL/SQL types.
PL/SQL Scripts
JPublisher generates the following PL/SQL scripts:
A wrapper script to create the PL/SQL package and any necessary SQL types
A script to grant permission to run the wrapper script
A script to revoke permission to run the wrapper script
A script to drop the package and types created by the wrapper script
This section discusses the following topics:
Figure 1-8 illustrates the basic steps for publishing specified SQL types, PL/SQL packages, or server-side Java classes. The steps are as follows:
Run JPublisher with input from the command line, properties file, and INPUT file, as desired.
JPublisher accesses the database to which it is attached to obtain definitions of SQL or PL/SQL entities that you specify for publishing.
JPublisher generates .java or .sqlj source files, as appropriate, depending on whether wrapper methods are created for stored procedures.
By default, JPublisher invokes the SQLJ translator, which is provided as part of JPublisher, to translate .sqlj files into .java files.
For SQLJ classes, by default, the SQLJ translator invokes the Java compiler to compile.java files into.class files. For non-SQLJ classes, JPublisher invokes the Java compiler.
JPublisher generates PL/SQL wrappers and scripts, as appropriate, in addition to the .class files. There is a script to create the PL/SQL wrapper package and any necessary SQL types, such as types to map to PL/SQL types, a script to drop these entities, and scripts to grant or revoke required privileges.
In the case of proxy class generation through the -proxywsdl or -proxyclasses option, JPublisher can load generated PL/SQL wrappers and scripts into the database to which it is connected for execution in the database PL/SQL engine.
By default, JPublisher loads generated Java classes for Web services call-outs into the database to which it is connected, for execution in Oracle JVM. JPublisher-generated classes other than those for Web services call-outs typically execute in a client or middle-tier JVM. You may also have your own classes, such as subclasses of JPublisher-generated classes, that would typically execute in a client or middle-tier JVM.
Figure 1-8 Translating and Using JPublisher-Generated Code
On most operating systems, you can start JPublisher from the command line by typing jpub followed by a series of option settings, as follows:
% jpub -option1=value1 -option2=value2 ...
JPublisher responds by connecting to the database and obtaining the declarations of the types or packages you specify. It then generates one or more custom Java classes and writes the names of the translated object types or PL/SQL packages to the standard output.
Here is an example of a single wraparound command that invokes JPublisher:
% jpub -user=scott -input=demoin -numbertypes=oracle -usertypes=oracle -dir=demo -d=demo -package=corp
Enter scott password: password
Enter the command on the command line, allowing it to wrap as necessary. This command directs JPublisher to connect to the database with the user name scott and password TIGER and to translate data types to Java classes, based on instructions in the INPUT file demoin. The -numbertypes=oracle option directs JPublisher to map object attribute types to Java classes supplied by Oracle, and the -usertypes=oracle option directs JPublisher to generate Oracle-specific ORAData classes. JPublisher places the classes that it generates in the corp package under the demo directory.
|
Note: This chapter refers to the input file specified by the-input option as the INPUT file to distinguish from any other kinds of input files. |
JPublisher also supports specification of .java files, or .sqlj files, if you are using SQLJ source files directly, on the JPublisher command line. In addition to any JPublisher-generated files, the specified files are translated and compiled. For example:
% jpub ...options... Myclass.java
|
Note:
|
This section provides a sample JPublisher translation of a user-defined object type. At this point, do not worry about the details of the code JPublisher generates. You can find more information about JPublisher input and output files, options, data type mappings, and translation later in this manual.
|
Note: For more examples, go toORACLE_HOME/sqlj/demo/jpub in your Oracle Database installation. |
Create the object type EMPLOYEE:
CREATE TYPE employee AS OBJECT
(
name VARCHAR2(30),
empno INTEGER,
deptno NUMBER,
hiredate DATE,
salary REAL
);
The INTEGER, NUMBER, and REAL types are all stored in the database as NUMBER types, but after translation they have different representations in the Java program, based on your setting of the -numbertypes option.
Assume JPublisher translates the types according to the following command entered on the command line:
% jpub -user=scott -dir=demo -numbertypes=objectjdbc -builtintypes=jdbc -package=corp -case=mixed -sql=Employee
Enter scott password: password
Note that JPublisher generates a non-SQLJ class, because the EMPLOYEE object type does not define any methods.
Because -dir=demo and -package=corp are specified on the JPublisher command line, the translated class Employee is written to Employee.java at the following location:
./demo/corp/Employee.java
|
Note: This location is specific for a UNIX system. |
The Employee.java class file would contain the code shown in the following example.
|
Note: The details of the code JPublisher generates are subject to change. In particular, non-public methods, non-public fields, and all method bodies may be generated differently. |
package corp;
import java.sql.SQLException;
import java.sql.Connection;
import oracle.jdbc.OracleTypes;
import oracle.sql.ORAData;
import oracle.sql.ORADataFactory;
import oracle.sql.Datum;
import oracle.sql.STRUCT;
import oracle.jpub.runtime.MutableStruct;
public class Employee implements ORAData, ORADataFactory
{
public static final String _SQL_NAME = "SCOTT.EMPLOYEE";
public static final int _SQL_TYPECODE = OracleTypes.STRUCT;
protected MutableStruct _struct;
private static int[] _sqlType = { 12,4,2,91,7 };
private static ORADataFactory[] _factory = new ORADataFactory[5];
protected static final Employee _EmployeeFactory = new Employee(false);
public static ORADataFactory getORADataFactory()
{ return _EmployeeFactory; }
/* constructor */
protected Employee(boolean init)
{ if(init) _struct = new MutableStruct(new Object[5], _sqlType, _factory); }
public Employee()
{ this(true); }
public Employee(String name, Integer empno, java.math.BigDecimal deptno,
java.sql.Timestamp hiredate, Float salary)
throws SQLException
{ this(true);
setName(name);
setEmpno(empno);
setDeptno(deptno);
setHiredate(hiredate);
setSalary(salary);
}
/* ORAData interface */
public Datum toDatum(Connection c) throws SQLException
{
return _struct.toDatum(c, _SQL_NAME);
}
/* ORADataFactory interface */
public ORAData create(Datum d, int sqlType) throws SQLException
{ return create(null, d, sqlType); }
protected ORAData create(Employee o, Datum d, int sqlType) throws SQLException
{
if (d == null) return null;
if (o == null) o = new Employee(false);
o._struct = new MutableStruct((STRUCT) d, _sqlType, _factory);
return o;
}
/* accessor methods */
public String getName() throws SQLException
{ return (String) _struct.getAttribute(0); }
public void setName(String name) throws SQLException
{ _struct.setAttribute(0, name); }
public Integer getEmpno() throws SQLException
{ return (Integer) _struct.getAttribute(1); }
public void setEmpno(Integer empno) throws SQLException
{ _struct.setAttribute(1, empno); }
public java.math.BigDecimal getDeptno() throws SQLException
{ return (java.math.BigDecimal) _struct.getAttribute(2); }
public void setDeptno(java.math.BigDecimal deptno) throws SQLException
{ _struct.setAttribute(2, deptno); }
public java.sql.Timestamp getHiredate() throws SQLException
{ return (java.sql.Timestamp) _struct.getAttribute(3); }
public void setHiredate(java.sql.Timestamp hiredate) throws SQLException
{ _struct.setAttribute(3, hiredate); }
public Float getSalary() throws SQLException
{ return (Float) _struct.getAttribute(4); }
public void setSalary(Float salary) throws SQLException
{ _struct.setAttribute(4, salary); }
}
Code Generation Notes
JPublisher also generates object constructors based on the object attributes.
Additional private or public methods may be generated with other option settings. For example, the -serializable=true setting results in the object wrapper class implementing the interface java.io.Serializable and in the generation of private writeObject() and readObject() methods. In addition, the -tostring=true setting results in the generation of a public toString() method.
There is a protected _struct field in JPublisher-generated code for SQL object types. This is an instance of the oracle.jpub.runtime.MutableStruct internal class. It contains the data in original SQL format. In general, you should never reference this field directly. Instead, use the -methods=always or -methods=named setting, as necessary, to ensure that JPublisher produces setFrom() and setValueFrom() methods, and then use these methods when extending a class.
JPublisher generates SQLJ classes instead of non-SQLJ classes in the following circumstances:
The SQL object being published has methods, and the -methods=false setting is not specified.
A PL/SQL package, stored procedure, query, or DML statement is published, and the -methods=false setting is not specified.
In addition:
If a SQLJ class is created for a type definition, then a SQLJ class is also created for the corresponding REF definition.
If a SQLJ class is created for a base class, then SQLJ classes are also created for any subclasses.
This means that, in a backward-compatibility mode, JPublisher generates .sqlj files instead of .java files.
JPublisher also generates an EmployeeRef.java class. The source code is as follows:
package corp;
import java.sql.SQLException;
import java.sql.Connection;
import oracle.jdbc.OracleTypes;
import oracle.sql.ORAData;
import oracle.sql.ORADataFactory;
import oracle.sql.Datum;
import oracle.sql.REF;
import oracle.sql.STRUCT;
public class EmployeeRef implements ORAData, ORADataFactory
{
public static final String _SQL_BASETYPE = "SCOTT.EMPLOYEE";
public static final int _SQL_TYPECODE = OracleTypes.REF;
REF _ref;
private static final EmployeeRef _EmployeeRefFactory = new EmployeeRef();
public static ORADataFactory getORADataFactory()
{ return _EmployeeRefFactory; }
/* constructor */
public EmployeeRef()
{
}
/* ORAData interface */
public Datum toDatum(Connection c) throws SQLException
{
return _ref;
}
/* ORADataFactory interface */
public ORAData create(Datum d, int sqlType) throws SQLException
{
if (d == null) return null;
EmployeeRef r = new EmployeeRef();
r._ref = (REF) d;
return r;
}
public static EmployeeRef cast(ORAData o) throws SQLException
{
if (o == null) return null;
try { return (EmployeeRef) getORADataFactory().create(o.toDatum(null),
OracleTypes.REF); }
catch (Exception exn)
{ throw new SQLException("Unable to convert "+o.getClass().getName()+" to
EmployeeRef: "+exn.toString()); }
}
public Employee getValue() throws SQLException
{
return (Employee) Employee.getORADataFactory().create(
_ref.getSTRUCT(), OracleTypes.REF);
}
public void setValue(Employee c) throws SQLException
{
_ref.setValue((STRUCT) c.toDatum(_ref.getJavaSqlConnection()));
}
}
|
Note: JPublisher also generates a public staticcast() method to cast from other strongly typed references into a strongly typed reference instance. |
This appendix contains generated code examples that are explained in the following sections:
This section contains a generated code example for a specified SQL statement, related to the discussion in "Declaration of SQL Statements to Translate".
The example is for the following sample settings of the -sqlstatement option:
-sqlstatement.class=MySqlStatements
-sqlstatement.getEmp="select ename from emp
where ename=:{myname VARCHAR}"
-sqlstatement.return=both
Note that for this example:
Code comments show #sql statements that correspond to the translated code shown.
The getEmpBeans() method, generated because of the -sqlstatement.return=both setting, returns an array of JavaBeans. Each element represents a row of the result set. The GetEmpRow class is defined for this purpose.
JPublisher generates a SQLJ class. The result set is mapped to a SQLJ iterator.
(For UPDATE, INSERT, or DELETE statements, code is generated both with and without batching for array binds.)
The translated SQLJ code that JPublisher would produce is:
public class MySqlStatements_getEmpRow
{
/* connection management */
/* constructors */
public MySqlStatements_getEmpRow()
{ }
public String getEname() throws java.sql.SQLException
{ return ename; }
public void setEname(String ename) throws java.sql.SQLException
{ this.ename = ename; }
private String ename;
}
/*@lineinfo:filename=MySqlStatements*/
/*@lineinfo:user-code*/
/*@lineinfo:1^1*/
import java.sql.SQLException;
import sqlj.runtime.ref.DefaultContext;
import sqlj.runtime.ConnectionContext;
import java.sql.Connection;
import oracle.sql.*;
public class MySqlStatements
{
/* connection management */
protected DefaultContext __tx = null;
protected Connection __onn = null;
public void setConnectionContext(DefaultContext ctx) throws SQLException
{ release(); __tx = ctx; }
public DefaultContext getConnectionContext() throws SQLException
{ if (__tx==null)
{ __tx = (__onn==null) ? DefaultContext.getDefaultContext() :
new DefaultContext(__onn); }
return __tx;
};
public Connection getConnection() throws SQLException
{ return (__onn==null) ? ((__tx==null) ? null : __tx.getConnection()) : __onn; }
public void release() throws SQLException
{ if (__tx!=null && __onn!=null) __tx.close(ConnectionContext.KEEP_CONNECTION);
__onn = null; __tx = null;
}
/* constructors */
public MySqlStatements() throws SQLException
{ __tx = DefaultContext.getDefaultContext(); }
public MySqlStatements(DefaultContext c) throws SQLException
{ __tx = c; }
public MySqlStatements(Connection c) throws SQLException
{__onn = c; __tx = new DefaultContext(c); }
/*@lineinfo:generated-code*/
/*@lineinfo:36^1*/
// ************************************************************
// SQLJ iterator declaration:
// ************************************************************
public static class getEmpIterator
extends sqlj.runtime.ref.ResultSetIterImpl
implements sqlj.runtime.NamedIterator
{
public getEmpIterator(sqlj.runtime.profile.RTResultSet resultSet)
throws java.sql.SQLException
{
super(resultSet);
enameNdx = findColumn("ename");
m_rs = (oracle.jdbc.OracleResultSet) resultSet.getJDBCResultSet();
}
private oracle.jdbc.OracleResultSet m_rs;
public String ename()
throws java.sql.SQLException
{
return m_rs.getString(enameNdx);
}
private int enameNdx;
}
// ************************************************************
/*@lineinfo:user-code*/
/*@lineinfo:36^56*/
public MySqlStatements_getEmpRow[] getEmpBeans (String myname)
throws SQLException
{
getEmpIterator iter;
/*@lineinfo:generated-code*/
/*@lineinfo:43^5*/
// ************************************************************
// #sql [getConnectionContext()]
// iter = { select ename from emp where ename=:myname };
// ************************************************************
{
// declare temps
oracle.jdbc.OraclePreparedStatement __sJT_st = null;
sqlj.runtime.ref.DefaultContext __sJT_cc = getConnectionContext();
if (__sJT_c c==null) sqlj.runtime.error.RuntimeRefErrors.raise_NULL_CONN_CTX();
sqlj.runtime.ExecutionContext.OracleContext __sJT_ec =
((__sJT_cc.getExecutionContext()==null) ?
sqlj.runtime.ExecutionContext.raiseNullExecCtx() :
__sJT_cc.getExecutionContext().getOracleContext());
try {
String theSqlTS = "select ename from emp where ename= :1";
__sJT_st = __sJT_ec.prepareOracleStatement
(__sJT_cc,"0MySqlStatements",theSqlTS);
// set IN parameters
__sJT_st.setString(1,myname);
// execute query
iter = new MySqlStatements.getEmpIterator
(new sqlj.runtime.ref.OraRTResultSet
(__sJT_ec.oracleExecuteQuery(),__sJT_st,"0MySqlStatements",null));
} finally { __sJT_ec.oracleCloseQuery(); }
}
// ************************************************************
/*@lineinfo:user-code*/
/*@lineinfo:43^84*/
java.util.Vector v = new java.util.Vector();
while (iter.next())
{
MySqlStatements_getEmpRow r = new MySqlStatements_getEmpRow();
r.setEname(iter.ename());
v.addElement(r);
}
MySqlStatements_getEmpRow[] __jPt_result =
new MySqlStatements_getEmpRow[v.size()];
for (int i = 0; i < v.size(); i++)
__jPt_result[i] = (MySqlStatements_getEmpRow) v.elementAt(i);
return __jPt_result;
}
public java.sql.ResultSet getEmp (String myname)
throws SQLException
{
sqlj.runtime.ResultSetIterator iter;
/*@lineinfo:generated-code*/
/*@lineinfo:62^5*/
// ************************************************************
// #sql [getConnectionContext()] iter =
// { select ename from emp where ename=:myname };
// ************************************************************
{
// declare temps
oracle.jdbc.OraclePreparedStatement __sJT_st = null;
sqlj.runtime.ref.DefaultContext __sJT_cc = getConnectionContext();
if (__sJT_c c==null) sqlj.runtime.error.RuntimeRefErrors.raise_NULL_CONN_CTX();
sqlj.runtime.ExecutionContext.OracleContext __sJT_ec =
((__sJT_cc.getExecutionContext()==null) ?
sqlj.runtime.ExecutionContext.raiseNullExecCtx() :
__sJT_cc.getExecutionContext().getOracleContext());
try {
String theSqlTS = "select ename from emp where ename= :1";
__sJT_st = __sJT_ec.prepareOracleStatement
(__sJT_cc,"1MySqlStatements",theSqlTS);
// set IN parameters
__sJT_st.setString(1,myname);
// execute query
iter = new sqlj.runtime.ref.ResultSetIterImpl
(new sqlj.runtime.ref.OraRTResultSet
(__sJT_ec.oracleExecuteQuery(),__sJT_st,"1MySqlStatements",null));
} finally { __sJT_ec.oracleCloseQuery(); }
}
// ************************************************************
/*@lineinfo:user-code*/
/*@lineinfo:62^84*/
java.sql.ResultSet __jPt_result = iter.getResultSet();
return __jPt_result;
}
}
/*@lineinfo:generated-code*/
JPublisher supports the calling of Java methods in the database from a Java client outside the database. In Oracle Database 11g release 2 (11.2), the JPublisher -dbjava option is used for server-side Java invocation. Unlike the -java option, the -dbjava option supports non-serializable parameter or return types.
This section describes an example of server-side Java invocation. This section comprises:
|
Note: You must have the 11g Release 2 (11.2) version of Oracle Database. |
In this example, there are three source files to be created. These are:
A server-side Java class
A JavaBean used in the server-side Java class
An entry point Java class that invokes the methods in the published classes
The source code of these files is as follows:
Server-Side Java Class
The source code of the server-side Java class, Callin2.java, is as follows:
public class Callin2
{
public static int testInt(int i)
{ return i; }
public static int[] testInt(int[] i)
{ return i; }
public static int[][] testInt(int[][] i)
{ return i; }
public static Integer testInteger(Integer i)
{ return i; }
public static Integer[] testInteger(Integer[] i)
{ return i; }
public static Integer[][] testInteger(Integer[][] i)
{ return i; }
// Test ORAData
public static oracle.sql.NUMBER testNum(oracle.sql.NUMBER num)
{ return num; }
public oracle.sql.NUMBER testInstNum(oracle.sql.NUMBER num)
{ return num; }
public oracle.sql.NUMBER[] testInstNum(oracle.sql.NUMBER[] num)
{ return num; }
public oracle.sql.NUMBER[][] testInstNum(oracle.sql.NUMBER[][] num)
{ return num; }
// Test Beans
public static Callin2Bean testBean()
{ return new Callin2Bean("mybean", new int[]{1,2}); }
public static Callin2Bean testBean (Callin2Bean b)
{ return b; }
public static Callin2Bean[] testBean (Callin2Bean[] b)
{ return b; }
public static Callin2Bean[][] testBean (Callin2Bean[][] b)
{ return b; }
public Callin2Bean testInstBean (Callin2Bean b)
{ return b; }
public Callin2Bean[] testInstBean (Callin2Bean[] b)
{ return b; }
public Callin2Bean[][] testInstBean (Callin2Bean[][] b)
{ return b; }
// Test Serializable
public static java.io.Serializable testSer()
{ return new String("test Serializable"); }
public static java.io.Serializable testSer (java.io.Serializable b)
{ return b; }
public static java.io.Serializable[] testSer (java.io.Serializable[] b)
{ return b; }
public static java.io.Serializable[][] testSer (java.io.Serializable[][] b)
{ return b; }
public java.io.Serializable testInstSer (java.io.Serializable b)
{ return b; }
public java.io.Serializable[] testInstSer (java.io.Serializable[] b)
{ return b; }
public java.io.Serializable[][] testInstSer (java.io.Serializable[][] b)
{ return b; }
}
JavaBean Used in the Server-Side Java Class
The source code of the JavaBean, Callin2Bean.java, used in the server-side Java class, Callin2.java, is as follows:
public class Callin2Bean
{
private String stringValue = "";
private int[] numberValue;
public Callin2Bean ()
{
}
public Callin2Bean(String string_val, int[] number_val)
{
stringValue = string_val;
numberValue = number_val;
}
public void setStringValue(String string_val)
{
stringValue = string_val;
}
public String getStringValue ()
{
return stringValue;
}
public void setNumberValue (int[] number_val)
{
numberValue = number_val;
}
public int[] getNumberValue ()
{
return numberValue;
}
public boolean equals(Object other)
{
if(other instanceof Callin2Bean)
{
Callin2Bean my_bean = (Callin2Bean)other;
if ( stringValue.equals(my_bean.getStringValue()) && compareIntArray(numberValue, my_bean.getNumberValue()) )
{
return true;
}
}
return false;
}
private boolean compareIntArray(int[] b1, int[] b2)
{
try
{
if ((b1 == null) && (b2 == null))
return true;
if ((b1.length == 0) && (b2.length == 0))
return true;
if (b1.length != b2.length)
return false;
int x;
for (x = 0; x < b1.length; x++)
{
if (b1[x] != b2[x])
return false;
}
return true;
}
catch (Exception e)
{
return false;
}
}
}
Entry Point Java Class
The TestCallin2.java is the entry point Java class for this example. This class invokes the methods in the published class. The source code of the TestCallin2.java file is as follows:
public class TestCallin2
{
public static void main(String[] args) throws Exception
{
java.sql.DriverManager.registerDriver(new oracle.jdbc.OracleDriver());
oracle.jdbc.OracleConnection conn = (oracle.jdbc.OracleConnection)
//java.sql.DriverManager.getConnection("jdbc:oracle:thin:@localhost:1521:lsqlj1", "scott", "tiger");
java.sql.DriverManager.getConnection("jdbc:oracle:oci8:@", "scott", "tiger");
Callin2Client tkpu = new Callin2Client (conn);
System.out.println("testInstNum() returned " + tkpu.testinstnum(new java.math.BigDecimal(1999)));
TblNumber na = new TblNumber(new java.math.BigDecimal[]{new java.math.BigDecimal(2999)});
System.out.println("testInstNum([]) returned " +
tkpu.testinstnum(na).getArray()[0]);
ObjCallin2bean mb = new ObjCallin2bean("mybean", na);
System.out.println("testCallin2Bean() returned " + tkpu.testbean(mb).getStringValue());
System.out.println("testCallin2Bean([]) returned " +
tkpu.testbean(new TblObjCallin2bean(new ObjCallin2bean[]{mb})).getArray()[0].getStringValue());
java.io.Serializable s = new java.util.Hashtable();
((java.util.Hashtable) s).put("bush", "cheny");
((java.util.Hashtable) s).put("kerry", "dean");
java.io.Serializable[] s1 = new java.io.Serializable[]{s};
java.io.Serializable[][] s2 = new java.io.Serializable[][]{s1};
System.out.println("testSer() returned " + ((java.util.Hashtable) tkpu.testser(s)).get("kerry"));
System.out.println("testSer([]) returned " + ((java.util.Hashtable) tkpu.testser0(s1)[0]).get("kerry"));
System.out.println("testSer([][]) returned " + ((java.util.Hashtable) tkpu.testser1(s2)[0][0]).get("kerry"));
}
}
|
Note: If you are connecting to the database using the JDBC Thin driver, then you must uncomment the first call to thegetConnection() method in the preceding code and comment the second call to the getConnection() method, which includes a connect statement for an Oracle Call Interface (OCI) driver. |
After you have created the required source files, you must publish these files. To publish the server-side Java classes, you must first load these files on to the database. Ensure that you load both Callin2.java and Callin2Bean.java. The command for loading the files is:
% loadjava -u scott -r -v -f Callin2.java Callin2Bean.java
Password: password
To publish these files, issue the following command:
% jpub -u scott -sysuser=sys/sys_password -dbjava=Callin2:Callin2Client -dir=tmp Enter scott password: password
The JPublisher output is:
tmp/Callin2JPub.java tmp/plsql_wrapper.sql tmp/plsql_dropper.sql SCOTT.TBL_NUMBER SCOTT.TBL_TBL_NUMBER SCOTT.OBJ_CALLIN2BEAN SCOTT.TBL_OBJ_CALLIN2BEAN SCOTT.TBL_TBL_OBJ_CALLI SCOTT.JPUB_PLSQL_WRAPPER Executing tmp/plsql_dropper.sql Executing tmp/plsql_wrapper.sql Loading Callin2JPub.java
When you publish the server-side Java classes JPublisher generates a few Java classes and PL/SQL scripts. Some of these files are:
Callin2JPub.java
This is the server-side Java wrapper class for Callin2.java.
Callin2Client.java
This is the client-side Java class.
plsql_wrapper.sql
This is the PL/SQL wrapper for the server-side Java class.
plsql_dropper.sql
This is the PL/SQL script dropping the PL/SQL wrapper.
The other files generated by JPublisher are as follows:
TblNumber.java
A client-side wrapper generated for int[].
TblTblNumber.java
A client-side wrapper generated for int[][].
ObjCallin2bean.java
A client-side wrapper generated for the server-side class Callin2Bean.
ObjCallin2beanRef.java
A client-side wrapper generated for the server-side class Callin2Bean, used as a REF column in a table. This file is generated, but not used in the call-in scenario.
TblObjCallin2bean.java
A client-side wrapper generated for Callin2Bean[].
TblTblObjCalli.java
A client-side wrapper generated for Callin2Bean[][].
After the files have been published, you can test the published classes by issuing the following commands:
% javac -classpath tmp:${CLASSPATH} -d tmp TestCallin2.java
% java -classpath tmp:${CLASSPATH} TestCallin2
This chapter discusses the JPublisher support for data type mapping, including a section on JPublisher styles and style files for Java-to-Java type mappings. These style files are primarily used to provide Web services support. The chapter contains the following sections:
This section covers the JPublisher functionality for mapping from SQL and PL/SQL to Java in the following topics:
When you use the -builtintypes, -lobtypes, -numbertypes, and -usertypes type mapping options, you can specify one of the following settings for data type mappings:
oracle
jdbc
objectjdbc
bigdecimal
|
Note: Theobjectjdbc and bigdecimal settings are for the -numbertypes options only. |
These mappings affect the argument and result types that JPublisher uses in the methods it generates.
The class that JPublisher generates for an object type has the getXXX() and setXXX() accessor methods for the object attributes. The class that JPublisher generates for a VARRAY or nested table type has the getXXX() and setXXX() methods, which access the elements of the array or nested table. When generation of wrapper methods is enabled, the class that JPublisher generates for an object type or PL/SQL package has wrapper methods. These wrapper methods invoke server methods, or stored procedures, of the object type or package. The mapping options control the argument and result types that these methods use.
The Java Database Connectivity (JDBC) and Object JDBC mappings use familiar Java types that can be manipulated using standard Java operations. The Oracle mapping is the most efficient mapping. The oracle.sql types match Oracle internal data types as closely as possible so that little or no data conversion is required between the Java and SQL formats. You do not lose any information and have greater flexibility in how you process and unpack the data. If you are manipulating data or moving data within the database, then Oracle mappings for standard SQL types are the most convenient representations. For example, performing SELECT and INSERT operations from one existing table to another. When data format conversion is necessary, you can use methods in the oracle.sql.* classes to convert to Java native types.
Table 3-1 lists the mappings from SQL and PL/SQL data types to Java types. You can use all the supported data types listed in this table as argument or result types for PL/SQL methods. You can also use a subset of the data types as object attribute types.
The SQL and PL/SQL Data Type column contains all possible data types.
Oracle Mapping column lists the corresponding Java types that JPublisher uses when all the type mapping options are set to oracle. These types are found in the oracle.sql package provided by Oracle and are designed to minimize the overhead incurred when converting Oracle data types to Java types.
The JDBC Mapping column lists the corresponding Java types that JPublisher uses when all the type mapping options are set to jdbc. For standard SQL data types, JPublisher uses Java types specified in the JDBC specification. For SQL data types that are Oracle extensions, JPublisher uses the oracle.sql.* types. When you set the -numbertypes option to objectjdbc, the corresponding types are the same as in the JDBC Mapping column, except that primitive Java types, such as int, are replaced with their object counterparts, such as java.lang.Integer.
|
Note: Type correspondences explicitly defined in the JPublisher type map, such as PL/SQLBOOLEAN to SQL NUMBER to Java boolean, are not affected by the mapping option settings. |
A few data types are not directly supported by JPublisher, in particular those types that pertain only to PL/SQL. You can overcome these limitations by providing equivalent SQL and Java types, as well as PL/SQL conversion functions between PL/SQL and SQL representations. The annotations and subsequent sections explain these conversions further.
Table 3-1 SQL and PL/SQL Data Type to Oracle and JDBC Mapping Classes
| SQL and PL/SQL Data Type | Oracle Mapping | JDBC Mapping |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Object types |
Generated class |
Generated class |
|
SQLJ object types |
Java class defined at type creation |
Java class defined at type creation |
|
|
Generated or predefined class (note 4) |
Generated or predefined class (note 4) |
|
|
Through mapping to SQL object type (note 5) |
Through mapping to SQL object type (note 5) |
|
Nested table, |
Generated class implemented using |
|
|
Reference to object type |
Generated class implemented using |
|
|
|
|
|
|
Index-by tables |
Through mapping to SQL collection (note 6) |
Through mapping to SQL collection (note 6) |
|
Scalar (numeric or character) Index-by tables |
Through mapping to Java array (note 7) |
Through mapping to Java array (note 7) |
|
User-defined subtypes |
Same as for base type |
Same as for base type |
Data Type Mapping Notes The following notes correspond to the entries in the preceding table:
The Java classes oracle.sql.NCHAR, oracle.sql.NCLOB, and oracle.sql.NString are not part of JDBC but are distributed with the JPublisher run time. JPublisher uses these classes to represent the NCHAR form of use of the corresponding classes, oracle.sql.CHAR, oracle.sql.CLOB, and java.lang.String.
Mappings of SQL INTERVAL types to the Java String type are defined in the JPublisher default type map. Functions from the SYS.SQLJUTL package are used for the conversions.
Mapping of PL/SQL BOOLEAN to SQL NUMBER and Java boolean is defined in the default JPublisher type map. This process uses conversion functions from the SYS.SQLJUTL package.
Mapping of the SYS.XMLTYPE SQL OPAQUE type to the oracle.xdb.XMLType Java class is defined in the default JPublisher type map. For other OPAQUE types, the vendor typically provides a corresponding Java class. In this case, you must specify a JPublisher type map entry that defines the correspondence between the SQL OPAQUE type and the corresponding Java wrapper class. If JPublisher encounters an OPAQUE type that does not have a type map entry, then it generates a Java wrapper class for that OPAQUE type.
To support a PL/SQL RECORD type, JPublisher maps the RECORD type to a SQL object type and then to a Java type corresponding to the SQL object type. JPublisher generates two SQL scripts. One script is to create the SQL object type and to create a PL/SQL package containing the conversion functions between the SQL type and the RECORD type. The other script is used to drop the SQL type and the PL/SQL package created by the first script.
To support a PL/SQL index-by table type, JPublisher first maps the index-by table type into a SQL collection type and then maps it into a Java class corresponding to that SQL collection type. JPublisher generates two SQL scripts. One to create the SQL collection type and to create a PL/SQL package containing conversion functions between the SQL collection type and the index-by table type. The other to drop the collection type and the PL/SQL package created by the first script.
If you use the JDBC driver to call PL/SQL stored procedures or object methods, then you have direct support for scalar index-by tables, also known as PL/SQL TABLE types. In this case, you must use a type map entry for JPublisher that specifies the PL/SQL scalar index-by table type and a corresponding Java array type. JPublisher can then automatically publish PL/SQL or object method signatures that use this scalar index-by type.
JPublisher has a user type map, which is controlled by the -typemap and -addtypemap options and starts out empty. It also has a default type map, which is controlled by the -defaulttypemap and -adddefaulttypemap options and starts with entries such as the following:
jpub.defaulttypemap=SYS.XMLTYPE:oracle.xdb.XMLType jpub.adddefaulttypemap=BOOLEAN:boolean:INTEGER: SYS.SQLJUTL.INT2BOOL:SYS.SQLJUTL.BOOL2INT jpub.adddefaulttypemap=INTERVAL DAY TO SECOND:String:CHAR: SYS.SQLJUTL.CHAR2IDS:SYS.SQLJUTL.IDS2CHAR jpub.adddefaulttypemap=INTERVAL YEAR TO MONTH:String:CHAR: SYS.SQLJUTL.CHAR2IYM:SYS.SQLJUTL.IYM2CHAR
These commands, which include some wraparound lines, indicate mappings between PL/SQL types, Java types, and SQL types. Where applicable, they also specify conversion functions to convert between PL/SQL types and SQL types.
JPublisher checks the default type map first. If you attempt in the user type map to redefine a mapping that is in the default type map, JPublisher generates a warning message and ignores the redefinition. Similarly, attempts to add mappings through -adddefaulttypemap or -addtypemap settings that conflict with previous mappings are ignored and generate warnings.
There are typically two scenarios for using the type maps:
Specify type mappings for PL/SQL data types that are unsupported by JDBC.
Avoid regenerating a Java class to map to a user-defined type. For example, assume you have a user-defined SQL object type, STUDENT, and have already generated a Student class to map to it. If you specify the STUDENT:Student mapping in the user type map, then JPublisher finds the Student class and uses it for mapping without regenerating it.
To use custom mappings, it is recommended that you clear the default type map, as follows:
-defaulttypemap=
Then use the -addtypemap option to put any required mappings into the user type map.
The predefined default type map defines a correspondence between the SYS.XMLTYPE SQL OPAQUE type and the oracle.xdb.XMLType Java wrapper class. In addition, it maps the PL/SQL BOOLEAN type to the Java boolean type and the SQL INTEGER type through two conversion functions defined in the SYS.SQLJUTL package. Also, the default type map provides mappings between the SQL INTERVAL type and the Java String type.
However, you may prefer mapping the PL/SQL BOOLEAN type to the Java object type Boolean to capture the SQL NULL values in addition to the true and false values. You can accomplish this by resetting the default type map, as shown by the following:
-defaulttypemap=BOOLEAN:Boolean:INTEGER:SYS.SQLJUTL.INT2BOOL:SYS.SQLJUTL.BOOL2INT
This changes the designated Java type from boolean to Boolean, as well as eliminating any other existing default type map entries. The rest of the conversion remains valid.
Example: Using the Type Map to Avoid Regeneration The following example uses the JPublisher type map to avoid the mapping of regenerated Java classes. Assume the following type declarations, noting that the CITY type is an attribute of the TRIP type:
SQL> CREATE TYPE city AS OBJECT (name VARCHAR2(20), state VARCHAR2(10)); / SQL> CREATE OR REPLACE TYPE trip AS OBJECT (leave DATE, place city); /
Now assume that you invoke JPublisher as follows:
% jpub -u scott -s TRIP:Trip
Enter scott password: password
The JPublisher output is:
SCOTT.TRIP SCOTT.CITY
Only TRIP is specified for processing. However, the command produces the source files City.java, CityRef.java, Trip.java, and TripRef.java, because CITY is an attribute.
If you want to regenerate the classes for TRIP without regenerating the classes for CITY, then you can rerun JPublisher as follows:
% jpub -u scott -addtypemap=CITY:City -s TRIP:Trip SCOTT.TRIP
Enter scott password: password
As you can see from the output line, the CITY type is not reprocessed and, therefore, the City.java and CityRef.java files are not regenerated. This is because of the addition of the CITY:City relationship to the type map, which informs JPublisher that the existing City class is to be used for mapping.
To map a given SQL or PL/SQL type to Java, JPublisher uses the following logical progression:
Checks the type maps to see if the mapping is already specified.
Checks the predefined Java mappings for SQL and PL/SQL types.
Checks whether the data type to be mapped is a PL/SQL RECORD type or an index-by table type. If it is a PL/SQL RECORD type, JPublisher generates a corresponding SQL object type that it can then map to Java. If it is an index-by table type, JPublisher generates a corresponding SQL collection type that it can then map to Java.
If none of steps 1 through 3 apply, then the data type must be a user-defined type. JPublisher generates an ORAData or SQLData class to map it according to the JPublisher option settings.
You can use a subset of the SQL data types in Table 3-1 as object attribute types. The types that can be used are listed here:
CHAR, VARCHAR, VARCHAR2, CHARACTER
NCHAR, NVARCHAR2
DATE
DECIMAL, DEC, NUMBER, NUMERIC
DOUBLE PRECISION, FLOAT
INTEGER, SMALLINT, INT
REAL
RAW, LONG RAW
CLOB
BLOB
BFILE
NCLOB
Object type, OPAQUE type, SQLJ object type
Nested table, VARRAY type
Object reference type
JPublisher supports the following TIMESTAMP types as object attributes:
TIMESTAMP
TIMESTAMP WITH TIMEZONE
TIMESTAMP WITH LOCAL TIMEZONE
|
Note: The Oracle JDBC implementation does not support the TIMESTAMP types. |
If a PL/SQL stored procedure or function or a SQL query returns a REF CURSOR, then JPublisher generates a method, by default, to map the REF CURSOR to java.sql.ResultSet.
In addition, for a SQL query, but not for a REF CURSOR returned by a stored procedure or function, JPublisher generates a method to map the REF CURSOR to an array of rows. In this array, each row is represented by a JavaBean instance.
In addition, with a setting of -style=webservices-common, if the following classes are available in the classpath, then JPublisher generates methods to map the REF CURSOR to the following types:
javax.xml.transform.Source
oracle.jdbc.rowset.OracleWebRowSet
org.w3c.dom.Document
|
Note:
|
If required, you must perform the following actions to ensure that JPublisher can find the classes:
Ensure that the libraries translator.jar, runtime12.jar, and ojdbc5.jar are in the classpath. These files contain JPublisher and SQLJ translator classes, SQLJ run time classes, and JDBC classes, respectively.
Use Java Development Kit (JDK) 1.4, for mapping to Source. This class is not defined in earlier JDK versions.
Add ORACLE_HOME/jdbc/lib/rowset-jsr114.jar to the classpath, for mapping to OracleWebRowSet.
Add ORACLE_HOME/lib/xmlparsev2.jar to the classpath, for mapping to Document.
Consider the following PL/SQL stored procedure:
TYPE curtype1 IS REF CURSOR RETURN emp%rowtype; FUNCTION get1 RETURN curtype1;
If the OracleWebRowSet class is found in the classpath during publishing, but Document and Source are not, then JPublisher generates the following methods for the get1 function:
public oracle.jdbc.rowset.OracleWebRowSet get1WebRowSet()
throws java.sql.SQLException;
public java.sql.ResultSet get1() throws java.sql.SQLException;
The names of methods returning Document and Source would be get1XMLDocument() and get1XMLSource(), respectively.
Disabling Mapping to Source, OracleWebRowSet, or Document
There is currently no JPublisher option to explicitly enable or disable mapping to Source, OracleWebRowSet, or Document. The only condition in the webservices-common style file is whether the classes exist in the classpath. However, you can copy and edit your own style file if you want more control over how JPublisher maps REF CURSOR. The following code is an excerpt from the webservices-common file that has been copied and edited as an example. Descriptions of the edits follow the code.
BEGIN_TRANSFORMATION
MAPPING
SOURCETYPE java.sql.ResultSet
TARGETTYPE java.sql.ResultSet
RETURN
%2 = %1;
END_RETURN;
END_MAPPING
MAPPING
#CONDITION oracle.jdbc.rowset.OracleWebRowSet
SOURCETYPE java.sql.ResultSet
TARGETTYPE oracle.jdbc.rowset.OracleWebRowSet
TARGETSUFFIX WebRowSet
RETURN
%2 = null;
if (%1!=null)
{
%2 = new oracle.jdbc.rowset.OracleWebRowSet();
%2.populate(%1);
}
END_RETURN
END_MAPPING
#MAPPING
#CONDITION org.w3c.dom.Document oracle.xml.sql.query.OracleXMLQuery
#SOURCETYPE java.sql.ResultSet
#TARGETTYPE org.w3c.dom.Document
#TARGETSUFFIX XMLDocument
#RETURN
#%2 = null;
#if (%1!=null)
# %2= (new oracle.xml.sql.query.OracleXMLQuery
# (_getConnection(), %1)).getXMLDOM();
#END_RETURN
#END_MAPPING
MAPPING
CONDITION org.w3c.dom.Document oracle.xml.sql.query.OracleXMLQuery
javax.xml.transform.Source javax.xml.transform.dom.DOMSource
SOURCETYPE java.sql.ResultSet
TARGETTYPE javax.xml.transform.Source
TARGETSUFFIX XMLSource
RETURN
%2 = null;
if (%1!=null)
%2= new javax.xml.transform.dom.DOMSource
((new oracle.xml.sql.query.OracleXMLQuery
(new oracle.xml.sql.dataset.OracleXMLDataSetExtJdbc(_getConnection(),
(oracle.jdbc.OracleResultSet) %1))).getXMLDOM());
END_RETURN
END_MAPPING
END_TRANSFORMATION
Assume that you copy this file into myrefcursormaps.properties. There are four MAPPING sections intended for mapping REF CURSOR to ResultSet, OracleWebRowSet, Document, and Source according to the SOURCETYPE and TARGETTYPE entries. For this example, lines are commented out using the "#" character to accomplish the following:
The CONDITION statement is commented out for the OracleWebRowSet mapping. Because of this, JPublisher will generate a method for this mapping regardless of whether OracleWebRowSet is in the classpath.
The entire MAPPING section is commented out for the Document mapping. JPublisher will not generate a method for this mapping.
Run JPublisher with the following options to use your custom mappings:
% jpub -u scott -style=myrefcursormaps -s MYTYPE:MyType
Enter scott password: password
With the -usertypes=jdbc setting, JPublisher generates SQLData for a SQL object type. The underlying JDBC connection for a SQLData instance is not automatically set by the JDBC driver. Therefore, before accessing attributes in a SQLData instance, you must set a JDBC connection using the setConnectionContext() method.
Consider Address is a SQLData class generated by JPublisher with -usertypes=jdbc. The following code segment accesses the attribute of an Address instance. Note that the setConnectionContext call explicitly initializes the underlying JDBC connection.
... ResultSet rset = stmt.executeQuery(); Address address = (Address) rset.getObject(1); address.setConnectionContext(new sqlj.runtime.ref.DefaultContext(connection)); String addr = address.getAddress(); ...
|
Note: Other-usertypes settings do not require setting the connection, as described in the preceding code example. |
On the other hand, for ORAData types that JPublisher generates with the -usertypes=oracle setting or by default, connection initialization is not required. The underlying JDBC connection for ORAData is already assigned at the time it is read from ResultSet.
There are three scenarios if JPublisher encounters a PL/SQL stored procedure or function, including method of a SQL object type, which uses a PL/SQL type that is unsupported by JDBC:
If you specify a mapping for the PL/SQL type in the default type map or user type map, then JPublisher uses that mapping.
If there is no mapping in the type maps, and the PL/SQL type is a RECORD type or an index-by table type, then JPublisher generates a corresponding SQL type that JDBC supports. For a PL/SQL RECORD type, JPublisher generates a SQL object type to bridge between the RECORD type and Java. For an index-by table type, JPublisher generates a SQL collection type for the bridge.
If neither of the first two scenarios applies, then JPublisher issues a warning message and uses <unsupported type> in the generated code to represent the unsupported PL/SQL type.
The following sections discuss further details of JPublisher type mapping features for PL/SQL types unsupported by JDBC:
Type Mapping Support for PL/SQL RECORD and Index-By Table Types
Direct Use of PL/SQL Conversion Functions Versus Use of Wrapper Functions
This section describes JPublisher type mapping support for SQL OPAQUE types in general.
|
Note: If you want JPublisher to generate wrapper classes for SQLOPAQUE types, then you must use an Oracle9i Database release 2 (9.2) or later installation and JDBC driver. |
The Oracle JDBC and SQLJ implementations support SQL OPAQUE types published as Java classes implementing the oracle.sql.ORAData interface. Such classes must contain the following public, static fields and methods:
public static String _SQL_NAME = "SQL_name_of_OPAQUE_type";
public static int _SQL_TYPECODE = OracleTypes.OPAQUE;
public static ORADataFactory getORADataFactory() { ... }
If you have a Java wrapper class to map to a SQL OPAQUE type, and the class meets this requirement, then you can specify the mapping through the JPublisher user type map. Use the -addtypemap option with the following syntax to append the mapping to the user type map:
-addtypemap=sql_opaque_type:java_wrapper_class
In Oracle Database 11g, the SYS.XMLTYPE SQL OPAQUE type is mapped to the oracle.xdb.XMLType Java class through the JPublisher default type map. You could accomplish the same thing explicitly through the user type map, as follows:
-addtypemap=SYS.XMLTYPE:oracle.xdb.XMLType
Whenever JPublisher encounters a SQL OPAQUE type for which no type correspondence has been provided, it publishes a Java wrapper class. Consider the following SQL type defined in the SCOTT schema:
CREATE TYPE X_TYP AS OBJECT (xml SYS.XMLTYPE);
The following command publishes X_TYP as a Java class XTyp:
% jpub -u scott -s X_TYP:XTyp
Enter scott password: password
By default, the xml attribute is published using oracle.xdb.XMLType, which is the predefined type mapping for SYS.XMLTYPE. If you clear the JPublisher default type map, then a wrapper class, Xmltype, will automatically be generated for the SYS.XMLTYPE attribute. You can verify this by invoking JPublisher as follows:
% jpub -u scott -s X_TYP:XTyp -defaulttypemap=
Enter scott password: password
The -defaulttypemap option is for setting the JPublisher default type map. Giving it no value, as in the preceding example, clears it.
The term scalar PL/SQL index-by table refers to a PL/SQL index-by table with elements of VARCHAR and numerical types. Starting 10g Release 2 (10.2), JPublisher can map a simple PL/SQL index-by table into a Java array, as an alternative to mapping PL/SQL index-by tables into custom JDBC types. The option plsqlindextable specifies how a simple PL/SQL index-by table is mapped.
-plsqlindextable=custom|array|int
If -plsqlindextable=custom is set, all indexby tables are mapped to custom JDBC types, such as SQLData, CustomDatum, or ORAData. If -plsqlindextable=array or -plsqlindextable=int is set, a simple index-by table will be mapped to a Java array. With -plsqlindextable=int, the int value specifies the array capacity, which is 32768 by default. The default setting for this option is custom.
Consider the following PL/SQL package:
CREATE OR REPLACE PACKAGE indexbytable_package AS TYPE index_tbl1 IS TABLE OF VARCHAR2(111) INDEX BY binary_integer; TYPE index_tbl2 IS TABLE OF NUMBER INDEX BY binary_integer; TYPE varray_tbl3 IS VARRAY(100) OF VARCHAR2(20); TYPE nested_tbl4 IS TABLE OF VARCHAR2(20); FUNCTION echo_index_tbl1(a index_tbl1) RETURN index_tbl1; FUNCTION echo_index_tbl2(a index_tbl2) RETURN index_tbl2; FUNCTION echo_varray_tbl3(a varray_tbl3) RETURN varray_tbl3; FUNCTION echo_nested_tbl4(a nested_tbl4) RETURN nested_tbl4; END; /
Run the following command:
% jpub -u scott -sql=indexbytable_package:IndexbyTablePackage#IndexbyTableIntf -plsqlindextable=32
Enter scott password: password
The -plsqlindextable=32 setting specifies that simple index-by tables are mapped to Java arrays, with a capacity of 32. The following interface is generated in IndexbyTableIntf.java:
public interface IndexbyTableIntf
{
public String[] echoIndexTbl1(String[] a);
public java.math.BigDecimal[] echoIndexTbl2(java.math.BigDecimal[] a);
public IndexbytableintfVarrayTbl3 echoVarrayTbl4(IndexbytableintfVarrayTbl3 a);
public IndexbytableintfNestedTbl4 echoVarrayTbl4(IndexbytableintfNestedTbl4 a);
}
In the generated code, the simple index-by table types, index_tbl1 and index_tb2, are mapped to String[] and BigDecimal[] respectively. The nested table and varray table, however, are still mapped to custom JDBC types, because they are not index-by tables and their mappings are not affected by the -plsqlindextable setting.
The limitation of mapping PL/SQL index-by table to an array is that the table must be indexed by integer. If a PL/SQL package contains both tables indexed by integer and by VARCHAR, you cannot use the setting -plsqlindexbytable=array or -plsqlindexbytable=int. Otherwise the mapping for the table indexed by VARCHAR will encounter run-time errors. Instead, one must use -plsqlindexbytable=custom.
Mapping of the index-by table elements follows the JDBC type mappings. For example, with JDBC mapping, SMALLINT is mapped to the Java int type. Therefore, an index-by table of SMALLINT is mapped to int[]. The -plsqlindexbytable=array or -plsqlindexbytable=int setting will be ignored if Oracle mappings are turned on for numbers, that is, -numbertypes=oracle. The reason is that the Java array mapped to the index-by table must have string or numerical Java types as elements, while Oracle mappings map SQL numbers into oracle.sql types.
Oracle JDBC drivers directly support PL/SQL scalar index-by tables with numeric or character elements. An index-by table with numeric elements can be mapped to the following Java array types:
int[]
double[]
float[]
java.math.BigDecimal[]
oracle.sql.NUMBER[]
An index-by table with character elements can be mapped to the following Java array types:
String[]
oracle.sql.CHAR[]
In the following circumstances, you must convey certain information for an index-by table type, as described:
Whenever you use the index-by table type in an OUT or IN OUT parameter, you must specify the maximum number of elements, which is otherwise optional. You can specify the maximum number of elements using the customary syntax for Java array allocation. For example, you could specify int[100] to denote a type that can accommodate up to 100 elements or oracle.sql.CHAR[20] for up to 20 elements.
For index-by tables with character elements, you can optionally specify the maximum size of an individual element, in bytes. This setting is defined using the SQL-like size syntax. For example, for an index-by table used for IN arguments, you could specify String[](30). You could also specify oracle.sql.CHAR[20](255) for an index-by table of maximum length 20, the elements of which will not exceed 255 bytes each.
Use the JPublisher -addtypemap option to add instructions to the user type map to specify correspondences between PL/SQL types, which are scalar index-by tables, and the corresponding Java array types. The size hints that are given using the syntax outlined earlier are embedded into the generated SQLJ class and thus conveyed to JDBC at run time.
As an example, consider the following code fragment from the definition of the INDEXBY PL/SQL package in the SCOTT schema. Assume this is available in a file called indexby.sql.
CREATE OR REPLACE PACKAGE indexby AS -- jpub.addtypemap=SCOTT.INDEXBY.VARCHAR_ARY:String[1000](4000) -- jpub.addtypemap=SCOTT.INDEXBY.INTEGER_ARY:int[1000] -- jpub.addtypemap=SCOTT.INDEXBY.FLOAT_ARY:double[1000] TYPE varchar_ary IS TABLE OF VARCHAR2(4000) INDEX BY BINARY_INTEGER; TYPE integer_ary IS TABLE OF INTEGER INDEX BY BINARY_INTEGER; TYPE float_ary IS TABLE OF NUMBER INDEX BY BINARY_INTEGER; FUNCTION get_float_ary RETURN float_ary; PROCEDURE pow_integer_ary(x integer_ary, y OUT integer_ary); PROCEDURE xform_varchar_ary(x IN OUT varchar_ary); END indexby; / CREATE OR REPLACE PACKAGE BODY indexby IS ... /
The following are the required -addtypemap directives for mapping the three index-by table types:
-addtypemap=SCOTT.INDEXBY.VARCHAR_ARY:String[1000](4000) -addtypemap=SCOTT.INDEXBY.INTEGER_ARY:int[1000] -addtypemap=SCOTT.INDEXBY.FLOAT_ARY:double[1000]
Note that depending on the operating system shell you are using, you may have to quote options that contain square brackets [...] or parentheses (...). You can avoid this by placing such options into a JPublisher properties file, as follows:
jpub.addtypemap=SCOTT.INDEXBY.VARCHAR_ARY:String[1000](4000) jpub.addtypemap=SCOTT.INDEXBY.INTEGER_ARY:int[1000] jpub.addtypemap=SCOTT.INDEXBY.FLOAT_ARY:double[1000]
Additionally, as a feature of convenience, JPublisher directives in a properties file are recognized when placed behind a "--" prefix (two dashes), whereas any entry that does not start with "jpub." or with "-- jpub." is ignored. So, you can place JPublisher directives into SQL scripts and reuse the same SQL scripts as JPublisher properties files. Thus, after invoking the indexby.sql script to define the INDEXBY package, you can now run JPublisher to publish this package as a Java class, IndexBy, as follows:
% jpub -u scott -s INDEXBY:IndexBy -props=indexby.sql
Enter scott password: password
As mentioned previously, you can use this mapping of scalar index-by tables only with Oracle JDBC drivers. If you are using another driver or if you want to create driver-independent code, then you must define SQL types that correspond to the index-by table types, as well as defining conversion functions that map between the two.
This section discusses the mechanism that JPublisher uses for supporting PL/SQL types in Java code, through PL/SQL conversion functions that convert between each PL/SQL type and a corresponding SQL type to allow access by JDBC.
In general, Java programs do not support the binding of PL/SQL-specific types. The only way you can use such types from Java is to use PL/SQL code to map them to SQL types, and then access these SQL types from Java. However, one exception is the scalar index-by table type.
JPublisher makes this task more convenient through the use of its type maps. For a particular PL/SQL type, specify the following information in a JPublisher type map entry:
Name of the PL/SQL type, typically of the form:
SCHEMA.PACKAGE.TYPE
Name of the corresponding Java wrapper class
Name of the SQL type that corresponds to the PL/SQL type
You must be able to directly map this type to the Java wrapper type. For example, if the SQL type is NUMBER, then the corresponding Java type could be int, double, Integer, Double, java.math.BigDecimal, or oracle.sql.NUMBER. If the SQL type is an object type, then the corresponding Java type would be an object wrapper class that implements the oracle.sql.ORAData or java.sql.SQLData interface. The object wrapper class is typically generated by JPublisher.
Name of a PL/SQL conversion function that maps the SQL type to the PL/SQL type
Name of a PL/SQL conversion function that maps the PL/SQL type to the SQL type
The -addtypemap specification for this has the following form:
-addtypemap=plsql_type:java_type:sql_type:sql_to_plsql_fun:plsql_to_sql_fun
As an example, consider a type map entry for supporting the PL/SQL BOOLEAN type. It consists of the following specifications:
Name of the PL/SQL type: BOOLEAN
Specification to map it to Java boolean
Corresponding SQL type: INTEGER
JDBC considers boolean values as special numeric values.
Name of the PL/SQL function that maps from SQL to PL/SQL: INT2BOOL
The code for the function is:
FUNCTION int2bool(i INTEGER) RETURN BOOLEAN IS
BEGIN IF i IS NULL THEN RETURN NULL;
ELSE RETURN i<>0;
END IF;
END int2bool;
Name of the PL/SQL function that maps from PL/SQL to SQL: BOOL2INT
The code for the function is:
FUNCTION bool2int(b BOOLEAN) RETURN INTEGER IS
BEGIN IF b IS NULL THEN RETURN NULL;
ELSIF b THEN RETURN 1;
ELSE RETURN 0;
END IF;
END bool2int;
You can put all this together in the following type map entry:
-addtypemap=BOOLEAN:boolean:INTEGER:INT2BOOL:BOOL2INT
Such a type map entry assumes that the SQL type, the Java type, and both conversion functions have been defined in SQL, Java, and PL/SQL, respectively. Note that there is already an entry for PL/SQL BOOLEAN in the JPublisher default type map. If you want to try the preceding type map entry, you will have to override the default type map. You can use the JPublisher -defaulttypemap option to accomplish this, as follows:
% jpub -u scott -s SYS.SQLJUTL:SQLJUtl -defaulttypemap=BOOLEAN:boolean:INTEGER:INT2BOOL:BOOL2INT
Enter scott password: password
|
Note:
|
Be aware that under some circumstances, PL/SQL wrapper functions are also created by JPublisher. Each wrapper function wraps a stored procedure that uses PL/SQL types. It calls this original stored procedure and processes its PL/SQL input or output through the appropriate conversion functions so that only the corresponding SQL types are exposed to Java. The following JPublisher options control how JPublisher creates code for invocation of PL/SQL stored procedures that use PL/SQL types, including the use of conversion functions and possibly the use of wrapper functions:
-plsqlpackage=plsql_package
This option determines the name of the PL/SQL package into which JPublisher generates the PL/SQL conversion functions: a function to convert each unsupported PL/SQL type to the corresponding SQL type and a function to convert from each corresponding SQL type back to the PL/SQL type. Optionally, depending on how you set the -plsqlmap option, the package also contains wrapper functions for the original stored procedures, with each wrapper function invoking the appropriate conversion function.
If you do not specify a package name, then JPublisher uses JPUB_PLSQL_WRAPPER.
-plsqlfile=plsql_wrapper_script,plsql_dropper_script
This option determines the name of the wrapper script and dropper script that JPublisher creates. The wrapper script creates necessary SQL types that map to unsupported PL/SQL types and also creates the PL/SQL package. The dropper script drops these SQL types and the PL/SQL package.
If the files already exist, then they will be overwritten. If you do not specify any file names, then JPublisher will write to the files named plsql_wrapper.sql and plsql_dropper.sql.
-plsqlmap=flag
This option specifies whether JPublisher generates wrapper functions for stored procedures that use PL/SQL types. Each wrapper function calls the corresponding stored procedure and the appropriate PL/SQL conversion functions for PL/SQL input or output of the stored procedure. Only the corresponding SQL types are exposed to Java. The flag setting can be any of the following:
true
This is the default setting. JPublisher generates PL/SQL wrapper functions only as needed. For any given stored procedure, if the Java code to call it and convert its PL/SQL types directly is simple enough, and if PL/SQL types are used only as IN parameters or for the function return, then the generated code calls the stored procedure directly instead. The code then processes the PL/SQL input or output through the appropriate conversion functions.
If a PL/SQL type is used as an OUT or IN OUT parameter, then wrapper functions are required, because conversions between PL/SQL and SQL representations may be necessary either before or after calling the original stored procedure.
false
JPublisher does not generate PL/SQL wrapper functions. If it encounters a PL/SQL type in a signature that cannot be supported by a direct call and conversion, then it skips the generation of Java code for the particular stored procedure.
always
JPublisher generates a PL/SQL wrapper function for every stored procedure that uses a PL/SQL type. This setting is useful for generating a proxy PL/SQL package that complements an original PL/SQL package, providing JDBC-accessible signatures for those functions or procedures that were not accessible through JDBC in the original package.
JPublisher automatically publishes a PL/SQL RECORD type whenever it publishes a PL/SQL stored procedure or function that uses that type as an argument or return type. The same is true for PL/SQL index-by table types. This is the only way that a RECORD type or index-by table type can be published. There is no way to explicitly request any such types to be published through JPublisher option settings.
|
Note: The following are limitations to the JPublisher support for PL/SQLRECORD and index-by table types:
|
The following sections demonstrate JPublisher support for PL/SQL RECORD types and index-by table types:
The following PL/SQL package is used to illustrate JPublisher support for PL/SQL RECORD and index-by table types:
CREATE OR REPLACE PACKAGE company IS TYPE emp_rec IS RECORD (empno NUMBER, ename VARCHAR2(10)); TYPE emp_tbl IS TABLE OF emp_rec INDEX BY binary_integer; PROCEDURE set_emp_rec(er emp_rec); FUNCTION get_emp_rec(empno number) RETURN emp_rec; FUNCTION get_emp_tbl RETURN emp_tbl; END;
This package defines a PL/SQL RECORD type, EMP_REC, and a PL/SQL index-by table type, EMP_TBL. Use the following command to publish the COMPANY package:
% jpub -u scott -s COMPANY:Company -plsqlpackage=WRAPPER1
-plsqlfile=wrapper1.sql,dropper1.sql
Enter scott password: password
The JPublisher output is:
SCOTT.COMPANY SCOTT."COMPANY.EMP_REC" SCOTT."COMPANY.EMP_TBL" J2T-138, NOTE: Wrote PL/SQL package WRAPPER1 to file wrapper1.sql. Wrote the dropping script to file dropper1.sql
In this example, JPublisher generates Company.java for the Java wrapper class for the COMPANY package, as well as the following SQL and Java entities:
The wrapper1.sql script that creates the SQL types corresponding to the PL/SQL RECORD and index-by table types, and also creates the conversion functions between the SQL types and the PL/SQL types
The dropper1.sql script that removes the SQL types and conversion functions created by wrapper1.sql
The CompanyEmpRec.java source file for the Java wrapper class for the SQL object type that is generated for the PL/SQL RECORD type
The CompanyEmpTbl.java source file for the Java wrapper class for the SQL collection type that is generated for the PL/SQL index-by table type
This section continues the example from Sample Package for RECORD Type and Index-By Table Type Support. For the PL/SQL RECORD type, EMP_REC, JPublisher generates the corresponding COMPANY_EMP_REC SQL object type. JPublisher also generates the conversion functions between the two. In this example, the following is generated in wrapper1.sql for EMP_REC:
CREATE OR REPLACE TYPE COMPANY_EMP_REC AS OBJECT (
EMPNO NUMBER(22),
ENAME VARCHAR2(10)
);
/
-- Declare package containing conversion functions between SQL and PL/SQL types
CREATE OR REPLACE PACKAGE WRAPPER1 AS
-- Declare the conversion functions the PL/SQL type COMPANY.EMP_REC
FUNCTION PL2COMPANY_EMP_REC(aPlsqlItem COMPANY.EMP_REC)
RETURN COMPANY_EMP_REC;
FUNCTION COMPANY_EMP_REC2PL(aSqlItem COMPANY_EMP_REC)
RETURN COMPANY.EMP_REC;
END WRAPPER1;
/
In addition, JPublisher publishes the COMPANY_EMP_REC SQL object type into the CompanyEmpRec.java Java source file.
Once the PL/SQL RECORD type is published, you can add the mapping to the type map. The following is an entry in a sample JPublisher properties file, done.properties:
jpub.addtypemap=SCOTT.COMPANY.EMP_REC:CompanyEmpRec:COMPANY_EMP_REC: WRAPPER1.COMPANY_EMP_REC2PL:WRAPPER1.PL2COMPANY_EMP_REC
Use this type map entry whenever you publish a package or type that refers to the RECORD type, EMP_REC. For example, the following JPublisher invocation uses done.properties with this type map entry:
% jpub -u scott -p done.properties -s COMPANY -plsqlpackage=WRAPPER2
-plsqlfile=wrapper2.sql,dropper2.sql
Enter scott password: password
The JPublisher output is:
SCOTT.COMPANY SCOTT."COMPANY.EMP_TBL" J2T-138, NOTE: Wrote PL/SQL package WRAPPER2 to file wrapper2.sql. Wrote the dropping script to file dropper2.sql
This section continues the example from Sample Package for RECORD Type and Index-By Table Type Support.
To support an index-by table type, a SQL collection type must be defined that permits conversion to and from the PL/SQL index-by table type. JPublisher also supports PL/SQL nested tables and VARRAYs in the same fashion. Therefore, JPublisher generates the same code for the following three definitions of EMP_TBL:
TYPE emp_tbl IS TABLE OF emp_rec INDEX BY binary_integer; TYPE emp_tbl IS TABLE OF emp_rec; TYPE emp_tbl IS VARRAY OF emp_rec;
For the PL/SQL index-by table type EMP_TBL, JPublisher generates a SQL collection type, and conversion functions between the index-by table type and the SQL collection type.
In addition to what was shown for the RECORD type earlier, JPublisher generates the following:
-- Declare the SQL type for the PL/SQL type COMPANY.EMP_TBL
CREATE OR REPLACE TYPE COMPANY_EMP_TBL AS TABLE OF COMPANY_EMP_REC;
/
-- Declare package containing conversion functions between SQL and PL/SQL types
CREATE OR REPLACE PACKAGE WRAPPER1 AS
-- Declare the conversion functions for the PL/SQL type COMPANY.EMP_TBL
FUNCTION PL2COMPANY_EMP_TBL(aPlsqlItem COMPANY.EMP_TBL)
RETURN COMPANY_EMP_TBL;
FUNCTION COMPANY_EMP_TBL2PL(aSqlItem COMPANY_EMP_TBL)
RETURN COMPANY.EMP_TBL;
...
END WRAPPER1;
JPublisher further publishes the SQL collection type into CompanyEmpTbl.java.
As with a PL/SQL RECORD type, once a PL/SQL index-by table type is published, the published result, including the Java wrapper classes, the SQL collection type, and the conversion functions, can be used in the future for publishing PL/SQL packages involving that PL/SQL index-by table type. For example, if you add the following entry into a properties file that you use in invoking JPublisher, say done.properties, then JPublisher will use the provided type map and avoid republishing that index-by table type:
jpub.addtypemap=SCOTT.COMPANY.EMP_TBL:CompanyEmpTbl:COMPANY_EMP_TBL: WRAPPER1.COMPANY_EMP_TBL2PL:WRAPPER1.PL2COMPANY_EMP_TBL
In generating Java code to invoke a stored procedure that uses a PL/SQL type, JPublisher can use either of the following modes of operation:
Invoke the stored procedure directly, which processes the PL/SQL input or output through the appropriate conversion functions.
Invoke a PL/SQL wrapper function, which in turn calls the stored procedure and processes its PL/SQL input or output through the appropriate conversion functions. The wrapper function that is generated by JPublisher uses the corresponding SQL types for input or output.
The -plsqlmap option determines whether JPublisher uses the first mode, the second mode, or possibly either mode, depending on circumstances.
As an example, consider the SCOTT.COMPANY.GET_EMP_TBL PL/SQL stored procedure that returns the EMP_TBL PL/SQL index-by table type. Assume that the COMPANY package, introduced in "Sample Package for RECORD Type and Index-By Table Type Support", is processed by JPublisher through the following command:
% jpub -u scott -s COMPANY:Company -plsqlpackage=WRAPPER1
-plsqlfile=wrapper1.sql,dropper1.sql -plsqlmap=false
Enter scott password: password
The JPublisher output is:
SCOTT.COMPANY SCOTT."COMPANY.EMP_REC" SCOTT."COMPANY.EMP_TBL" J2T-138, NOTE: Wrote PL/SQL package WRAPPER1 to file wrapper1.sql. Wrote the dropping script to file dropper1.sql
With this command, JPublisher creates the following:
SQL object type COMPANY_EMP_REC to map to the PL/SQL RECORD type EMP_REC
SQL collection type COMPANY_EMP_TBL to map to the PL/SQL index-by table type EMP_TBL
Java classes to map to COMPANY, COMPANY_EMP_REC, and COMPANY_EMP_TBL
PL/SQL package WRAPPER1, which includes the PL/SQL conversion functions to convert between the PL/SQL index-by table type and the SQL collection type
In this example, assume that the conversion function PL2COMPANY_EMP_TBL converts from the PL/SQL EMP_TBL type to the SQL COMPANY_EMP_TBL type. Because of the setting -plsqlmap=false, no wrapper functions are created. The stored procedure is called with the following JDBC statement in generated Java code:
conn.prepareOracleCall =
("BEGIN :1 := WRAPPER1.PL2COMPANY_EMP_TBL(SCOTT.COMPANY.GET_EMP_TBL()) \n; END;");
SCOTT.COMPANY.GET_EMP_TBL is called directly, with its EMP_TBL output being processed through the PL2COMPANY_EMP_TBL conversion function to return the desired COMPANY_EMP_TBL SQL type.
By contrast, if you run JPublisher with the setting -plsqlmap=always, then WRAPPER1 also includes a PL/SQL wrapper function for every PL/SQL stored procedure that uses a PL/SQL type. In this case, for any given stored procedure, the generated Java code calls the wrapper function instead of the stored procedure. The wrapper function, in this example WRAPPER1.GET_EMP_TBL, calling the original stored procedure and processing its output through the conversion function is as follows:
FUNCTION GET_EMP_TBL()
BEGIN
RETURN WRAPPER1.PL2COMPANY_EMP_TBL(SCOTT.COMPANY.GET_EMP_TBL())
END;
In the generated Java code, the JDBC statement calling the wrapper function is:
conn.prepareOracleCall("BEGIN :1=SCOTT.WRAPPER1.GET_EMP_TBL() \n; END;");
If -plsqlmap=true, then JPublisher uses direct calls to the original stored procedure wherever possible. However, in the case of any stored procedure for which the Java code for direct invocation and conversion is too complex or any stored procedure that uses PL/SQL types as OUT or IN OUT parameters, JPublisher generates a wrapper function and calls that function in the generated code.
The preceding sections describe the mechanisms that JPublisher employs to access PL/SQL types unsupported by JDBC. As an alternative to using JPublisher in this way, you can try one of the following:
Rewrite the PL/SQL method to avoid using the type
Write an anonymous block that does the following:
Converts input types that JDBC supports into the input types used by the PL/SQL stored procedure
Converts output types used by the PL/SQL stored procedure into output types that JDBC supports
JPublisher style files allow you to specify Java-to-Java type mappings. This is to ensure that generated classes can be used in Web services. As an example, CLOB types, such as java.sql.Clob and oracle.sql.CLOB, cannot be used in Web services, but the data can be used if it is converted to a type that is supported by Web services, such as java.lang.String. JPublisher must generate user subclasses to implement its use of style files and Java-to-Java type transformations.
Typically, style files are provided by Oracle, but there may be situations in which you may want to edit or create your own.
The following sections discuss features and usage of styles and style files:
Use the JPublisher -style option to specify the base name of a style file:
-style=stylename
Based on the stylename you specify, JPublisher looks for a style file as follows, and uses the first file that it finds:
It looks for the following resource in the classpath:
/oracle/jpub/mesg/stylename.properties
It takes stylename as a resource name, possibly qualified, and looks for the following in the classpath:
/stylename-dir/stylename-base.properties
It takes stylename as a name, possibly qualified, and looks for the following file in the current directory:
stylename.properties
In this case, stylename can optionally include a directory path. If you use the setting -style=mydir/foo, for example, then JPublisher looks for mydir/foo.properties relative to the current directory.
If no matching file is found, JPublisher generates an exception.
As an example of the first scenario, if the resource /oracle/jpub/mesg/webservices.properties exists in ORACLE_HOME/sqlj/lib/translator.jar and translator.jar is found in the classpath, then the -style=webservices setting uses /oracle/jpub/mesg/webservices.properties from translator.jar, even if there is a webservices.properties file in the current directory.
However, if you specify -style=mystyle and a mystyle.properties resource is not found in /oracle/jpub/mesg, but there is a mystyle.properties file in the current directory, then that is used.
|
Note: Oracle currently provides three style files:/oracle/jpub/mesg/webservices-common.properties /oracle/jpub/mesg/webservices10.properties /oracle/jpub/mesg/webservices9.properties These are in the To use Web services in Oracle Database 11g, specify the following style file: -style=webservices10 To use Web services in Oracle9i, specify |
The key portion of a style file is the TRANSFORMATION section. This section comprises everything between the TRANSFORMATION tag and END_TRANSFORMATION tag. It describes the type transformations, or Java-to-Java mappings, to be applied to types used for object attributes or in method signatures.
For convenience, there is an OPTIONS section in which you can specify any other JPublisher option settings. Because of this section, a style file can replace the functionality of any other JPublisher properties file, in addition to specifying mappings.
This section covers the following topics:
|
Note: The following details about style files are provided for general information. This information is subjected to change. |
This section provides a template for a style file TRANSFORMATION section, with comments. Within the TRANSFORMATION section, there is a MAPPING section for each mapping that you specify. The MAPPING section starts at a MAPPING tag and ends with an END_MAPPING tag. Each MAPPING section includes a number of subtags with additional information. In the MAPPING section, the SOURCETYPE and TARGETTYPE tags are the required subtags. Within each TARGETTYPE section, you should generally provide information for at least the RETURN, IN, and OUT cases, using the corresponding tags. The following code illustrates the structure of a typical TRANSFORMATION section:
TRANSFORMATION IMPORT # Packages to be imported by the generated classes END_IMPORT # THE FOLLOWING OPTION ONLY APPLIES TO PL/SQL PACKAGES # This interface should be implemented/extended by # the methods in the user subclasses and interfaces # This option takes no effect when subclass is not generated. SUBCLASS_INTERFACE java_interface # THE FOLLOWING OPTION ONLY APPLIES TO PL/SQL PACKAGES # Each method in the interface and the user subclass should # throw this exception (the default SQLException will be caught # and re-thrown as an exception specified here) # This option takes no effect when subclass is not generated. SUBCLASS_EXCEPTION Java_exception_type STATIC # Any code provided here is inserted at the # top level of the generated subclass regardless # of the actual types used. END_STATIC # Enumerate as many MAPPING sections as needed. MAPPING SOURCETYPE Java_source_type # Can be mapped to several target types. TARGETTYPE Java_target_type # With CONDITION specified, the source-to-target # mapping is carried out only when the listed Java # classes are present during publishing. # The CONDITION section is optional. CONDITION list_of_java_classes IN # Java code for performing the transformation # from source type argument %1 to the target # type, assigning it to %2. END_IN IN_AFTER_CALL # Java code for processing IN parameters # after procedure call. END_IN_AFTER_CALL OUT # Java code for performaing the transformation # from a target type instance %2 to the source # type, assigning it to %1. END_OUT RETURN # Java code for performing the transformation # from source type argument %1 to the target # type and returning the target type. END_RETURN # Include the code given by a DEFINE...END_DEFINE block # at the end of this template file. USE defined_name # Holder for OUT/INOUT of the type defined by SOURCETYPE. HOLDER Java_holder_type END_TARGETTYPE # More TARGETTYPE sections, as needed END_MAPPING DEFAULT_HOLDER # JPublisher will generate holders for types that do # not have HOLDER entries defined in this template. # This section includes a template for class definitions # from which JPublisher will generate .java files for # holder classes. END_DEFAULT_HOLDER # More MAPPING sections, as needed DEFINE defined_name # Any code provided here is inserted at the # top level of the generated class if the # source type is used. END_DEFINE # More DEFINE sections, as needed END_TRANSFORMATION
|
Note:
|
For convenience, you can specify any desired JPublisher option settings in the OPTIONS section of a style file, in the standard format for JPublisher properties files. The syntax for the same is as follows:
OPTIONS # Comments jpub.option1=value1 jpub.option2=value2 ... END_OPTIONS
The Oracle style files webservices-common.properties, webservices9.properties, and webservices10.properties, through their SOURCETYPE and TARGETTYPE specifications, have a number of important Java-to-Java type mappings to support Web services and REF CURSOR mappings. These mappings are summarized in Table 3-2.
Table 3-2 Summary of Java-to-Java Type Mappings in Oracle Style Files
| Source Type | Target Type |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
JPublisher allows multiple -style options on the command line, with the following behavior:
The OPTIONS sections are concatenated.
The TRANSFORMATION sections are concatenated, except that the entries in the MAPPING sections are overridden, as applicable. A MAPPING entry from a style file specified later on the command line overrides a MAPPING entry with the same SOURCETYPE specification from a style file specified earlier on the command line.
This functionality is useful if you want to overwrite type mappings defined earlier or add new type mappings. For example, if you want to map SYS.XMLTYPE to java.lang.String, then you can append the setting -style=xml2string to the JPublisher command line. This example assumes that the ./xml2string.properties style file will be accessed. This style file is defined as follows:
OPTIONS
jpub.defaulttypemap=SYS.XMLTYPE:oracle.xdb.XMLType
END_OPTIONS
TRANSFORM
MAPPING
SOURCETYPE oracle.xdb.XMLType
TARGETTYPE java.lang.String
# XMLType => String
OUT
%2 = null;
if (%1!=null) %2=%1.getStringVal();
END_OUT
# String => XMLType
IN
%1 = null;
if (%2!=null)
{
%1 = new %p.%c(_getConnection());
%1 = %1.createXML(%2);
}
END_IN
END_TARGETTYPE
END_MAPPING
END_TRANSFORM
Continuing this example, assume the following PL/SQL stored procedure definition:
PROCEDURE foo (arg XMLTYPE);
JPublisher maps this as follows in the base class:
void foo (arg oracle.xdb.XMLType);
And JPublisher maps it as follows in the user subclass:
void foo (arg String);
|
Note: By default, JPublisher mapsSYS.XMLTYPE to oracle.xdb.XMLType. |
This preface introduces you to the Oracle Database JPublisher User's Guide, discussing the intended audience, structure, and conventions of this document. A list of related Oracle documents is also provided.
The JPublisher utility is for Java programmers who want classes in their applications to correspond to SQL or PL/SQL entities or server-side Java classes.
This preface covers the following topics:
The Oracle Database JPublisher User's Guide is intended for Java Database Connectivity (JDBC) and Java2 Platform, Enterprise Edition (J2EE) programmers who want to accomplish any of the following for database applications:
Create Java classes to map to SQL user-defined types, including object types, VARRAY types, and nested table types
Create Java classes to map to OPAQUE types
Create Java classes to map to PL/SQL packages
Create client-side Java stubs to call server-side Java classes
Publish SQL queries or data manipulation language (DML) statements as methods in Java classes
Create Java and PL/SQL wrappers for Web services client proxy classes
Publish server-side SQL, PL/SQL, or Java entities as Web services
To use this document, you need knowledge of Java, Oracle Database, SQL, PL/SQL, and JDBC.
For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.
Access to Oracle Support
Oracle customers have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.
Accessibility of Links to External Web Sites in Documentation
This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites.
Deaf/Hard of Hearing Access to Oracle Support Services
To reach Oracle Support Services, use a telecommunications relay service (TRS) to call Oracle Support at 1.800.223.1711. An Oracle Support Services engineer will handle technical issues and provide customer support according to the Oracle service request process. Information about TRS is available at http://www.fcc.gov/cgb/consumerfacts/trs.html, and a list of phone numbers is available at http://www.fcc.gov/cgb/dro/trsphonebk.html.
This document contains:
Chapter 1, "Introduction to JPublisher"
Introduces the JPublisher utility by way of examples, lists new JPublisher features in this release, and provides an overview of JPublisher operations.
Describes how you can use JPublisher for publishing SQL and PL/SQL objects, Oracle Stream Advanced Queue (AQ), server-side Java classes, and Web services.
Chapter 3, "Data Type and Java-to-Java Type Mappings"
Provides details of JPublisher data type mappings and the styles mechanism for Java-to-Java type mappings.
Chapter 5, "Generated Classes and Interfaces"
Discusses details and concepts of the classes, interfaces, and subclasses generated by JPublisher, including how output parameters (PL/SQL IN OUT or OUT parameters) are treated, how overloaded methods are translated, and how the generated classes and interfaces are used.
Chapter 4, "Additional Features and Considerations"
Covers additional JPublisher features and considerations: a summary of support for Web services, filtering of JPublisher output, and migration and backward compatibility.
Chapter 6, "Command-Line Options and Input Files"
Provides details of the JPublisher command-line syntax, command-line options and their usage, and input file format.
Appendix A, "Generated Code Examples"
Contains code examples that are too lengthy to fit conveniently with corresponding material earlier in the manual. This includes examples of Java-to-Java type transformations to support Web services, and Java and PL/SQL wrappers to support Web services.
Covers the troubleshooting tips for JPublisher
For more information, see the following Oracle resources.
From the Oracle Java Platform group, for Oracle Database releases:
Oracle Database Java Developer's Guide
This book introduces the basic concepts of Java in Oracle Database and provides general information about server-side configuration and functionality. It contains information that pertains to the Oracle Database Java environment in general, rather than to a particular product, such as JDBC.
The book also discusses Java stored procedures, which are programs that run directly in Oracle Database. With stored procedures (functions, procedures, and triggers), Java developers can implement business logic at the server level, which improves application performance, scalability, and security.
Oracle Database JDBC Developer's Guide
This book covers programming syntax and features of the Oracle implementation of the JDBC standard. This includes an overview of the Oracle JDBC drivers, the details of the Oracle implementation of JDBC 1.22, 2.0, and 3.0 features, and a discussion of Oracle JDBC type extensions and performance extensions.
From the Oracle Java Platform group, for Oracle Application Server releases:
Oracle Application Server Containers for J2EE Developer’s Guide
Oracle Application Server Containers for J2EE Services Guide
Oracle Application Server Containers for J2EE Security Guide
Oracle Application Server Containers for J2EE Servlet Developer's Guide
Oracle Application Server Containers for J2EE Support for JavaServer Pages Developer's Guide
Oracle Application Server Containers for J2EE JSP Tag Libraries and Utilities Reference
Oracle Application Server Containers for J2EE Enterprise JavaBeans Developer's Guide
From the Oracle Server Technologies group:
|
Note: Oracle error message documentation is available in HTML only. Only if you have access to the Oracle Documentation CD, you can browse the error messages by range. After you find the specific range, use the Find in Page feature of your browser to locate the specific message. When connected to the Internet, you can search for a specific error message using the error message search feature of the Oracle online documentation. |
From the Oracle Application Server group:
From the Oracle JDeveloper group:
JDeveloper online help
JDeveloper documentation on the Oracle Technology Network:
http://www.oracle.com/technetwork/developer-tools/jdev/overview/index.html
To download free release notes, installation documentation, white papers, or other collateral, visit the Oracle Technology Network (OTN). You must register online before using OTN. Registration is free and can be done at
http://www.oracle.com/technetwork/community/join/overview/index.html
If you already have a user name and password for OTN, then you can go directly to the documentation section of the OTN Web site at
http://www.oracle.com/technetwork/documentation/index.html
For additional information about JAX-RPC and holders and access to the Java API for XML-based RPC, JAX-RPC 1.0 specification, visit the following site:
http://jcp.org/aboutJava/communityprocess/final/jsr101/index.html
For Java Development Kit (JDK) users, the following link contains native2ascii documentation, including information about character encoding that is supported by Java environments.
http://download.oracle.com/javase/1.3/docs/tooldocs/solaris/native2ascii.html
This section describes the conventions used in the text and code examples of this documentation set. It describes:
Conventions in Text
We use various conventions in text to help you quickly identify special terms. The following table describes these conventions and provides examples of their use.
| Convention | Meaning | Example |
|---|---|---|
| Bold | Bold typeface indicates terms defined in the text. | A class is a blueprint that defines the variables and the methods common to all objects of a certain kind. |
| Italics | Italic typeface indicates book titles and emphasis. | Oracle Database Concepts
Ensure that the recovery catalog and target database do not reside on the same disk. |
UPPERCASE monospace (fixed-width) font | Uppercase monospace typeface indicates system elements. Such elements include parameters, privileges, data types (including user-defined types), RMAN keywords, SQL keywords, SQL*Plus or utility commands, packages and methods, as well as system-supplied column names, database objects and structures, user names, and roles. | You can specify this clause only for a NUMBER column.
You can back up the database by using the Query the Use the |
lowercase monospace (fixed-width) font | Lowercase monospace typeface indicates executables, file names, directory names, and some user-supplied elements. Such elements include computer and database names, net service names, and connect identifiers, as well as Java packages and classes, program units, and parameter values.
Note: Some programmatic elements use a mixture of UPPERCASE and lowercase. Enter these elements as shown. | Enter sqlplus to start SQL*Plus.
The password is specified in the Back up the data files and control files in the The Set the The |
lowercase italic monospace (fixed-width) font | Lowercase italic monospace font represents placeholders or variables. | You can specify the parallel_clause.
Run |
Conventions in Code Examples
Code examples illustrate Java, SQL, PL/SQL, SQL*Plus, or command-line statements. They are displayed in a monospace (fixed-width) font and separated from typical text as shown in this example:
SELECT username FROM dba_users WHERE username = 'MIGRATE';
The following table describes typographic conventions used in code examples and provides examples of their use.
| Convention | Meaning | Example |
|---|---|---|
[ ] | Brackets enclose one or more optional items. Do not enter the brackets. |
DECIMAL (digits [ , precision ]) |
{ }
| Braces enclose two or more items, one of which is required. Do not enter the braces. |
{ENABLE | DISABLE}
|
| | A vertical bar represents a choice of two or more options within brackets or braces. Enter one of the options. Do not enter the vertical bar. |
{ENABLE | DISABLE}
[COMPRESS | NOCOMPRESS]
|
... | Horizontal ellipsis points indicate either:
|
CREATE TABLE ... AS subquery; SELECT col1, col2, ... , coln FROM employees; |
| Other notation | You must enter symbols other than brackets, braces, vertical bars, and ellipsis points as shown. |
|
Italics
| Italicized text indicates placeholders or variables for which you must supply particular values. |
CONNECT SYSTEM/system_password DB_NAME = database_name |
UPPERCASE | Uppercase typeface indicates elements supplied by the system. We show these terms in uppercase in order to distinguish them from terms you define. Unless terms appear in brackets, enter them in the order and with the spelling shown. However, because these terms are not case-sensitive, you can enter them in lowercase. |
SELECT last_name, employee_id FROM employees; SELECT * FROM USER_TABLES; DROP TABLE hr.employees; |
lowercase | Lowercase typeface indicates programmatic elements that you supply. For example, lowercase indicates names of tables, columns, or files.
Note: Some programmatic elements use a mixture of UPPERCASE and lowercase. Enter these elements as shown. |
SELECT last_name, employee_id FROM employees; sqlplus hr/hr CREATE USER mjones IDENTIFIED BY ty3MU9; |
PS?SP <eߟ<]3} 1>ژ٨.3U.2N!,5 |h4&џ.-N@]C~(̇ḊST d8J
7"P[ʗxLƥ H\.bğ'Bⷛv+Y%_m/>«^^o $(=M'p4t! SO/mYLPf\F2U0E D%__sݦ> +I`fK<;V-o> U0!@7
?|[`J9/}QP <:!K *ؼ ts_%
%݂,jki+y08SYDy{D+!p< M
愃zJ+4ay|a9%!@HBÍm~)x3#~cq ~i ȁ
̋V<W5a 1ꓗ'ggz x' zdp$ff` Rv }x{xR^B' ÷I%-P^JFn qG[&+pzAc wwR8xWx']'#G 5r@(t)Łl@c%4 +F2'&ZA2ӆ bfyn8E2lqTx`&MeW;@] A&F? %`AJHQ=_.QaRu1VyWG rE 4nU A*RR~'r r0 G!oF{1)%xr UwGRq"xpobTRk'r 0 :WsҴLLX1W rRmx x%XmpyϢ_. =y_&+0Z($
'l vАI &($=)}g.Cma#5 |b/0&Mvj' wewn(fxQ]uطF `0 0l˨(Yuq 0 wcEcЖؗ~wx"ԧ'b ƈi{İxr;5ƎȤ'd) & ] ]`ȒrUBzq2lrP&e 19_G"#+@8sBzg{(:p :3 P([x X* ^% &3X@%p_xt#'Y
$Wax&s{ {w
HIzg{HxșW&ڢ`ZP(
dvx {x9/' (H{
{*'
q0iS I%yUP';Z:
X:tjS)r]))6ZzI}p"xo᠙b`Y}'y_B 4F&Wx&`U (r : hXvR࠘HQ, W} kȎ4W~ La[6 x& 6 Z];,y Ċ nj&XZgtnJn ]li;Ni]@ P(`&I: zEhO(b5
5UY
Wࠊ
Y}_;hljٮw}`I 0) 2+D^z31 l`GjIuECf&<4=84N=L)D,cBO1 K2L@E!+ RE$1A"/&LhSm9S r !B #B
'4
NDT cE\
4ֆ
8^ i5BaIeaIYXU!VWu ƕmYU&Z`3J)Uh! S! `"rs\ tg6,jjꩨzZf۬e!$H#!r+M
]F"5 ED+ xqGpblk 6 ],E;4f Ӗ# 0a> ո`8
F&XF'V<2r*"R;ZML$Ð@ KZզ'YxU1}50 IAUeUz91BTU7Vofc%E0U, Ue
Z^IMe2ƣ< ")ixJ
|귪."o kq>"Ư~XBgp݈26;72$H 0PmICMQB}22 ;2D
$lt? #@ HSD*+,]ld Q@K顋TF4L"DM.9YNe (
TVIg#AaJ]P_蒧\-)U:KF"\ktRV(e+1!1ԗgN5HJ
P0Q |c ʁP|&:C
3Ǫ6vc4qx~e9 VъX~"P>'x (=B{F@z8!x;$2#i 2 =@.
@ X5F 8#JG#;@3QD,QF֒ FDXv$q" " .Y +GF,p:Y+[!U$h48aN2KYt *L^8C'!-Q0Z
m?KP)4
RJ\
Ȉ\Q1Nr.E,biFU6ojո\'Y#&ǖT:8VȀ[V% vSqE
s
10P C~*3П(vA}H.bq@* hz30y|W
\@
-7`'GE) qE # ,Q TLQ 3H&.Q9 ,20BW@D7k!9 XAlNSaW1
p:яufG
FGgtavWa&. u8QFokc,0"_E۷baDb K=%Q 8*@.hFH5S796x7< /' ӉOٚ X{
vmQ nz:1w`wa`E(Ȝn 8 KIwJgА@Q-$as
#My76 PL+!` i^qeQ
!s"E GK`L P( Y)ZC"P*p~cHႄQea$ 4`5PPXQm 52 E
3}
ǐ.Q]Ěm1j%ސٰ6kCI @r GP=(l)Sk11ln?Q
Qi}-NHwK
P,
R @&`= +S+. G".$*,(S7R针Qi' "8q'PL iY~HK/B"sQu(ʂׂ p #TP0Br_ > :xq7OBY 9>`&bZ&[ >lzK)n YIYH? x
: `~QS lİbGJ$xAƗCR&,A^85K&ɆiΣ 4aaQ p Q J/C."~gaǸ( )0i++CUL[ h+- Τښ祐ਓ p#G# ˌj2$0 ;
b $ ʻۼ btOahBkC
+TB图䛾 T -@@+p+* i 1@=۾l Ҽ <0 Ў+˻6 \=@hkՃrkN =:G/C l\s C d*7B?!C
p G ]n4r%+夰@ Up3tP BτLuPބ bPYC-Q,QX=y6NuIO9'ExDVP|fxc;w 7Pe5$5C;)9p5kRaC/s Uw$:T-&Zʢ,]W 4v"pt@3)G*S44lj|t>T/>8c; wAN 5J@Bl^Inn$B1/~
YG)\W)p; 9FbG(*7*^*_T9Ȋ蘎S@;'4; vhI(uv($rlBxS t)CW@ 3*WG@#.H㒍$Y낐2N)*20IQ@ao3^P2Qu
ِD)& +h3 R9&Rb$ jB&2+L,dyWu0$W,6%]9(^IJ%j))M+jI(o 'DHuɖm$z&si&l%rDW{vl %&yٙ9Yyiyb G9%ғ^ A#! ) 4ɛ1+" ֡4 yY!aaG qI 䩝y p yș a)˱") 9
#
z
* ԑ z"Z!ڠ 灡ڱ# j 2 (! XQ5p5PuFzH1JJzLڤcORO* tΦ_l`]:dZc
TbfڥptJZawoyzOT:p:qJڨ`::ZzZ
:ک
J೨
@Sw ה'"(b $o*PV@ >9p@0SZ52NKzKIK0P3Zz0*ꊮ@uT1mRmzoʯʯf[}ک
+ KʨZ sZ>(?3)>,SD"(T5
R!L'
JE19 sP@b6R+
Wz[۵ZKz40T/USڴy:";;t[|۷뷄;+oP+Sx [fkK
>o ;[aSkV O 7 P@S*KFRGʤ'L+uhZkDЫkf[N{ʼ39ʶڴ9@%t۾:[{˺ \˿[m:Yz"H;jV0rS67p#[8I*,lzE¼'mLIS@eIPHuP&BI&մl ĜHhꦀuz?`uڴYjo w ]> 1@S|~ǂ̹+״,y;Ǔ\ɉ5;%0 6$ E2ĨʪlF*E:K
oIRtCI)\L ʤL#fԴA7pZ[N[mŸbL9ǛܴVl|,/YuɃǐ,|\
Lɚ:|,
}k%+b=np ^>
5\5Y욵W;.
$ZkkKcT[]X*錰]F}H}4V`.c+o
>4b*yuP%Px 4%P=PF( ?VяjV#R >V*0ypւO}sWpKL% n@nݹ =YU} @@{
(>) eҶ]*-ӹۺe3ۻM>< ͪI|۴SWO \ଙ*0[0gMu`cj}O
U.@V0a@Yy=V0=0u]lpe
c{W 4SD1=n 4Zګ~˓ M1}0.=MZ_8; kj[jНJ tVs2P2+eo h ANl#Ӓ#bFfL$SOO0#@1PC#d)d ;ȿAYmu5b#! Nh [0nH0eO @P,SF
dcaXa X cXcYacdc cX XYaXYY c]{X{aa >X }{. }}z0E fy{ׄZrTLXŗ5';ٜ=r~qv(h[䛱8Hvju~8fNe kt(gr'` TPZW̝B lã>&
=zT#z@ ܃=ޏ >8 Ҁ
6c
W c P|7rʗrK(şfYRrظ{]Ζ5" U ~pn[/p7ku;thfe~_ݶP`B;]k֎|a oP$Ț0gN 1?KCK^bơ]GtBmv]vf~wXr.t>v^x~z|~ >^~芞.OWiW0uj xJGewLbB
i@ִlzOTô:> -`=ʾT >^~؞ھ >^~~dM ? ) >j&
PhnнȅLg} 4K W/? / "?$_&(*o +0 2 ]6M8!3?=5DA o7 S?Z f0
`f f`ee0~ N*/$Lx|?N>ëe {+<
L n ˱{< Ďަ ˳ =ʓ{oi ւ^ 6k~pT "K
# Tggeeege ȃ¾ฬ窲䵧i 0TXp#J4Ѱŋ3VHPAa " 1,
'PR\IeV$0Or6ijOH iQ$]z4-OFEٴիXj5
4f 6kZ\ymځht](/*KJ}Dpby#?<RBJe
Bp(p0ӤQNڴ֬WV}idh la+<24+ĩ?KLw:wPKO~?JWihMU]!h~`w^ µ \!UvYhu8 ul@@/0X6H1J<ch- y$6A %\JkrFeg`M\%\P Y(9p t**-'pxVgG Ju~g
JIA^xPi6Q_T9 0ej1ꪬ<'PLYNt!\*ta:R昂T챐PɚT*VkbX]^+>ěr;pU]i0A6k\*;L0$<
Z+i(E :\Y"=w&l
( @؝\7%W@-J3L3kIY(U;vx
O4LJPA2M1:ϡ$1W,$ќ^QfͭV;-R:\r*mIxaEUSZع\{6cOmh=f`&f(OF,apoȯ1+|y¥pm|U}ko~?＇~a[{'{7 XpnrNi- \J,חG*W!F=m:B0m8Cfȼ͐ӫJ|Pw/P|{74_
ӾQH<"X<
q>ӏU<)Xx-<\iMj]5
(BA'JhEPd&:'p"5
ZgS´BOI '95kܢD' N q
O
OiD벴
EQM讎v8=Cp 0)H
q$O\Т - '
!%ZYs̜ D sp&UrNTf(9-5
T@^) Ape'3O4J@i t2̆l z JH&pp9\ZF/qu2B^ 6'S*bhK1ttQ(66sa[L?O̱ YP/N+^NA5)%g=9BթZ5o"&*UN6ؾzB:QPs $%IJ7Ԃ ./:dV9*O7ޒ P&Fd!
C#x A*%IuHkBHGZs*] -U4Ru*bTK劜 OX="VڞIsƁނ/EW Eb.x B= CPm&I]oE 9 ZʠlQ=peQBգ}1-~lءĵ[!hi?SЀWjfL\Ӻpwk>7(l_YIzWBzN%ֵI*:^-hVviEE$F1u -ve2g6NCiB
P*d7&;8a B!d%xU76q\[{ w2G6[IpD+]ub[RgYsxݝxh"ó +Z\MgQ>ZT83Lp$mG r_Tu]vNǣ:1&qLY Ů[Rw!X6śY+l wuݕpgx5z5*[ͶVLcmO&*r GCQs2\go[.+{1 XpӇptq$Ӿ~kޔ+l
ۺYNe_[*eNۏ 2wg_m=, k :S߷]kx kRz0хK]Qv[V ɦT &7{Ύ=WFu s˶WW줍~sܕ;hiC }a+}6 t_SQlh~hy"sgMޗVf VRz
r81;8rp <5I:¹{{,y}5 hgqt !)L!Kkx) PQ Q:qp0kSy ;{6~HkHV<lxT@#SГ#
@WLR'ƪ8`ŏff
]Zn2 ) GE %PjC/q,5Ƙ}Bu@oֆqq盭}Qg yz4q(Q!` RdV}2# C8亯 y28)h;
b).O7!9a:Q]F -Z/غVHu vymh_PR Tpz Ҫyd|ڑy5~p9n#t6f_2`_#?nyԲ] g *]vuAyQj7 Wغa#(S˒dxuTN2Ǐ geqwr榈PGP^hXqIh{)k2@ ;yUBȉ г8y8o)qy 7PIcyr 0v [^{-WZԙl%)])hЭX; WKv˰۽++Bh"H/h/GHnfX0`%0@#pIu 8K]4w:ޕnB"Gc8"ڥ q[ Ǿ("/y;(#Qq ^9+gox fk[5%0kby!ʼnǙϖ JA+ Lɋ @o4\ bcDZxv^][!o|t]5rrRd>k#!Ge~H c
E$Ŧ]ߴt ՛y5/G_, xc8~ V&
A^ʬh@$Y]J>Dd۱=;7` i/?I5b+*x;2dbT"i"Q0 H+ІfS&GHʸgBּ8u0A'ш }0ʽ5Q nqP@2A̡V,5À6լF=tԱ: ``qơ}KB'mLP ZR4{Px"& F$G#JB?Jd?z#
--eh䴨MjOˊMJ7Bb2P83qʩpZ#h $"X `Zr-\u! x ].h.3 \Z <)M1[S);4짼 Hr(EppM!
,L Ik#'[),D6|
C_촛.XMqz
'JKt\vk})Y rc
az'pV "`QJ@a
Pլ.
黴eQSu@xV``S'k\*@p:uְ²x+{Dۥ=#LJ{
\LB:R#WZQ
kI|"Ƹ|L)GLo;)-
{ ~:U@tll
{p[@P=B֠* pȸְFPw
2`,<[˥hL*s%쌈 }u@ u,w̼zl,$0͒& ѥ'[G谴@@ q
RQ#="E fR " D
l"`J"
NUZ&kZRwjGIח= Vwzt zNUזti.dW{ 8)e
* 8FyeY'7
Daw(T
mzJ~7:Xz,6ڠ['cd蕬Yg'ʮ6i #JYDhq$ZY$tcJ/z-4yz[ zoGb**#7+jQpа:5Ghb#QwD !I2
Y([&I
KIwjS x' ʫ5SՊ3;ۍ=DP;Z4Kz3;[lRK@T`rN"!c ` 1 0!S
!0z*p:4 ~[9;Z%6jeʬJ дVttpCTr$w-qcxZ !iK2QmK鐷;.8ǻx Ȟ;JE˸ :GgkU+h kWDNNFr\$%i% KcX7aKۧ*iN+ D˼
ۨf:=`lG;3W9 ,!cpc3@&{'̮fڟr[9a^~D@hQa;ٕCp}^ L:^ښ {QjZ8` s ɕt!f$S<#' 2ʭ
'Y^ g\+;qoU9[[
';| R1I(MZa{m;:Lc /b9 x_'L
x |_0|_xjg#c|I{|(5l ͉L̀f͏I@-Z Y
웨Krz'b!Qڪu8ƙ+QDzl6fu7-h T:ɞl}ś
PG^ ;OV z;
#M%M?IҡmR
.tR̮Ts+WTur-
k'-ѿ iǜЌԁNg7Tu\
meeuJ܋%+(ݬITo
7 O59ogܨ}V O|N=U H_i'*"tfJf qzRx` uJC>DžwxYx)6JuCD
"
maDQqᘛeM"*Ba^+FGbpPdT5J (qoPs[NyN
b{lAN)&/I,./^T(nWn'G[ő& "~[`= ñ9ix}n?C?^Ӈ̮ҾyiD:\Fll &> R; q+Z8k*ov,?}k| l~UߴӮ&ծ?2VY.k
x !io!))^` ^/ h5v˾GmR@N^ P at'W^ ( dT @
:~hr6 ;L;
<2@R. $(IK=|;|pSR,]ю?h(F qO/La6`l@2Lm-nP b&Ef͉sH|:st#ޙGE ?/Eozg>} BPt2_D4FVǹ
<*Mb[jK`Kǹ
d!Pm0Wֺ%y0!#( v
{pȌfqRSXHUzc
$& JO8c렢( ԭC7PHTi@_Zź!lKw[tLY 6πY.?iRN
7Vy|TmK{V mbŝX%jV :d:pr $-x5 Y;L6ck[]ńwp
/.{˱o
Kܮ4Q!~N-[ ,0Jh=bgX9[Ta-lЈĂ8Bg#]b3q2֬O{rc z`ꩣ[պij]&uPnxkD f w-liY"y{ 6Dy~79sflgA v :ЅMy3Ғ]Ӛ>$&Alq"WU;|yu@3K*_A4k@u%O5Uڻ DVѥ$ he
pi }*7цCGutrGkėFC6GތgQ&Vt/s vX7FnMރ*t _'#lJ
"6 L?¸<'/SG|cI_̛|:?a-Ӓ@A$~)7`_ &z;gD0lc.>3ڟvHW
]i'( ו{ N\PwYWjTC{ sCa877't5 ZJk4A&/VTtI@Ve>d`];33q2&jW&XI1g+3u }] dAw;ck 3"}3~B8DXFx+4
8z N&
RC65U68y { T!Gb|'fNUw>v d&C'E V2y&Hh'fQ`]5h3%(V Jrg؉8X;("Yg[8BQaQ
+aB
WXX-A"Aʸ0ͨG|8c?{?7cVؘngd/Ȉ6X%m(A0v q؎8"HF) ٴ+xg1BM^PP_xrBȌ ّh . uU3ژ2v'ՍV8XWx8:lz=E.@SX9Φ,rAuXIT7<ӕۣR0"0^@B9D69]P NPRyT)Q V\ T0_ٕb N `[gnp
0tYv qwtnɗ|闂0oYT {~Mi
~ h(m'.n!JW#!UeOFN#ZHP;c V @eh||5|-qŠ`4`6*QGm '0Pw[Yj֥0vi/p<$y /w"<{o
r[0 W &x
@ ڨh?V
,*VBSD/]]A