Skip to main content
Jump to: navigation, search


< EclipseLink‎ | UserGuide‎ | DBWS
Revision as of 11:09, 8 December 2011 by (Talk | contribs) (XML-to-Relational Mapping (XRM))

EclipseLink DBWS

Mailing ListForumsIRCmattermost
OpenHelp WantedBug Day
Browse Source

EclipseLink DBWS Overview

EclipseLink DBWS provides Java EE-compliant, client-neutral access to relational database artifacts via a Web service. EclipseLink DBWS extends EclipseLink's core capabilities while leveraging its existing ORM and OXM components.

XML-to-Relational Mapping (XRM)

EclipseLink's ORM and OXM features provides the basis for a powerful bridge between a database's relational structure(s) and XML's hierarchical structure.
EclipseLink DBWS includes two parts

  • DBWSBuilder command-line utility - while some of the deployment artifacts can be created manually, it is much simpler to use the DBWSBuilder utility to generate them.
  • A Runtime Provider component that takes a service descriptor (along with related deployment artifacts) and realizes it as a JAX-WS 2.0 Web service. The runtime provider uses EclipseLink to bridge between the database and the XML SOAP Messages used by Web service clients.

An EclipseLink DBWS service may include any number of the following operations:

  1. insert - inserts into the database persistent entities described by an XML document.
  2. update - updates database persistent entities described by an XML document.
  3. delete - removes from the database persistent entities described by an XML document.
  4. query - retrieves from the database persistent entities described by an XML document.
    Selection criteria for Query operations can be specified by:
    • custom SQL SELECT statement
    • Stored Procedure invocation
    • EclipseLink Named Query: can use the complete range of EclipseLink ORM Expression Framework APIs


A typical EclipseLink DBWS service is packaged in an archive (.jar or .war file) with a service descriptor file in the META-INF directory (or WEB-INF/classes/META-INF when packaged in a .war file). To bridge the relational database and XML worlds, an EclipseLink sessions.xml file points to two Eclipse projects - one for the ORM side, the other for the OXM side. The service also requires an XML Schema Definition file (.xsd) which in conjunction with the OXM project, specifies how information from the database is to be 'shaped' into XML.

eclipselink-dbws-sessions.xml -- name can be overriden by <sessions-file> entry in eclipselink-dbws.xml
EclipseLink DBWS Service descriptor file

The EclipseLink DBWS Service descriptor file (eclipselink-dbws.xml) is easy to read with minimum required information and simple defaults for omitted fields. The service descriptor file is described in the User Guide.

<dbws xmlns:xsi="" xmlns:xsd="">
    <sql><!--[CDATA[select count(*) from EMP]]--></sql>
EclipseLink DBWS Service sessions.xml file

The EclipseLink DBWS Service sessions.xml file (eclipselink-dbws-sessions.xml) is described in the User Guide.

EclipseLink DBWS mapping files

The EclipseLink DBWS Service mapping files (eclipselink-dbws-or.xml,eclipselink-dbws-ox.xml) are described in the User Guide.

EclipseLink DBWS Service schema file

The EclipseLink DBWS Service schema file (eclipselink-dbws-schema.xsd) can be created by hand, or auto-generated by the DBWSBuilder utility which derives XML element-tag names from Database metadata (column names, types, nullable, etc).

Simple XML Format (SXF)

The DBWSBuilder utility will not generate a schema file when the information returned by a query operation has no pre-determined structure:

  • a resultSet from a custom SQL query operation
  • the results from a Stored Procedure query operation
  • the row-count from an update operation

In these cases, the EclipseLink DBWS runtime provider uses the resultSet's metadata to build the XML element tag names:

ResultSetMetaData rsmd = rs.getMetaData();
int colcount = rsmd.getColumnCount();
for (int i=1; i <= colcount; i++) {
    String elementName = rsmd.getColumnName(i).toLower(); //empno, ename, job ...

These XML documents are 'dumb' as they cannot be validated against a schema - or more accurately, only the following very permissive 'sequence-of-any' schema can validate such documents:

Simple XML Format Schema
<xsd:schema xmlns:xsd="">
  <xsd:complextype name="simple-xml-format">
      <xsd:any minoccurs="0"></xsd:any>

The element tags simple-xml-format and simple-xml can be customized by setting the appropriate properties on an operation

Back to the top