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/EclipseLink DBWSBuilder File (ELUG)"
(→EclipseLink DBWSBuilder File) |
|||
Line 173: | Line 173: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| align="left" | | | align="left" | | ||
− | name | + | <tt>name</tt> |
| | | | ||
Name of the operation. | Name of the operation. | ||
Line 180: | Line 180: | ||
|- | |- | ||
| | | | ||
− | isCollection | + | <tt>isCollection</tt> |
|Specifies whether or not the procedure returns multiple results. The following are valid values: | |Specifies whether or not the procedure returns multiple results. The following are valid values: | ||
*true - the operation returns more than a single row. | *true - the operation returns more than a single row. | ||
Line 188: | Line 188: | ||
|- | |- | ||
| | | | ||
− | isSimpleXMLFormat | + | <tt>isSimpleXMLFormat</tt> |
| | | | ||
Specifies whether or not the procedure returns information in the Simple XML Format (SXF). The following are valid values: | Specifies whether or not the procedure returns information in the Simple XML Format (SXF). The following are valid values: | ||
Line 198: | Line 198: | ||
|- | |- | ||
| | | | ||
− | simpleXMLFormatTag | + | <tt>simpleXMLFormatTag</tt> |
| | | | ||
The name of the root-level Simple XML Format element-tag. | The name of the root-level Simple XML Format element-tag. | ||
Line 206: | Line 206: | ||
|- | |- | ||
| | | | ||
− | xmlTag | + | <tt>xmlTag</tt> |
| | | | ||
The name of the grouping XML element-tag for rows. | The name of the grouping XML element-tag for rows. | ||
Line 214: | Line 214: | ||
|- | |- | ||
| | | | ||
− | binaryAttachment | + | <tt>binaryAttachment</tt> |
| | | | ||
Specifies whether or not the operation returns binary data as a SOAP attachment. The following are valid values: | Specifies whether or not the operation returns binary data as a SOAP attachment. The following are valid values: | ||
Line 223: | Line 223: | ||
|- | |- | ||
| | | | ||
− | returnType | + | <tt>returnType</tt> |
|Specifies a return type when the operation's return type cannot be deduced from database metadata. Valid values are any type that the '''eclipselink-dbws-schema.xsd''' file defines. | |Specifies a return type when the operation's return type cannot be deduced from database metadata. Valid values are any type that the '''eclipselink-dbws-schema.xsd''' file defines. | ||
Note: This attribute is optional. | Note: This attribute is optional. | ||
Line 239: | Line 239: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| align="left" | | | align="left" | | ||
− | catalogPattern | + | <tt>catalogPattern</tt> |
| | | | ||
A pattern that matches one or more catalog names in the database identified by the parent operation (supports SQL-92 % wild-card). | A pattern that matches one or more catalog names in the database identified by the parent operation (supports SQL-92 % wild-card). | ||
|- | |- | ||
| | | | ||
− | schemaPattern | + | <tt>schemaPattern</tt> |
| | | | ||
A pattern that matches one or more schema names in the database identified by the parent operation (supports SQL-92 % wild-card). | A pattern that matches one or more schema names in the database identified by the parent operation (supports SQL-92 % wild-card). | ||
|- | |- | ||
| | | | ||
− | procedurePattern | + | <tt>procedurePattern</tt> |
| | | | ||
A pattern that matches one or more stored procedure, stored function, or stored trigger names in the database identified by the parent operation (supports SQL-92 % wild-card). | A pattern that matches one or more stored procedure, stored function, or stored trigger names in the database identified by the parent operation (supports SQL-92 % wild-card). | ||
Line 262: | Line 262: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| align="left" | | | align="left" | | ||
− | catalogPattern | + | <tt>catalogPattern</tt> |
| | | | ||
A pattern that matches one or more catalog names in the database identified by the parent operation (supports SQL-92 % wild-card). | A pattern that matches one or more catalog names in the database identified by the parent operation (supports SQL-92 % wild-card). | ||
|- | |- | ||
| | | | ||
− | schemaPattern | + | <tt>schemaPattern</tt> |
| | | | ||
A pattern that matches one or more schema names in the database identified by the parent operation (supports SQL-92 % wild-card). | A pattern that matches one or more schema names in the database identified by the parent operation (supports SQL-92 % wild-card). | ||
|- | |- | ||
| | | | ||
− | tableNamePattern | + | <tt>tableNamePattern</tt> |
| | | | ||
A pattern that matches one or more table names in the database identified by the parent operation (supports SQL-92 % wild-card). | A pattern that matches one or more table names in the database identified by the parent operation (supports SQL-92 % wild-card). |
Revision as of 13:07, 20 March 2009
EclipseLink DBWSBuilder
File
The DBWSBuilder
design-time utility processes the elements in this file to produce the requisite EclipseLink DBWS service
descriptor and accompanying files. The XML Schema definition for a DBWSBuilder
file is
eclipselink-dbws-builder_1.0.xsd and can be found in the META-INF/ directory in the
eclipselink-dbwsutils.jar file, located in the <ECLIPSELINK_HOME>/utils/dbws/ directory.
The file has two main sections - global properties settings and specific operation settings.
Property | Description | Required | Default |
---|---|---|---|
projectName |
The name of the EclipseLink DBWS service. |
Yes |
None |
username |
Database user name. |
Yes |
None |
password |
Database password. |
Yes |
None |
url |
Database connection URL. |
Yes |
None |
driver |
Class name of the JDBC driver. |
Yes |
None |
contextRoot |
The value of the web.xml file servlet-mapping element's url-pattern sub-element: Example: <servlet-mapping> ... <url-pattern> /servlet/MyWebService </url-pattern> </servlet-mapping> |
No |
" / "+ projectName |
dataSource |
JNDI datasource location for the EclipseLink sessions.xml file You must configure a JNDI datasource before deploying your EclipseLink DBWS to a Java-EE server |
No |
None |
sessionsFileName |
The name of EclipseLink sessions.xml file to add to the EclipseLink DBWS service archive file. |
No |
eclipselink-dbws-sessions.xml |
platformClassname |
The fully qualified name of the EclipseLink database platform class to use to connect to the relational database. This class must be in the classpath. |
No |
org.eclipse.persistence.platform.database.MySQLPlatform |
orSessionCustomizerClassName |
The name of a Java class that implements the |
No |
None |
oxSessionCustomizerClassName |
The name of a Java class that implements the |
No |
None |
wsdlLocationURI |
The URI of this EclipseLink Database Web service's WSDL (used by Web service tools to generate client code). |
No |
http://localhost:7001/projectName |
logLevel |
EclipseLink logging level to be inserted in the EclipseLink database Web service sessions.xml file. Controls the amount and detail of log output by configuring the log level (in ascending order of information) to one of the following java.util.logging.Level values:
|
No |
info |
targetNameSpace |
The URI of the target namespace that the EclipseLink Database Web service inserts into the eclipselink-dbws-schema.xsd file. |
No |
urn: + projectName |
The following tables describe attributes of builder operations.
This table lists attributes common to all three builder operations - table, procedure and sql.
Attribute | Description | Default |
---|---|---|
name |
Name of the operation. |
None |
isCollection |
Specifies whether or not the procedure returns multiple results. The following are valid values:
|
false |
isSimpleXMLFormat |
Specifies whether or not the procedure returns information in the Simple XML Format (SXF). The following are valid values:
For more information, see foobar |
false |
simpleXMLFormatTag |
The name of the root-level Simple XML Format element-tag. For more information, see foobar |
<simple-xml-format> |
xmlTag |
The name of the grouping XML element-tag for rows. For more information, see foobar |
<simple-xml> |
binaryAttachment |
Specifies whether or not the operation returns binary data as a SOAP attachment. The following are valid values:
|
false |
returnType |
Specifies a return type when the operation's return type cannot be deduced from database metadata. Valid values are any type that the eclipselink-dbws-schema.xsd file defines.
Note: This attribute is optional. |
None |
This table lists attributes of the procedure operation.
Attribute | Description |
---|---|
catalogPattern |
A pattern that matches one or more catalog names in the database identified by the parent operation (supports SQL-92 % wild-card). |
schemaPattern |
A pattern that matches one or more schema names in the database identified by the parent operation (supports SQL-92 % wild-card). |
procedurePattern |
A pattern that matches one or more stored procedure, stored function, or stored trigger names in the database identified by the parent operation (supports SQL-92 % wild-card). |
This table lists attributes of the table operation.
Attribute | Description |
---|---|
catalogPattern |
A pattern that matches one or more catalog names in the database identified by the parent operation (supports SQL-92 % wild-card). |
schemaPattern |
A pattern that matches one or more schema names in the database identified by the parent operation (supports SQL-92 % wild-card). |
tableNamePattern |
A pattern that matches one or more table names in the database identified by the parent operation (supports SQL-92 % wild-card). |
Example DBWSBuilder
builder xml file:
<?xml version="1.0" encoding="UTF-8"?> <dbws-builder xmlns:xsd="http://www.w3.org/2001/XMLSchema" <properties> <property name="projectName">test</property> <property name="driver">oracle.jdbc.OracleDriver</property> <property name="password">tiger</property> <property name="url">jdbc:oracle:thin:@localhost:1521:ORCL</property> <property name="username">scott</property> </properties> <table catalogPattern="%" schemaPattern="SCOTT" tableNamePattern="XR_EMP"> <procedure returnType="xr_empType" catalogPattern="SOME_PKG" schemaPattern="SCOTT" procedurePattern="GetEmployeeByEMPNO_DEPTNO" /> <sql name="findXREmpByName" isCollection="true" returnType="xr_empType"> <text> <![CDATA[select * from XR_EMP where ENAME like ?]]> </text> <binding name="ENAME" type="xsd:string"/> </sql> </table> <sql name="employeeInfo" simpleXMLFormatTag="employee-info" xmlTag="aggregate-counts"> <text> <![CDATA[select count(*) as "COUNT", max(SAL) as "MAX-Salary" from EMP]]> </text> </sql> </dbws-builder>