[jboss-cvs] JBossAS SVN: r108139 - projects/jboss-jca/trunk/doc/userguide/en/modules.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Tue Sep 14 10:24:16 EDT 2010
Author: jesper.pedersen
Date: 2010-09-14 10:24:15 -0400 (Tue, 14 Sep 2010)
New Revision: 108139
Modified:
projects/jboss-jca/trunk/doc/userguide/en/modules/deployment.xml
projects/jboss-jca/trunk/doc/userguide/en/modules/schemas.xml
Log:
Include IronJacamar XSD in user guide
Modified: projects/jboss-jca/trunk/doc/userguide/en/modules/deployment.xml
===================================================================
--- projects/jboss-jca/trunk/doc/userguide/en/modules/deployment.xml 2010-09-14 14:07:48 UTC (rev 108138)
+++ projects/jboss-jca/trunk/doc/userguide/en/modules/deployment.xml 2010-09-14 14:24:15 UTC (rev 108139)
@@ -49,7 +49,10 @@
<para>on Windows.</para>
- <para>The resource adapter can be configured and activated through deployment of a <code>-ra.xml</code>
+ <para>The resource adapter can configured and activated through a <code>META-INF/ironjacamar.xml</code>
+ file in the archive. The format of the XML document is defined by the <code>ironjacamar_1_0.xsd</code>.</para>
+
+ <para>A resource adapter can also be configured and activated through deployment of a <code>-ra.xml</code>
file in the <code>deploy/</code> directory - f.ex. <code>deploy/example-ra.xml</code>. The format of the XML
document is defined by the <code>resource-adapters_1_0.xsd</code> - f.ex</para>
Modified: projects/jboss-jca/trunk/doc/userguide/en/modules/schemas.xml
===================================================================
--- projects/jboss-jca/trunk/doc/userguide/en/modules/schemas.xml 2010-09-14 14:07:48 UTC (rev 108138)
+++ projects/jboss-jca/trunk/doc/userguide/en/modules/schemas.xml 2010-09-14 14:24:15 UTC (rev 108139)
@@ -2712,6 +2712,444 @@
</programlisting>
</section>
+ <section id="ironjacamar10">
+ <title>IronJacamar 1.0</title>
+
+ <programlisting>
+<![CDATA[
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
+
+ <xs:complexType name="boolean-presenceType"></xs:complexType>
+
+ <xs:complexType name="config-propertyType" mixed="true">
+ <xs:annotation>
+ <xs:documentation>
+ Specifies an override for a config-property element in ra.xml or a @ConfigProperty
+ </xs:documentation>
+ </xs:annotation>
+ <xs:simpleContent>
+ <xs:extension base="xs:token">
+ <xs:attribute use="required" name="name" type="xs:token">
+ <xs:annotation>
+ <xs:documentation>
+ Specifies the name of the config-property
+ </xs:documentation>
+ </xs:annotation>
+ </xs:attribute>
+ </xs:extension>
+ </xs:simpleContent>
+ </xs:complexType>
+
+ <xs:complexType name="ironjacamarType">
+ <xs:sequence>
+ <xs:element name="bean-validation-groups" type="bean-validation-groupsType" minOccurs="0" maxOccurs="1">
+ <xs:annotation>
+ <xs:documentation>
+ Specifies bean validation group that should be used
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ <xs:element name="bootstrap-context" type="xs:token" minOccurs="0" maxOccurs="1">
+ <xs:annotation>
+ <xs:documentation>
+ Specifies the unique name of the bootstrap context that should be used
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ <xs:element name="config-property" type="config-propertyType" minOccurs="0" maxOccurs="unbounded">
+ <xs:annotation>
+ <xs:documentation>
+ The config-property specifies resource adapter configuration properties.
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ <xs:element name="transaction-support" type="transaction-supportType" minOccurs="0">
+ <xs:annotation>
+ <xs:documentation>
+ Specifies the transaction support level of the resource adapter
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ <xs:element name="connection-definitions" type="connection-definitionsType" minOccurs="0" maxOccurs="1">
+ <xs:annotation>
+ <xs:documentation>
+ Specifies the connection definitions
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ <xs:element name="admin-objects" type="admin-objectsType" minOccurs="0" maxOccurs="1">
+ <xs:annotation>
+ <xs:documentation>
+ Specifies the administration objects
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ </xs:sequence>
+ </xs:complexType>
+
+ <xs:simpleType name="transaction-supportType">
+ <xs:annotation>
+ <xs:documentation>
+ Define the type of transaction supported by this resource adapter.
+ Valid values are: NoTransaction, LocalTransaction, XATransaction
+ </xs:documentation>
+ </xs:annotation>
+ <xs:restriction base="xs:token">
+ <xs:enumeration value="NoTransaction" />
+ <xs:enumeration value="LocalTransaction" />
+ <xs:enumeration value="XATransaction" />
+ </xs:restriction>
+ </xs:simpleType>
+
+ <xs:attributeGroup name="common-attribute">
+ <xs:attribute name="class-name" type="xs:token" use="optional">
+ <xs:annotation>
+ <xs:documentation>
+ Specifies the the fully qualified class name of a managed connection factory
+ or admin object
+ </xs:documentation>
+ </xs:annotation>
+ </xs:attribute>
+ <xs:attribute name="jndi-name" type="xs:token" use="required">
+ <xs:annotation>
+ <xs:documentation>
+ Specifies the JNDI name
+ </xs:documentation>
+ </xs:annotation>
+ </xs:attribute>
+ <xs:attribute name="enabled" type="xs:boolean" default="true" form="unqualified" use="optional">
+ <xs:annotation>
+ <xs:documentation>
+ Should the object in question be activated
+ </xs:documentation>
+ </xs:annotation>
+ </xs:attribute>
+ <xs:attribute default="false" name="use-java-context" type="xs:boolean">
+ <xs:annotation>
+ <xs:documentation>
+ Specifies if a global JNDI context should be used
+ </xs:documentation>
+ </xs:annotation>
+ </xs:attribute>
+ <xs:attribute name="pool-name" type="xs:token" use="optional">
+ <xs:annotation>
+ <xs:documentation>
+ Specifies the pool name for the object
+ </xs:documentation>
+ </xs:annotation>
+ </xs:attribute>
+ </xs:attributeGroup>
+
+ <xs:complexType name="admin-objectType">
+ <xs:sequence>
+ <xs:element name="config-property" type="config-propertyType" minOccurs="0" maxOccurs="unbounded">
+ <xs:annotation>
+ <xs:documentation>
+ The config-property specifies administration object configuration properties.
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ </xs:sequence>
+ <xs:attributeGroup ref="common-attribute"></xs:attributeGroup>
+ </xs:complexType>
+
+ <xs:complexType name="time-outType">
+ <xs:sequence>
+ <xs:element name="blocking-timeout-millis" type="xs:nonNegativeInteger" minOccurs="0">
+ <xs:annotation>
+ <xs:documentation>
+ The blocking-timeout-millis element indicates the maximum time in
+ milliseconds to block while waiting for a connection before throwing an exception.
+ Note that this blocks only while waiting for a permit for a connection, and
+ will never throw an exception if creating a new connection takes an inordinately
+ long time. The default is 30000 (30 seconds).
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ <xs:element name="idle-timeout-minutes" type="xs:nonNegativeInteger" minOccurs="0">
+ <xs:annotation>
+ <xs:documentation>
+ The idle-timeout-minutes elements indicates the maximum time in minutes
+ a connection may be idle before being closed. The actual maximum time depends
+ also on the IdleRemover scan time, which is 1/2 the smallest idle-timeout-minutes
+ of any pool.
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ <xs:element name="allocation-retry" type="xs:nonNegativeInteger" minOccurs="0" maxOccurs="1">
+ <xs:annotation>
+ <xs:documentation>
+ The allocation retry element indicates the number of times that allocating
+ a connection should be tried before throwing an exception. The default is
+ 0.
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ <xs:element name="allocation-retry-wait-millis" type="xs:nonNegativeInteger" minOccurs="0" maxOccurs="1">
+ <xs:annotation>
+ <xs:documentation>
+ The allocation retry wait millis element indicates the time in milliseconds
+ to wait between retrying to allocate a connection. The default is 5000 (5 seconds).
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ <xs:element name="xa-resource-timeout" type="xs:nonNegativeInteger" minOccurs="0" maxOccurs="1">
+ <xs:annotation>
+ <xs:documentation>
+ Passed to XAResource.setTransactionTimeout(). Default is zero which does not invoke the setter.
+ Specified in seconds - e.g. 5 minutes
+ <xa-resource-timeout>300</xa-resource-timeout>
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ </xs:sequence>
+ </xs:complexType>
+
+ <xs:complexType name="validationType">
+ <xs:sequence>
+ <xs:element name="background-validation" type="xs:boolean" minOccurs="0">
+ <xs:annotation>
+ <xs:documentation>
+ An element to specify that connections should be validated on a background
+ thread versus being validated prior to use
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ <xs:element name="background-validation-minutes" type="xs:nonNegativeInteger" minOccurs="0">
+ <xs:annotation>
+ <xs:documentation>
+ The background-validation-minutes element specifies the amount of
+ time, in minutes, that background validation will run.
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ <xs:element name="use-fast-fail" type="xs:boolean" minOccurs="0">
+ <xs:annotation>
+ <xs:documentation>
+ Whether fail a connection allocation on the first connection if it
+ is invalid (true) or keep trying until the pool is exhausted of all potential
+ connections (false). Default is false. e.g. <use-fast-fail>true</use-fast-fail>
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ </xs:sequence>
+ </xs:complexType>
+
+ <xs:complexType name="connection-definitionsType">
+ <xs:sequence>
+ <xs:element name="connection-definition" type="connection-defintionType" minOccurs="1" maxOccurs="unbounded">
+ <xs:annotation>
+ <xs:documentation>
+ Specifies a connection definition
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ </xs:sequence>
+ </xs:complexType>
+
+ <xs:complexType name="connection-defintionType">
+ <xs:sequence>
+ <xs:element name="config-property" type="config-propertyType" minOccurs="0" maxOccurs="unbounded">
+ <xs:annotation>
+ <xs:documentation>
+ The config-property specifies managed connection factory configuration properties.
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ <xs:choice>
+ <xs:element name="pool" type="poolType" minOccurs="0" maxOccurs="1">
+ <xs:annotation>
+ <xs:documentation>
+ Specifies pooling settings
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ <xs:element name="xa-pool" type="xa-poolType" minOccurs="0" maxOccurs="1">
+ <xs:annotation>
+ <xs:documentation>
+ Specifies xa-pooling settings
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ </xs:choice>
+ <xs:element name="security" type="securityType" minOccurs="0" maxOccurs="1">
+ <xs:annotation>
+ <xs:documentation>
+ Specifies security settings
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ <xs:element name="timeout" type="time-outType" minOccurs="0" maxOccurs="1">
+ <xs:annotation>
+ <xs:documentation>
+ Specifies timeout settings
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ <xs:element name="vaidation" type="validationType" minOccurs="0" maxOccurs="1">
+ <xs:annotation>
+ <xs:documentation>
+ Specifies validation settings
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ </xs:sequence>
+ <xs:attributeGroup ref="common-attribute"></xs:attributeGroup>
+ </xs:complexType>
+
+ <xs:complexType name="poolType">
+ <xs:sequence>
+ <xs:element name="min-pool-size" type="xs:nonNegativeInteger" minOccurs="0">
+ <xs:annotation>
+ <xs:documentation>
+ The min-pool-size element indicates the minimum number of connections
+ a pool should hold. These are not created until a Subject is known from a
+ request for a connection. This default to 0. Ex: <min-pool-size>1</min-pool-size>
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ <xs:element name="max-pool-size" type="xs:nonNegativeInteger" minOccurs="0">
+ <xs:annotation>
+ <xs:documentation>
+ The max-pool-size element indicates the maximum number of connections
+ for a pool. No more than max-pool-size connections will be created in each sub-pool.
+ This defaults to 20.
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ <xs:element name="prefill" type="xs:boolean" minOccurs="0">
+ <xs:annotation>
+ <xs:documentation>
+ Whether to attempt to prefill the connection pool.
+ Default is true. e.g. <prefill>true</prefill>.
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ <xs:element name="use-strict-min" type="xs:boolean" minOccurs="0" maxOccurs="1">
+ <xs:annotation>
+ <xs:documentation>
+ Specifies if the min-pool-size should be considered strictly.
+ Default false
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ </xs:sequence>
+ </xs:complexType>
+
+ <xs:complexType name="xa-poolType">
+ <xs:complexContent>
+ <xs:extension base="poolType">
+ <xs:sequence>
+ <xs:element name="is-same-rm-override" type="xs:boolean" minOccurs="0">
+ <xs:annotation>
+ <xs:documentation>
+ The is-same-rm-override element allows one to unconditionally
+ set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns
+ true or false. Ex: <is-same-rm-override>true</is-same-rm-override>
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ <xs:element name="interleaving" type="boolean-presenceType" minOccurs="0">
+ <xs:annotation>
+ <xs:documentation>
+ An element to enable interleaving for XA connection factories
+ Ex: <interleaving/>
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ <xs:element name="no-tx-separate-pools" type="boolean-presenceType" minOccurs="0">
+ <xs:annotation>
+ <xs:documentation>
+ Oracle does not like XA connections getting used both inside and outside a JTA transaction.
+ To workaround the problem you can create separate sub-pools for the different contexts
+ using <no-tx-separate-pools/>
+ Ex: <no-tx-separate-pools/>
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ <xs:element name="pad-xid" type="xs:boolean" default="false" minOccurs="0">
+ <xs:annotation>
+ <xs:documentation>
+ Should the Xid be padded
+ Ex: <pad-xid>true</pad-xid>
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ <xs:element name="wrap-xa-resource" type="xs:boolean" default="false" minOccurs="0">
+ <xs:annotation>
+ <xs:documentation>
+ Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper
+ instance
+ Ex: <wrap-xa-resource>true</wrap-xa-resource>
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ </xs:sequence>
+ </xs:extension>
+ </xs:complexContent>
+ </xs:complexType>
+
+ <xs:complexType name="securityType">
+ <xs:sequence>
+ <xs:element name="user-name" type="xs:token" minOccurs="0">
+ <xs:annotation>
+ <xs:documentation>
+ Specifies the username used when creating a new connection.
+ Ex: <user-name>sa</user-name>
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ <xs:element name="password" type="xs:token" minOccurs="0">
+ <xs:annotation>
+ <xs:documentation>
+ Specifies the password used when creating a new connection.
+ Ex: <password>sa-pass</password>
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ </xs:sequence>
+ </xs:complexType>
+
+ <xs:complexType name="admin-objectsType">
+ <xs:sequence>
+ <xs:element name="admin-object" type="admin-objectType" minOccurs="1" maxOccurs="unbounded">
+ <xs:annotation>
+ <xs:documentation>
+ Specifies the setup for an admin object
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ </xs:sequence>
+ </xs:complexType>
+
+ <xs:complexType name="bean-validation-groupsType">
+ <xs:sequence>
+ <xs:element name="bean-validation-group" type="xs:token" minOccurs="1" maxOccurs="unbounded">
+ <xs:annotation>
+ <xs:documentation>
+ Specifies the fully qualified class name for a bean validation group that
+ should be used for validation
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+ </xs:sequence>
+ </xs:complexType>
+
+ <xs:element name="ironjacamar" type="ironjacamarType">
+ <xs:annotation>
+ <xs:documentation>
+ Specifies the fully qualified class name for a bean validation group that
+ should be used for validation
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
+</xs:schema>
+
+]]>
+ </programlisting>
+ </section>
+
<section id="ra10">
<title>Resource adapters 1.0</title>
More information about the jboss-cvs-commits
mailing list