Difference between revisions of "EclipseLink/FAQ/DBWS"

From Eclipsepedia

Jump to: navigation, search
(How are Oracle PL/SQL Records and Collections Handled?)
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== EclipseLink Database Web Services (DBWS) ==
+
__TOC__
 +
 
 +
== What is EclipseLink DBWS? ==
 +
 
 
===Overview===
 
===Overview===
 +
 
{{:EclipseLink/UserGuide/DBWS/Overview#EclipseLink_DBWS_Overview}}
 
{{:EclipseLink/UserGuide/DBWS/Overview#EclipseLink_DBWS_Overview}}
 
==== Design Documentation ====
 
[[EclipseLink/Development/DBWS|Design Docs]]
 
  
 
==== Who uses this feature? ====
 
==== Who uses this feature? ====
 +
 
Anyone who wishes to expose a database artifact as a Web Service.
 
Anyone who wishes to expose a database artifact as a Web Service.
  
Line 15: Line 17:
 
==== What technologies apply? ====
 
==== What technologies apply? ====
  
EclipseLink ORM, OXM, XRM, [http://jcp.org/en/jsr/detail?id=224 JAX-WS]
+
EclipseLink JPA/ORM, MOXy, [http://jcp.org/en/jsr/detail?id=224 JAX-WS]
 +
 
 +
== What version of JavaSE does DBWS support? ==
 +
 
 +
Using the EclipseLink DBWS design-time tools requires JDK 1.6 (or higher) while the DBWS runtime requires JDK 1.5 or higher.
 +
 
 +
== How are Oracle PL/SQL Records and Collections Handled? ==
 +
 
 +
Oracle PL/SQL Record and Collection types cannot be transported over JDBC.  To compensate for this, an anonymous block of PL/SQL code will be generated that contains functions responsible for converting to/from equivalent JDBC and PL/SQL types, based on the information passed to the DBWS Builder. In order for this to work, each PL/SQL record or collection type that will be an <tt>IN</tt>, <tt>IN OUT</tt>, <tt>OUT</tt> or <tt>RETURN</tt> argument (or any PL/SQL record/collection type nested within these) will need to have an equivalent JDBC type - the name of the type is expected to be in the form <tt><package name>_<type name></tt>.
 +
 
 +
For example, given the following PL/SQL Package:
 +
<source lang="plsql" enclose="div">
 +
CREATE OR REPLACE PACKAGE MYPKG AS
 +
  TYPE TBL1 IS TABLE OF VARCHAR2(111) INDEX BY BINARY_INTEGER;
 +
  TYPE ARECORD IS RECORD (
 +
    T1 TBL1,
 +
    T2 BOOLEAN
 +
  );
 +
  FUNCTION F1(FOO IN VARCHAR2) RETURN ARECORD;
 +
END MYPKG;
 +
</source>
 +
 
 +
The following equivalent JDBC types are required:
 +
<source lang="plsql" enclose="div">
 +
CREATE OR REPLACE TYPE MYPKG_TBL1 AS TABLE OF VARCHAR2(111)
  
Using the EclipseLink DBWS design-time tools requires JDK 1.6 (or higher).
+
CREATE OR REPLACE TYPE MYPKG_ARECORD AS OBJECT (
 +
  T1 MYPKG_TBL1,
 +
  T2 BOOLEAN
 +
)
 +
</source>
  
[[Category:EclipseLink FAQ|DBWS,X-R, XRM]]
+
[[Category:EclipseLink FAQ|DBWS]]

Latest revision as of 14:36, 25 July 2012

Contents


[edit] What is EclipseLink DBWS?

[edit] Overview

For the current version, see: Developing Persistence Architectures Using EclipseLink Database Web Services, Release 2.4

For EclispeLink DBWS Overview, see http://www.eclipse.org/eclipselink/documentation/2.4/dbws/overview.htm

[edit] Who uses this feature?

Anyone who wishes to expose a database artifact as a Web Service.

[edit] Why do they use it?

EclipseLink DBWS provides a simple light-weight metadata model that requires no Java programming, yet is highly extensible.

[edit] What technologies apply?

EclipseLink JPA/ORM, MOXy, JAX-WS

[edit] What version of JavaSE does DBWS support?

Using the EclipseLink DBWS design-time tools requires JDK 1.6 (or higher) while the DBWS runtime requires JDK 1.5 or higher.

[edit] How are Oracle PL/SQL Records and Collections Handled?

Oracle PL/SQL Record and Collection types cannot be transported over JDBC. To compensate for this, an anonymous block of PL/SQL code will be generated that contains functions responsible for converting to/from equivalent JDBC and PL/SQL types, based on the information passed to the DBWS Builder. In order for this to work, each PL/SQL record or collection type that will be an IN, IN OUT, OUT or RETURN argument (or any PL/SQL record/collection type nested within these) will need to have an equivalent JDBC type - the name of the type is expected to be in the form <package name>_<type name>.

For example, given the following PL/SQL Package:

CREATE OR REPLACE PACKAGE MYPKG AS
  TYPE TBL1 IS TABLE OF VARCHAR2(111) INDEX BY BINARY_INTEGER;
  TYPE ARECORD IS RECORD (
    T1 TBL1,
    T2 BOOLEAN
  );
  FUNCTION F1(FOO IN VARCHAR2) RETURN ARECORD;
END MYPKG;

The following equivalent JDBC types are required:

CREATE OR REPLACE TYPE MYPKG_TBL1 AS TABLE OF VARCHAR2(111)

CREATE OR REPLACE TYPE MYPKG_ARECORD AS OBJECT (
  T1 MYPKG_TBL1,
  T2 BOOLEAN
)