|
|
| (99 intermediate revisions by 3 users not shown) |
| Line 1: |
Line 1: |
| − | <div style="float:right;border:1px solid #000000;padding:5px;max-width:475px;">__TOC__
| + | [[Image:Elug draft icon.png]] '''For the latest EclipseLink documentation, please see http://www.eclipse.org/eclipselink/documentation/ ''' |
| − | [[Special:Whatlinkshere/Creating Deployment Files for EclipseLink Database Web Services (ELUG)|Related Topics]]</div> | + | |
| | | | |
| − | ==Creating Deployment Files for an EclipseLink Database Web Service (DBWS) ==
| + | For the latest EclipseLink DBWS documentation, see |
| − | This section describes how to automatically generate a WAR file containing the EclipseLink DBWS service descriptor along with all deployment artifacts that a JAX-WS 2.x compliant-Web services (DBWS) requires (WSDL, XML schema files, web.xml, EclipseLink ORM and OXM native Project XML files).
| + | '''[http://www.eclipse.org/eclipselink/documentation/2.4/dbws/toc.htm Developing Persistence Architectures Using EclipseLink Database Web Services, Release 2.4]''' |
| | | | |
| − | This section describes the following:
| |
| − | *[[#How to Create Deployment Files for an EclipseLink DBWS Using DBWSBuilder|How to Create Deployment Files for an EclipseLink DBWS Using DBWSBuilder]]
| |
| − | *[[#How to Customize an EclipseLink DBWS Using Java|How to Customize an EclipseLink DBWS Using Java]]
| |
| − | *[[#How to Customize an EclipseLink DBWS Using Project or Sessions XML Files|How to Customize an EclipseLink DBWS Using Project or Sessions XML Files]]
| |
| − | *[[#What You May Need to Know About Creating Deployment Files for an EclipseLink DBWS|What You May Need to Know About Creating Deployment Files for an EclipseLink DBWS]]
| |
| − | *[[#Binding|Binding]]
| |
| − | *[[#DBWSBuilder|DBWSBuilder]]
| |
| | | | |
| − | ===How to Create Deployment Files for an EclipseLink DBWS Using DBWSBuilder===
| + | <b>Note: A basic overview of EclipseLink Database Web Services (DBWS) can be found</b> [[EclipseLink/FAQ/WhatIsDBWS|here]] |
| − | You can use the EclipseLink DBWS design-time tool <tt>DBWSBuilder</tt> to create deployment files. DBWSBuilder is a Java application that processes the operations described in an EclipseLink DBWS builder XML file (see [[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>.sh</tt> file) before invoking DBWSBuilder:
| + | |
| − | *$JAVA_HOME
| + | |
| − | *$DRIVER_CLASSPATH
| + | |
| − | There are script files provided for invoking the DBWSBuilder. 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.
| + | |
| − | | + | |
| − | <blockquote style="padding:4px;border:1px solid black;">
| + | |
| − | <code>DBWSBuilder usage ([] indicates optional argument):<br>
| + | |
| − | prompt> dbwsbuilder.cmd -builderFile {path_to_builder.xml} -stageDir {path_to_stageDir} -packageAs[:archive_flag] {packager} [additional arguments]<br>
| + | |
| − | Available packagers:<br>
| + | |
| − | -packageAs:[default=not supported] jdev<br>
| + | |
| − | -packageAs:[default=archive] javase [jarFilename]<br>
| + | |
| − | -packageAs:[default=archive] wls [warFilename]<br>
| + | |
| − | </code>
| + | |
| − | </blockquote>
| + | |
| − | | + | |
| − | Using DBWSBuilder, you can generate an EclipseLink DBWS from the following sources:
| + | |
| − | *an existing relational database table;
| + | |
| − | *one or more SQL statements written with respect to an existing relational database schema;
| + | |
| − | *a stored procedure.
| + | |
| − | | + | |
| − | To create deployment files for your EclipseLink DBWS , do the following:
| + | |
| − | #Create the table in your relational database and ensure that the relational database management system is online.
| + | |
| − | #Execute DBWSBuilder. Optionally, specify a SessionCustomizer class name using the DBWSBuilder property '''orSessionCustomizerClassName''' (if you are customizing the EclipseLink object-relational mappings), or '''oxSessionCustomizerClassName''' (when customizing the EclipseLink XML mappings).
| + | |
| − | #Package and deploy the EclipseLink DBWS.
| + | |
| − | | + | |
| − | ====Using the EclipseLink DBWS builder XML File to Create Deployment Files for a Eclipselink DBWS from a Database Table====
| + | |
| − | <source lang="xml">
| + | |
| − | <?xml version="1.0" encoding="UTF-8"?>
| + | |
| − | <dbws-builder xmlns:xsd="http://www.w3.org/2001/XMLSchema"
| + | |
| − | <properties>
| + | |
| − | <property name="projectName">crud</property>
| + | |
| − | <property name="logLevel">off</property>
| + | |
| − | <property name="url">jdbc:oracle:thin:@localhost:1521:ORCL</property>
| + | |
| − | <property name="driver">oracle.jdbc.OracleDriver</property>
| + | |
| − | <property name="dataSource">jdbc/DBWSPoolDS</property>
| + | |
| − | <property name="username">scott</property>
| + | |
| − | <property name="password">tiger</property>
| + | |
| − | <property name="platformClassname">eclipselink.platform.database.oracle.Oracle10Platform</property>
| + | |
| − | </properties>
| + | |
| − | <table
| + | |
| − | catalogPattern="%"
| + | |
| − | tableNamePattern="XR_CRUD_TABLE"
| + | |
| − | />
| + | |
| − | </dbws-builder>
| + | |
| − | </source>
| + | |
| − | | + | |
| − | ===Using the EclipseLink DBWS builder XML File to Create Deployment Files for a Eclipselink DBWS from SQL ===
| + | |
| − | <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">employee</property>
| + | |
| − | <property name="driver">oracle.jdbc.OracleDriver</property>
| + | |
| − | <property name="url">jdbc:oracle:thin:@localhost:1521:ORCL</property>
| + | |
| − | <property name="username">scott</property>
| + | |
| − | <property name="password">tiger</property>
| + | |
| − | </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>
| + | |
| − | | + | |
| − | For more information, see [[EclipseLink DBWS builder XML File (ELUG)#What You May Need to Know About Builder Operations|What You May Need to Know About Builder Operations]].
| + | |
| − | | + | |
| − | ====Using the EclipseLink DBWS builder XML File to Create Deployment Files for a Eclipselink DBWS from a Stored Procedure====
| + | |
| − | <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">employee</property>
| + | |
| − | <property name="driver">oracle.jdbc.OracleDriver</property>
| + | |
| − | <property name="url">jdbc:oracle:thin:@localhost:1521:ORCL</property>
| + | |
| − | <property name="username">scott</property>
| + | |
| − | <property name="password">tiger</property>
| + | |
| − | </properties>
| + | |
| − | <procedure returnType="empType"
| + | |
| − | catalogPattern="SOME_PKG"
| + | |
| − | schemaPattern="SCOTT"
| + | |
| − | procedurePattern="GetEmployeeByEMPNO_DEPTNO"/>
| + | |
| − | </procedure>
| + | |
| − | </dbws-builder>
| + | |
| − | </source>
| + | |
| − | | + | |
| − | For more information, see [[EclipseLink DBWS builder XML File (ELUG)#What You May Need to Know About Builder Operations|What You May Need to Know About Builder Operations]].
| + | |
| − | | + | |
| − | ===How to Customize a Eclipselink DBWS Using Java===
| + | |
| − | You can customize an EclipseLink DBWS with an EclipseLink SessionCustomizer as follows:
| + | |
| − | <ol>
| + | |
| − | <li>Implement a '''org.eclipse.persistence.config.SessionCustomizer''', as the following example shows. <br>
| + | |
| − | <span id="Example 9-4"></span><br>
| + | |
| − | ''''' Implementing a SessionCustomizer '''''
| + | |
| − | <source lang="java">
| + | |
| − | import org.eclipse.persistence.config.SessionCustomizer;
| + | |
| − | import org.eclipse.persistence.sessions.Session;
| + | |
| − | import org.eclipse.persistence.sessions.DatabaseLogin;
| + | |
| − | | + | |
| − | public class MySessionCustomizer implements SessionCustomizer {
| + | |
| − | | + | |
| − | public void customize(Sesssion session) {
| + | |
| − | DatabaseLogin login = (DatabaseLogin)session.getDatasourceLogin();
| + | |
| − | login.setTransactionIsolation(DatabaseLogin.TRANSACTION_READ_UNCOMMITTED);
| + | |
| − | }
| + | |
| − | }
| + | |
| − | </source>
| + | |
| − | <br>
| + | |
| − | For more information, see [[#EclipseLink DBWS Customization]]. </li>
| + | |
| − | <li>Add the SessionCustomizer to the classpath. </li>
| + | |
| − | <li>Set the following environment variables:
| + | |
| − | *$JAVA_HOME
| + | |
| − | *$DRIVER_CLASSPATH
| + | |
| − | </li>
| + | |
| − | <li>Execute DBWSBuilder using the following command: <br>
| + | |
| − | <tt>
| + | |
| − | $ dbwsbuilder.cmd -builderFile (path to eclipselink dbws_builder.xml file) -stageDir {path to output directory} -packageAs (javase | jdev | wls)</tt>
| + | |
| − | <br>
| + | |
| − | When executing the DBWSBuilder, specify the SessionCustomizer class name using the DBWSBuilder property orSessionCustomizerClassName (if you are customizing the EclipseLink object-relational mappings), or
| + | |
| − | oxSessionCustomizerClassName (when customizing the EclipseLink XML mappings).
| + | |
| − | | + | |
| − | For more information, see the following:
| + | |
| − | *[[EclipseLink dbws-builder.xml File (ELUG)#eclipselink-dbws-builder.xml|EclipseLink dbws-builder.xml File]]
| + | |
| − | *[[#DBWSBuilder]]
| + | |
| − | *[[#EclipseLink Database Web Services WAR File]]
| + | |
| − | </li>
| + | |
| − | <li>Package and deploy the EclipseLink database Web service. </li>
| + | |
| − | </ol>
| + | |
| − | | + | |
| − | ====How to Customize an EclipseLink DBWS Using Project or Sessions XML Files====
| + | |
| − | You can customize an EclipseLink database Web service by creating your own '''project.xml''' and '''sessions.xml''' files, as follows:
| + | |
| − | <ol>
| + | |
| − | <li>Set the following environment variables:
| + | |
| − | *$JAVA_HOME
| + | |
| − | *$DRIVER_CLASSPATH
| + | |
| − | </li>
| + | |
| − | <li>Execute DBWSBuilder using the following command: <br>
| + | |
| − | <tt>
| + | |
| − | $ dbwsbuilder.cmd -builderFile (path to eclipselink dbws_builder.xml file) -stageDir {path to output directory} -packageAs (javase | jdev | wls)</tt>
| + | |
| − | | + | |
| − | This creates the necessary EclipseLink database Web service files and subdirectories.
| + | |
| − | | + | |
| − | For more information, see the following:
| + | |
| − | *[[#How to Create Deployment Files for an EclipseLink Database Web Service Using DBWSBuilder]]
| + | |
| − | *[[#DBWSBuilder]]
| + | |
| − | *[[EclipseLink dbws-builder.xml File (ELUG)#eclipselink-dbws-builder.xml|eclipselink-dbws-builder.xml]]
| + | |
| − | </li>
| + | |
| − | <li>Manually create your '''project.xml''' files and '''sessions.xml''' file using your tool of choice.
| + | |
| − | **Map your objects to your relational database in an EclipseLink relational project
| + | |
| − | **Map your objects to your XML schema in an EclipseLink XMl project</li>
| + | |
| − | <li>Add both projects to your session.
| + | |
| − | {| class="Note oac_no_warn" width="80%" border="1" frame="hsides" rules="groups" cellpadding="3" frame="hsides" rules="groups"
| + | |
| − | | align="left" |
| + | |
| − | '''Note''': Your custom sessions.xml file must use the same name as specified by the DBWSBuilder property sessionsFileName (see [[#Table 9-4|eclipselink-dbws-builder.xml File Elements (DBWSBuilder Properties)]]).
| + | |
| − | |}
| + | |
| − | | + | |
| − | For more information, see the following:
| + | |
| − | *[[Introduction to Projects (ELUG)]]
| + | |
| − | *[[Introduction to EclipseLink Sessions (ELUG)]]
| + | |
| − | *[[#What You May Need to Know About Creating Deployment Files for an EclipseLink Database Web Service|What You May Need to Know About Creating Deployment Files for an EclipseLink Database Web Service]]
| + | |
| − | </li>
| + | |
| − | <li>Replace the generated project.xml files and sessions.xml file in your EclipseLink database Web services directory hierarchy with your custom project.xml files and sessions.xml files. </li>
| + | |
| − | <li>Execute DBWSBuilder. For more information, see the following:
| + | |
| − | **[[#DBWSBuilder|DBWSBuilder]]
| + | |
| − | **[[#EclipseLink Database Web Services WAR File|EclipseLink Database Web Services WAR File]]</li>
| + | |
| − | <li> Package and deploy the EclipseLink database Web service. </li>
| + | |
| − | </ol>
| + | |
| − | | + | |
| − | === What You May Need to Know About Creating Deployment Files for an EclipseLink Database Web Service ===
| + | |
| − | This figure illustrates the process for creating EclipseLink database Web service
| + | |
| − | deployment files.
| + | |
| − | | + | |
| − | ''''' Creating EclipseLink Database Web Service Deployment Files '''''
| + | |
| − | | + | |
| − | This illustration shows the process for creating EclipseLink database Web service deployment files. The EclipseLink database Web service design-time tool takes your XSD and database schema as input to generate from table, SQL, stored procedure, or package and create a WAR file containing an EclipseLink database Web service xr-service.xml file, an EclipseLink database Web service WSDL file, EclipseLink object-relational and XML '''project.xml''' files, and EclipseLink '''sessions.xml''' file.
| + | |
| − | | + | |
| − | This section describes the following:
| + | |
| − | *EclipseLink Database Web Services WAR File
| + | |
| − | *Unstructured Data
| + | |
| − | *EclipseLink Database Web Services Customization
| + | |
| − | | + | |
| − | For more information, see the following:
| + | |
| − | *[[Introduction to EclipseLink (ELUG)#Considering EclipseLink Database Web Service Architecture|Considering EclipseLink Database Web Service Architecture]]
| + | |
| − | *[[EclipseLink dbws-builder.xml File (ELUG)#eclipselinlk-dbws.xml File|eclipselinlk-dbws.xml File]].
| + | |
| − | | + | |
| − | | + | |
| − | ===== EclipseLink Database Web Services WAR File =====
| + | |
| − | When you generate an EclipseLink database Web service, all generated files are packaged into a WAR file, as this example shows. [[#Table 9-1|EclipseLink Database Web Service WAR File Contents]] lists the files in these WAR files.
| + | |
| − | | + | |
| − | <span id="Example 9-5"></span>
| + | |
| − | ''''' EclipseLink Database Web Services WAR File '''''
| + | |
| − | | + | |
| − | <tt>
| + | |
| − | | + | |
| − | root of WAR file
| + | |
| − | web-inf
| + | |
| − | web.xml
| + | |
| − | web-inf/
| + | |
| − | oracle-webservices.xml
| + | |
| − | web.xml
| + | |
| − | classes/
| + | |
| − | com/ // optional domain classes
| + | |
| − | acme/
| + | |
| − | Address.class
| + | |
| − | Employee.class
| + | |
| − | PhoneNumber.class
| + | |
| − | META-INF/
| + | |
| − | eclipselink-dbws.xml
| + | |
| − | eclipselink-dbws-sessions.xml // override eclipselink-dbws.xml sessions-file
| + | |
| − | eclipselink-dbws-or.xml
| + | |
| − | eclipselink-dbws-ox.xml
| + | |
| − | _dbws
| + | |
| − | DBWSProvider.class
| + | |
| − | DBWSProvider.java
| + | |
| − | wsdl/
| + | |
| − | eclipselink-dbws.wsdl
| + | |
| − | swaref.xsd // optional
| + | |
| − | eclipselink-dbws-schema.xsd
| + | |
| − | </tt>
| + | |
| − | | + | |
| − | | + | |
| − | <span id="Table 9-1"></span>
| + | |
| − | ''''' EclipseLink Database Web Service WAR File Contents '''''
| + | |
| − | | + | |
| − | {| class="RuleFormalWideMax" dir="ltr" title="EclipseLink Database Web Service WAR File Contents." width="100%" border="1" frame="border" rules="all" cellpadding="3" frame="border" rules="all"
| + | |
| − | |- 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" |
| + | |
| − | index.html
| + | |
| − | |
| + | |
| − | Default EclipseLink database Web service landing page. The name and content of this file is determined by its role in Web deployment and cannot be changed.
| + | |
| − | Applicable to all WAR files.
| + | |
| − | |-
| + | |
| − | |
| + | |
| − | swaref.xsd
| + | |
| − | |
| + | |
| − | Contains XML type definitions for attachments. The name and content of this file is determined by its role in Web deployment and cannot be changed.
| + | |
| − | |-
| + | |
| − | |
| + | |
| − | eclipselink-dbws-schema.xsd
| + | |
| − | |
| + | |
| − | Contains XML type definitions for operation arguments and return types. The EclipseLink database Web service automatically generates this file from your database table metadata and uses it to derive
| + | |
| − | element-tag names and types. For more information, see [[EclipseLink dbws-builder.xml File (ELUG)#eclipselink-dbws-schema.xsd|eclipselink-dbws-schema.xsd]].
| + | |
| − | |-
| + | |
| − | |
| + | |
| − | MANIFEST.MF
| + | |
| − | |
| + | |
| − | The manifest file for the WAR file.
| + | |
| − | |-
| + | |
| − | |
| + | |
| − | web.xml
| + | |
| − | |
| + | |
| − | The Web application deployment file that binds the EclipseLink database Web service to Web services stack servlet.
| + | |
| − | |-
| + | |
| − | |
| + | |
| − | eclipselink-dbws.xml
| + | |
| − | |
| + | |
| − | The EclipseLink database Web services configuration file. For more information, see [[EclipseLink dbws-builder.xml File (ELUG)#eclipselink-dbws.xml File|eclipselink-dbws.xml File]].
| + | |
| − | |-
| + | |
| − | |
| + | |
| − | eclipselink-dbws-sessions .xml
| + | |
| − | |
| + | |
| − | The EclipseLink sessions.xml file for this EclipseLink database Web service. It contains references to the EclipseLink relational and object-XML project.xml files. For more information, see [[Introduction to EclipseLink Sessions (ELUG)]].
| + | |
| − | |-
| + | |
| − | |
| + | |
| − | eclipselink-dbws-or.xml
| + | |
| − | |The EclipseLink relational '''project.xml''' file. For more information, see [[Introduction to Relational Projects (ELUG)]].
| + | |
| − | |-
| + | |
| − | |
| + | |
| − | eclipselink-dbws-ox.xml
| + | |
| − | |The EclipseLink object-XML '''project.xml''' file. For more information, see [[Introduction to XML Projects (ELUG)]].
| + | |
| − | |-
| + | |
| − | |
| + | |
| − | eclipselink-dbws.wsdl
| + | |
| − | |Contains equivalent entries for each operation for the specified EclipseLink database Web service. Required for deployment as a Web service.
| + | |
| − | |}
| + | |
| − | | + | |
| − | Before you can deploy the EclipseLink database Web service, you must package the WAR in the appropriate Java EE archive for your application, such as an EAR.
| + | |
| − | | + | |
| − | ===== Unstructured Data =====
| + | |
| − | In some circumstances, an EclipseLink database Web services operation may return unstructured data rather than a persistent entity. For example:
| + | |
| − | *a resultSet from a custom SQL SELECT statement;
| + | |
| − | *information returned by a Stored Procedure;
| + | |
| − | *scalar results such as from a Stored Function or a count of updated-rows from an update operation.
| + | |
| − | | + | |
| − | The OC4J Web services provider will return such unstructured data as documents that
| + | |
| − | conform to the Simple XML Format (SXF) schema shown in this example.
| + | |
| − | | + | |
| − | <span id="Example 9-6"></span>
| + | |
| − | '''''Simple XML Format XSD for Unstructured Data '''''
| + | |
| − | | + | |
| − | <source lang="xml">
| + | |
| − | <?xml version="1.0" encoding="UTF-8"?>
| + | |
| − | <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
| + | |
| − | <xsd:complexType name="sxfType">
| + | |
| − | <xsd:sequence>
| + | |
| − | <xsd:any minOccurs="0"/>
| + | |
| − | | + | |
| − | | + | |
| − | </xsd:sequence>
| + | |
| − | | + | |
| − | | + | |
| − | </xsd:complexType>
| + | |
| − | | + | |
| − | | + | |
| − | <xsd:element name="simple-xml-format" type="sxfType"/>
| + | |
| − | </xsd:schema>
| + | |
| − | </source>
| + | |
| − | | + | |
| − | The following example shows a typical unstructured data document. Note the following:
| + | |
| − | *Element tag names are direct copies of table column names.
| + | |
| − | *The default root-element tag name is simple-xml-format and each row uses the tag name simple-xml. You can customize these element tag names using simpleXMLFormatTagand xmlTag attributes of builder operations (see [[#Table 9-5|Common Attributes of Builder Operations]]).
| + | |
| − | *Columnar data uses tag names taken either from the database schema (the actual database column name) or from the stored procedure, stored function, or trigger.
| + | |
| − | | + | |
| − | | + | |
| − | <span id="Example 9-7"></span>
| + | |
| − | | + | |
| − | ''''' Example Unstructured Data Document '''''
| + | |
| − | <source lang="xml">
| + | |
| − | | + | |
| − | <simple-xml-format>
| + | |
| − | <simple-xml>
| + | |
| − | <ENAME>SCOTT</ENAME>
| + | |
| − | <JOB>ANALYST</JOB>
| + | |
| − | <MGR>7566</MGR>
| + | |
| − | <HIREDATE>1987-04-19T00:00:00.000-0400</HIREDATE>
| + | |
| − | <SAL>3000</SAL>
| + | |
| − | <DEPTNO>20</DEPTNO>
| + | |
| − | </simple-xml>
| + | |
| − | <simple-xml>
| + | |
| − | <ENAME>SMITH</ENAME>
| + | |
| − | <JOB>CLERK</JOB>
| + | |
| − | <MGR>7902</MGR>
| + | |
| − | <HIREDATE>1980-12-17T00:00:00.000-0400</HIREDATE>
| + | |
| − | <SAL>800</SAL>
| + | |
| − | <DEPTNO>20</DEPTNO>
| + | |
| − | </simple-xml>
| + | |
| − | | + | |
| − | | + | |
| − | </simple-xml-format>
| + | |
| − | </source>
| + | |
| − | | + | |
| − | | + | |
| − | ===== EclipseLink Database Web Services Customization =====
| + | |
| − | To customize an EclipseLink database Web service, you can do the following:
| + | |
| − | *Implement an EclipseLink SessionCustomizer class.
| + | |
| − | <blockquote>
| + | |
| − | A SessionCustomizer is a Java class that implements the eclipselink.tools.sessionconfiguration.SessionCustomizer interface and provides a default (zero-argument) constructor.
| + | |
| − | | + | |
| − | Use this class's customizemethod, which takes an eclipselink.sessions.Session, to programmatically access advanced EclipseLink session API. Using this API you can get object relational and XML descriptors and from descriptors, you can get object relational and XML mappings.
| + | |
| − | | + | |
| − | In this way, you can access all session, descriptor, and mapping API to customize any part of the EclipseLink runtime that the EclipseLink database Web service generates. For example, to turn off the session cache. This approach is best when you just want to customize a few details.
| + | |
| − | | + | |
| − | You specify the SessionCustomizerusing DBWSBuilder properties (see [[EclipseLink dbws-builder.xml File (ELUG)#eclipselink-dbws-builder.xml|eclipselink-dbws-builder.xml]] and [[#DBWSBuilder]]).
| + | |
| − | | + | |
| − | By default, the session names are defined based on the eclipselink-dbws.xml
| + | |
| − | file (see [[EclipseLink dbws-builder.xml File (ELUG)#eclipselink-dbws.xml File|eclipselink-dbws.xml File]]) name attribute as follows:
| + | |
| − | *relational session name: name-dbws-or-session
| + | |
| − | *object-xml session name: name-dbws-ox-session
| + | |
| − | </blockquote>
| + | |
| − | *Manually generate project.xml files and sessions.xml file.
| + | |
| − | <blockquote>
| + | |
| − | 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.xmlfile 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.
| + | |
| − | | + | |
| − | </blockquote>
| + | |
| − | | + | |
| − | | + | |
| − | === Binding ===
| + | |
| − | The binding nested element of the sqlbuilder operation is an EclipseLink database Web services function that you use to bind an argument in an SQL statement to an XSD data type (see [[#Table 9-8|Attributes of the sql Operation]]). You define this element in the eclipselink-dbws-build.xml file (see [[#Example 9-5|eclipselink-dbws-build.xml File]]).
| + | |
| − | | + | |
| − | | + | |
| − | <span id="Table 9-2"></span>
| + | |
| − | ''''' Attributes of the binding Element '''''
| + | |
| − | | + | |
| − | Attribute Description Required
| + | |
| − | name The name of the stored procedure, stored function, or trigger to execute. The parent
| + | |
| − | builder operation specifies the database that provides the stored procedure, stored
| + | |
| − | function, or trigger.
| + | |
| − | Yes
| + | |
| − | type The XSD data type to bind to the argument name. Yes
| + | |
| − | | + | |
| − | | + | |
| − | This example shows a typical sql operation that specifies arguments using nested bindingelements. The order in which you define bindingelements must match the order of the arguments in your SQL statement.
| + | |
| − | | + | |
| − | <span id="Example 9-8"></span>
| + | |
| − | ''''' SQLOperation Task: With Binding Elements for Arguments '''''
| + | |
| − | | + | |
| − | <source lang="xml">
| + | |
| − | ...
| + | |
| − | | + | |
| − | | + | |
| − | <sql name="findXREmpByName" isCollection="true" returnType="xr_empType">
| + | |
| − | <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>
| + | |
| − | ...
| + | |
| − | </source>
| + | |
| − | | + | |
| − | For more information, see [[EclipseLink dbws-builder.xml File (ELUG)#eclipselink-dbws-builder.xml|eclipselink-dbws-builder.xml]].
| + | |
| − | | + | |
| − | === DBWSBuilder ===
| + | |
| − | The EclipseLink database Web service design-time tool, DBWSBuilder, is a Java application that produces EclipseLink database Web service files and assembles them into a Web Archive (WAR) file.
| + | |
| − | | + | |
| − | You set the DBWSBuilder’s properties (see [[EclipseLink dbws-builder.xml File (ELUG)#Table 9-4|eclipselink-dbws-builder.xml File Elements (DBWSBuilder Properties)]]) to define features of your EclipseLink database Web service.
| + | |
| − | | + | |
| − | You can also set the design-time tool’s properties, add table and procedure definitions, and SQL operations programmatically through the API. Use the eclipselink.tools.dbws.DBWSBuilder class’s methods such as setDriver, setProjectName, setURL, and so on, to set properties; the addDbTableand addDbStoredProceduremethods-to add table and procedure definitions; and the addSQLOperation method-to add SQL operations.
| + | |
| − | | + | |
| − | {| class="Note oac_no_warn" width="80%" border="1" frame="hsides" rules="groups" cellpadding="3" frame="hsides" rules="groups"
| + | |
| − | | align="left" |
| + | |
| − | '''Note''': Before adding a table or procedure definition, ensure that the definitions are supported by calling the checkTablesand checkStoredProcedures methods.
| + | |
| − | |}
| + | |
| − | | + | |
| − | Once you set all the data and definitions, invoke the builder using its build method.
| + | |
| − | | + | |
| − | | + | |
| − | | + | |
| − | | + | |
| − | ----
| + | |
| − | ''[[EclipseLink User's Guide Copyright Statement|Copyright Statement]]''
| + | |
| − | | + | |
| − | | + | |
| − | [[Category: EclipseLink User's Guide]]
| + | |
| − | [[Category: Release 1.1]]
| + | |
| − | [[Category: DBWS]]
| + | |
For the latest EclipseLink documentation, please see http://www.eclipse.org/eclipselink/documentation/