Jump to: navigation, search

Difference between revisions of "EclipseLink/UserGuide/DBWS/Creating EclipseLink DBWS Services (ELUG)"

(Creating EclipseLink DBWS Services)
m (Replacing page with 'Image:Elug draft icon.png '''For the latest EclipseLink documentation, please see http://www.eclipse.org/eclipselink/documentation/ ''' For the latest EclipseLink DBWS doc...')
 
(19 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<b>Note: A basic overview of EclipseLink Database Web Services (DBWS) can be found</b> [[EclipseLink/FAQ/WhatIsDBWS|here]]
+
[[Image:Elug draft icon.png]] '''For the latest EclipseLink documentation, please see http://www.eclipse.org/eclipselink/documentation/ '''
__TOC__
+
  
==Creating EclipseLink DBWS Services==
+
For the latest EclipseLink DBWS documentation, see
This section describes how to automatically generate a <tt>.war</tt> file containing the EclipseLink DBWS service descriptor along with all required deployment artifacts for a JAX-WS 2.0 Web service (WSDL, XML schema, web.xml, EclipseLink ORM and OXM native Project XML files, etc.)
+
'''[http://www.eclipse.org/eclipselink/documentation/2.4/dbws/toc.htm Developing Persistence Architectures Using EclipseLink Database Web Services, Release 2.4]'''
<onlyinclude>
+
<source lang="text" enclose="div">
+
root of war file
+
    \---web-inf
+
    |
+
    |  web.xml
+
    |
+
    +---classes
+
    |  +---foo                              -- optional domain classes (typically not required)
+
    |  |  \---bar                             
+
    |  |          Address.class
+
    |  |          Employee.class
+
    |  |          PhoneNumber.class
+
    |  |
+
    |  +---META-INF
+
    |  |      eclipselink-dbws.xml
+
    |  |      eclipselink-dbws-or.xml
+
    |  |      eclipselink-dbws-ox.xml
+
    |  |      eclipselink-dbws-sessions.xml -- name can be overridden by <sessions-file> entry in eclipselink-dbws.xml
+
    |  |
+
    |  \---_dbws
+
    |          DBWSProvider.class            -- auto-generated JAX-WS 2.0 Provider
+
    |
+
    \---wsdl
+
            eclipselink-dbws-schema.xsd
+
            eclipselink-dbws.wsdl
+
            swaref.xsd                               
+
</source>
+
{| class="RuleFormalWideMax" dir="ltr" title="<b>EclipseLink DBWS Service <code>.war</code> File Contents</b>" width="100%" border="1" frame="border" rules="all" cellpadding="3" frame="border" rules="all"
+
|+ <b>EclipseLink DBWS Service <code>.war</code> File Contents</b>
+
|- align="left" valign="top"
+
! id="r1c1-t2" align="left" valign="bottom" | '''File'''
+
! id="r1c2-t2" align="left" valign="bottom" | '''Description'''
+
|- align="left" valign="top"
+
| align="left" |
+
|-
+
|<tt>web.xml</tt>
+
|The Web application deployment file (required for deployment as a JAX-WS Web service)
+
|-
+
|<tt>eclipselink-dbws.xml</tt>
+
|[[EclipseLink/UserGuide/DBWS/Overview/EclipseLink_DBWS_Service_Descriptor_File_(ELUG)|The EclipseLink DBWS service descriptor file]]<br/>(described in full in the User Guide)
+
|-
+
|<tt>eclipselink-dbws-or.xml</tt>
+
|The EclipseLink ORM Project XML file.<br/>For more information, see [[Introduction to Relational Projects (ELUG)]]
+
|-
+
|<tt>eclipselink-dbws-ox.xml</tt>
+
|The EclipseLink OXM Project XML file.<br/>For more information, see [[Introduction to XML Projects (ELUG)]]
+
|-
+
|<tt>eclipselink-dbws-sessions.xml</tt>
+
|The EclipseLink sessions.xml file for the EclipseLink DBWS service.<br/>It contains references to the EclipseLink ORM and OXM Project XML files.<br/>For more information, see [[Introduction to EclipseLink Sessions (ELUG)]]
+
|-
+
|<tt>eclipselink-dbws-schema.xsd</tt>
+
|Contains XML type definitions for operation arguments and return types.<br/>The <tt>DBWSBuilder</tt> utility automatically generates this file from database<br/>metadata to derive element-tag names and types
+
|-
+
|<tt>eclipselink-dbws.wsdl</tt>
+
|Contains entries for all operations in the EclipseLink DBWS service.<br/>required for deployment as a JAX-WS Web service
+
|-
+
|<tt>swaref.xsd</tt>
+
|(optional) Contains XML type definitions for SOAP attachments
+
|-
+
|}
+
NB - the files <tt>swaref.xsd</tt> and <tt>web.xml</tt> have names and content determined by their roles in web deployment and cannot be changed.
+
</onlyinclude>
+
The deployable <tt>.war</tt> file has been verified to work with the [http://www.oracle.com/technology/software/products/ias/htdocs/wls_main.html?rssid=rss_otn_soft Oracle WebLogic Server 10.3 JavaEE container].
+
  
An alternate deployable <tt>.jar</tt> file has been verified to work as a JavaSE 6 'container-less' [http://java.sun.com/javase/6/docs/api/javax/xml/ws/Endpoint.html EndPoint] (please see <br /> the example <i>[[EclipseLink/Examples/DBWS/AdvancedJavase6Containerless|EclipseLink DBWS Service deployed as a JavaSE 6 'containerless' EndPoint]]</i> for more details).
 
  
This section describes the following:
+
<b>Note: A basic overview of EclipseLink Database Web Services (DBWS) can be found</b> [[EclipseLink/FAQ/WhatIsDBWS|here]]
*[[#How to Create EclipseLink DBWS Services Using the DBWSBuilder utility|How to Create EclipseLink DBWS Services Using the <tt>DBWSBuilder</tt> utility]]
+
*[[#How to Customize an EclipseLink DBWS Service|How to Customize an EclipseLink DBWS Service]]
+
*[[#How to Use DBWSBuilder an an API|How to Use <tt>DBWSBuilder</tt> an an API]]
+
 
+
===Creating EclipseLink DBWS Services Using the <tt>DBWSBuilder</tt> utility===
+
You can use the EclipseLink DBWS design-time tool <tt>DBWSBuilder</tt> to create deployment files. <tt>DBWSBuilder</tt> is a Java application that processes the operations described in an [[EclipseLink dbws-builder.xml File (ELUG)#eclipselink-dbws-builder.xml|EclipseLink DBWS builder XML file]] to produce all the required deployment artifacts.
+
 
+
Be sure to set the following environment variables in the <tt><ECLIPSELINK_HOME>\utils\dbws\setenv.cmd</tt> (or <tt>setenv.sh</tt> file) before invoking <tt>DBWSBuilder</tt>:
+
*$JAVA_HOME
+
*$DRIVER_CLASSPATH
+
There are script files provided for invoking <tt>DBWSBuilder</tt>. They are located in <tt><ECLIPSELINK_HOME>\utils\dbws</tt>. The scripts are '''dbwsbuilder.cmd''' for Windows usage and '''dbwsbuilder.sh''' for other operating systems.
+
<source lang="text">
+
DBWSBuilder usage - [] indicates optional argument:
+
prompt > dbwsbuilder.cmd -builderFile {path_to_builder.xml} -stageDir {path_to_stageDir} -packageAs[:archive_flag] {packager} [additional args]
+
Available packagers:
+
  -packageAs:[default=archive] javase [jarFilename]
+
  -packageAs:[default=archive] wls [warFilename]
+
</source>
+
 
+
Using <tt>DBWSBuilder</tt>, you can generate an EclipseLink DBWS service from the following sources:
+
*an existing relational database table;
+
*one or more SQL <tt>SELECT</tt> statements;
+
*a stored procedure.
+
 
+
====Creating an EclipseLink DBWS Service from a Database Table====
+
Create an EclipseLink DBWS builder XML File with a <tt>&lt;table&gt;</tt> <b>query operation</b>:
+
<span id="Example 9-1"></span>
+
<source lang="xml">
+
<?xml version="1.0" encoding="UTF-8"?>
+
<dbws-builder xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+
  <properties>
+
    <property name="projectName">table_test</property>
+
    ... database properties ...
+
  </properties>
+
  <table
+
    schemaPattern="%"
+
    tableNamePattern="dbws_crud"
+
  />
+
</dbws-builder>
+
</source>
+
For more information, see the basic example [[EclipseLink/Examples/DBWS/DBWSBasicTable| Creating EclipseLink DBWS Service based on Database Table]].
+
 
+
====Creating an EclipseLink DBWS Service from a SQL statement====
+
Create an EclipseLink DBWS builder XML File with a <tt>&lt;sql&gt;</tt> <b>query operation</b>:
+
<span id="Example 9-2"></span>
+
<source lang="xml">
+
<?xml version="1.0" encoding="UTF-8"?>
+
<dbws-builder xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+
  <properties>
+
    <property name="projectName">sql_test</property>
+
    ... database properties ...
+
  </properties>
+
  <sql name="employeeInfo" simpleXMLFormatTag="employee-info" xmlTag="aggregate-counts">
+
    <text>
+
      <![CDATA[select count(*) as "COUNT", max(SAL) as "MAX-Salary" from EMP]]>
+
    </text>
+
  </sql>
+
</dbws-builder>
+
</source>
+
=====Parameter Binding=====
+
The SQL <tt>SELECT</tt> statement for a <tt>&lt;sql&gt;</tt> operation may have parameters that must be bound to a datatype from the <b><tt>eclipselink-dbws-schema.xsd</tt></b>, or to any of the basic XSD datatypes. The SQL <tt>SELECT</tt> string uses JDBC-style '?' markers to indicate the position of the argument. The <tt>&lt;sql&gt;</tt> operation uses nested <tt>&lt;binding&gt;</tt> elements to match the datatype to the parameters. The order in which <tt>&lt;binding&gt;</tt> elements are defined must match the order of '?' markers in the SQL string:
+
<source lang="xml">
+
<?xml version="1.0" encoding="UTF-8"?>
+
<dbws-builder xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+
  <properties>
+
    <property name="projectName">sql_binding_test</property>
+
    ... database properties ...
+
  </properties>
+
  <sql name="findEmpByName" isCollection="true" isSimpleXMLFormat="true"> 
+
    <text>
+
      <![CDATA[select * from EMP where EMPNO = ? and LAST_NAME = ?]]>
+
    </text>
+
    <binding name="EMPNO" type="xsd:int"/>
+
    <binding name="LAST_NAME" type="xsd:string"/>
+
  </sql>
+
</dbws-builder>
+
</source>
+
The argument named <tt>"EMPNO"</tt> is bound to an integer type while the argument named <tt>"LAST_NAME"</tt> is bound to a string type.
+
<br />
+
For more information, see the basic example [[EclipseLink/Examples/DBWS/DBWSBasicSQL|Creating EclipseLink DBWS Service based on Results Sets from custom SQL <code>SELECT</code> statements]].
+
 
+
====Creating an EclipseLink DBWS Service from a Stored Procedure====
+
Create an EclipseLink DBWS builder XML File with a <tt>&lt;procedure&gt;</tt> <b>query operation</b>:
+
<span id="Example 9-3"></span>
+
<source lang="xml">
+
<?xml version="1.0" encoding="UTF-8"?>
+
<dbws-builder xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+
  <properties>
+
    <property name="projectName">procedure_test</property>
+
    ... database properties ...
+
    </properties>
+
  <procedure
+
    returnType="empType"
+
    catalogPattern="SOME_PKG"
+
    schemaPattern="SCOTT"
+
    procedurePattern="GetEmployeeByEMPNO_DEPTNO"/>
+
  </procedure>
+
</dbws-builder>
+
</source>
+
For more information, see the basic example [[EclipseLink/Examples/DBWS/DBWSBasicStoredProcedure|Creating EclipseLink DBWS Service based on Stored Procedure]].
+
 
+
==Customizing an EclipseLink DBWS Service==
+
There are a number use-cases that require an EclipseLink DBWS Service to be customized. The use-cases can be sub-divided into
+
* simple - changing an &lt;element-tag&gt; to an "attribute"
+
* intermediate - customizing the EclipseLink ORM or OXM Projects
+
* advanced - hand-generating all required deployment artifacts
+
 
+
===Simple customization===
+
See the example [[EclipseLink/Examples/DBWS/DBWSIntermediateAttribute|Changing an &lt;element-tag&gt; to an "attribute"]]
+
 
+
===Intermediate customization===
+
The primary reason to use an EclipseLink SessionCustomizer is to enable programmatic access to the EclipseLink API. Using this API, one can retrieve the ORM or OXM descriptors from the session, and from these descriptors add, change or delete mappings. Other examples might be to
+
turn off the session cache or change the transation isolation level of the database connection:
+
 
+
Implement a <code><b>org.eclipse.persistence.config.SessionCustomizer</b></code>:
+
<source lang="java5">
+
package some.java.package;
+
 
+
import org.eclipse.persistence.config.SessionCustomizer;
+
import org.eclipse.persistence.sessions.Session;
+
import org.eclipse.persistence.sessions.DatabaseLogin;
+
 
+
public class MySessionCustomizer implements SessionCustomizer {
+
 
+
  public MySessionCustomizer() {
+
  }
+
 
+
  public void customize(Sesssion session) {
+
    DatabaseLogin login = (DatabaseLogin)session.getDatasourceLogin();
+
    login.setTransactionIsolation(DatabaseLogin.TRANSACTION_READ_UNCOMMITTED);
+
  }
+
}
+
</source>
+
In the <tt>DBWSBuilder</tt> builder XML file, specify if the customization applies to the ORM Project or the OXM Project:
+
<source lang="xml">
+
<?xml version="1.0" encoding="UTF-8"?>
+
<dbws-builder xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+
  <properties>
+
    <property name="projectName">customize_test</property>
+
    ...
+
    <property name="orSessionCustomizerClassName">some.java.package.MyORSessionCustomizer</property>
+
</source>
+
or
+
<source lang="xml">
+
<?xml version="1.0" encoding="UTF-8"?>
+
<dbws-builder xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+
  <properties>
+
    <property name="projectName">customize_test</property>
+
    ...
+
    <property name="oxSessionCustomizerClassName">some.java.package.MyOXSessionCustomizer</property>
+
</source>
+
For more details, please see the [[Introduction to EclipseLink Sessions (ELUG)#Session_Customization|Session Customization section]] in the User Guide.
+
 
+
===Advanced customization===
+
You can customize an EclipseLink DBWS service by creating your own '''project.xml''' and '''sessions.xml''' files.
+
Using your preferred tool you can map your objects to your relational database in an EclipseLink relational project, map your objects to your XML schema in an EclipseLink XMl project, and create an EclipseLink sessions.xml file that references both projects.
+
In this way, you can control all aspects of the relational and XML mapping. This approach is best when you want to customize most or all details. See the advanced example [[EclipseLink/Examples/DBWS/ExistingMappingFiles|Creating EclipseLink DBWS Service based upon existing ORM and OXM Projects]].
+
 
+
==DBWSBuilder API==
+
The EclipseLink DBWS design-time utility, <tt>DBWSBuilder</tt>, is a Java application that generates EclipseLink DBWS files and assembles them into deployable archives. One can also set the <tt>DBWSBuilder</tt>’s properties, add table or procedure definitions and SQL operations programmatically through <tt>DBWSBuilder</tt>’s API.
+
 
+
More info pending
+
 
+
----
+
''[[EclipseLink User's Guide Copyright Statement|Copyright Statement]]''
+
 
+
 
+
[[Category: EclipseLink User's Guide]]
+
[[Category: Release 1.1]]
+
[[Category: DBWS]]
+

Latest revision as of 07:33, 14 August 2012

Elug draft icon.png For the latest EclipseLink documentation, please see http://www.eclipse.org/eclipselink/documentation/

For the latest EclipseLink DBWS documentation, see Developing Persistence Architectures Using EclipseLink Database Web Services, Release 2.4


Note: A basic overview of EclipseLink Database Web Services (DBWS) can be found here