JBoss.orgCommunity Documentation

Appendix A. ra.xml file Template

This appendix contains an example of the ra.xml file that can be used as a template when creating a new Connector.

<?xml version="1.0" encoding="UTF-8"?>

<connector xmlns="http://java.sun.com/xml/ns/j2ee"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee
           http://java.sun.com/xml/ns/j2ee/connector_1_5.xsd"
           version="1.5">

   <vendor-name>${comapany-name}</vendor-name>
   <eis-type>${type-of-connector}</eis-type>
   <resourceadapter-version>1.0</resourceadapter-version>
   <license>
      <description>
        ${license text}
      </description>
      <license-required>true</license-required>
   </license>
   <resourceadapter>
      <resourceadapter-class>org.teiid.resource.spi.BasicResourceAdapter</resourceadapter-class>

      <outbound-resourceadapter>
         <connection-definition>
            <managedconnectionfactory-class>${connection-factory-class}</managedconnectionfactory-class>

            <!-- repeat for every configuration property -->
            <config-property>
                <description>{$display:"${short-name}",$description:"${description}", $allowed:[${value-list}], $required:"${required-boolean}", $defaultValue:"${default-value}"}</description>
                <config-property-name>${property-name}</config-property-name>
                <config-property-type>${property-type}</config-property-type>
                <config-property-value>${optional-property-value}</config-property-value>
            </config-property>
            
            <!-- use the below as is if you used the Connection Factory interface -->
            
            <connectionfactory-interface>javax.resource.cci.ConnectionFactory</connectionfactory-interface>
            <connectionfactory-impl-class>org.teiid.resource.spi.WrappedConnectionFactory</connectionfactory-impl-class>
            <connection-interface>javax.resource.cci.Connection</connection-interface>
            <connection-impl-class>org.teiid.resource.spi.WrappedConnection</connection-impl-class>

         </connection-definition>
         
         <transaction-support>NoTransaction</transaction-support>
        
        <authentication-mechanism>
            <authentication-mechanism-type>BasicPassword</authentication-mechanism-type>
            <credential-interface>javax.resource.spi.security.PasswordCredential</credential-interface>
        </authentication-mechanism>
        <reauthentication-support>false</reauthentication-support>
      </outbound-resourceadapter>
   </resourceadapter>
</connector>

${...} indicates a value to be supplied by the developer.