Skip to main content

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.

Jump to: navigation, search

EclipseLink/UserGuide/DBWS/DBWSBuilderAPI

DBWSBuilder API

The EclipseLink DBWS design-time utility, DBWSBuilder, is a Java application that generates EclipseLink DBWS files and assembles them into deployable archives. It is normally invoked from the command-line via its main method


You can also set the DBWSBuilder’s properties, add table or procedure definitions and SQL operations programmatically through DBWSBuilder’s API.

The class org.eclipse.persistence.tools.dbws.DBWSBuilder is public and can be populated programmatically through property setters (i.e. setDriver(), setUrl()) and adding table or procedure definitions via the public addDbTable() and addDbStoredProcedure() methods; SQL operations via addSqlOperation() (NB - before adding a table or procedure definition, it is recommended that the public checkTables() and checkStoredProcedures() methods be used to ensure that the definitions are supported). Once all the data and definitions have been set, the builder is invoked through the build(...) method:

public void build(OutputStream dbwsSchemaStream, OutputStream dbwsSessionsStream,
        OutputStream dbwsServiceStream, OutputStream dbwsOrStream, OutputStream dbwsOxStream,
        OutputStream swarefStream, OutputStream webXmlStream, OutputStream wsdlStream,
        OutputStream codeGenProviderStream, OutputStream sourceProviderStream, Logger logger)
        throws WSDLException


Information pending

Back to the top