Jump to: navigation, search

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

Line 15: Line 15:
 
The EclipseLink DBWS design-time utility <tt><b>DBWSBuilder</b></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 a deployable archive (typically a <tt>.war</tt> file) containing all the required deployment artifacts (WSDL, <tt>.xsd</tt> schema, <tt>web.xml</tt>, eclipselink-dbws-or.xml, etc). Typical <tt>.war</tt> file layout:
 
The EclipseLink DBWS design-time utility <tt><b>DBWSBuilder</b></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 a deployable archive (typically a <tt>.war</tt> file) containing all the required deployment artifacts (WSDL, <tt>.xsd</tt> schema, <tt>web.xml</tt>, eclipselink-dbws-or.xml, etc). Typical <tt>.war</tt> file layout:
 
  root of war file
 
  root of war file
     \---web-inf
+
     \---WEB-INF
 
     |
 
     |
 
     |  <span style="font-weight: bold;">web.xml</span>
 
     |  <span style="font-weight: bold;">web.xml</span>
 
     |
 
     |
 +
    +---classes
 
     |  +---META-INF
 
     |  +---META-INF
 
     |  |      <span style="font-weight: bold;">eclipselink-dbws.xml</span>
 
     |  |      <span style="font-weight: bold;">eclipselink-dbws.xml</span>
Line 26: Line 27:
 
     |  |
 
     |  |
 
     |  \---_dbws
 
     |  \---_dbws
     |          <span style="font-weight: bold;">DBWSProvider.class</span>           -- auto-generated JAX-WS 2.0 Provider
+
     |          <span style="font-weight: bold;">DBWSProvider.class</span>     -- auto-generated JAX-WS 2.0 Provider
 +
    |          <span style="font-weight: bold;">ProviderListener.class</span> -- auto-generated Servlet Listener
 
     |
 
     |
 
     \---wsdl
 
     \---wsdl
 
             <span style="font-weight: bold;">eclipselink-dbws-schema.xsd</span>
 
             <span style="font-weight: bold;">eclipselink-dbws-schema.xsd</span>
 
             <span style="font-weight: bold;">eclipselink-dbws.wsdl</span>
 
             <span style="font-weight: bold;">eclipselink-dbws.wsdl</span>
             <span style="font-weight: bold;">swaref.xsd</span>                       -- optional
+
             <span style="font-weight: bold;">swaref.xsd</span>                 -- optional
  
 
Please ensure that the following environment variables in the <tt><ECLIPSELINK_HOME>\utils\dbws\setenv.cmd</tt> (or <tt>setenv.sh</tt> file) are set before invoking <tt>DBWSBuilder</tt>:
 
Please ensure that the following environment variables in the <tt><ECLIPSELINK_HOME>\utils\dbws\setenv.cmd</tt> (or <tt>setenv.sh</tt> file) are set before invoking <tt>DBWSBuilder</tt>:

Revision as of 16:24, 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 a Java application that processes an EclipseLink DBWS builder XML file to produce a deployable archive (typically a .war file) containing all the required deployment artifacts (WSDL, .xsd schema, web.xml, eclipselink-dbws-or.xml, etc). Typical .war file layout:

root of war file
   \---WEB-INF
   |
   |   web.xml
   |
   +---classes
   |   +---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
   |           ProviderListener.class -- auto-generated Servlet Listener
   |
   \---wsdl
           eclipselink-dbws-schema.xsd
           eclipselink-dbws.wsdl
           swaref.xsd                 -- optional

Please ensure that the following environment variables in the <ECLIPSELINK_HOME>\utils\dbws\setenv.cmd (or setenv.sh file) are set 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 use, and dbwsbuilder.sh for all other operating systems.

DBWSBuilder usage - [] indicates optional argument:
prompt > dbwsbuilder.cmd  -builderFile {path_to_dbws_builder.xml} -stageDir  {path_to_stageDir} -packageAs[:archive_flag - archive, noArchive, ignore] {packager} [additional args]
Available packagers:
    -packageAs:[default=not supported] jdev
    -packageAs:[default=archive] javase [jarFilename]
    -packageAs:[default=archive] wls [warFilename] [warFilename]
    -packageAs:[default=archive] glassfish [warFilename] [warFilename]
    -packageAs:[default=archive] jboss [warFilename] [warFilename]
    -packageAs:[default=archive] war [warFilename] [warFilename]
    -packageAs:[default=archive] was [warFilename] [warFilename]
    -packageAs:[default=not supported] eclipse