Oracle9iAS TopLink CMP for Users of IBM WebSphere Guide Release 2 (9.0.3) Part Number B10067-01 |
|
This appendix offers a listing of the toplink-ejb-jar document type description (DTD).
<!--This is the root element and exists only for XML structure--> <!ELEMENT toplink-configuration (session* , session-broker*)> <!--This element used if a session broker must be configured--> <!ELEMENT session-broker (name , session-name+)> <!--This is the element that represents the session name--> <!ELEMENT session-name (#PCDATA)> <!--This is the node element that describes a particular session for use within toplink--> <!ELEMENT session (name , (project-class | project-xml) , session-type , login? , cache-synchronization-manager? , event-listener-class* , profiler-class? , external-transaction-controller-class? , exception-handler-class? , connection-pool* , enable-logging? , logging-options?)> <!--This is the type of session that is being configured--> <!ELEMENT session-type (server-session | database-session)> <!ELEMENT server-session EMPTY> <!ELEMENT database-session EMPTY> <!--This is the class name that this session will load to provide login and mapping information--> <!ELEMENT project-class (#PCDATA)> <!--This is the file that contains the project that this session will load to provide login and mapping information--> <!ELEMENT project-xml (#PCDATA)> <!--This is the element that is used if the session will be synchronized with others--> <!ELEMENT cache-synchronization-manager (clustering-service , multicast-port? , multicast-group-address? , packet-time-to-live? , is-asynchronous? , should-remove-connection-on-error? , (jndi-user-name , jndi-password)? , jms-topic-connection-factory-name?, jms-topic-name?, naming-service-initial-context-factory-name?,naming-service-url?)> <!--This is the name of the clustering service that will be used for connecting sessions for Cache Synchronization--> <!ELEMENT clustering-service (#PCDATA)> <!--This is the IP that the Clustering Service will be listening for new session anouncements--> <!ELEMENT multicast-group-address (#PCDATA)> <!--This is the multicast port the the clustering service will be listening on for announcements of new sessions--> <!ELEMENT multicast-port (#PCDATA)> <!ATTLIST multicast-port e-dtype NMTOKEN #FIXED 'number' > <!--Set to true if synchronization should not wait until all sessions have been synchronised before returning--> <!ELEMENT is-asynchronous (#PCDATA)> <!--Set to true if the connection should be removed from this session if a communication error occurs--> <!ELEMENT should-remove-connection-on-error (#PCDATA)> <!--This is the JNDI name of the Topic Connection Factory that was created for synchronizing TopLink Sessions--> <!ELEMENT jms-topic-connection-factory-name (#PCDATA)> <!--This is the JNDI name of the Topic that was created for synchronizing TopLink Sessions--> <!ELEMENT jms-topic-name (#PCDATA)> <!--This is the name of the initial context factory that will be included in the Context Properties when creating an initial context for accessing JNDI--> <!ELEMENT naming-service-initial-context-factory-name (#PCDATA)> <!--The URL to the global Namespace for the Synchronization connection. Usually the URL of the JNDI service--> <!ELEMENT naming-service-url (#PCDATA)> <!--The maximum number of hops a packet will be broadcast--> <!ELEMENT packet-time-to-live (#PCDATA)> <!ATTLIST packet-time-to-live e-dtype NMTOKEN #FIXED 'number' > <!--This element used if a user name is required to access the JNDI service in the case of Cache Synchronization--> <!ELEMENT jndi-user-name (#PCDATA)> <!--This element used if a password is required to access the JNDI service in the case of Cache Synchronization--> <!ELEMENT jndi-password (#PCDATA)> <!--This describes one of possibly many event-listeners that can be registered on the session--> <!ELEMENT event-listener-class (#PCDATA)> <!--This element represents the class name of the profiler that will be used by the session--> <!ELEMENT profiler-class (#PCDATA)> <!--This is the class that the session will use as the external transaction controller--> <!ELEMENT external-transaction-controller-class (#PCDATA)> <!--This is the class that the session will use to handle exceptions generated from within the session--> <!ELEMENT exception-handler-class (#PCDATA)> <!--SQL will be logged to the Session writer which, by default, is System.out--> <!ELEMENT enable-logging (#PCDATA)> <!--This element used to specify the extra logging options--> <!ELEMENT logging-options (log-debug? , log-exceptions? , log-exception-stacktrace? , print-thread? , print-session? , print-connection? , print-date?)> <!--Debug messages will be logged--> <!ELEMENT log-debug (#PCDATA)> <!--exceptions will be logged--> <!ELEMENT log-exceptions (#PCDATA)> <!--exceptions stack traces will be logged when they occur--> <!ELEMENT log-exception-stacktrace (#PCDATA)> <!--Each line of the log will contain the connection id--> <!ELEMENT print-connection (#PCDATA)> <!--each line of the log will contain the date--> <!ELEMENT print-date (#PCDATA)> <!--each line of the log will contain the session id--> <!ELEMENT print-session (#PCDATA)> <!--each line of the log will contain the thread id--> <!ELEMENT print-thread (#PCDATA)> <!--This the node element that stores the information for the connection pools--> <!ELEMENT connection-pool (is-read-connection-pool , name , max-connections? , min-connections? , login)> <!ELEMENT is-read-connection-pool (#PCDATA)> <!--The max number of connections that will be created in the pool--> <!ELEMENT max-connections (#PCDATA)> <!ATTLIST max-connections e-dtype NMTOKEN #FIXED 'number' > <!--The min number of connections that will aways be in the pool--> <!ELEMENT min-connections (#PCDATA)> <!ATTLIST min-connections e-dtype NMTOKEN #FIXED 'number' > <!--This is the node element that represents the login for a particular connection pool. The read and write connection pools will use the login from the project--> <!ELEMENT login (license-path? , driver-class? , (connection-url | datasource)? , platform-class? , user-name? , password? , uses-native-sequencing? , sequence-preallocation-size? , sequence-table? , sequence-name-field? , sequence-counter-field? , (should-bind-all-parameters , should-cache-all-statements?)? , uses-byte-array-binding? , uses-string-binding? , uses-streams-for-binding? , should-force-field-names-to-uppercase? , should-optimize-data-conversion? , should-trim-strings? , uses-batch-writing? , uses-jdbc20-batch-writing? , uses-external-connection-pool? , uses-native-sql? , uses-external-transaction-controller? , ((non-jts-connection-url | non-jts-datasource), uses-sequence-connection-pool?)?)> <!--This is the element that represents the platform class name--> <!ELEMENT platform-class (#PCDATA)> <!--This is the element that represents the database driver class name--> <!ELEMENT driver-class (#PCDATA)> <!--This is the URL that will be used to connect to the database--> <!ELEMENT connection-url (#PCDATA)> <!--This is the URL of a datasource that may be used by the session to connect to the database--> <!ELEMENT datasource (#PCDATA)> <!--This element used if a read-only datasource is required for cache synchronization (usually used within an application server)--> <!ELEMENT read-only-datasource (#PCDATA)> <!--This element is used in the login as well as the Cache Synchronization feature--> <!ELEMENT user-name (#PCDATA)> <!--This element is used in the login as well as the Cache Synchronization feature--> <!ELEMENT password (#PCDATA)> <!--Set to true if the login should use native sequencing--> <!ELEMENT uses-native-sequencing (#PCDATA)> <!--Sets the sequencing pre-allocation size. This is the number of sequences that will be retrieved from the database each time--> <!ELEMENT sequence-preallocation-size (#PCDATA)> <!ATTLIST sequence-preallocation-size e-dtype NMTOKEN #FIXED 'number' > <!--The name of the sequence table--> <!ELEMENT sequence-table (#PCDATA)> <!--The field within the sequence table the stores that the sequence name--> <!ELEMENT sequence-name-field (#PCDATA)> <!--The field within the sequence table that stores the --> <!ELEMENT sequence-counter-field (#PCDATA)> <!--Set to true if all queries should bind all parameters--> <!ELEMENT should-bind-all-parameters (#PCDATA)> <!--Set to true if all statements should be cached--> <!ELEMENT should-cache-all-statements (#PCDATA)> <!--Set to true if byte arrays should be bound--> <!ELEMENT uses-byte-array-binding (#PCDATA)> <!--Set to true if strings should be bound--> <!ELEMENT uses-string-binding (#PCDATA)> <!--Set to true if streams should be used when binding attributes--> <!ELEMENT uses-streams-for-binding (#PCDATA)> <!--Set to true if field names should be converted to uppercase when generating SQL--> <!ELEMENT should-force-field-names-to-uppercase (#PCDATA)> <!--Set to true if the session should optimize data conversions--> <!ELEMENT should-optimize-data-conversion (#PCDATA)> <!--Set to true if the connection should use native SQL--> <!ELEMENT uses-native-sql (#PCDATA)> <!--Set to true if trailing white spaces should be removed from strings--> <!ELEMENT should-trim-strings (#PCDATA)> <!--Set to true if the connection should batch the statements--> <!ELEMENT uses-batch-writing (#PCDATA)> <!--Set tio true if the connection should use jdbc2.0 batch writing--> <!ELEMENT uses-jdbc20-batch-writing (#PCDATA)> <!--Set to true if the connection should use an external connection pool--> <!ELEMENT uses-external-connection-pool (#PCDATA)> <!--Set to true if the session will be using an external transaction controller--> <!ELEMENT uses-external-transaction-controller (#PCDATA)> <!--Genereic element used to describe a string that represents the name of an item--> <!ELEMENT name (#PCDATA)> <!--This element used if a non-jts connection is required (usually only required in an Application server when CacheSync is used--> <!ELEMENT non-jts-connection-url (#PCDATA)> <!--This element used if a non-jts connection is required (usually only required in an Application server when CacheSync is used--> <!ELEMENT non-jts-datasource (#PCDATA)>
|
Copyright © 2002 Oracle Corporation. All Rights Reserved. |
|