Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<h3>Container support</h3>Here are the configurations that currently support DataSource or Resource configuration:<img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2luY2x1ZGU6Q29udGFpbmVycyB3aXRoIERhdGFTb3VyY2UgYW5kIFJlc291cmNlIHN1cHBvcnR9&amp;locale=en_GB&amp;version=2" data-macro-name="include" data-macro-default-parameter="Containers with DataSource and Resource support">Notes:<ul><li>Datasources on the Jetty container use the <a href="http://sourceforge.net/projects/c3p0/">c3p0</a> datasource pool.</li><li>JOnAS handles transactions for datasources using its <code>jtm</code> service.</li></ul><h3>DataSource properties</h3>DataSources are added through pipe-delimited configuration properties that starts with <code>cargo.datasource.datasource</code>. Example:<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>cargo.datasource.datasource1=cargo.datasource.url=jdbc:mydriver:userdb\|cargo.datasource.driver=org.database.Driver\|...
cargo.datasource.datasource2=cargo.datasource.url=jdbc:mydriver:referencedb\|cargo.datasource.driver=org.database.Driver\|...
</pre></td></tr></table>Here are the properties that are valid for this:<ul><li>Note that c.d means cargo.datasource</li><li>Note that if you specify a property marked do not set you will get a CargoException.</li></ul><table class="confluenceTable"><tbody><tr><th class="confluenceTh">Property</th><th class="confluenceTh">Purpose</th><th class="confluenceTh">Valid Values</th><th class="confluenceTh">DataSource</th><th class="confluenceTh">Transactional DataSource</th><th class="confluenceTh">XA DataSource</th></tr><tr><td class="confluenceTd"><code>c.d.jndi</code></td><td class="confluenceTd">The path to this datasource in JNDI</td><td class="confluenceTd">Any jndi path, like <code>jdbc/userds</code></td><td class="confluenceTd">mandatory</td><td class="confluenceTd">mandatory</td><td class="confluenceTd">mandatory</td></tr><tr><td class="confluenceTd"><code>c.d.driver</code></td><td class="confluenceTd">The implementation class</td><td class="confluenceTd">ex. <code>my.Driver</code></td><td class="confluenceTd">mandatory: must implement <code>java.sql.Driver</code></td><td class="confluenceTd">mandatory: must implement <code>java.sql.Driver</code></td><td class="confluenceTd">mandatory: must implement <code>javax.sql.XADataSource</code></td></tr><tr><td class="confluenceTd"><code>c.d.properties</code></td><td class="confluenceTd">Properties to pass to the driver</td><td class="confluenceTd">Semi-colon delimited string</td><td class="confluenceTd">optional</td><td class="confluenceTd">optional</td><td class="confluenceTd">mandatory</td></tr><tr><td class="confluenceTd"><code>c.d.url</code></td><td class="confluenceTd">URL for the <code>java.sql.Driver</code></td><td class="confluenceTd">ex. <code>jdbc:host:port/mydb</code></td><td class="confluenceTd">mandatory</td><td class="confluenceTd">mandatory</td><td class="confluenceTd">optional</td></tr><tr><td class="confluenceTd"><code>c.d.type</code></td><td class="confluenceTd">Determines the type of the driver</td><td class="confluenceTd">Defaults to <code>java.sql.Driver</code>, only set if you want to use a <code>javax.sql.XADataSource</code></td><td class="confluenceTd">do not set</td><td class="confluenceTd">do not set</td><td class="confluenceTd"><code>javax.sql.XADataSource</code></td></tr><tr><td class="confluenceTd"><code>c.d.transactionsupport</code></td><td class="confluenceTd">Determines transaction support type</td><td class="confluenceTd"><code>LOCAL_TRANSACTION</code> or <code>XA_TRANSACTION</code></td><td class="confluenceTd">do not set</td><td class="confluenceTd">mandatory</td><td class="confluenceTd">unset defaults to only valid option: <code>XA_TRANSACTION</code></td></tr><tr><td class="confluenceTd"><code>c.d.id</code></td><td class="confluenceTd">Identifier used in configuration files to reference this datasource</td><td class="confluenceTd">Must contain no path-like characters</td><td class="confluenceTd">optional</td><td class="confluenceTd">optional</td><td class="confluenceTd">optional</td></tr><tr><td class="confluenceTd"><code>c.d.username</code></td><td class="confluenceTd">Username to connect to the database</td><td class="confluenceTd">String</td><td class="confluenceTd">optional</td><td class="confluenceTd">optional</td><td class="confluenceTd">optional</td></tr><tr><td class="confluenceTd"><code>c.d.password</code></td><td class="confluenceTd">Password to connect to the database</td><td class="confluenceTd">String</td><td class="confluenceTd">optional</td><td class="confluenceTd">optional</td><td class="confluenceTd">optional</td></tr></tbody></table><h3>Resource properties</h3>Resources are added through pipe-delimited configuration properties that starts with <code>cargo.resource.resource</code>. Example:<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>cargo.resource.resource1=cargo.resource.name=resource/apple\|cargo.resource.class=org.mycompany.Apple\|...
cargo.resource.resource2=cargo.resource.name=resource/pear\|cargo.resource.driver=org.mycompany.Pear\|...
</pre></td></tr></table>Here are the properties that are valid for this:<ul><li>Note that <code>c.r</code> means <code>cargo.resource</code></li></ul><table class="confluenceTable"><tbody><tr><th class="confluenceTh">Property</th><th class="confluenceTh">Purpose</th><th class="confluenceTh">Valid Values</th><th class="confluenceTh">Mandatory?</th></tr><tr><td class="confluenceTd"><code>c.r.name</code></td><td class="confluenceTd">The path to this datasource in JNDI</td><td class="confluenceTd">Any jndi path, like <code>resource/apple</code></td><td class="confluenceTd">mandatory</td></tr><tr><td class="confluenceTd"><code>c.r.type</code></td><td class="confluenceTd">Interface of the object</td><td class="confluenceTd">Any valid interface</td><td class="confluenceTd">mandatory</td></tr><tr><td class="confluenceTd"><code>c.r.class</code></td><td class="confluenceTd">The implementation class</td><td class="confluenceTd">Any valid class implementing the interface</td><td class="confluenceTd">mandatory</td></tr><tr><td class="confluenceTd"><code>c.r.parameters</code></td><td class="confluenceTd">Properties to to populate the class with</td><td class="confluenceTd">Semi-colon delimited string; must correspond to setters</td><td class="confluenceTd">optional</td></tr></tbody></table><h3>Examples</h3>Users of the Java API can take a look at the following classes as example:<ul><li><a href="http://svn.codehaus.org/cargo/core/trunk/samples/java/src/test/java/org/codehaus/cargo/sample/java/DataSourceOnStandaloneConfigurationTest.java"><code>DataSourceOnStandaloneConfigurationTest</code></a>: datasource definition.</li><li><a href="http://svn.codehaus.org/cargo/core/trunk/samples/java/src/test/java/org/codehaus/cargo/sample/java/TransactionEmulationDataSourceOnStandaloneConfigurationTest.java"><code>TransactionEmulationDataSourceOnStandaloneConfigurationTest</code></a>: datasource definition with transaction emulation.</li><li><a href="http://svn.codehaus.org/cargo/core/trunk/samples/java/src/test/java/org/codehaus/cargo/sample/java/XATransactionDataSourceOnStandaloneConfigurationTest.java"><code>XATransactionDataSourceOnStandaloneConfigurationTest</code></a>: XA datasource definition.</li><li><a href="http://svn.codehaus.org/cargo/core/trunk/samples/java/src/test/java/org/codehaus/cargo/sample/java/ResourceOnStandaloneConfigurationTest.java"><code>ResourceOnStandaloneConfigurationTest</code></a>: resource definition, showing for example <code>mailsession</code>.</li></ul>Users of the Maven2/Maven3 plugin can use the Maven2 Archetype showing datasource support. Please read: <a class="confluence-link" href="/display/CARGO/Maven2+Archetypes#Maven2Archetypes-datasource" data-anchor="datasource" data-linked-resource-id="74316" data-linked-resource-type="page" data-linked-resource-default-alias="Maven2 Archetypes#datasource" data-base-url="http://docs.codehaus.org">Datasource Definition Archetype</a>.