Using AQ in WebLogic 10.3

For a project we want to use a Message Driven Bean in WebLogic 10.3 which listens to an Oracle AQ queue. You can use a JMS bridge which uses jndi and OID to retrieve the connection and queue. This didn't work for me because the OID username and password must be same as the Database user of the queue. But there is another way to make this happen. Robert Patrick made a great howto. I decide to do same what Robert did I do it from JDeveloper 11G.
In this blog we will create a startup class for WebLogic which can connect to the AQ queues and topics.
First I made a new jdeveloper 11G application with 3 projects.
The first is wls10.3. This project generates a startup class jar ( I imported the wls10 and jms1.1 code from Robert) In this project there is also a password file generator for the database user / password. WLS uses this password file to connect to the Oracle database .
The MDB project is my Message Driven Bean which will enqueue the AQ messages.
The last project is JmsClient which can dequeue or enqueue new messages to AQ through WLS. Not directly to the database.


For these projects I need the AQ and Weblogic 10.3 remote-client library.

Now we can create a new jar ( deploy project wls10.3 to jar ) called WLS103AQJMSStartupClass.jar

Let's create in the scott/tiger schema a jms queue table called TEST_TABLE and a queue TEST

begin

  sys.dbms_aqadm.create_queue_table(

       queue_table => 'TEST_TABLE',

       queue_payload_type => 'SYS.AQ$_JMS_MESSAGE',

       sort_list => 'PRIORITY',

       compatible => '10.0.0',

       primary_instance => 0,

       secondary_instance => 0,

       storage_clause => 'tablespace USERS pctfree 10 initrans 1 maxtrans 255 storage ( initial 64K minextents 1 maxextents unlimited )');

end;

/

begin

    sys.dbms_aqadm.create_queue(

       queue_name => 'TEST',

       queue_table => 'TEST_TABLE',

       queue_type => sys.dbms_aqadm.normal_queue,

       max_retries => 5,

       retry_delay => 0,

       retention_time => 0);

end;

/

Make sure to start the queue

Next step is to generate the password files which holds the scott/tiger username password.
We do this by running the AQJMSPasswordUtility class. Delete the aqjms.dat and aqjms_user.properties files.

com.oracle.oems.weblogic.AQJMSPasswordUtility -username scott -password tiger

this will generate the password files agian

I use in this blog the Weblogic server of jdeveloper 11g. In this middleware home I create a new folder jms_lib ( D:\oracle\Middleware\jms_lib ) . In this folder I copied the following files WLS103AQJMSStartupClass.jar, aqapi.jar , aqjms.dat, aqjms_user.properties and aqjms.properties files.

Change the aqjms.properties file so it matches with your database and queue.

# Oracle database connection-related properties#

Server=XPCND7010XMP

Port=1521

DBInstance=orcl

These are important settings ( I will use AQJMS_QueueConnectionFactory as my jndi connection factory lookup, I have a queue and I don't use XA )

XAQueueConnectionFactoryJNDIName=AQJMS_XAQueueConnectionFactory

QueueConnectionFactoryJNDIName=AQJMS_QueueConnectionFactory

XATopicConnectionFactoryJNDIName=AQJMS_XATopicConnectionFactory

TopicConnectionFactoryJNDIName=AQJMS_TopicConnectionFactory

Change QueueName1 to TEST ( the name of the Queue in the scott schema)

QueueName1=TEST

#QueueName2=JMSDEMO_QUEUE2

#TopicName1=JMSDEMO_TOPIC1

Give the queue name a jndi name so we can use this name in the JNDI lookup of the queue

QueueJNDIName1=ORAQ_TEST

#QueueJNDIName2=ORAQ_JMSDEMO_QUEUE2

#TopicJNDIName1=ORAQ_JMSDEMO_TOPIC1

We are ready with changing this file. Now we can configure Weblogic so it uses the startup class.

first open the setDomainEnv.cmd file located in D:\oracle\Middleware\jdeveloper\system\system11.1.1.0.31.51.56\DefaultDomain\bin

Add -Doracle.jms.useEmulatedXA=false -Doracle.jms.useNativeXA=true to the JAVA_PROPERTIES variable

and Add D:\oracle\Middleware\jms_lib\WLS103AQJMSStartupClass.jar;D:\oracle\Middleware\jms_lib\aqapi.jar to the PRE_CLASSPATH variable

Start the WebLogic Server where we will create a new Startup Class

Use as "AQJMSPropertiesFile=aqjms.properties, AQJMSPasswordFile=aqjms_user.properties, AQJMSSecretFile=aqjms.dat, AQJMSConfigDirectory=D:/oracle/Middleware/jms_lib" as arguments.

Or you can change the config.xml and add the startupclass to this xml

  <startup-class>
    <name>AQStartUpClass</name>
    <target>DefaultServer</target>
    <deployment-order>1000</deployment-order>
    <class-name>com.oracle.oems.weblogic.AQJMSStartupClass</class-name>
    <arguments>AQJMSPropertiesFile=aqjms.properties,AQJMSPasswordFile=aqjms_user.properties,AQJMSSecretFile=aqjms.dat,AQJMSConfigDirectory=D:/oracle/Middleware/jms_lib</arguments>
    <failure-is-fatal>true</failure-is-fatal>
    <load-before-app-deployments>true</load-before-app-deployments>
    <load-before-app-activation>true</load-before-app-activation>
  </startup-class>

Restart Weblogic and deploy the Message Driven Bean to WLS or use the dequeue / enqueue class to connect to weblogic / aq.
Here is some code from the dequeue java class which can connect to weblogic.

        String queueName = "ORAQ_TEST";
        String queueConnectionFactoryName = "AQJMS_QueueConnectionFactory";

        Context ctx;

        try {
            Properties parm = new Properties();
            parm.setProperty("java.naming.factory.initial","weblogic.jndi.WLInitialContextFactory");
            parm.setProperty("java.naming.provider.url","t3://localhost:7101");
            parm.setProperty("java.naming.security.principal","weblogic");
            parm.setProperty("java.naming.security.credentials","weblogic");

            ctx = new InitialContext(parm);
            
            QueueConnectionFactory connectionFactory = 
            (QueueConnectionFactory)ctx.lookup(queueConnectionFactoryName);

            connection = connectionFactory.createQueueConnection();        
            connection.start();        
            session = connection.createQueueSession(false, Session.AUTO_ACKNOWLEDGE);          
            queue = (Queue)ctx.lookup(queueName); 
            receiver = session.createReceiver(queue); 

            try {
                javax.jms.TextMessage textMessage = (javax.jms.TextMessage)receiver.receive();
                System.out.println("Receiving message [" + textMessage.getJMSMessageID() + "] enqueued at " + new Timestamp(textMessage.getJMSTimestamp()).toString());
                String xmlText = textMessage.getText();
                System.out.println(xmlText);
            } catch (JMSException jmse) {
                jmse.printStackTrace();
            }

            receiver.close(); 
            session.close(); 
            connection.close();


        } catch (JMSException je) {
            throw new RuntimeException("Fout opgetreden bij het starten ",je);
        } catch (Throwable t) {
            throw new RuntimeException("Fout opgetreden bij het starten ",t);

Download the 11g example project here