[CONF] OpenEJB 3.0.x documentation > Configuring DataSources

[confluence]

Configuring DataSources Page edited by Jean-Louis MONTEIRO Documentation of the ciphering password feature Documentation of the ciphering password feature Configuring DataSources in openejb.xml The <Resource> element is used to configure a javax.sql.DataSource. It is also used to configure other resources like Timers, Topics, Queues. We will see some examples of using <Resource> to configure a DataSource. The <Resource> element is designed after @Resource annotation and has similar attributes. For example, this annotation in your bean: @Resource(name = "myDerbyDatasource", type = javax.sql.DataSource.class) Would map to a Resource declared in your openejb.xml as follows: <Resource id="myDerbyDatasource" type="javax.sql.DataSource"> . . . . <Resource> Note that in the xml element, the type value of javax.sql.DataSource can abbreviated to just DataSource as follows: <Resource id="myDerbyDatasource" type="DataSource"> . . . . <Resource> Ciphering passwords Apache OpenEJB 3.1.2 or later required Apache OpenEJB now provides an easy and extensible way to cipher databases passwords. Not that by default, this feature is not activated so plain passwords are used. Usage Default Plain text password example: <Resource id="MySQL Database" type="DataSource"> # MySQL example # # This connector will not work until you download the driver at: # http://www.mysql.com/downloads/api-jdbc-stable.html JdbcDriver com.mysql.jdbc.Driver JdbcUrl jdbc:mysql://localhost/test UserName test Password Passw0rd </Resource> 3DES ciphered password example: Note that the built in 3DES implementation uses a static key to encode/decode your password. <Resource id="MySQL Database" type="DataSource"> # MySQL example # # This connector will not work until you download the driver at: # http://www.mysql.com/downloads/api-jdbc-stable.html JdbcDriver com.mysql.jdbc.Driver JdbcUrl jdbc:mysql://localhost/test UserName test # ciphered value for Passw0rd using Static3DES codec is xMH5uM1V9vQzVUv5LG7YLA== Password xMH5uM1V9vQzVUv5LG7YLA== PasswordCipher Static3DES </Resource> Hint You can plug your own algorithm to extend Apache OpenEJB built in ones. To do such, you just need to implement the org.apache.openejb.resource.jdbc.PasswordCipher interface and push a file in META-INF/org.apache.openejb.resource.jdbc.PasswordCipher/<your cipher algorithm alias> containing the fully qualified name of your implementation. Command line tool Apache OpenEJB also provides a command line tool allowing password cipher algorithm. Actually, it's useful to get the ciphered value of a plain text value using a given algorithm. NAME openejb cipher - OpenEJB Cypher Tool SYNOPSIS openejb cipher options <value> DESCRIPTION The OpenEJB Cipher tool is an OPTIONAL tool that allows you to use PasswordCipher algorithm to encode/decode values. It can be used to deploy into an offline server, however in this scenario it simply copies the archive into the openejb.base/apps directory which is something that can be done manually with a simple copy command or drag and drop. The OpenEJB Cipher tool can be executed from any directory as long as <OPENEJB_HOME>/bin is in the system PATH. Before running this tool you need to set the environment variable OPENEJB_HOME to the path of the directory where you unpacked the OpenEJB installation. For for the remainder of this document we will assume you unpacked OpenEJB into the directory C:\openejb-3.1.2. In Windows, the cipher tool can be executed as follows: C:\openejb-3.1.2> bin\openejb cipher --help In UNIX, Linux, or Mac OS X, the cipher tool can be executed as follows: [u...@host openejb-3.1.2]# bin/openejb cipher --help Depending on your OpenEJB version, you may need to change execution bits to make the scripts executable. You can do this with the following command. [u...@host openejb-3.1.2]# chmod 755 bin/openejb From here on out, it will be assumed that you know how to execute the right openejb script for your operating system and commands will appear in shorthand as show below. openejb cipher --help OPTIONS -h, --help Lists these options and exit. -c, --cipher Specifies the password cipher implementation to use (default is Static3DES). -d, --decrypt Switches command line tool to decrypt. -e, --encrypt Switches command line tool to encrypt (default). EXAMPLES Encrypt a plain password using the default algorithm. openejb cipher Passw0rd Output xMH5uM1V9vQzVUv5LG7YLA== Configurations for some commonly used databases: HSQLDB The drivers are included with OpenEJB 3.0 and HSQLDB is the default database. <Resource id="HSQLDB Database" type="DataSource"> JdbcDriver org.hsqldb.jdbcDriver JdbcUrl jdbc:hsqldb:file:hsqldb UserName sa Password </Resource> Derby (Embedded) <Resource id="Derby Database" type="DataSource"> #Embedded Derby example JdbcDriver org.apache.derby.jdbc.EmbeddedDriver JdbcUrl jdbc:derby:derbyDB;create=true UserName admin Password pass </Resource> MySQL <Resource id="MySQL Database" type="DataSource"> # MySQL example # # This connector will not work until you download the driver at: # http://www.mysql.com/downloads/api-jdbc-stable.html JdbcDriver com.mysql.jdbc.Driver JdbcUrl jdbc:mysql://localhost/test UserName test </Resource> Oracle <Resource id="Oracle Database" type="DataSource"> # Oracle example # # This connector will not work until you download the driver at: # http://otn.oracle.com/software/tech/java/sqlj_jdbc/content.html JdbcDriver oracle.jdbc.OracleDriver JdbcUrl jdbc:oracle:thin:@localhost:1521:orcl UserName scott Password tiger </Resource> PosgreSQL <Resource id="PostgreSQL Database" type="DataSource"> # PostgreSQL example # # This connector will not work until you download the driver at: # http://jdbc.postgresql.org/download.html JdbcDriver org.postgresql.Driver JdbcUrl jdbc:postgresql://localhost/test UserName postgres Password pass </Resource> InstantDB <Resource id="InstantDB Database" type="DataSource"> # InstantDB example # JdbcDriver org.enhydra.instantdb.jdbc.idbDriver JdbcUrl jdbc:idb:conf/instantdb.properties UserName Admin Password pass </Resource> Information Internally, OpenEJB relies on Apache Commons DBCP to manage DataSources. To get the full list of available configuration properties, have a look to Apache Commons DBCP configuration. JNDI names for configured DataSources Example 1 <Resource id="Default JDBC Database" type="DataSource"> . . . . . </Resource> The global jndi name would be java:openejb/Resource/Default JDBC Database Example 2 <Resource id="Derby Database" type="DataSource"> . . . . . </Resource> The global jndi name would be java:openejb/Resource/Derby Database Obtaining a DataSource DataSource references in your ejb should get automatically mapped to the Resource you declare. The shortest and easiest rule is that if your reference name matches a Resource in your openejb.xml, that's the one you get. Alternatively, you can explicitly set them via an openejb-jar.xml. There are various ways one could obtain a DataSource now. Lets take an example of Derby. With a Resource declaration in your openejb.xml like this: <Resource id="myDerbyDatabase" type="DataSource"> . . . . . </Resource> There are several possible ways to refer to it in your bean code or ejb-jar.xml @Stateless public class FooBean { @Resource DataSource myDerbyDatabase; } OR @Stateless public class FooBean { @Resource(name="myDerbyDatabase") DataSource dataSource; } OR @Resource(name="myDerbyDatabase", type="javax.sql.DataSource") @Stateless public class FooBean { public void setSessionContext(SessionContext sessionContext) { DataSource dataSource = (DataSource) sessionContext.lookup("myDerbyDatabase"); } public void someOtherMethod() throws Exception { InitialContext initialContext = new InitialContext(); DataSource dataSource = (DataSource) initialContext.lookup("java:comp/env/myDerbyDatabase"); } } OR <resource-ref> <res-ref-name>myDerbyDatabase</res-ref-name> <res-type>javax.sql.DataSource</res-type> </resource-ref> OR <resource-ref> <res-ref-name>jdbc/myDerbyDatabase</res-ref-name> <res-type>javax.sql.DataSource</res-type> </resource-ref> OR <resource-ref> <res-ref-name>someOtherName</res-ref-name> <res-type>javax.sql.DataSource</res-type> <mapped-name>myDerbyDatabase</mapped-name> </resource-ref> Change Notification Preferences View Online | View Change | Add Comment