Jump to: navigation, search

Creating EclipseLink Files for Deployment (ELUG)

Contents

Related Topics

This section includes EclipseLink information that you need when creating deployment files for various types of applications.

For more information on packaging and deployment, see the following:


Introduction to the EclipseLink Deployment File Creation

Depending on the type of application you are deploying, you may need to create any of the following deployment files:

Workbench provides the ability to create deployment files from a Workbench project. After you build a project, you have two options to create the deployment files:

  • Create XML deployment files that require no compiling.
  • Create Java source files, which you compile and deploy outside of Workbench.

We recommend XML deployment because XML files are easier to deploy and troubleshoot than compiled Java files. This approach gives you a very flexible configuration that enables you to make changes safely and easily. XML deployment files do not require third-party applications or compilers to deploy successfully.

Note: If you are using JPA, you can use annotations to specify most of what you formerly specified in deployment descriptors. Use deployment descriptors to override annotations or specify options not supported by annotations.


project.xml File

The project.xml file is the core of your application. It contains the descriptors and mappings you define and also includes any named queries or finders associated with your project.


XSD File Format

The project.xml file XSD is eclispelink-object-persistence_11_1_1.xsd and it is located in the <ECLIPSELINK_HOME>\config\xsds directory.


POJO Applications and Project Metadata

For a POJO application, you define your project metadata in a project.xml file.

The project.xml file provides a simple and flexible way to configure, modify, and troubleshoot the project metadata. Because of these attributes, the project.xml file is the preferred way to configure an EclipseLink project.Workbench provides a graphical tool to build and edit the project.xml file. For information on creating projects with Workbench, see Creating the project.xml File with Workbench.


JPA Applications and Project Metadata

For a JPA application, you can express project metadata using JPA annotations, persistence.xml, orm.xml, and EclipseLink JPA annotation and persistence.xml property extensions. The EclipseLink JPA persistence provider interprets all these sources of metadata to create an in-memory EclipseLink session and project at run time.

Using EclipseLink JPA, you also have the option of specifying your metadata using EclipseLink sessions.xml and project.xml while accessing your persistent classes using JPA and an EntityManger. For more information, see What You May Need to Know About EclipseLink JPA Overriding Mechanisms.



Creating the project.xml File with Workbench

Because you must synchronize the project.xml file with the classes and data source associated with your application, we recommend that you not modify this file manually. Workbench ensures proper synchronization, and is the best way to make changes to the project. Simply modify the project in Workbench and redeploy the project.xml file. Using this option reduces development time by eliminating the need to regenerate and recompile Java code each time the project changes.

See Exporting Project Information for detailed information on exporting the deployment XML information.


Note: You can name this file with a name other than project.xml; however, for clarity, this discussion assumes that the file has not been renamed.


Creating project.xml Programatically

Optionally, you can use the DeploymentXMLGenerator API to programatically generate the project.xml file in either of the following ways:

  • From an application, instantiate the DeploymentXMLGenerator and your java source. Call the following method:generate (<MW_Project.mwp>, <output file.xml>)
  • From the command line, use the following:
java -classpath eclipselink.jar;eclispelinkmw.jar;xmlparserv2.jar;ejb.jar;
org.eclipse.persistence.tools.workbench.mappings.DeploymentXMLGenerator <MW_Project.mwp> <output file.xml>

Before you use either method, ensure that your classpath includes the <ECLIPSELINK_HOME>\config directory.


Note: If you are using EJB 3.0, you can use annotations to specify most of what you formerly specified in the project.xml file. To override annotations or specify options not supported by annotations, you can still provide a project.xml file in your EJB 3.0 application. For more information on what annotations are currently supported, see Oracle Fusion Middleware Enterprise JavaBeans Developer's Guide for Oracle Containers for Java EE


sessions.xml File

Each EclipseLink project belongs to an EclipseLink session. A session is the facade through which an application accesses EclipseLink functionality (for more information on sessions, see EclipseLink Sessions).


XSD File Format

The sessions.xml file XSD is eclipse_persistence_sessions_1_0.xsd and it is located in the <ECLISPELINK_HOME>\config\xsds directory as well as on the web at http://www.eclipse.org/eclipselink/xsds/eclipse_persistence_sessions_1_0.xsd.

When you use the XSD formatted sessions.xml file, the EclipseLink run time separates sessions.xml file validation from session instantiation. Separating XML file formatting problems from Session Manager session instantiation problems simplifies troubleshooting. Exceptions thrown during validation clearly indicate that the failure is due to an invalid sessions.xml file, as the following illustrates.


Enhanced Validation Exceptions

Exception [ECLIPSELINK-9010] (EclipseLink): org.eclipselink.exceptions.SessionLoaderException
Exception Description: A End tag does not match start tag 'session'. was thrown while parsing the XML file against the XML schema.
Internal Exception: oracle.xml.parser.v2.XMLParseException: End tag does not match start tag 'session'.


POJO Applications and Session Metadata

For a POJO application, you define your sessions in a sessions.xml file.

The sessions.xml file provides a simple and flexible way to configure, modify, and troubleshoot the application sessions. Because of these attributes, the sessions.xml file is the preferred way to configure an EclipseLink session.EclipseLink provides graphical toosl to build and edit the sessions.xml file. For information see Creating a Session.


JPA Applications and Session Metadata

For a JPA application, you can express session metadata using JPA annotations, persistence.xml, orm.xml, and EclipseLink JPA annotation and persistence.xml property extensions. The EclipseLink JPA persistence provider interprets all these sources of metadata to create an in-memory EclipseLink session and project at run time.

Using EclipseLink JPA, you also have the option of specifying your metadata using EclipseLink sessions.xml and project.xml while accessing your persistent classes using JPA and an EntityManger. For more information, see What You May Need to Know About EclipseLink JPA Overriding Mechanisms.


Creating Deployment Files for Java Applications

In a Java application, EclipseLink does not use a Java EE container for deployment. Instead, it relies on EclipseLink mechanisms to provide functionality and persistence. The key elements of this type of application are the lack of a Java EE container and the fact that you deploy the application by placing the application JAR file on the classpath.

Java applications require the following deployment files:


Creating Deployment Files for JavaServer Pages and Servlet Applications

Many designers build EclipseLink applications that use JavaServer Pages (JSP) and Java servlets. This type of design generally supports Web-based applications.

JSP and servlet applications require the following deployment files:


Creating Deployment Files for Session Bean Applications

Session beans generally model a process, operation, or service and as such, are not persistent. You can build EclipseLink applications that wrap interaction with EclipseLink in session beans. Session beans execute all EclipseLink-related operations on behalf of the client.

This type of design uses JTS and externally managed transactions, but does not incur the overhead associated with persistence applications. Session bean applications also scale and deploy easily.

This section describes the following:


How to Create Deployment Files for EJB 3.0 Session Bean Applications

We recommend using JPA annotations and persistence unit properties, or a special-case eclipselink.session-xml persistence unit property (see EclipseLink JPA Persistence Unit Properties for Database, Session, and Application Server) in your EJB 3.0 session bean application.

You may also choose to use the project.xml File and sessions.xml File.

For more information, see the following:


Creating Deployment Files for JPA Applications

See Packaging and Deploying EclipseLink JPA Applications for information on how to create deployment files for your JPA application.


Creating Deployment Files for EclipseLink Database Web Services

This section describes how to automatically generate a WAR file containing the WSDL and all deployment files an EclipseLink database Web service requires, including the following:


How to Create Deployment Files for a EclipseLink Database Web Service Using Ant: from a Database Table

You can generate an EclipseLink database Web service from an existing relational database table using Ant.


To Create Deployment Files for a EclipseLink Database Web Service Using Ant: from a Database Table

  1. Create the table in your relational database and ensure that the relational database management system is online.
  2. Execute the GenerateFromTables Ant task, as the following example shows.
    Generating an EclipseLink Database Web Service from a Table
    <BuildDBWSWar
        destfile="emp.war"
        projectName="emp"
        sessionsFileName="emp-sessions.xml"
        platformClassName="org.eclipse.persistence.platform.database.oracle.Oracle10Platform"
        classpathref="eclispelink.dbws.path"
        >
        <GenerateFromTables
            driver="${login.driverClass}"
            userid="${login.username}"
            password="${login.password}"
            url="${login.databaseURL}"
            >
    
            <Table                <!-- Generates CRUD operations -->
                catalogPattern="%"
                schemaPattern="SCOTT"
                tableNamePattern="XR_EMP"
                >
                <Operations>      <!-- Additional operations -->
                    <SQLOperation
                        name="findXREmpByName"
                        returnType="xr_empType"
                        >
                            select * from XR_EMP where ENAME like ?
                        <Binding
                            name="ENAME"
                            type="xsd:string"
                        />
    
                    </SQLOperation>
                    <SQLOperation
                        name="xr-employeeInfo"
                        isCollection="false"
                        simpleXMLFormatTag="xr-employee-info"
                        xmlTag="aggregate-counts"
                        >
                            select count(*) as "COUNT", max(SAL) as "MAX-Salary" from XR_EMP
                    </SQLOperation>
                    <Procedure
                        catalogPattern="SOME_PKG"
                        schemaPattern="SCOTT"
                        procedurePattern="GetEmployeeByEMPNO_DEPTNO"
                        returnType="xr_empType"
                    />
                </Operations>
            </Table>
    
        </GenerateFromTables>
    </BuildDBWSWar>
    

    Optionally, specify a SessionCustomizer class name using the BuildDBWSWar attribute sessionCustomizerClassName.
    For more information, see the following:
  3. Package and deploy the EclipseLink database Web service.
    For more information, see the following:

How to Create Deployment Files for a EclipseLink Database Web Service Using Ant: from SQL

You can generate an EclipseLink database Web service from one or more SQL statements written with respect to an existing relational database schema using Ant.


To Create Deployment Files for a EclipseLink Database Web Service Using Ant: from SQL

  1. Create your relational database schema and ensure that the relational database management system is online.
  2. Execute the GenerateFromSQL Ant task, as the following example shows:
    1. Create an SQLOperation for each SQL statement you want to expose.
    2. If the SQL statement takes arguments, add a Binding task for each argument. The order in which you define Binding tasks must match the order of the arguments in your SQL statement.
      Generating an EclipseLink Databases Service from SQL
      <BuildDBWSWar
          destfile="emp.war"
          projectName="emp"
          sessionsFileName="emp-sessions.xml"
          platformClassName="org.eclipse.persistence.platform.database.oracle.Oracle10Platform"
          classpathref="eclispelink.dbws.path"
          >
          <GenerateFromSQL
              driver = "oracle.jdbc.OracleDriver"
              url = "jdbc:oracle:thin:@localhost:1251:orcl"
              password = "tiger"
              userid = "scott"
              >
              <SQLOperation
                  name="findXREmpByName"
                  returnType="xr_empType"
                  >
                      select * from XR_EMP where ENAME like ?
                  <Binding
                      name="ENAME"
                      type="xsd:string"
                  />
              </SQLOperation>
          <GenerateFromSQL>
      
      </BuildDBWSWar>
      

      Optionally, specify a SessionCustomizer class name using the BuildDBWSWar attribute sessionCustomizerClassName.
      For more information, see the following:

  3. Package and deploy the EclipseLink database Web service.
    For more information, see the following:


How to Create Deployment Files for a EclipseLink Database Web Service Using Ant: from a Stored Procedure

You can generate an EclipseLink database Web service from one or more stored procedures, stored functions, and triggers defined in an existing relational database schema using Ant.


To Create Deployment Files for a EclipseLink Database Web Service Using Ant: from a Stored Procedure

  1. Create your relational database schema and ensure that the relational database management system is online.
  2. Execute the GenerateFromStoredProcedure Ant task, as the following example shows. Create an Operation for each stored procedure, stored function, or trigger you want to expose.
    Generating an EclipseLink Databases Service from a Stored Procedure
    <BuildDBWSWar
        destfile="emp.war"
        projectName="emp"
        sessionsFileName="emp-sessions.xml"
        platformClassName="org.eclipse.persistence.platform.database.oracle.Oracle10Platform"
        classpathref="eclispelink.dbws.path"
        >
        <GenerateFromStoredProcedures
            driver="${login.driverClass}"
            userid="${login.username}"
            password="${login.password}"
            url="${login.databaseURL}"
            >
            <Procedure
                catalogPattern="SOME_PKG"
                schemaPattern="SCOTT"
                procedurePattern="GetEmployeeByEMPNO_DEPTNO"
                returnType="xr_empType"
            />
        </GenerateFromStoredProcedures>
    </BuildDBWSWar>
    

    Optionally, specify a SessionCustomizer class name using the BuildDBWSWar attribute sessionCustomizerClassName.
    For more information, see the following:

  3. Package and deploy the EclipseLink database Web service.
    For more information, see the following:


How to Customize a EclipseLink Database Web Service Using Java: Session Customization

You can customize an EclipseLink database Web service with an EclipseLink SessionCustomizer.


To Customize a EclipseLink Database Web Service Using Java: Session Customization

  1. Implement a org.eclipse.persistence.tools.sessionconfiguration.SessionCustomizer, as the following example shows.
    Implementing a SessionCustomizer
    import org.eclipse.persistence.tools.sessionconfiguration.SessionCustomizer;
    import org.eclipse.persistence.sessions.Session;
    import org.eclipse.persistence.sessions.DatabaseLogin;
    public class MySessionCustomizer implements SessionCustomizer {
        public void customize(Sesssion session) {
            DatabaseLogin login = (DatabaseLogin)session.getDatasourceLogin();
            login.setTransactionIsolation(DatabaseLogin.TRANSACTION_READ_UNCOMMITTED);
        }
    }
    
    For more information, see Customizing EclipseLink Database Web Services.
  2. Add the SessionCustomizer to the Ant classpath.
  3. Execute the BuildDBWSWar Ant task, as this example shows.When you execute the BuildDBWSWar Ant task, specify the SessionCustomizer class name using the BuildDBWSWar attribute sessionCustomizerClassName.
    Building the EclipseLink Database Web Service WAR File With a Session Customizer
    <BuildDBWSWar
        destfile="emp.war"
        projectName="emp"
        sessionsFileName="emp-sessions.xml"
        platformClassName="org.eclipse.persistence.platform.database.oracle.Oracle10Platform"
        classpathref="eclispelink.dbws.path"
        sessionCustomizerClassName = "MySessionCustomizer.class"
        >
        <GenerateFromTables>
        ...
        </GenerateFromTables>
    </BuildDBWSWar>
    
    For more information, see the following:
  4. Package and deploy the EclipseLink database Web service.
    For more information, see the following:

How to Customize a EclipseLink Database Web Service Using project.xml and sessions.xml

You can customize an EclipseLink database Web service by creating your own project.xml and sessions.xml files.


To Customize a Oracle Sensor Edge Server Database Web Service Using project.xml and sessions.xml

  1. Execute the BuildDBWSWar Ant task with a generator, as the following example shows.
    Creating the Initial EclipseLink Database Web Services Files
    <BuildDBWSWar
        destfile="emp.war"
        projectName="emp"
        sessionsFileName="emp-sessions.xml"
        platformClassName="org.eclipse.persistence.platform.database.oracle.Oracle10Platform"
        classpathref="eclispelink.dbws.path"
        sessionCustomizerClassName = "MySessionCustomizer.class"
        >
        <GenerateFromTables>
        ...
        </GenerateFromTables>
    </BuildDBWSWar>
    

    Executing the BuildDBWSWar Ant task with a generator creates the necessary EclipseLink database Web service files and subdirectories.

    For more information, see:

  2. Manually create your project.xml files and sessions.xml file using the Workbench:

    Note: Your custom project.xml files must use the same names as specified by BuildDBWSWar attributes ormProjectFilename and oxmProjectFilename. Your custom sessions.xml file must use the same name as specified by BuildDBWSWar attribute sessionsFileName.


    For more information, see:
  3. Replace the generated project.xml files and sessions.xml file in your EclipseLink database Web services directory hierarchy with your custom project.xml files and sessions.xml files.
  4. Execute the BuildDBWSWar Ant task without a generator, as the following example shows.

    Building the EclipseLink Database Web Service WAR File
    <xr:BuildDBWSWar
        classpathref = "${myApplication.classpath}" 
        contextRoot = "/servlet/MyWebService"
        destFile = "${stage.dir}/${project.name}.war"
        ormProjectFilename = "C:/projects/myOrmProject.xml"
        oxmProjectFilename = "C:/projects/myOxmProject.xml"
        platformClassName = "org.eclipse.persistence.platform.database.oracle.Oracle11Platform"
        projectName = "MyWebService"
        schemaFileName = "C:/projects/myWebService.xsd"
        sessionsXMLFileName = "C:/projects/mySessions.xml"
        wsdlFileName = "C:/projects/myWebService.wsdl"
        wsdlLocationURI =,  "http://productionServer:8888/MyWebService">
    </xr:BuildDBWSWar>
    

    Executing the BuildDBWSWar Ant task without a generator assembles the EclipseLink database Web service files in the subdirectory of the current working directory named according to the EclipseLinkProjectName attribute.
    For more information, see:

  5. Package and deploy the EclipseLink database Web service.
    For more information, see:


How to Configure Ant to Use EclipseLink Database Web Services Tasks

Before you can generate a EclipseLink database Web service using Ant within your application's build, you must configure Ant to use EclipseLink database Web service Ant tasks.


To Configure Ant to Use EclipseLink Database Web Services Tasks

  1. Consider the Ant library dependencies.
    For more information, see http://ant.apache.org/manual/installl#librarydependencies
  2. Ensure that the EclipseLink database Web service-specific JAR files that the EclipseLink Ant Task Library Dependencies table lists are on the Ant classpath.
    EclipseLink Ant Task Library Dependencies
    JAR Name Needed For... Available At...

    eclipselink-dbws-tools.jar

    EclipseLink database Web services Ant tasks and type definitions.

    <ECLIPSELINK_HOME>/lib/java/shared/org.eclipse.persistence.dbws/11.1.1.0.0


  3. Declare EclipseLink database Web service tasks in a eclipselinkant-lib.xml file, as this example shows.
    eclipselink-ant-lib.xml File for EclipseLink Database Web Service Ant Tasks
    <?xml version="1.0"?>
    <antlib>
        <taskdef name="GenerateFromTables"
            classname="org.eclipse.persistence.tools.dbws.GenerateFromTables" />
    
        <taskdef name="GenerateFromSQL"
            classname="org.eclipse.persistence.tools.dbws.GenerateFromSQL" />
    
        <taskdef name="GenerateFromStoredProcedure"
            classname="org.eclipse.persistence.tools.dbws.GenerateFromStoredProcedure" />
    
        <taskdef name="GenerateFromPackage"
            classname="org.eclipse.persistence.tools.dbws.GenerateFromPackage" />
    
        <taskdef name="BuildDBWSWar"
            classname="org.eclipse.persistence.tools.dbws.BuildDBWSWar" />
    
        <taskdef name="Operation"
            classname="org.eclipse.persistence.tools.dbws.Op" />
    
        <taskdef name="SQLOperation"
            classname="org.eclipse.persistence.tools.dbws.SQLOp" />
    
        <taskdef name="Binding"
            classname="org.eclipse.persistence.tools.dbws.Binding" />
    
    </antlib>
    
  4. Include the eclipselink-ant-lib.xml file in your Ant build.xml file, as the following example shows.
    Specifying the eclipselink-ant-lib.xml File in a build.xml File
    <project name="MyBuild" default="validate.session" basedir="." xmlns:eclispelink="eclispelinklib">
        <typedef file = "eclipselink-ant-lib.xml" classpathref = "xr.classpath" uri = "eclispelinklib" />
    ...
    </project>
    


What You May Need to Know About Creating Deployment Files for a EclipseLink Database Web Service

This figure illustrates the process for creating EclipseLink database Web service deployment files.


Creating EclipseLink Database Web Service Deployment Files

Creating EclipseLink Database Web Service Deployment Files

This section describes the following:

For more information, see the following:


EclipseLink Database Web Services Ant Tasks

This table lists the Ant tasks that you can use to generate EclipseLink database Web services.


EclipseLink Database Web Services Ant Tasks

Task EclipseLink Class

Binding

org.eclipse.persistence.tools.dbws.Binding

BuildDBWSWar

org.eclipse.persistence.tools.dbws.BuildDBWSWar

GenerateFromSQL

org.eclipse.persistence.tools.dbws.GenerateFromSQL

GenerateFromStoredProcedures

org.eclipse.persistence.tools.dbws.GenerateFromStoredProcedure

GenerateFromTables

org.eclipse.persistence.tools.dbws.GenerateFromTables

Operations

org.eclipse.persistence.tools.dbws.Operations

Procedure

org.eclipse.persistence.tools.dbws.Procedure

SQLOperation

org.eclipse.persistence.tools.dbws.SQLOperation

Table

org.eclipse.persistence.tools.dbws.Table


You can invoke these Ant tasks directly on the command line or within your application's build system. For more information, see How to Configure Ant to Use EclipseLink Database Web Services Tasks.


EclipseLink Database Web Services WAR File

When you generate a EclipseLink database Web service, all generated files are packaged into a WAR file, as the following example shows. The EclipseLink Database Web Service WAR File Contents table lists the files in these WAR files.

For more information, see EclipseLink Database Web Services Ant Tasks.

EclipseLink Database Web Services WAR File

eclipselink-dbws.war
    indexl
    swaref.xsd
    eclispelink-dbws-schema.xsd
    META-INF/
        MANIFEST.MF
    web-inf/
        oracle-webservices.xml
        web.xml
        classes/
            META-INF/
                eclispelink-dbws.xml
                eclispelink-dbws-sessions.xml    // override eclispelink-dbws.xml sessions-file
                eclispelink-dbws-or.xml
                eclispelink-dbws-ox.xml
            com/                    // optional domain classes
                acme/
                    Address.class
                    Employee.class
                    PhoneNumber.class
        wsdl/
            eclispelink-dbws.wsdl


EclipseLink Database Web Service WAR File Contents

File Description

indexl

Default EclipseLink database Web service landing page.The name and content of this file is determined by its role in Web deployment and cannot be changed.Applicable to all WAR files.

swaref.xsd

Contains XML type definitions for attachments.The name and content of this file is determined by its role in Web deployment and cannot be changed.

topink-dbws-schema.xsd

Contains XML type definitions for operation arguments and return types. The EclipseLink database Web service automatically generates this file from your database table metadata and uses it to derive element-tag names and types. For more information, see eclispelink-dbws-schema.xsd.

MANIFEST.MF

The manifest file for the WAR file.

oracle-webservices.xml

The deployment descriptor that the OC4J Web services stack requires.The name and content of this file is determined by its role in Web deployment and cannot be changed.

web.xml

The Web application deployment file that binds the EclipseLink database Web service to an OC4J Web services stack servlet.

eclispelink-dbws.xml

The EclipseLink database Web services configuration file.
For more information, see eclispelink-dbws.xml File.

eclispelink-dbws-sessions.xml

The EclipseLink sessions.xml file for this EclipseLink database Web service. It contains references to the EclipseLink relational and object-XML project.xml files.
For more information, see Introduction to EclipseLink Sessions.

eclispelink-dbws-or.xml

The EclipseLink relational project.xml file.
For more information, see Introduction to Relational Projects.

eclispelink-dbws-ox.xml

The EclipseLink object-XML project.xml file.
For more information, see Introduction to XML Projects.

eclispelink-dbws.wsdl

Contains equivalent entries for each operation for the specified EclipseLink database Web service. Required for deployment as a Web service.


Before you can deploy the EclipseLink database Web service, you must package the WAR in the appropriate Java EE archive for your application, such as an EAR.

For more information, see the following:


Unstructured Data

In some circumstances, an EclipseLink database Web services operation may return unstructured data rather than a persistent entity. For example:

  • a resultSet from a custom SQL SELECT statement;
  • information returned by a program-unit;
  • scalar results such as from a stored function or a count of updated-rows from an update operation.

The OC4J Web services provider will return such unstructured data as documents that conform to the Simple XML Format (SXF) schema shown in this example.


Simple XML Format XSD for Unstructured Data

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

    </xsd:complexType>
    <xsd:element name="simple-xml-format" type="sxfType"/>
</xsd:schema>


The Example Unstructured Data Document example shows a typical unstructured data document. Note the following:

  • Element tag names are direct copies of table column names.
  • The default root-element tag name is simple-xml-format and each row uses the tag name simple-xml. You can customize these element tag names using attributes simpleXMLFormatTag and xmlTag in Ant tasks and.
  • Columnar data uses tag names taken either from the database schema (the actual database column name) or from the stored procedure, stored function, or trigger.
  • If a column is a primary key, the EclipseLink database Web service adds a isPrimaryKey attribute to the column tag and sets it to true, as shown for EMPNO in this example.


Example Unstructured Data Document

<?xml version = '1.0' encoding = 'UTF-8'?>
<simple-xml-format>
    <simple-xml>
        <EMPNO isPrimaryKey="true">7788</EMPNO>

        <ENAME>SCOTT</ENAME>
        <JOB>ANALYST</JOB>
        <MGR>7566</MGR>
        <HIREDATE>1987-04-19T00:00:00.000-0400</HIREDATE>

        <SAL>3000</SAL>
        <DEPTNO>20</DEPTNO>
    </simple-xml>
    <simple-xml>
        <EMPNO isPrimaryKey="true">7369</EMPNO>

        <ENAME>SMITH</ENAME>
        <JOB>CLERK</JOB>
        <MGR>7902</MGR>
        <HIREDATE>1980-12-17T00:00:00.000-0400</HIREDATE>

        <SAL>800</SAL>
        <DEPTNO>20</DEPTNO>
    </simple-xml>
</simple-xml-format>


For more information, see the following:


Customizing EclipseLink Database Web Services

To customize an EclipseLink database Web service, you can do the following:

  • Implement an EclipseLink SessionCustomizer class.A SessionCustomizer is a Java class that implements the org.eclipse.persistence.sessionconfiguration.SessionCustomizer interface and provides a default (zero-argument) constructor.Use this class's customize method, which takes an oracle.toplink.essentials.sessions.Session, to programmatically access advanced EclipseLink session API. Using this API you can get object relational and XML descriptors and from descriptors, you can get object relational and XML mappings.
    In this way, you can access all session, descriptor, and mapping API to customize any part of the EclipseLink runtime that the EclipseLink database Web service generates. For example, to turn off the session cache. This approach is best when you just want to customize a few details.You specify the SessionCustomizer when you execute the BuildDBWSWar Ant task.By default, the session names are defined based on the eclipselink-dbws.xml file name attribute as follows:
    • relational session name: name-dbws-or-session
    • object-xml session name: name-dbws-ox-session
  • Manually generate project.xml files and sessions.xml file.Using your preferred tool, Oracle JDeveloper or Workbench, you can map your objects to your relational database in an EclipseLink relational project, map your objects to your XML schema in an EclipseLink XMl project, and create an EclipseLink sessions.xml file that references both projects.In this way, you can control all aspects of the relational and XML mapping. This approach is best when you want to customize most or all details.

For more information, see the following:


Binding

The Binding Ant task is a EclipseLink database Web services task you use to bind an argument in an SQL statement to an XSD data type.

The order in which you define Binding tasks must match the order of the arguments in your SQL statement, as the SQLOperation Task: With Binding Elements for Arguments example shows.


Using Parameters

Binding Task Parameters

Attribute Description Required

name

The name of the stored procedure, stored function, or trigger to execute. The parent task that owns the Operation specifies the database that provides the stored procedure, stored function, or trigger.
For more information, see GenerateFromSQL.

Yes

type

The XSD data type to bind to the argument name.

Yes


Examples

The following example shows a typical SQLOperation task that specifies arguments using nested Binding tasks. The order in which you define Binding tasks must match the order of the arguments in your SQL statement.

For example, the SQLOperation named FindAnEmployee takes one int argument (EMPNO), one string argument (LAST_NAME), and returns all fields in a RowSet using a rowsetTag of employee-rowset and a rowTag of employee


SQLOperation Task: With Binding Elements for Arguments

<xr:GenerateFromSQL
    driver = "oracle.jdbc.OracleDriver"
    user = "scott"
    password = "tiger"
    url = "jdbc:oracle:thin:@localhost:1251:orcl"
    rdbms = "org.eclipse.persistence.platform.database.oracle.Oracle9Platform"
    tablename = "EMP"
    EclipseLinkProjectName = "employeeService"
    logLevel = "CONFIG"
    classpathref = "${myApplication.classpath}">

    <xr:SQLOperation name="CountEmployees" rowTag="employee-info">
        select count(*) from EMP
    </xr:SQLOperation>

    <xr:SQLOperation name="FindAnEmployee" rowsetTag="employee-rowset" rowTag="employee">

        select * from EMP where EMPNO = ? and LAST_NAME = ?
            <xr:Binding name="EMPNO" type="xsd:int"/>
            <xr:Binding name="LAST_NAME" type="xsd:string"/>
    </xr:SQLOperation

</xr:GenerateFromSQL>


For more information, see SQLOperation.


BuildDBWSWar

The BuildDBWSWar Ant task (see the BuildDBWSWar Task example) is a EclipseLink database Web services task you use either with a EclipseLink database Web services generator task or without.

When you execute the BuildDBWSWar task with a generator, the BuildDBWSWar task generates EclipseLink database Web services files and assemble them into a Web Archive (WAR) file. The BuildDBWSWar task supports the following generators:

When you execute the BuildDBWSWar task without a generator, the BuildDBWSWar task assembles EclipseLink database Web services files in a subdirectory of the current working directory named according to the EclipseLinkProjectName attribute into a Web Archive (WAR) file.

This allows you to customize the generated EclipseLink database Web services files and then execute the BuildDBWSWar task again to re-package the WAR file to include your changes.

This task extends the Ant Jar task and inherits its attributes and nested elements.


Using Parameters

BuildDBWSWar Task Parameters

Attribute Description Required Default

classpathref

Reference to a path defined elsewhere.

The EclipseLink database Web services classpath must includes references to:

  • JDBC driver
  • EclipseLink database platform (see platformClassName)
  • EclipseLink session customizer class, if used (see sessionCustomizerClassName)
  • eclipselink-xr-tools.jar file that contains the EclipseLink database Web services Ant tasks.

Alternatively, you can use a nested Ant classpath element.

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>

Yes

None

destfile

The fully qualified path to the WAR file.

Yes

None

dataSource

JNDI datasource location to be inserted into the EclipseLink database Web service sessions.xml file (see sessionsFileName).

The JNDI name you use here is as defined in ORACLE_INSTANCE/config/oc4j/OC4J_INSTANCE/data-sources.xml file element managed-data-source attribute jndi-name or element native-data-source attribute jndi-name.

You must configure this datasource in OC4J before deploying your EclipseLink database Web service.

Use this attribute as an alternative to generator attributes:

  • driver
  • password
  • rdbms
  • url
  • userid

Example:

Given the following OC4J data-sources.xml configuration, you would set BuildDBWSWar attribute dataSource to jdbc/OracleDS.

<data-sources ... >
    <connection-pool name="MyPool">
    ...
    </connection-pool>
    <managed-data-source
        name="OracleManagedDS"
        jndi-name="jdbc/OracleDS"
        connection-pool-name="MyPool"
        ...
    />
</data-sources ... >

No

None

logLevel

Control 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

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 task classpath.

Example: org.eclipse.persistence.platform.database.oracle.Oracle11Platform

Yes – when you execute this task with a generator to generate a new service.

No – when you execute this task without a generator to assemble pre-existing metadata files.

None

projectName

The name of this EclipseLink database Web service.

By default, the EclipseLink project names are defined based on this attribute:

  • relational session name: projectName-dbws-or-session
  • object-xml session name: projectName-dbws-ox-sessionThe EclipseLink project file names are not configurable and are set to the following:
  • relational project file name: eclipselink-dbws-or.xml
  • object-xml project file name: eclipselink-dbws-ox.xml

Yes – when you execute this task with a generator to generate a new service.

No – when you execute this task without a generator to assemble pre-existing metadata files.

eclipselink-dbws.xml file element name. For more information, see eclipselink-dbws.xml File.

sessionCustomizerClassName

The name of the org.eclipse.persistence.sessions.SessionCustomizer class you use to customize the EclipseLink database Web service.

For more information, see How to Customize a EclipseLink Database Web Service Using Java: Session Customization.

Yes – when you execute this task with a generator to generate a new service.

No – when you execute this task without a generator to assemble pre-existing metadata files.

None

sessionsFileName

The name of the EclipseLink sessions.xml file that references the relational and XML projects.

By default, the EclipseLink session names are defined based on the projectName attribute:

  • relational session name: projectName-dbws-or-session
  • object-xml session name: projectName-dbws-ox-session

Yes – when you execute this task with a generator to generate a new service.

No – when you execute this task without a generator to assemble pre-existing metadata files.

eclipselink-dbws-sessions.xml

targetNameSpace

The URI of the target namespace that the EclipseLink database Web service inserts into the eclipselink-dbws-schema.xsd file. For more information, see eclipselink-dbws-schema.xsd.

No

"urn:" + projectName

wsdlLocationURI

URI of this EclipseLink DBWS service's WSDL (used by Web Service tools to generate client code).

No

http://localhost:8888/


Specifying Parameters as Nested Elements

You can specify the following as nested elements of this task:


Examples

This example shows a typical BuildDBWSWar task.


BuildDBWSWar Task

<BuildDBWSWar
    destfile="emp.war"
    projectName="emp"
    sessionsFileName="emp-sessions.xml"
    platformClassName="org.eclipse.persistence.platform.database.oracle.Oracle10Platform"
    classpathref="eclipselink.dbws.path"
    >
    <GenerateFromTables
        driver="${login.driverClass}"
        userid="${login.username}"
        password="${login.password}"
        url="${login.databaseURL}"
        >
        <Table                <!-- Generates CRUD operations -->
            catalogPattern="%"
            schemaPattern="SCOTT"
            tableNamePattern="XR_EMP"
            >
            <Operations>      <!-- Additional operations -->

                <SQLOperation
                    name="findXREmpByName"
                    returnType="xr_empType"
                    >
                        select * from XR_EMP where ENAME like ?
                    <Binding
                        name="ENAME"
                        type="xsd:string"
                    />
                </SQLOperation>
                <SQLOperation
                    name="xr-employeeInfo"
                    isCollection="false"
                    simpleXMLFormatTag="xr-employee-info"
                    xmlTag="aggregate-counts"
                    >
                        select count(*) as "COUNT", max(SAL) as "MAX-Salary" from XR_EMP
                </SQLOperation>

                <Procedure
                    catalogPattern="SOME_PKG"
                    schemaPattern="SCOTT"
                    procedurePattern="GetEmployeeByEMPNO_DEPTNO"
                    returnType="xr_empType"
                />
            </Operations>
        </Table>
    </GenerateFromTables>
</BuildDBWSWar>


For more information, see the following:


GenerateFromSQL

The GenerateFromSQL task is a EclipseLink database Web services task you use to generate a Web service based on one or more SQL statements you specify with SQLOperation nested elements. You specify SQL statements with respect to the existing relational database schema that the SQLOperation element's parent identifies.

This task generates an operation for each SQLOperation nested element you specify.

This task generates EclipseLink database Web service files in a subdirectory of the current working directory named according to the EclipseLinkProjectName attribute.


Using Parameters

GenerateFromSQL Task Parameters

Attribute Description Required Default

driver

The fully qualified name of the JDBC driver class to use to connect to the relational database. This class must be in the task classpath.

This attribute is inherited from the Ant Sql task.

Example: oracle.jdbc.OracleDriver

No – Can be overridden by BuildDBWSWar attribute dataSource.

None

password

The password to use when connecting to the relational database.

This attribute is inherited from the Ant Sql task.

No – Can be overridden by BuildDBWSWar attribute dataSource.

None

url

The connection URL to use when connecting the relational database.

This attribute is inherited from the Ant Sql task.

Example: jdbc:oracle:thin:@HOST_NAME:PORT:SID

No – Can be overridden by BuildDBWSWar attribute dataSource.

None

userid

The user name to use when connecting to the relational database.

This attribute is inherited from the Ant Sql task.

No – Can be overridden by BuildDBWSWar attribute dataSource.

None


Specifying Parameters as Nested Elements

You can specify the following parameters as nested elements of this task:


Examples

The GenerateFromSQL Task example shows a typical GenerateFromSQL task that specifies an SQLOperation.

The EclipseLink database Web service named emp will contain an operation findXREmpByName that takes one string argument (ENAME) and returns all records from the XR_EMP table whose ENAME column is like the argument. Results are returned as a Collection of xr_emptType instances.


GenerateFromSQL Task

<BuildDBWSWar
    destfile="emp.war"
    projectName="emp"
    sessionsFileName="emp-sessions.xml"
    platformClassName="org.eclipse.persistence.platform.database.oracle.Oracle10Platform"
    classpathref="eclipselink.dbws.path"
    >
    <GenerateFromSQL
        driver = "oracle.jdbc.OracleDriver"
        url = "jdbc:oracle:thin:@localhost:1251:orcl"
        password = "tiger"
        userid = "scott"
        >
        <SQLOperation
            name="findXREmpByName"
            returnType="xr_empType"
            >
                select * from XR_EMP where ENAME like ?
            <Binding
                name="ENAME"
                type="xsd:string"
            />
        </SQLOperation>

    <GenerateFromSQL>
</BuildDBWSWar


For more information, see How to Create Deployment Files for a EclipseLink Database Web Service Using Ant: from SQL.


GenerateFromStoredProcedures

The GenerateFromStoredProcedures task is a EclipseLink database Web services task you use to generate a Web service based on one or more stored procedures, stored functions, or triggers you specify with Procedure nested elements. You specify stored procedures, stored functions, or triggers with respect to the existing relational database schema that the Procedure element's parent identifies.

This task generates an operation for each Procedure nested element you specify.

This task generates EclipseLink database Web service files in a subdirectory of the current working directory named according to the EclipseLinkProjectName attribute.


Using Parameters

GenerateFromStoredProcedures Task Parameters

Attribute Description Required Default

driver

The fully qualified name of the JDBC driver class to use to connect to the relational database. This class must be in the task classpath.

This attribute is inherited from the Ant Sql task.

Example: oracle.jdbc.OracleDriver

No – Can be overridden by BuildDBWSWar attribute dataSource.

None

password

The password to use when connecting to the relational database.

This attribute is inherited from the Ant Sql task.

No – Can be overridden by BuildDBWSWar attribute dataSource.

None

url

The connection URL to use when connecting the relational database.

This attribute is inherited from the Ant Sql task.

Example: jdbc:oracle:thin:@HOST_NAME:PORT:SID

No – Can be overridden by BuildDBWSWar attribute dataSource.

None

userid

The user name to use when connecting to the relational database.

This attribute is inherited from the Ant Sql task.

No – Can be overridden by BuildDBWSWar attribute dataSource.

None


Specifying Parameters as Nested Elements

You can specify the following parameters as nested elements of this task:


Examples

The GenerateFromStoredProcedures Task example shows a typical GenerateFromStoredProcedures task that specifies a Procedure for each of two stored procedures.

The EclipseLink database Web service named emp will contain one operation GetEmployeeByEMPNO_DEPTNO that invokes a stored procedure such as this:

GetEmployeeByEMPNO_DEPTNO(I_EMPNO IN NUMBER,I_DEPTNO IN NUMBER, Y OUT SYS_REFCURSOR);
OPEN y FOR SELECT * FROM XR_EMP where EMPNO = I_EMPNO and DEPTNO = I_DEPTNO;

Note that if procedurePattern matches more than one stored procedure, stored function, or trigger, then the EclipseLink database Web service will contain a procedure for each match. For more information, see Procedure.


GenerateFromStoredProcedures Task

<BuildDBWSWar
    destfile="emp.war"
    projectName="emp"
    sessionsFileName="emp-sessions.xml"
    platformClassName="org.eclipse.persistence.platform.database.oracle.Oracle10Platform"
    classpathref="eclipselink.dbws.path"
    >
    <GenerateFromStoredProcedures
        driver="${login.driverClass}"
        userid="${login.username}"
        password="${login.password}"
        url="${login.databaseURL}"
        >
        <Procedure
            catalogPattern="SOME_PKG"
            schemaPattern="SCOTT"
            procedurePattern="GetEmployeeByEMPNO_DEPTNO"
            returnType="xr_empType"
        />
    </GenerateFromStoredProcedures>
</BuildDBWSWar>


For more information, see How to Create Deployment Files for a EclipseLink Database Web Service Using Ant: from a Stored Procedure.


GenerateFromTables

The GenerateFromTables task is a EclipseLink database Web services task you use to generate a Web service based on one or more relational database tables.

This task generates the following operations for each table you specify using one or more Table nested elements:

  • create
  • findAll
  • findByPrimaryKey
  • update
  • delete

These operations apply to a single table only: they do not traverse relationships to other tables. For example, the read operation returns the key value of a foreign key column, not the row it references in a related table.

This task generates EclipseLink database Web service files in a subdirectory of the current working directory named according to the EclipseLinkProjectName attribute.


Using Parameters

GenerateFromTables Task Parameters

Attribute Description Required Default

driver

The fully qualified name of the JDBC driver class to use to connect to the relational database. This class must be in the task classpath.

This attribute is inherited from the Ant Sql task.

Example: oracle.jdbc.OracleDriver

No – Can be overridden by BuildDBWSWar attribute dataSource.

None

password

The password to use when connecting to the relational database.

This attribute is inherited from the Ant Sql task.

No – Can be overridden by BuildDBWSWar attribute dataSource.

None

url

The connection URL to use when connecting the relational database.

This attribute is inherited from the Ant Sql task.

Example: jdbc:oracle:thin:@HOST_NAME:PORT:SID

No – Can be overridden by BuildDBWSWar attribute dataSource.

None

userid

The user name to use when connecting to the relational database.

This attribute is inherited from the Ant Sql task.

No – Can be overridden by BuildDBWSWar attribute dataSource.

None


Specifying Parameters as Nested Elements

You can specify the following parameters as nested elements of this task:

  • Table – this is a mandatory element. The GenerateFromTables task requires at least one Table element.


Examples

The GenerateFromTables Task example shows a typical GenerateFromTables task.

The EclipseLink database Web service named emp will contain create, read, read-all, update, and delete operations for table XR_EMP.

Note that if tableNamePattern matches more than one table name, then the EclipseLink database Web service will contain create, read, read-all, update, and delete operations for each match. For more information, see Table.


GenerateFromTables Task

<BuildDBWSWar
    destfile="emp.war"
    projectName="emp"
    sessionsFileName="emp-sessions.xml"
    platformClassName="org.eclipse.persistence.platform.database.oracle.Oracle10Platform"
    classpathref="eclipselink.dbws.path"
    >
    <GenerateFromTables
        driver="${login.driverClass}"
        userid="${login.username}"
        password="${login.password}"
        url="${login.databaseURL}"
        >
        <Table                <!-- Generates CRUD operations -->

            catalogPattern="%"
            schemaPattern="SCOTT"
            tableNamePattern="XR_EMP"
            >
        </Table>
    </GenerateFromTables>
</BuildDBWSWar>


For more information, see How to Create Deployment Files for a EclipseLink Database Web Service Using Ant: from a Database Table.


Operations

The Operations task is a EclipseLink database Web services task you use to specify one or more stored procedure or SQL operations.

This task is applicable only in Table tasks. For more information, see Table.


Using Parameters

This task has no parameters (only nested elements).


Specifying Parameters as Nested Elements

You can specify the following parameters as nested elements of this task:


Examples

This example shows a typical Operations task.


Operations Task

<BuildDBWSWar
    destfile="emp.war"
    projectName="emp"
    sessionsFileName="emp-sessions.xml"
    platformClassName="org.eclipse.persistence.platform.database.oracle.Oracle10Platform"
    classpathref="eclipselink.dbws.path"
    >
    <GenerateFromTables
        driver="${login.driverClass}"
        userid="${login.username}"
        password="${login.password}"
        url="${login.databaseURL}"
        >
        <Table                <!-- Generates CRUD operations -->
            catalogPattern="%"
            schemaPattern="SCOTT"
            tableNamePattern="XR_EMP"
            >

            <Operations>      <!-- Additional operations -->
                <SQLOperation
                    name="findXREmpByName"
                    returnType="xr_empType"
                    >
                        select * from XR_EMP where ENAME like ?
                    <Binding
                        name="ENAME"
                        type="xsd:string"
                    />
                </SQLOperation>
                <SQLOperation
                    name="xr-employeeInfo"
                    isCollection="false"
                    simpleXMLFormatTag="xr-employee-info"
                    xmlTag="aggregate-counts"
                    >

                        select count(*) as "COUNT", max(SAL) as "MAX-Salary" from XR_EMP
                </SQLOperation>
                <Procedure
                    catalogPattern="SOME_PKG"
                    schemaPattern="SCOTT"
                    procedurePattern="GetEmployeeByEMPNO_DEPTNO"
                    returnType="xr_empType"
                />
            </Operations>
        </Table>
    </GenerateFromTables>
</BuildDBWSWar>


For more information, see How to Create Deployment Files for a EclipseLink Database Web Service Using Ant: from a Database Table.


Procedure

The Procedure task is a EclipseLink database Web services task you use to specify a stored procedure.

You can invoke this task from the following parent tasks:


Using Parameters

Procedure Task Parameters

Attribute Description Required Default

catalogPattern

A pattern that matches one or more catalog names in the database identified by the parent task (supports SQL-92 % wild-card).

No

%

schemaPattern

A pattern that matches one or more schema names in the database identified by the parent task (supports SQL-92 % wild-card).

No

%

procedurePattern

A pattern that matches one or more stored procedure, stored function, or stored trigger names in the database identified by the parent task (supports SQL-92 % wild-card).

Yes

None

isCollection

Specifies whether or not the procedure returns multiple results. Valid values are:

  • true - the operation returns more than a single row.
  • false - the operation returns a single row.

No

true

isSimpleXMLFormat

Specifies whether or not the procedure returns information in the Simple XML Format (SXF). Valid values are:

  • true - the operation returns information in the Simple XML Format.
  • false - the operation returns information in the Simple XML Format.
    For more information, see Unstructured Data.

Yes

false

simpleXMLFormatTag

The name of the root-level Simple XML Format element-tag.
For more information, see Unstructured Data.

No

simple-xml-format

xmlTag

The name of the grouping XML element-tag for rows.
For more information, see Unstructured Data.

No

simple-xml

binaryAttachment

Specifies whether or not the operation returns binary data as a SOAP attachment. Valid values are:

  • true - the operation returns binary data as a SOAP attachment.
  • false - the operation does not return binary data as a SOAP attachment.

No

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. For more information, see eclipselink-dbws-schema.xsd.

No

Deduced from database metadata


Examples

This example shows a Procedure task.


Procedure Task

<BuildDBWSWar
    destfile="emp.war"
    projectName="emp"
    sessionsFileName="emp-sessions.xml"
    platformClassName="org.eclipse.persistence.platform.database.oracle.Oracle10Platform"
    classpathref="eclipselink.dbws.path"
    >
    <GenerateFromStoredProcedures
        driver="${login.driverClass}"
        userid="${login.username}"
        password="${login.password}"
        url="${login.databaseURL}"
        >
        <Procedure
            catalogPattern="SOME_PKG"
            schemaPattern="SCOTT"
            procedurePattern="GetEmployeeByEMPNO_DEPTNO"
            isSimpleXMLFormat = "true"
            simpleXMLFormatTag = "EmployeesByEmpNoDeptNo"
            xmlTag = "Employee"
        />
    </GenerateFromStoredProcedures>
</BuildDBWSWar>


The EclipseLink database Web service named emp will contain one operation GetEmployeeByEMPNO_DEPTNO that invokes a stored procedure of the same name (defined in the database table that the parent task specifies) like this:

GetEmployeeByEMPNO_DEPTNO(I_EMPNO IN NUMBER,I_DEPTNO IN NUMBER, Y OUT SYS_REFCURSOR);
OPEN y FOR SELECT * FROM XR_EMP where EMPNO = I_EMPNO and DEPTNO = I_DEPTNO;

Note that if procedurePattern matches more than one stored procedure, stored function, or trigger, then the EclipseLink database Web service will contain a procedure for each match.

This procedure returns unstructured data in the Simple XML Format, as the Unstructured Data Result example shows. Column tags (like EMPNO, DEPTNO, and SAL) are determined by the database schema.


Unstructured Data Result

<?xml version = '1.0' encoding = 'UTF-8'?>
<EmployeesByEmpNoDeptNo>
    <Employee>
        <EMPNO isPrimaryKey="true">12345</EMPNO>
        <DEPTNO>50</DEPTNO>

        <SAL>125000</SAL>
        ...
    </Employee>
    <Employee>
        <EMPNO isPrimaryKey="true">67890</EMPNO>

        <DEPTNO>40</DEPTNO>
        <SAL>75000</SAL>
        ...
    </Employee>
    ...
</EmployeesByEmpNoDeptNo>


For more information, see How to Create Deployment Files for a EclipseLink Database Web Service Using Ant: from SQL.


SQLOperation

The SQLOperation task is a EclipseLink database Web services task you use to specify an SQL statement.

You can invoke this task from the following parent tasks:


Using Parameters

SQLOperation Task Parameters

Attribute Description Required Default

name

The name of the SQL operation. The parent task that owns the SQLOperation specifies the database on which to perform the SQL operation.

Yes


isCollection

Specifies whether or not the procedure returns multiple results. Valid values are:

  • true - the operation returns more than a single row.
  • false - the operation returns a single row.

No

true

isSimpleXMLFormat

Specifies whether or not the procedure returns information in the Simple XML Format (SXF). Valid values are:

  • true - the operation returns information in the Simple XML Format.
  • false - the operation returns information in the Simple XML Format.
    For more information, see Unstructured Data.

Yes

false

simpleXMLFormatTag

The name of the root-level Simple XML Format element-tag.
For more information, see Unstructured Data.

No

simple-xml-format

xmlTag

The name of the grouping XML element-tag for rows.
For more information, see Unstructured Data.

No

simple-xml

binaryAttachment

Specifies whether or not the operation returns binary data as a SOAP attachment. Valid values are:

  • true - the operation returns binary data as a SOAP attachment.
  • false - the operation does not return binary data as a SOAP attachment.

No

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. For more information, see eclipselink-dbws-schema.xsd.

No

Deduced from database metadata


Specifying Parameters as Nested Elements

You can specify the following parameter as nested element of this task:


Examples

This example shows two SQLOperation tasks.


SQLOperation Task

<BuildDBWSWar
    destfile="emp.war"
    projectName="emp"
    sessionsFileName="emp-sessions.xml"
    platformClassName="org.eclipse.persistence.platform.database.oracle.Oracle10Platform"
    classpathref="eclipselink.dbws.path"
    >
    <GenerateFromSQL
        driver = "oracle.jdbc.OracleDriver"
        url = "jdbc:oracle:thin:@localhost:1251:orcl"
        password = "tiger"
        userid = "scott"
        >
        <SQLOperation
            name="findXREmpByName"
            returnType="xr_empType"
            >
                select * from XR_EMP where ENAME like ?
            <Binding
                name="ENAME"
                type="xsd:string"
            />
        </SQLOperation>

        <SQLOperation
            name="xr-employeeInfo"
            isCollection="false"
            simpleXMLFormatTag="xr-employee-info"
            xmlTag="aggregate-counts"
            >
                select count(*) as "COUNT", max(SAL) as "MAX-Salary" from XR_EMP
        </SQLOperation>
    <GenerateFromSQL>
</BuildDBWSWar


The EclipseLink database Web service named emp will contain two operations:

  • findXREmpByName that takes one string argument (ENAME) and returns all records from the XR_EMP table whose ENAME column is like the argument. Results are returned as a Collection of xr_emptType instances.
  • xr-employeeInfo that returns unstructured data in the Simple XML Format as the Unstructured Data Result example shows. In this output, COUNT is the number of records in table XR_EMP and MAX-Salary is the largest number in the SAL column. The tag names COUNT and MAX-Salary are as specified in the SQL statement.


Unstructured Data Result

<?xml version = '1.0' encoding = 'UTF-8'?>
<xr-employee-info>
  <aggregate-counts>
    <COUNT>60000</COUNT>

    <MAX-Salary>125000</MAX-Salary>
  </aggregate-counts>
</xr-employee-info>


For more information, see How to Create Deployment Files for a EclipseLink Database Web Service Using Ant: from SQL.


Table

The Table task is a EclipseLink database Web services task you use to specify a database table.

This task is applicable only in GenerateFromTables tasks. For more information, see GenerateFromTables.


Using Parameters

Table Task Parameters

Attribute Description Required Default

catalogPattern

A pattern that matches one or more catalog names in the database identified by the parent task (supports SQL-92 % wild-card).

No

%

schemaPattern

A pattern that matches one or more schema names in the database identified by the parent task (supports SQL-92 % wild-card).

No

%

tableNamePattern

A pattern that matches one or more table names in the database identified by the parent task (supports SQL-92 % wild-card).

Yes

None


Specifying Parameters as Nested Elements

You can specify the following parameters as nested elements of this task:


Examples

The following example shows a typical Table task.

The EclipseLink database Web service named emp will contain create, read, read-all, update, and delete operations for table XR_EMP.

Note that if tableNamePattern matches more than one table name, then the EclipseLink database Web service will contain create, read, read-all, update, and delete operations for each match.


Table Task

<BuildDBWSWar
    destfile="emp.war"
    projectName="emp"
    sessionsFileName="emp-sessions.xml"
    platformClassName="org.eclipse.persistence.platform.database.oracle.Oracle10Platform"
    classpathref="eclipselink.dbws.path"
    >
    <GenerateFromTables
        driver="${login.driverClass}"
        userid="${login.username}"
        password="${login.password}"
        url="${login.databaseURL}"
        >
        <Table                <!-- Generates CRUD operations -->
            catalogPattern="%"
            schemaPattern="SCOTT"
            tableNamePattern="XR_EMP"
            >
        </Table>
     </GenerateFromTables>
</BuildDBWSWar>


For more information, see How to Create Deployment Files for a EclipseLink Database Web Service Using Ant: from a Database Table.


Configuring the orion-ejb-jar.xml File for OC4J

To deploy a EclipseLink application to OC4J Release R1 or later, modify the orion-ejb-jar.xml file. For more information, see How to Configure persistence-manager Entries.


How to Configure persistence-manager Entries

If you are using EclipseLink as your OC4J persistence manager, the default persistence manager in Release R1, you can configure the persistence-manager subentry (see the orion-ejb-jar.xml File persistence-manager Entries table) in the orion-ejb-jar.xml file.

If you are not using EclipseLink as your OC4J persistence manager, do not modify the persistence-manager subentries.

OC4J does not support entity-deployment attribute pm-name. Use persistence-manager attribute name instead (see the orion-ejb-jar.xml File persistence-manager Entries table). When OC4J parses the orion-ejb.jar.xml file, if it finds a pm-name attribute, OC4J ignores its value and logs the following warning message:


Use of pm-name is unsupported and will be removed in a future release. 
Specify pm usage using  <persistence-manager> 'name' instead.


orion-ejb-jar.xml File persistence-manager Entries

Entry Description

name

The name of the persistence manager to use. Set this value to eclipselink.

If you set the name property to eclipselink, you may also configure pm-properties (see Configuring pm-properties).

class-name

Do not configure this attribute. If name is set to eclipselink, then class-name is set correctly by default.

descriptor

This property applies only when name is set to eclipselink.

If you export your EclipseLink mapping metadata to a deployment XML file, set this property to the name of the deployment XML file (default: toplink-ejb-jar.xml).

Do not set this property if you are using a EclipseLink project class instead of a mapping metadata file (see project-class in the orion-ejb-jar.xml File persistence-manager Subentries for pm-properties table).



Configuring pm-properties

When you select EclipseLink as the persistence manager (see name in the orion-ejb-jar.xml File persistence-manager Entries table), use the persistence-manager subentries for pm-properties (see the orion-ejb-jar.xml File persistence-manager Subentries for pm-properties table) to configure the EclipseLink session that the EclipseLink run time creates and uses internally.


Note: You can only configure a subset of session features using these properties and in most cases, default configuration applies. To configure all session features and to override defaults, you must use a customization class (see customization-class in the orion-ejb-jar.xml File persistence-manager Subentries for pm-properties table).


orion-ejb-jar.xml File persistence-manager Subentries for pm-properties

Entry Description

session-name

Unique name for this EclipseLink-persisted EJB deployment JAR file. Must be unique among all EclipseLink-persisted deployed JAR files in this application server instance.

When the EclipseLink run time internally creates a EclipseLink session for this EclipseLink-persisted deployed JAR file, the EclipseLink session manager stores the session instance under this session-name. For more information about the session manager, see Acquiring and Using Sessions at Run Time).

If you do not specify a name, the EclipseLink runtime will generate a unique name.

project-class

If you export your EclipseLink mapping metadata to a Java class (that extends org.eclipse.persistence.sessions.Project), set this property to the name of the class, fully qualified by its package name. Be sure to include the class file in the deployable JAR file.

Do not set this property if you are using a mapping metadata file (see descriptor in the orion-ejb-jar.xml File persistence-manager Entries table).

customization-class

Optional Java class (that implements org.eclipse.persistence.ejb.cmp.DeploymentCustomization) used to allow deployment customization of EclipseLink mapping and run-time configuration. At deployment time, the EclipseLink run time creates a new instance of this class and invokes its methods beforeLoginCustomization (before the EclipseLink run time logs into the session) and afterLoginCustomization (after the EclipseLink runtime logs into the session), passing in the EclipseLink session as a parameter.

Use your implementation of the beforeLoginCustomization method to configure session attributes not supported by the pm-properties including: cache coordination (see also Configuring cache-synchronization Properties), parameterized SQL, native SQL, batch writing/batch size, byte-array/string binding, EIS login, event listeners, table qualifier, and sequencing. For more information about session configuration, see Configuring a Session.

The class must be fully qualified by its package name and included in the deployment JAR file.

db-platform-class

Optional EclipseLink database platform class (instance of org.eclipse.persistence.platform.database or org.eclipse.persistence.platform.database.oracle) containing EclipseLink support specific to a particular database.

Set this value to the database platform class that corresponds to the database that your application uses. The class must be fully qualified by its package name.

remote-relationships

Optional flag to allow relationships between remote objects. Valid values are:

  • true: All relationships will be maintained through the remote interfaces of the entity beans
  • false: Disables this feature.

cache-synchronization

See Configuring cache-synchronization Properties.

default-mapping

See Configuring default-mapping Properties.


Configuring cache-synchronization Properties

When you select EclipseLink as the persistence manager (see name in the orion-ejb-jar.xml File persistence-manager Entries table), use the pm-properties subentry for cache-synchronization (see the orion-ejb-jar.xml File pm-properties Subentries for cache-synchronization table table) to configure EclipseLink cache coordination features of the session that the EclipseLink run time uses internally for CMP projects. For more information about EclipseLink cache coordination, see Cache Coordination.

When this subentry is present, you must use a customization class (see customization-class in the orion-ejb-jar.xml File persistence-manager Subentries for pm-properties table) to complete cache coordination configuration. For more information about EclipseLink cache coordination configuration, see Configuring a Coordinated Cache.

orion-ejb-jar.xml File pm-properties Subentries for cache-synchronization

Entry Description

mode

An indicator of whether or not cache coordination updates should be propagated to other servers synchronously or asynchronously. Valid values are as follows:

  • asynchronous (default)
  • synchronous

server-url

For a JMS coordinated cache: assuming that you are using the Oracle Containers for J2EE (OC4J) JNDI naming service and that all the hosts in your coordinated cache can communicate using OC4J proprietary RMI protocol ORMI, use a URL like:

ormi://<JMS-host-IP>:<JMS-host-port>

where JMS-host-IP is the IP address of the host on which the JMS service provider is running and JMS-host-port is the port on which the JMS service provider is listening for JMS requests.
For an RMI or CORBA coordinated cache: assuming that you are using the OC4J JNDI naming service and that all the hosts in your coordinated cache can communicate using OC4J proprietary RMI protocol ORMI on OC4J default port 23791, use a URL like:

ormi://<session-host-IP>:23791

where session-host-IP is the IP address of the host on which this session is deployed.

server-user

Optional username required to log in to the JNDI naming service.


Configuring default-mapping Properties

When you select EclipseLink as the persistence manager (see name in the orion-ejb-jar.xml File persistence-manager Entries table), use the pm-properties subentry for default-mapping (see the the following table table) to configure the EclipseLink default mapping and automatic table generation feature.

For more information about EclipseLink automatic table generation, see Creating Database Tables Automatically.


orion-ejb-jar.xml File pm-properties Subentries for default-mapping

Entry Description

db-table-gen

Optional element that determines what EclipseLink will do to prepare the database tables that are being mapped to. Valid values are:

  • Create (default): This value tells EclipseLink to create the mapped tables during the deployment. If the tables already exist, EclipseLink will log an appropriate warning messages (such as "Table already existed...") and keeps processing the deployment.
  • DropAndCreate: This value tells EclipseLink to drop tables before creating them during deployment. If a table does not initially exist, the drop operation will cause anSQLException to be thrown through the driver. However, EclipseLink handles the exception (logs and ignores it) and moves on to process the table creation operation. The deployment fails only if both drop and create operations fail.
  • UseExisting: This value tells EclipseLink to perform no table manipulation. If the tables do not exist, deployment still goes through without error.

If no orion-ejb-jar.xml file is defined in your EAR file, the OC4J container generates one during deployment. In this case, to specify a value for db-table-gen, use the EclipseLink system property eclipselink.defaultmapping.dbTableGenSetting. For example: -Declipselink.defaultmapping.dbTableGenSetting="DropAndCreate".

The orion-ejb-jar.xml property overrides the system property. If both the orion-ejb-jar.xml property and the system property are present, EclipseLink retrieves the setting from the orion-ejb-jar.xml file.

This setting overrides autocreate-tables and autodelete-tables configuration at the application (EAR) or system level. For more information, see Creating Database Tables Automatically.

extended-table-names

An element used if the generated table names are not long enough to be unique. Values are restricted to true or false (default). When set to true, the EclipseLink run time will ensure that generated tables names are unique.

In default mapping, each entity is mapped to one table. The only exception is in many-to-many mappings where there is one extra relation table involved in the source and target entities.

When extended-table-names is set to false (the default), a simple table naming algorithm is used as follows: table names are defined as TL_<bean_name>. For example, if the bean name is Employee, the associated table name would be TL_EaMPLOYEE.

However, if the same entity is defined in multiple JAR files in an application, or across multiple applications, table-naming collision is inevitable.

To address this problem, set extended-table-names to true. When set to true, EclipseLink uses an alternative table-naming algorithm as follows: table names are defined as <bean_name>_<jar_name>_<app_name>. This algorithm uses the combination of bean, JAR, and EAR names to form a table name unique across the application. For example, given a bean named Employee, which is in Test.jar, which is in Demo.ear (and the application name is "Demo"), then the corresponding table name will be EMPLOYEE_TEST_DEMO.

If there is no orion-ejb-jar.xml file defined in the EAR file, the OC4J container generates one during deployment. In this case, to specify a value for extended-table-names, use the EclipseLink system property eclipselink.defaultmapping.useExtendedTableNames. For example: -Declipselink.defaultmapping.useExtendedTableNames="true".

The orion-ejb-jar.xml property overrides the system property. If both the orion-ejb-jar.xml property and the system property are present, EclipseLink retrieves the setting from the orion-ejb-jar.xml file.


Configuring the weblogic-ejb-jar.xml File for BEA WebLogic Server

Before you deploy a EclipseLink application to a BEA WebLogic Server, you must modify the weblogic-ejb-jar.xml file.

Avoid the weblogic-ejb-jar.xml tags that EclipseLink either does not support or does not require (see What You May Need to Know About Unsupported weblogic-ejb-jar.xml File Tags).


What You May Need to Know About Unsupported weblogic-ejb-jar.xml File Tags

The weblogic-ejb-jar.xml file includes the following tags that EclipseLink either does not support or does not require:

  • concurrency-strategy: This tag specifies how WebLogic manages concurrent users for a given bean. Because EclipseLink manages concurrent access internally, it does not require this tag.
    For more information about the EclipseLink concurrency strategy, see Configuring Locking Policy.
  • db-is-shared: Because EclipseLink does not make any assumptions about the exclusivity of database access, EclipseLink does not require this tag. EclipseLink addresses multiuser access issues through various locking and refreshing policies.
  • delay-updates-until-end-of-tx: EclipseLink always delays updates until the end of a transaction, and does not require this tag.
  • finders-load-bean: EclipseLink always loads the bean upon execution of the finder, and does not require this tag.
  • pool: EclipseLink does not use a pooling strategy for entity beans. This avoids object-identity problems that can occur due to pooling.
  • lifecycle: This element manages beans that follow a pooling strategy. Because EclipseLink does not use a pooling strategy, EclipseLink ignores this tag.
  • is-modified-method-name: EclipseLink does not require a bean developer-defined method to detect changes in the object state.
  • isolation-level: Because isolation level settings for the cache or database transactions are specified in the EclipseLink project, EclipseLink ignores this tag.
  • cache: Because you define EclipseLink cache properties in Workbench, this tag is unnecessary.



Copyright Statement