Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "EclipseLink/UserGuide/DBWS/Overview/Design time"
< EclipseLink | UserGuide | DBWS | Overview
| Line 7: | Line 7: | ||
== 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> | + | 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 | ||
| Line 27: | Line 27: | ||
<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>: | |
* <tt>JAVA_HOME</tt> | * <tt>JAVA_HOME</tt> | ||
* <tt>DRIVER_CLASSPATH</tt> | * <tt>DRIVER_CLASSPATH</tt> | ||
| − | There are script files provided for invoking <tt>DBWSBuilder</tt>. They are located in the <tt><ECLIPSELINK_HOME>\utils\dbws</tt> directory. The scripts are <tt>dbwsbuilder.cmd</tt> for Windows | + | There are script files provided for invoking <tt>DBWSBuilder</tt>. They are located in the <tt><ECLIPSELINK_HOME>\utils\dbws</tt> directory. The scripts are <tt>dbwsbuilder.cmd</tt> for Windows use, and <tt>dbwsbuilder.sh</tt> for all other operating systems. |
<source lang="text"> | <source lang="text"> | ||
DBWSBuilder usage - [] indicates optional argument: | 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] | prompt > dbwsbuilder.cmd -builderFile {path_to_dbws_builder.xml} -stageDir {path_to_stageDir} -packageAs[:archive_flag - archive, noArchive, ignore] {packager} [additional args] | ||
| − | |||
Available packagers: | Available packagers: | ||
-packageAs:[default=not supported] jdev | -packageAs:[default=not supported] jdev | ||
Revision as of 17:12, 7 December 2011
EclipseLink DBWS
| EclipseLink | |
| Website | |
| Download | |
| Community | |
| Mailing List • Forums • IRC • mattermost | |
| Issues | |
| 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 | | +---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
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