Difference between revisions of "EclipseLink/UserGuide/DBWS/Overview/EclipseLink DBWSBuilder File (ELUG)"

From Eclipsepedia

Jump to: navigation, search
(EclipseLink DBWSBuilder File)
m (Replacing page with 'For EclipseLink DBWS documentation,including JAX-WS and JAX-RS, see http://www.eclipse.org/eclipselink/dbws.php Category: EclipseLink User's Guide [[Category: Release 1.1]...')
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOTOC__
+
For EclipseLink DBWS documentation,including JAX-WS and JAX-RS, see http://www.eclipse.org/eclipselink/dbws.php
==EclipseLink <code>DBWSBuilder</code> File==
+
<onlyinclude>
+
The <code>DBWSBuilder</code> 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 <code>DBWSBuilder</code> file is
+
<tt><b>eclipselink-dbws-builder_1.0.xsd</b></tt> and can be found in the <tt>META-INF/</tt> directory in the
+
<tt>eclipselink-dbwsutils.jar</tt> file, located in the <tt><ECLIPSELINK_HOME>/utils/dbws/</tt> directory.
+
The file has two main sections - global properties settings and specific operation settings.
+
<br/>
+
{| class="RuleFormalWideMax" dir="ltr" title="<b><code>DBWSBuilder</code> file Properties</b>" width="100%" border="1" frame="border" rules="all" cellpadding="3" frame="border" rules="all"
+
|- align="left" valign="top"
+
|+ <b><code>DBWSBuilder</code> builder xml file Properties</b>
+
! id="r1c1-t2" align="left" valign="bottom" | '''Element'''
+
! id="r1c2-t2" align="left" valign="bottom" | '''Description'''
+
! id="r1c1-t2" align="left" valign="bottom" | '''Required'''
+
! id="r1c2-t2" align="left" valign="bottom" | '''Default'''
+
|- align="left" valign="top"
+
| align="left" |
+
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:
+
<source lang="xml" enclose="div">
+
Example:
+
<servlet-mapping>
+
    ...
+
    <url-pattern>
+
        /servlet/MyWebService
+
    </url-pattern>
+
</servlet-mapping>
+
</source>
+
|
+
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 <b><code>eclipselink.persistence.config.SessionCustomizer</code></b> interface.
+
The name is added to the EclipseLink sessions.xml file, allowing the ORM project to be customized.
+
|
+
No
+
|
+
None
+
|-
+
|
+
oxSessionCustomizerClassName
+
|
+
The name of a Java class that implements the <b><code>eclipselink.persistence.config.SessionCustomizer</code></b> interface.
+
The name is added to the EclipseLink sessions.xml file, allowing the OXM project to be customized.
+
|
+
No
+
|
+
None
+
|-
+
|
+
wsdlLocationURI
+
|
+
The URI of this EclipseLink Database Web service's WSDL (used by Web service tools to generate client code).
+
|
+
No
+
|
+
<nowiki>http://localhost:7001/projectName</nowiki>
+
|-
+
|
+
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:
+
*off - Disable logging.
+
*severe - Logs exceptions indicating EclipseLink cannot continue, as well as any exceptions generated during login. This includes a stack trace.
+
*warning - Logs exceptions that do not force EclipseLink to stop, including all exceptions not logged with severe level. This does not include a stack trace.
+
*info - Logs the login/logout per sever session, including the user name. After acquiring the session, detailed information is logged.
+
*config - Logs only login, JDBC connection, and database information.
+
*fine - Logs SQL.
+
*finer - Similar to warning. Includes stack trace.
+
*finest - Includes additional low level information.
+
|
+
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
+
|}
+
<br/>
+
The following tables describe attributes of builder operations.
+
<br/>
+
This table lists attributes common to all three builder operations - <b>table</b>, <b>procedure</b> and <b>sql</b>.
+
{| class="RuleFormalWideMax" dir="ltr" title="<b>Common Attributes of Builder Operations</b>" width="100%" border="1" frame="border" rules="all" cellpadding="3" frame="border" rules="all"
+
|- align="left" valign="top"
+
|+ <b>Common Attributes of Builder Operations</b>
+
! id="r1c1-t2" align="left" valign="bottom" | '''Attribute'''
+
! id="r1c2-t2" align="left" valign="bottom" | '''Description'''
+
! id="r1c2-t2" align="left" valign="bottom" | '''Default'''
+
|- align="left" valign="top"
+
| align="left" |
+
name
+
|
+
Name of the operation.
+
|
+
None
+
|-
+
|
+
isCollection
+
|Specifies whether or not the procedure returns multiple results. The following are valid values:
+
*true - the operation returns more than a single row.
+
*false - the operation returns a single row.
+
|
+
false
+
|-
+
|
+
isSimpleXMLFormat
+
|
+
Specifies whether or not the procedure returns information in the Simple XML Format (SXF). The following are valid values:
+
*true - the operation returns information in the Simple XML Format.
+
*false - the operation returns information in the Simple XML Format.
+
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:
+
*true - the operation returns binary data as a SOAP attachment.
+
*false - the operation does not return binary data as a SOAP attachment.
+
|
+
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
+
|}
+
<br/>
+
This table lists attributes of the <b>procedure</b> operation.
+
<br/>
+
{| class="RuleFormalWideMax" dir="ltr" title="Attributes of the <b>procedure</b> Operation" width="100%" border="1" frame="border" rules="all" cellpadding="3" frame="border" rules="all"
+
|- align="left" valign="top"
+
|+ Attributes of the <b>procedure</b> Operation
+
! id="r1c1-t2" align="left" valign="bottom" | '''Attribute'''
+
! id="r1c2-t2" align="left" valign="bottom" | '''Description'''
+
|- align="left" valign="top"
+
| align="left" |
+
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 <b>table</b> operation.
+
{| class="RuleFormalWideMax" dir="ltr" title="Attributes of the <b>table</b> Operation" width="100%" border="1" frame="border" rules="all" cellpadding="3" frame="border" rules="all"
+
|- align="left" valign="top"
+
|+ Attributes of the <b>table</b> Operation
+
! id="r1c1-t2" align="left" valign="bottom" | '''Attribute'''
+
! id="r1c2-t2" align="left" valign="bottom" | '''Description'''
+
|- align="left" valign="top"
+
| align="left" |
+
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).
+
|}
+
 
+
<span id="Example 9-5"></span>
+
Example <code>DBWSBuilder</code> builder xml file:
+
<source lang="xml">
+
<?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>
+
</source>
+
 
+
===Graphical view of EclipseLink DBWS Service Descriptor's Schema <code>eclipselink-dbws_1.0.xsd</code>===
+
[[Image:dbws-builder_1_0.png]]
+
 
+
----
+
''[[EclipseLink User's Guide Copyright Statement|Copyright Statement]]''
+
 
+
  
 
[[Category: EclipseLink User's Guide]]
 
[[Category: EclipseLink User's Guide]]
 
[[Category: Release 1.1]]
 
[[Category: Release 1.1]]
 
[[Category: DBWS]]
 
[[Category: DBWS]]

Latest revision as of 08:50, 1 November 2012

For EclipseLink DBWS documentation,including JAX-WS and JAX-RS, see http://www.eclipse.org/eclipselink/dbws.php