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.
EclipseLink/UserGuide/DBWS/Overview/Design time
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 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:
\---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: