Jump to: navigation, search

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

Line 13: Line 13:
  
 
== 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 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>, etc.) for a JAX-WS 2.0 compliant Web Service. There are script files provided for invoking <tt>DBWSBuilder</tt>. They are located in the <tt><ECLIPSELINK_HOME>\utils\dbws</tt> directory. The scripts ending in <tt>.cmd</tt> are for Windows use while those that end with <tt>.sh</tt> are for all other operating systems. Before runnign the <tt>dbwsbuilder.cmd</tt> script, 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:
+
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>, etc.) for a JAX-WS 2.0 compliant Web Service. There are script files provided for invoking <tt>DBWSBuilder</tt>. They are located in the <tt><ECLIPSELINK_HOME>\utils\dbws</tt> directory. The scripts ending in <tt>.cmd</tt> are for Windows use while those that end with <tt>.sh</tt> are for all other operating systems. Before running the <tt>dbwsbuilder.cmd</tt> script, 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:
 
* <tt>JAVA_HOME</tt>
 
* <tt>JAVA_HOME</tt>
 
* <tt>DRIVER_CLASSPATH</tt>  
 
* <tt>DRIVER_CLASSPATH</tt>  

Revision as of 16:29, 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, etc.) for a JAX-WS 2.0 compliant Web Service. There are script files provided for invoking DBWSBuilder. They are located in the <ECLIPSELINK_HOME>\utils\dbws directory. The scripts ending in .cmd are for Windows use while those that end with .sh are for all other operating systems. Before running the dbwsbuilder.cmd script, please ensure that the following environment variables in the <ECLIPSELINK_HOME>\utils\dbws\setenv.cmd (or setenv.sh file) are set:

  • JAVA_HOME
  • DRIVER_CLASSPATH
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

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