How do I configure JDBC Connection Factories for J2EE Applications?

How do I configure JDBC Connection Factories for J2EE Applications?

A JDBC Connection Factory Resource is used to obtain connections from the given driver or XA datasource implementation. No connection pooling is involved in this process.

Where are the Driver JARs located?

Different versions of the same driver can be used in the same instance of a running server. For example, you can create a JDBC Connection Factory with OracleDriver version 3, and create another one with version 4. This is possible since the driver jars are not picked up from a common location, but are taken from the path specified in the input box. In case you do not specify the path, the Server attempts to pick up the jars from the \lib\ext directory under the Server installation directory, or from the system classpath.

Whatever the type of Connection Factory, make sure that the driver is present in the classpath. The Console issues a warning message if the driver is not found. To add the driver to the classpath, either place the required .jars in the \jre\lib\ext directory, or add the classpath to the classpath variable of the .bat or .sh setup file.

How do I use resource-config.xml to create JDBC Connection Factory Resources?

You can configure a Connection Factory using resource-config.xml by adding a connection-factory tag under the connection-factories tag. The resource-config.xml looks as below:

<resource-service>
  <resources>
  <default-resources> <default-resources>
  <datasources> <datasources>
  <connection-factories>
    <connection-factory name="CLOUDSCAPE_CF1" description="CloudscapeCF" classname="COM.cloudscape.core.JDBCDriver"
     url="jdbc:cloudscape:../samples/sample_db" authorized-by="Container">
     <login-parameters user="" password="" mask-password="false"/>
    <connection-factory>
  <connection-factories>
  <mail-resources> <mail-resources>
  <url-resources> <url-resources>
  <jms-adapters> <jms-adapters>
  <resources>
</resource-service>

The mandatory fields for the connection-factory tag are connection-factory name, classname, url, and authorized-by. If the authorized-by field is specified as container, you also need to provide values for the user and password attributes, else blank strings will be taken as values for these fields.

How do I use Resource Shell to create JDBC Connection Factory Resources?

JDBC resources can also be added using the command prompt. To invoke the resource shell, type the command ressh on the Server command prompt. To add a JDBC Connection Factory, type add_jdbc_cf. There are two ways to add a Connection Factory using the command.

Interactive

To use the interactive mode, enter add_jdbc_cf, and press Enter. This asks for all the required fields one after the other. No special flag is required for this mode.

Enter the following values needed for the command resourceadmin:> add_jdbc_cf

resourceadmin>  - jndi name * #my_jdbc_cf
resourceadmin>  - class name * #oracle.jdbc.driver.OracleDriver
resourceadmin>  - url * #jdbc:oracle:thin:@db1.pramati.com:1521:db1
resourceadmin>  - user name #scott
resourceadmin>  - password #tiger
resourceadmin>  - classpath #
resourceadmin>  - authorizedBy #container
resourceadmin>  - test [true] #
Adding JDBC Connection Factory my_jdbc_cf
Creating  JDBC Connection Factory my_jdbc_cf
Connection Factory [my_jdbc_cf] started
Created  JDBC Connection Factory [my_jdbc_cf] successfully
Added JDBC Connection Factory [my_jdbc_cf]

Note: Fields followed by * are mandatory. You can press Enter for default values shown. Typing 'q' and pressing Enter at any point cancels the current command.

Non-interactive

To use the non-interactive mode, enter add_jdbc_cf. All the required attributes, such as JNDI name, Class Name, and the URL in this case, have to be specified. All optional attributes have default values that can be modified. There are three ways to specify the fields:

• add_jdbc_cf jndiName=my_jdbc_cf className=oracle.jdbc.driver.OracleDriver url=jdbc:oracle:thin:@db1.pramati.com:1521:db1
• add_jdbc_cf my_jdbc_cf oracle.jdbc.driver.OracleDriver jdbc:oracle:thin:@db1.pramati.com:1521:db1
• add_jdbc_cf -jndiName my_jdbc_cf -className oracle.jdbc.driver.OracleDriver -url jdbc:oracle:thin:@db1.pramati.com:1521:db1

How do I use JDBC Resource MBean to create JDBC Connection Factory Resources?

Once you have the Resource Service MBean, call the JDBCResourceMBean by entering JDBCResourceMBean jdbcResource= resourceServiceMBean.getJDBCResourceMBean();

After this, call the createConnectionFactory method on this MBean.

/**
* Creates a new connection factory.
*
* @param jndiName JNDI name of the connection factory.
*
* @param className Full class name of implementation of any of the following
* interfaces, which is usually provided by the database vendor.
* 
*  java.sql.Driver

*  javax.sql.DataSource

*  javax.sql.XADataSource

*  javax.sql.ConnectionPoolDataSource

* 
*
* @ param jar: Full path to the jars from which the className has to be
* picked, this has to be mentioned incase the className is not mentioned in
* the system classpath.
*
* @param connectionFactoryProps: A set of properties for consumption of
* underlying driver specified in className parameter. If className parameter
* is of type java.sql.Driver following properties may make
* sense:
* 
*  {@link JDBCResourceMBean#USER user}
*   {@link JDBCResourceMBean#PASSWORD password}
*   {@link JDBCResourceMBean#URL url}
*   Any other database driver specific property(ies)
* 
*
* If className parameter is of other types then following is the list of
* standard properties and it can include any driver specific properties.
* 
*  {@link JDBCResourceMBean#DATABASE_NAME databaseName}
*  {@link JDBCResourceMBean#DATASOURCE_NAME dataSourceName}
*  {@link JDBCResourceMBean#DESCRIPTION description}
*  {@link JDBCResourceMBean#NETWORK_PROTOCOL networkProtocol}
*  {@link JDBCResourceMBean#PASSWORD password}
*  {@link JDBCResourceMBean#PORT_NUMBER portNumber}
*  {@link JDBCResourceMBean#ROLE_NAME roleName}
*  {@link JDBCResourceMBean#SERVER_NAME serverName}
*  {@link JDBCResourceMBean#USER user}
*  {@link JDBCResourceMBean#LOGIN_TIMEOUT_PERIOD loginTimeoutPeriod}
* 
*
* @param isAuthByServer: If true the sign-on to database will be
* done by the container on the behalf of user for obtaining database connections.
* If false application has to provide sign-on info
* (user name/password) at the time of obtaining the connection.
*
* @param test: Whether to test the connection factory at the time of
* instantiation (applicable only if isAuthByServer is true)
* @throws ResourceException: If some problem occurs in connection factory
* creation. For example, JNDI name may already be in use.
*/
public void createConnectionFactory(String jndiName, String className,
String jars, DataSourceProperty[] connectionFactoryProps,
boolean isAuthByServer, Boolean test)throws ResourceException;

How do I use the Console to configure Connection Factory Resources?

To configure a Connection Factory Resource using the Console, select Configure > Resources. This displays the Resources screen. If there are JDBC Connection Factory Resources added earlier, the following details are displayed:

Table 1: Details about Connection Factory

The following actions can be performed on a JDBC Connection Factory:

• Add: To add a new JDBC Connection Factory Resource.
• Delete: To delete a JDBC Connection Factory Resource after you have selected it using the check box provided.

Adding JDBC Connection Factories using the Console

To add a Connection Factory, click Add under JDBC Connection Factory, and specify the following information:

Table 2: Details needed to add a JDBC Connection Factory

When the URL provided is incorrect, a message Network adaptor could not establish a connection is displayed. Appropriate messages are displayed when the user name or password is incorrect.

Note: An XA datasource that has been authored by the application does not require user name and password.

Table 3: Drivers supported by Pramati Server

In case you select XA datasource as the driver, you will need to specify the following properties:

Table 4: Properties to be specified for XA datasources

The properties for an XA datasource may be standard or driver-specific. Depending on the driver selected earlier, the Console displays the standard properties as well as the proprietary properties accepted by the driver. Their values are optional.

Note: Certain vendor-specific properties may also need to be specified. These must be entered in the Property column. For more information about the Oracle datasource class, visit http://technet.oracle.com/doc/oracle8i_816/java.816/a81354/connpoc1.htm. These properties follow the JavaBeans design pattern.

Clicking Next>> displays the Step 2 for creating the JDBC Connection Factory.

Editing JDBC Connection Factories

Clicking Properties against the JNDI Connection Factory Name displays the properties with which the connection factory was created. These include:

• Class: The Driver class corresponding to that JDBC Connection Factory
• Authorized By Server: Displays if the Connection Factory was authorized by the Server
• Other Properties: These include the URL used to connect to the database server, the username using which it connects and classpath to the driver jar file (if specified at the time of creation of the connection factory)

Whether or not you can modify the properties, depends on the driver class selected.

Deleting JDBC Connection Factories

Select the check box for the Connection Factory Resource to be deleted on the Resources page and click Delete. This deletes the selected resource.

Related Topics:

• Datasource for a J2EE application
• Datasource cluster to provide auto failover from primary to secondary source
• Mail Resource to send mails from application using the mail session object
• JMS adapter to enable Java programs to create, send, receive, and read messages of a messaging system.
• Connectors to define a set of system-level contracts between the Server and resource adapter.
• URL resource to obtain URL connections.

© Pramati Technologies 2007	Runs on Pramati Server | Feedback | Legal