Jump to: navigation, search

Difference between revisions of "EclipseLink/UserGuide/DBWS/Overview/Design time"

Line 8: Line 8:
 
== Creating EclipseLink DBWS Services using the DBWSBuilder utility ==
 
== Creating EclipseLink DBWS Services using the DBWSBuilder utility ==
 
The EclipseLink DBWS design-time utility <tt><b>DBWSBuilder</b></tt> is used to create a deployable archive. <tt>DBWSBuilder</tt> is a Java application that processes an [[EclipseLink dbws-builder.xml File (ELUG)#eclipselink-dbws-builder.xml|EclipseLink DBWS builder XML file]] to produce all the required deployment artifacts (WSDL, <tt>.xsd</tt> schema, <tt>web.xml</tt>, eclipselink-dbws-or.xml, etc). Typical <tt>.war</tt> archive file layout:
 
The EclipseLink DBWS design-time utility <tt><b>DBWSBuilder</b></tt> is used to create a deployable archive. <tt>DBWSBuilder</tt> is a Java application that processes an [[EclipseLink dbws-builder.xml File (ELUG)#eclipselink-dbws-builder.xml|EclipseLink DBWS builder XML file]] to produce all the required deployment artifacts (WSDL, <tt>.xsd</tt> schema, <tt>web.xml</tt>, eclipselink-dbws-or.xml, etc). Typical <tt>.war</tt> archive file layout:
<source lang="text" enclose="div">
 
 
  root of war file
 
  root of war file
 
     \---web-inf
 
     \---web-inf
 
     |
 
     |
     |  web.xml
+
     |  <span style="font-weight: bold;">web.xml</span>
 
     |
 
     |
 
     |  +---META-INF
 
     |  +---META-INF
     |  |      eclipselink-dbws.xml
+
     |  |      <span style="font-weight: bold;">eclipselink-dbws.xml</span>
     |  |      eclipselink-dbws-or.xml
+
     |  |      <span style="font-weight: bold;">eclipselink-dbws-or.xml</span>
     |  |      eclipselink-dbws-ox.xml
+
     |  |      <span style="font-weight: bold;">eclipselink-dbws-ox.xml</span>
     |  |      eclipselink-dbws-sessions.xml
+
     |  |      <span style="font-weight: bold;">eclipselink-dbws-sessions.xml</span>
 
     |  |
 
     |  |
 
     |  \---_dbws
 
     |  \---_dbws
     |          DBWSProvider.class            -- auto-generated JAX-WS 2.0 Provider
+
     |          <span style="font-weight: bold;">DBWSProvider.class</span>           -- auto-generated JAX-WS 2.0 Provider
 
     |
 
     |
 
     \---wsdl
 
     \---wsdl
             eclipselink-dbws-schema.xsd
+
             <span style="font-weight: bold;">eclipselink-dbws-schema.xsd</span>
             eclipselink-dbws.wsdl
+
             <span style="font-weight: bold;">eclipselink-dbws.wsdl</span>
             swaref.xsd                        -- optional
+
             <span style="font-weight: bold;">swaref.xsd</span>                       -- optional
</source>
+
  
 
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>:
 
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>:

Revision as of 16:57, 7 December 2011

EclipseLink DBWS

link="http://wiki.eclipse.org/EclipseLink"
EclipseLink
Website
Download
Community
Mailing ListForumsIRC
Bugzilla
Open
Help Wanted
Bug Day
Contribute
Browse Source


Creating EclipseLink DBWS Services using the DBWSBuilder utility

The EclipseLink DBWS design-time utility DBWSBuilder is used to create a deployable archive. DBWSBuilder is a Java application that processes an EclipseLink DBWS builder XML file to produce all the required deployment artifacts (WSDL, .xsd schema, web.xml, eclipselink-dbws-or.xml, etc). Typical .war archive file layout:

root of war file
   \---web-inf
   |
   |   web.xml
   |
   |   +---META-INF
   |   |       eclipselink-dbws.xml
   |   |       eclipselink-dbws-or.xml
   |   |       eclipselink-dbws-ox.xml
   |   |       eclipselink-dbws-sessions.xml
   |   |
   |   \---_dbws
   |           DBWSProvider.class            -- auto-generated JAX-WS 2.0 Provider
   |
   \---wsdl
           eclipselink-dbws-schema.xsd
           eclipselink-dbws.wsdl
           swaref.xsd                        -- optional

Be sure to set the following environment variables in the <ECLIPSELINK_HOME>\utils\dbws\setenv.cmd (or setenv.sh file) before invoking DBWSBuilder:

  • JAVA_HOME
  • DRIVER_CLASSPATH

There are script files provided for invoking DBWSBuilder. They are located in the <ECLIPSELINK_HOME>\utils\dbws directory. The scripts are dbwsbuilder.cmd for Windows usage, and dbwsbuilder.sh for other operating systems.

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]

Using DBWSBuilder, you can generate an EclipseLink DBWS service from the following sources: