B
The toplink-ejb-jar DTD

This appendix offers a listing of the toplink-ejb-jar document type description (DTD).

DTD listing

<!ELEMENT toplink-ejb-jar (session)>

<!-- The element that describes the TopLink session for the beans in a 
particular jar.
Example:
<toplink-ejb-jar> 
  <session>
    <name>ejb20_AccountDemo</name>
    <project-class>oracle.toplink.demos.ejb20.cmp.account.

    AccountProject</project-class>
    <login>
      <connection-pool>ejbPool</connection-pool>
    </login>
    <customization-class>oracle.toplink.demos.ejb20.cmp.account.

    AccountCustomizer</customization-class>
  </session>
</toplink-ejb-jar>
Used in: toplink-ejb-jar
-->
<!ELEMENT session (
  name, 
  (project-class | project-xml), 
  login,
  cache-synchronization?,
  use-remote-relationships?,
  customization-class?
)>

<!-- The unique name that will be used to identify this session.
  Valid values: User-chosen name unique amongst all deployed jars
  Used in:  session
-->
<!ELEMENT name (#PCDATA)>

<!-- The class name that this session will load to provide mapping information.
  Valid values: fully-qualified class name 
  Example: <project-class>oracle.toplink.demos.ejb20.cmp

 .account.AccountProject</project-class>
  Used in: session
-->
<!ELEMENT project-class (#PCDATA)>

<!-- The XML project that this session will load to provide mapping information.  
The xml can (and should) be located
     in the deployable jar file in order simplify portability across machines.
  Valid values:  A fully-qualified, or relative file name 
  Example: <project-xml>META-INF/AccountProject.xml</project-xml>
  Used in: session 
-->
<!ELEMENT project-xml (#PCDATA)>

<!-- Used to specify the login parameters such as the data source.
  Example:
    // using a connection pool 
    <login>
      <connection-pool>ejbPool</connection-pool>
    </login>

    // using datasources 
    <login>
      <datasource>ejbDataSourceJTS</datasource>
      <non-jts-datasource>ejbDataSourceNonJTS</non-jts-datasource>
    </login>

  Used in: session 
-->
<!ELEMENT login (
  (connection-pool | (datasource, non-jts-datasource)),
  should-bind-all-parameters?, 
  uses-byte-array-binding?, 
  uses-string-binding?)>

<!-- The name of the WebLogic connection pool used by TopLink.
  Valid values:  Name of connection pool defined in WLS
  Used in: login
-->
<!ELEMENT connection-pool (#PCDATA)>

<!-- The name of the transactional data source used by TopLink to get db
     connections to use for writing.
  Valid values:  Name of transactional data source defined in WLS
  Used in: login
-->
<!ELEMENT datasource (#PCDATA)>

<!-- The name of the non-transactional data source used by TopLink to get db
     connections to use for reading.
  Valid values:  Name of non-transactional data source defined in WLS
  Used in: login
-->
<!ELEMENT non-jts-datasource (#PCDATA)>

<!-- Set to true if all queries should use parameter binding.
  Valid values:  "True", "False"
  Used in: login
-->
<!ELEMENT should-bind-all-parameters (#PCDATA)>

<!-- Set to true if byte arrays should be bound.
  Valid values:  "True", "False"
  Used in: login
-->
<!ELEMENT uses-byte-array-binding (#PCDATA)>

<!-- Set to true if strings should be bound.
  Valid values:  "True", "False"
  Used in: login
-->
<!ELEMENT uses-string-binding (#PCDATA)>

<!-- Configure how TopLink synchronizes its caches across all 
     local and remote sessions.
  Example:
    <cache-synchronization>
      <is-asynchronous>True</is-asynchronous>
      <should-remove-connection-on-error>True</should-remove-connection-on-error
>
    </cache-synchronization>

  Used in: session
-->
<!ELEMENT cache-synchronization (is-asynchronous?, 
should-remove-connection-on-error?)>

<!-- Set to true if synchronization should not wait until all sessions have been 
     synchronized before returning.
  Valid values:  "True", "False"
  Used in: cache-synchronization
-->
<!ELEMENT is-asynchronous (#PCDATA)>

<!-- Set to true if a synchronization connection should be removed from 
     the session if a communication error occurs.
  Valid values:  "True", "False"
  Used in: cache-synchronization
-->
<!ELEMENT should-remove-connection-on-error (#PCDATA)>

<!-- Defines whether the Session should use remote relationships for 
     all bean-to-bean relationships.
  Valid values: "True", "False"
  Default: "False"
  Example:
    <use-remote-relationships>True</use-remote-relationships>
  Used in: session
-->
<!ELEMENT use-remote-relationships (#PCDATA)>

<!-- The class that will be called to customize the session 
     before and after login.
  Valid values:  A fully-qualified class name
  Example:
    <customization-class>oracle.toplink.demos.ejb20.cmp

 .account.AccountCustomizer</customization-class>
  Used in: session
-->
<!ELEMENT customization-class (#PCDATA)>