JBoss.orgCommunity Documentation

Mobicents JAIN SLEE JDBC Resource Adaptor User Guide


This manual uses several conventions to highlight certain words and phrases and draw attention to specific pieces of information.

In PDF and paper editions, this manual uses typefaces drawn from the Liberation Fonts set. The Liberation Fonts set is also used in HTML editions if the set is installed on your system. If not, alternative but equivalent typefaces are displayed. Note: Red Hat Enterprise Linux 5 and later includes the Liberation Fonts set by default.

Four typographic conventions are used to call attention to specific words and phrases. These conventions, and the circumstances they apply to, are as follows.

Mono-spaced Bold

Used to highlight system input, including shell commands, file names and paths. Also used to highlight key caps and key-combinations. For example:

The above includes a file name, a shell command and a key cap, all presented in Mono-spaced Bold and all distinguishable thanks to context.

Key-combinations can be distinguished from key caps by the hyphen connecting each part of a key-combination. For example:

The first sentence highlights the particular key cap to press. The second highlights two sets of three key caps, each set pressed simultaneously.

If source code is discussed, class names, methods, functions, variable names and returned values mentioned within a paragraph will be presented as above, in Mono-spaced Bold. For example:

Proportional Bold

This denotes words or phrases encountered on a system, including application names; dialogue box text; labelled buttons; check-box and radio button labels; menu titles and sub-menu titles. For example:

The above text includes application names; system-wide menu names and items; application-specific menu names; and buttons and text found within a GUI interface, all presented in Proportional Bold and all distinguishable by context.

Note the > shorthand used to indicate traversal through a menu and its sub-menus. This is to avoid the difficult-to-follow 'Select Mouse from the Preferences sub-menu in the System menu of the main menu bar' approach.

Mono-spaced Bold Italic or Proportional Bold Italic

Whether Mono-spaced Bold or Proportional Bold, the addition of Italics indicates replaceable or variable text. Italics denotes text you do not input literally or displayed text that changes depending on circumstance. For example:

Note the words in bold italics above username, domain.name, file-system, package, version and release. Each word is a placeholder, either for text you enter when issuing a command or for text displayed by the system.

Aside from standard usage for presenting the title of a work, italics denotes the first use of a new and important term. For example:

If you find a typographical error in this manual, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a report in the the Issue Tracker, against the product Mobicents JAIN SLEE JDBC Resource Adaptor, or contact the authors.

When submitting a bug report, be sure to mention the manual's identifier: JAIN_SLEE_JDBC_RA_User_Guide

If you have a suggestion for improving the documentation, try to be as specific as possible when describing it. If you have found an error, please include the section number and some of the surrounding text so we can find it easily.

The Resource Adaptor Type is the interface which defines the contract between the RA implementations, the SLEE container, and the Applications running in it.

The name of the RA Type is JDBCResourceAdaptorType, its vendor is org.mobicents and its version is 1.0.

The single activity object for JDBC Resource Adaptor is the org.mobicents.slee.resource.jdbc.JdbcActivity interface. Through the activity an SBB can execute multiple JDBC statements, and receive the related responses asynchronously through events on it. Due to the nature of SLEE activities, this RA activity acts like a queue of requests, allowing the processing of their responses - the events- in a serialized way

An activity starts on demand by an SBB, through the RA SBB Interface, and it ends when an SBB invokes its endActivity() method.

The activity interface is defined as follows:



        
package org.mobicents.slee.resource.jdbc;
import java.sql.PreparedStatement;
import java.sql.Statement;
public interface JdbcActivity {
    void execute(Statement statement, String sql);
    void execute(Statement statement, String sql, int autoGeneratedKeys);
    void execute(Statement statement, String sql, int columnIndexes[]);
    void execute(Statement statement, String sql, String columnNames[]);
    void executeQuery(Statement statement, String sql);
    void executeUpdate(Statement statement, String sql);
    void executeUpdate(Statement statement, String sql, int autoGeneratedKeys);
    void executeUpdate(Statement statement, String sql, int columnIndexes[]);
    void executeUpdate(Statement statement, String sql, String columnNames[]);
    void execute(PreparedStatement preparedStatement);
    void executeQuery(PreparedStatement preparedStatement);
    void executeUpdate(PreparedStatement preparedStatement);
    public void endActivity();
}
     
The execute(Statement, String) method:

Asynchronous execution of statement with unknown result type, which is provided in an event, fired in the activity. Details about parameters can be seen in the javadoc for java.sql.Statement method with same signature. This method should only be used when the application has no idea of what is the SQL to be executed. If the execution throws an exception, it will be provided as an event too.

The execute(Statement, String, int) method:

Asynchronous execution of statement with unknown result type, which is provided in an event, fired in the activity. Details about parameters can be seen in the javadoc for java.sql.Statement method with same signature. This method should only be used when the application has no idea of what is the SQL to be executed. If the execution throws an exception, it will be provided as an event too.

The execute(Statement, String, int[]) method:

Asynchronous execution of statement with unknown result type, which is provided in an event, fired in the activity. Details about parameters can be seen in the javadoc for java.sql.Statement method with same signature. This method should only be used when the application has no idea of what is the SQL to be executed. If the execution throws an exception, it will be provided as an event too.

The execute(Statement, String, String[]) method:

Asynchronous execution of statement with unknown result type, which is provided in an event, fired in the activity. Details about parameters can be seen in the javadoc for java.sql.Statement method with same signature. This method should only be used when the application has no idea of what is the SQL to be executed. If the execution throws an exception, it will be provided as an event too.

The executeQuery(Statement, String) method:

Asynchronous execution of statement with result set result type, which is provided in an event, fired in the activity. Details about parameters can be seen in the javadoc for java.sql.Statement method with same signature. This method should be used when the application knows that the SQL to execute is a read query. If the execution throws an exception, it will be provided as an event too.

The executeUpdate(Statement, String) method:

Asynchronous execution of statement with update count result type, which is provided in an event, fired in the activity. Details about parameters can be seen in the javadoc for java.sql.Statement method with same signature. This method should be used when the application knows that the SQL to execute is a write query. If the execution throws an exception, it will be provided as an event too.

The executeUpdate(Statement, String, int) method:

Asynchronous execution of statement with update count result type, which is provided in an event, fired in the activity. Details about parameters can be seen in the javadoc for java.sql.Statement method with same signature. This method should be used when the application knows that the SQL to execute is a write query. If the execution throws an exception, it will be provided as an event too.

The executeUpdate(Statement, String, int[]) method:

Asynchronous execution of statement with update count result type, which is provided in an event, fired in the activity. Details about parameters can be seen in the javadoc for java.sql.Statement method with same signature. This method should be used when the application knows that the SQL to execute is a write query. If the execution throws an exception, it will be provided as an event too.

The executeUpdate(Statement, String, String[]) method:

Asynchronous execution of statement with update count result type, which is provided in an event, fired in the activity. Details about parameters can be seen in the javadoc for java.sql.Statement method with same signature. This method should be used when the application knows that the SQL to execute is a write query. If the execution throws an exception, it will be provided as an event too.

The execute(PreparedStatement) method:

Asynchronous execution of a prepared statement with unknown result type, which is provided in an event, fired in the activity. PreparedStatements are an effective way to improve performance, since the JDBC driver may cache and pool the SQL. Details about parameters can be seen in the javadoc for java.sql.PreparedStatement method with same signature. This method should only be used when the application has no idea of what is the SQL to be executed. If the execution throws an exception, it will be provided as an event too.

The executeQuery(PreparedStatement) method:

Asynchronous execution of a prepared statement with result set result type, which is provided in an event, fired in the activity. PreparedStatements are an effective way to improve performance, since the JDBC driver may cache and pool the SQL. This method should be used when the application knows that the SQL to execute is a read query. Details about parameters can be seen in the javadoc for java.sql.PreparedStatement method with same signature. This method should only be used when the application has no idea of what is the SQL to be executed. If the execution throws an exception, it will be provided as an event too.

The executeUpdate(PreparedStatement) method:

Asynchronous execution of a prepared statement with update count result type, which is provided in an event, fired in the activity. PreparedStatements are an effective way to improve performance, since the JDBC driver may cache and pool the SQL. This method should be used when the application knows that the SQL to execute is a write query. If the execution throws an exception, it will be provided as an event too.

The endActivity() method:

Ends the activity and its related Activity Context.

There are eight event types fired by JDBC Resource Adaptor, which provides applications the result of each kind of interaction with the Datasource - result set, update count, unknown result and exception - from executing a Statement or PreparedStatement.


Important

Spaces where introduced in the Name and Event Class column values, to correctly render the table. Please remove them when using copy/paste.


Important

Spaces where introduced in the Name and Event Class column values, to correctly render the table. Please remove them when using copy/paste.

The JDBC Resource Adaptor interface, of type org.mobicents.slee.resource.jdbc.JdbcResourceAdaptorSbbInterface, may be used by applications to create RA activities, and retrieve JDBC Connections, its interface is defined as follows:



        
package org.mobicents.slee.resource.jdbc;
import java.sql.Connection;
import java.sql.SQLException;
import javax.slee.resource.ResourceAdaptorTypeID;
public interface JdbcResourceAdaptorSbbInterface {
    public static final ResourceAdaptorTypeID RATYPE_ID;
    
    public JdbcActivity createActivity();
    Connection getConnection() throws SQLException;
    Connection getConnection(String username, String password)
            throws SQLException;
}
    

The JDBC Resource Adaptor interface also exposes a static RATYPE_ID field, containing the ResourceAdaptorTypeID of the Resource Adaptor Type it belongs, which may be used to retrieve the factory instance using the SbbContextExt JAIN SLEE 1.1 extension.

The following code examples shows how to use the Resource Adaptor Type for common functionalities

The following code examples the handling of events, for both PreparedStatement and Statement execution, following the service logic execution. It also shows the explicit ending of the activity:



                
    /**
     * Event handler for {@link StatementResultSetEvent}.
     * 
     * @param event
     * @param aci
     */
    public void onStatementResultSetEvent(StatementResultSetEvent event,
            ActivityContextInterface aci) {
        tracer.info("Received a StatementResultSetEvent, as result of executed SQL "
                + event.getSQL());
        tracer.info("Result: " + event.getResultSet());
        try {
            PreparedStatement preparedStatement = jdbcRA.getConnection()
                    .prepareStatement("INSERT INTO TestTable VALUES(?)");
            preparedStatement.setString(1, "Mobicents");
            tracer.info("Created prepared statement, executing...");
            ((JdbcActivity) aci.getActivity()).executeUpdate(preparedStatement);
        } catch (Throwable e) {
            tracer.severe("failed to create statement", e);
        }
    }
    /**
     * Event handler for {@link PreparedStatementUpdateCountEvent}.
     * 
     * @param event
     * @param aci
     */
    public void onPreparedStatementUpdateCountEvent(
            PreparedStatementUpdateCountEvent event,
            ActivityContextInterface aci) {
        tracer.info("Received a PreparedStatementUpdateCountEvent.");
        tracer.info("Update Count: " + event.getUpdateCount());
        try {
            Statement anotherStatement = jdbcRA.getConnection()
                    .createStatement();
            tracer.info("Created statement, executing query...");
            ((JdbcActivity) aci.getActivity()).executeUpdate(anotherStatement,
                    "DROP TABLE TestTable;");
        } catch (Throwable e) {
            tracer.severe("failed to create statement", e);
        }
    }
    
    /**
     * Event handler for {@link StatementUpdateCountEvent}.
     * 
     * @param event
     * @param aci
     */
    public void onStatementUpdateCountEvent(StatementUpdateCountEvent event,
            ActivityContextInterface aci) {
        tracer.info("Received a StatementUpdateCountEvent, as result of executed SQL "
                + event.getSQL());
        tracer.info("Update Count: " + event.getUpdateCount());
        tracer.info("Ending JDBC Activity...");
        ((JdbcActivity) aci.getActivity()).endActivity();
    }
        

The SBB XML descriptor code to declare the handling of such events:



        <event event-direction="Receive" initial-event="False">
            <event-name>StatementResultSetEvent</event-name>
            <event-type-ref>
                <event-type-name>StatementResultSetEvent</event-type-name>
                <event-type-vendor>org.mobicents</event-type-vendor>
                <event-type-version>1.0</event-type-version>
            </event-type-ref>
        </event>

        <event event-direction="Receive" initial-event="False">
            <event-name>PreparedStatementUpdateCountEvent</event-name>
            <event-type-ref>
                <event-type-name>PreparedStatementUpdateCountEvent</event-type-name>
                <event-type-vendor>org.mobicents</event-type-vendor>
                <event-type-version>1.0</event-type-version>
            </event-type-ref>
        </event>
        
        <event event-direction="Receive" initial-event="False">
            <event-name>StatementUpdateCountEvent</event-name>
            <event-type-ref>
                <event-type-name>StatementUpdateCountEvent</event-type-name>
                <event-type-vendor>org.mobicents</event-type-vendor>
                <event-type-version>1.0</event-type-version>
            </event-type-ref>
        </event>
    

This chapter documents the JDBC Resource Adaptor Implementation details, such as the configuration properties, the default Resource Adaptor entities, and the JAIN SLEE 1.1 Tracers and Alarms used.

The name of the RA is JDBCResourceAdaptor, its vendor is org.mobicents and its version is 1.0.

There is a single Resource Adaptor Entity created when deploying the Resource Adaptor, named JDBCRA.

The JDBCRA entity is also bound to Resource Adaptor Link Name JDBCRA, to use it in an Sbb add the following XML to its descriptor:



        <resource-adaptor-type-binding>
            <resource-adaptor-type-ref>
                <resource-adaptor-type-name>
                    JDBCResourceAdaptorType
                </resource-adaptor-type-name>
                <resource-adaptor-type-vendor>
                    org.mobicents
                </resource-adaptor-type-vendor>
                <resource-adaptor-type-version>
                    1.0
                </resource-adaptor-type-version>
            </resource-adaptor-type-ref>
            <activity-context-interface-factory-name>
                slee/ra/jdbc/1.0/acifactory
            </activity-context-interface-factory-name>
            <resource-adaptor-entity-binding>
                <resource-adaptor-object-name>
                    slee/ra/jdbc/1.0/sbbinterface
                </resource-adaptor-object-name>
                <resource-adaptor-entity-link>
                    JDBCRA
                </resource-adaptor-entity-link>
            </resource-adaptor-entity-binding>
        </resource-adaptor-type-binding>
    

  1. Downloading the source code

    Use SVN to checkout a specific release source, the base URL is http://mobicents.googlecode.com/svn/tags/servers/jain-slee/2.x.y/resources/jdbc, then add the specific release version, lets consider 1.0.0.BETA1.

    [usr]$ svn co http://mobicents.googlecode.com/svn/tags/servers/jain-slee/2.x.y/resources/jdbc/1.0.0.BETA1 slee-ra-jdbc-1.0.0.BETA1
  2. Building the source code

    Important

    Maven 2.2.1 (or higher) is used to build the release. Instructions for using Maven2, including install, can be found at http://maven.apache.org

    Use Maven to build the deployable unit binary.

    				    [usr]$ cd slee-ra-jdbc-1.0.0.BETA1
    				    [usr]$ mvn install
    				    

    Once the process finishes you should have the deployable-unit jar file in the target directory, if Mobicents JAIN SLEE is installed and environment variable JBOSS_HOME is pointing to its underlying JBoss Application Server directory, then the deployable unit jar will also be deployed in the container.

Similar process as for Section 4.2.1, “Release Source Code Building”, the only change is the SVN source code URL, which is http://mobicents.googlecode.com/svn/trunk/servers/jain-slee/resources/jdbc.

Revision History
Revision 1.0Wed Apr 20 2011Eduardo Martins
Creation of the Mobicents JAIN SLEE JDBC RA User Guide.