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/DBWSBuilderAPI"
Line 1: | Line 1: | ||
==DBWSBuilder API== | ==DBWSBuilder API== | ||
<onlyinclude> | <onlyinclude> | ||
− | The EclipseLink DBWS design-time utility, <tt>DBWSBuilder</tt>, is a Java application that generates EclipseLink DBWS files and assembles them into deployable archives. You can also set the <tt>DBWSBuilder</tt>’s properties, add table or procedure definitions and SQL operations programmatically through <tt>DBWSBuilder</tt>’s API. | + | The EclipseLink DBWS design-time utility, <tt>DBWSBuilder</tt>, 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 <code>main</code> method |
+ | |||
+ | |||
+ | You can also set the <tt>DBWSBuilder</tt>’s properties, add table or procedure definitions and SQL operations programmatically through <tt>DBWSBuilder</tt>’s API. | ||
+ | |||
+ | The class <b><code>org.eclipse.persistence.tools.dbws.DBWSBuilder</code></b> is public and can be populated programmatically through property setters (i.e. <b><code>setDriver()</code></b>, <b><code>setUrl()</code></b>) and adding table or procedure definitions via the public <b><code>addDbTable()</code></b> and <b><code>addDbStoredProcedure()</code></b> methods; SQL operations via <b><code>addSqlOperation()</code></b> (NB - before adding a table or procedure definition, it is recommended that the public <b><code>checkTables()</code></b> and <b><code>checkStoredProcedures()</code></b> 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 <b><code>build(...)</code></b> method: | ||
+ | |||
+ | <source lang="java"> | ||
+ | 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 | ||
+ | </source> | ||
+ | |||
+ | |||
</onlyinclude> | </onlyinclude> | ||
Information pending | Information pending | ||
[[Category: DBWS]] | [[Category: DBWS]] |
Revision as of 12:01, 17 April 2009
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