org.eclipse.persistence.internal.xr

Class XRServiceFactory

java.lang.Object

org.eclipse.persistence.internal.xr.XRServiceFactory

Direct Known Subclasses:

ProviderHelper

public class XRServiceFactory
extends java.lang.Object

INTERNAL: helper class that knows how to build a XRServiceAdapter (a.k.a DBWS). An XRService requires the following resources:

• metadata in the form of a descriptor file called eclipselink-dbws.xml
  
• an XML Schema Definition (.xsd) file called eclipselink-dbws-schema.xsd
• a TopLink sessions.xml file called eclipselink-dbws-sessions.xml
  the naming convention for the sessions.xml files can be overriden by the optional <sessions-file> entry in the eclipselink-dbws.xml descriptor file.
• EclipseLink metadata in the form of a EclipseLink Project (either deployment XML or Java classes).

  A typical XRService requires two projects: one to represent the O-R side, the other to represent the O-X side.
  The O-R and O-X Projects metadata must have:
  i) identical case-sensitive Project names:

   <?xml version="1.0" encoding="UTF-8"?>
   <eclipselink:object-persistence version="Eclipse Persistence Services ..."
     xmlns:xsd="http://www.w3.org/2001/XMLSchema"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns:eclipselink="http://xmlns.oracle.com/ias/xsds/eclipselink"
     >
     <eclipselink:name>example</eclipselink:name>
   or
   ...
   import org.eclipse.persistence.sessions.Project;
   public class SomeORProject extends Project {
     public SomeORProject () {
       setName("Example");
       ...
   }
   public class SomeOXProject extends Project {
     public SomeOXProject () {
       setName("Example");
       ...
   }
   

  ii) identical case-sensitive aliases for Descriptors that are common between the projects:

   <eclipselink:class-mapping-descriptor xsi:type="eclipselink:relational-class-mapping-descriptor">
     <eclipselink:class>some.package.SomeClass</eclipselink:class>
     <eclipselink:alias>SomeAlias</eclipselink:alias>
   ...
   <eclipselink:class-mapping-descriptor xsi:type="eclipselink:xml-class-mapping-descriptor">
     <eclipselink:class>some.package.SomeClass</eclipselink:class>
     <eclipselink:alias>SomeAlias</eclipselink:alias>
   

An example eclipselink-dbws.xml descriptor file:

 <?xml version="1.0" encoding="UTF-8"?>
 <dbws
   xmlns:xsd="http://www.w3.org/2001/XMLSchema"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   >
   <name>example</name>
   <sessions-file>example-dbws-sessions.xml</sessions-file>
   <query>
     <name>countEmployees</name>
     <result>
       <type>xsd:int</type>
       <simple-xml-format>
         <simple-xml-format-tag>employee-info</simple-xml-format-tag>
         <simple-xml-tag>aggregate-info</simple-xml-tag>
       </simple-xml-format>
     </result>
     <sql><![CDATA[select count(*) from EMP]]></sql>
   </query>
   <query>
     <name>findAllEmployees</name>
     <result isCollection="true">
       <type>empType</type>
     </result>
     <sql><![CDATA[select * from EMP]]></sql>
   </query>
 </dbws>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XRServiceFactory.JPAMetadataSource INTERNAL: Implementation of MetadataSource to allow passing JPA metadata to the MetadataProcessor.
static class	XRServiceFactory.OXMMetadataSource INTERNAL: Implementation of MetadataSource to allow passing XmlBindings to the DynamicJAXBContextFactory
static class	XRServiceFactory.XRPersistenceUnitInfo INTERNAL: PersistenceUnitInfo implementation to allow creation of a MetadataProcessor instance.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.ClassLoader	parentClassLoader
java.io.InputStream	xrSchemaStream
XRServiceAdapter	xrService

Constructor Summary

Constructors

Constructor and Description
XRServiceFactory()

Method Summary

Modifier and Type	Method and Description
void	buildDescriptorIndex() INTERNAL:
XRServiceAdapter	buildService()
XRServiceAdapter	buildService(XRServiceModel xrServiceModel)
void	buildSessions() INTERNAL:
void	customizeSession(Session orSession, Session oxSession)
static javax.xml.parsers.DocumentBuilder	getDocumentBuilder()
static javax.xml.transform.Transformer	getTransformer()
void	initializeOperations() INTERNAL:
void	initializeService(java.lang.ClassLoader parentClassLoader, java.io.InputStream xrSchemaStream) INTERNAL: Initialize the various components (of the XRService} (O-R Project, O-X Project, Schema definitions, auto-generated classes, etc.)
void	loadXMLSchema(java.io.InputStream xrSchemaStream) INTERNAL: Read and unmarshal XRService's .xsd file.
void	loginSessions() INTERNAL:
void	validateOperations() INTERNAL:

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

xrService

public XRServiceAdapter xrService

parentClassLoader

public java.lang.ClassLoader parentClassLoader

xrSchemaStream

public java.io.InputStream xrSchemaStream

Constructor Detail

XRServiceFactory

public XRServiceFactory()

Method Detail

buildService

public XRServiceAdapter buildService()

buildService

public XRServiceAdapter buildService(XRServiceModel xrServiceModel)

initializeService

public void initializeService(java.lang.ClassLoader parentClassLoader,
                              java.io.InputStream xrSchemaStream)

INTERNAL: Initialize the various components (of the XRService} (O-R Project, O-X Project, Schema definitions, auto-generated classes, etc.)

Parameters:

parentClassLoader - the parent ClassLoader for the auto-generated classes.

xrSchemaStream - stream resource for the XRService's .xsd file.

customizeSession

public void customizeSession(Session orSession,
                             Session oxSession)

loadXMLSchema

public void loadXMLSchema(java.io.InputStream xrSchemaStream)

INTERNAL: Read and unmarshal XRService's .xsd file.

Parameters:

xrSchemaStream - Stream resource for the XRService's .xsd file.

buildSessions

public void buildSessions()

INTERNAL:

loginSessions

public void loginSessions()

INTERNAL:

buildDescriptorIndex

public void buildDescriptorIndex()

INTERNAL:

validateOperations

public void validateOperations()

INTERNAL:

initializeOperations

public void initializeOperations()

INTERNAL:

getDocumentBuilder

public static javax.xml.parsers.DocumentBuilder getDocumentBuilder()

getTransformer

public static javax.xml.transform.Transformer getTransformer()