Difference between revisions of "EclipseLink/Examples/DBWS/DBWSBasicStoredProcedure"

From Eclipsepedia

Jump to: navigation, search
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==EclipseLink DBWS Service based on Stored Procedure==
+
<css>
 +
  .source-sql {padding:4px;}
 +
  .source-java5 {padding:4px;border:1px solid black;}
 +
  .source-xml {padding:4px;border:1px solid black;}
 +
  .source-text {padding:4px;border:1px solid black;}
 +
</css>
 +
__NOTOC__
 +
 
 +
== EclipseLink DBWS Service based on Stored Procedure ==
 
The use-case for this example is the creation of a Web service that exposes a Stored Procedure (or multiple procedures).
 
The use-case for this example is the creation of a Web service that exposes a Stored Procedure (or multiple procedures).
 
From the metadata for a Stored Procedure, it is not possible to determine the structure of the returned data. Therefore,
 
From the metadata for a Stored Procedure, it is not possible to determine the structure of the returned data. Therefore,
Line 15: Line 23:
 
</source>
 
</source>
  
The DBWSBuilder utility requires a DBWS configuration file as input.
+
The <tt>DBWSBuilder</tt> utility requires a DBWS configuration file as input.
 
<source lang="xml" enclose="div">
 
<source lang="xml" enclose="div">
 
<?xml version="1.0" encoding="UTF-8"?>
 
<?xml version="1.0" encoding="UTF-8"?>
Line 35: Line 43:
  
 
where
 
where
* <tt>dbws-builder.xml</tt> is the DBWS build XML file above
+
* <tt>dbws-builder.xml</tt> is the DBWS builder XML file above
 
* <tt>output_directory</tt> is the output directory for the generated files
 
* <tt>output_directory</tt> is the output directory for the generated files
 
* <tt>-packageAs</tt> specifies the platform on which the web service will be deployed
 
* <tt>-packageAs</tt> specifies the platform on which the web service will be deployed
Line 54: Line 62:
 
The element tags <tt><b>simple-xml-format</b></tt> and <tt><b>simple-xml</b></tt> can be customized by setting the appropriate properties
 
The element tags <tt><b>simple-xml-format</b></tt> and <tt><b>simple-xml</b></tt> can be customized by setting the appropriate properties
 
on an <tt>sql</tt> operation.
 
on an <tt>sql</tt> operation.
 +
[[Category:EclipseLink/Example/DBWS]]

Latest revision as of 09:59, 7 October 2010


[edit] EclipseLink DBWS Service based on Stored Procedure

The use-case for this example is the creation of a Web service that exposes a Stored Procedure (or multiple procedures). From the metadata for a Stored Procedure, it is not possible to determine the structure of the returned data. Therefore, the Simple XML Format schema is used. The EclipseLink DBWS runtime produces an XML document that is simple and 'human-readable'. Any combination of IN, OUT and IN OUT arguments are supported; in addition, procedures in packages that are overloaded - same name, different parameters – are supported.

The following stored procedure will be used for this example:

DROP PROCEDURE TESTECHO;
CREATE OR REPLACE PROCEDURE TESTECHO(T IN VARCHAR2, U OUT VARCHAR2) AS
BEGIN
  U := CONCAT(T, '-test');
END;

The DBWSBuilder utility requires a DBWS configuration file as input.

<?xml version="1.0" encoding="UTF-8"?>
<dbws-builder xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <properties>
    <property name="projectName">testEcho</property>
    ... database properties
  </properties>
  <procedure
   name="testEcho"
   procedurePattern="TESTECHO"
   isSimpleXMLFormat="true"
 />
</dbws-builder>
prompt > dbwsbuilder.cmd -builderFile dbws-builder.xml -stageDir output_directory -packageAs wls testEcho.war

where

  • dbws-builder.xml is the DBWS builder XML file above
  • output_directory is the output directory for the generated files
  • -packageAs specifies the platform on which the web service will be deployed

The generated eclipselink-dbws-schema.xsd file is the schema for the Simple XML format:

<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 >
  <xsd:complexType name="simple-xml-format">
    <xsd:sequence>
      <xsd:any minOccurs="0"/>
    </xsd:sequence>
  </xsd:complexType>
</xsd:schema>

The element tags simple-xml-format and simple-xml can be customized by setting the appropriate properties on an sql operation.