com.adaptris.core.jms.oracle

Class OracleAqImplementation

java.lang.Object

com.adaptris.core.jms.VendorImplementationImp

com.adaptris.core.jms.UrlVendorImplementation

com.adaptris.core.jms.oracle.OracleAqImplementation

All Implemented Interfaces:

ComponentLifecycleExtension, ConnectionComparator<VendorImplementationBase>, VendorImplementation, VendorImplementationBase, LicensedComponent

Direct Known Subclasses:

OracleAqQueueImplementation, OracleAqTopicImplementation

public class OracleAqImplementation
extends UrlVendorImplementation
implements LicensedComponent

Implementation that treats Oracle AQ as a standard JMS Provider.

Do not use this; if your OracleAQ JMS Driver is not JMS 1.1 compliant. If that is the case, then you should use either OracleAqQueueImplementation or OracleAqTopicImplementation instead.

When using this implementation you should explicitly configure the broker-url in the appropriate JmsConnection. This should be the correct url for making a connection to the Oracle database in question e.g. jdbc:oracle:thin:@localhost:1521:<OracleSid>

The oracle jar files are not shipped with the standard adapter installer, so you will need to provide your own jar files from your oracle installation. Depending on your configuration, you will need at least the aqapi and jdbc (JDK1.4) jar.

When configuring the destination queue name you may use . to separate out the owner (sometimes referred to as schema) from the actual Queue name. In this instance the corresponding AQjmsSession.getTopic(String, String) and AQjmsSession.getQueue(String, String) methods will be used.

This vendor implementation also overrides VendorImplementationImp.applyVendorSessionProperties(javax.jms.Session) so that specific Oracle session properties can be applied. The way of doing this is exactly the same as setting properties on the ConnectionFactory.

   <session-properties>
     <key-value-pair>
        <key>CloseCheckInterval</key>
        <value>15</value>
     </key-value-pair>
   </session-properties>
 

would invoke AQjmsSession.setCloseCheckInterval(int) with 15.

In the adapter configuration file this class is aliased as oracleaq-implementation which is the preferred alternative to the fully qualified classname when building your configuration.

License Required: BASIC

Field Summary

Fields inherited from class com.adaptris.core.jms.VendorImplementationImp

log

Constructor Summary

Constructors

Constructor and Description
OracleAqImplementation()

Method Summary

Modifier and Type	Method and Description
void	applyVendorSessionProperties(javax.jms.Session s)
javax.jms.ConnectionFactory	createConnectionFactory()
javax.jms.Queue	createQueue(java.lang.String qName, JmsActorConfig c)
javax.jms.MessageConsumer	createQueueReceiver(ConsumeDestination cd, JmsActorConfig c)
javax.jms.Topic	createTopic(java.lang.String name, JmsActorConfig c)
javax.jms.MessageConsumer	createTopicSubscriber(ConsumeDestination cd, java.lang.String subscriptionId, JmsActorConfig c)
KeyValuePairSet	getAdditionalProperties() Return any additional properties passed through to the AQjmsFactory.
KeyValuePairSet	getSessionProperties()
boolean	isEnabled(License license)
void	prepare()
void	setAdditionalProperties(KeyValuePairSet kvps) Set additional properties that should be passed through to the AQjmsFactory.
void	setSessionProperties(KeyValuePairSet sp) Any additional properties to apply on the session.

Methods inherited from class com.adaptris.core.jms.UrlVendorImplementation

connectionEquals, getBrokerUrl, retrieveBrokerDetailsForLogging, setBrokerUrl

Methods inherited from class com.adaptris.core.jms.VendorImplementationImp

createConsumer, createDestination, createSession

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.adaptris.core.jms.VendorImplementation

createConnection

Constructor Detail

OracleAqImplementation

public OracleAqImplementation()

Method Detail

createConnectionFactory

public javax.jms.ConnectionFactory createConnectionFactory()
                                                    throws javax.jms.JMSException

Specified by:

createConnectionFactory in interface VendorImplementation

Throws:

javax.jms.JMSException

createTopic

public javax.jms.Topic createTopic(java.lang.String name,
                                   JmsActorConfig c)
                            throws javax.jms.JMSException

Specified by:

createTopic in interface VendorImplementationBase

Overrides:

createTopic in class VendorImplementationImp

Throws:

javax.jms.JMSException

createQueue

public javax.jms.Queue createQueue(java.lang.String qName,
                                   JmsActorConfig c)
                            throws javax.jms.JMSException

Specified by:

createQueue in interface VendorImplementationBase

Overrides:

createQueue in class VendorImplementationImp

Throws:

javax.jms.JMSException

applyVendorSessionProperties

public void applyVendorSessionProperties(javax.jms.Session s)
                                  throws javax.jms.JMSException

Overrides:

applyVendorSessionProperties in class VendorImplementationImp

Throws:

javax.jms.JMSException

See Also:

VendorImplementationImp.applyVendorSessionProperties(javax.jms.Session)

getAdditionalProperties

public KeyValuePairSet getAdditionalProperties()

Return any additional properties passed through to the AQjmsFactory.

Returns:

the additionalProperties

setAdditionalProperties

public void setAdditionalProperties(KeyValuePairSet kvps)

Set additional properties that should be passed through to the AQjmsFactory.

Parameters:

kvps - the additionalProperties to set

createQueueReceiver

public javax.jms.MessageConsumer createQueueReceiver(ConsumeDestination cd,
                                                     JmsActorConfig c)
                                              throws javax.jms.JMSException

Specified by:

createQueueReceiver in interface VendorImplementationBase

Overrides:

createQueueReceiver in class VendorImplementationImp

Throws:

javax.jms.JMSException

createTopicSubscriber

public javax.jms.MessageConsumer createTopicSubscriber(ConsumeDestination cd,
                                                       java.lang.String subscriptionId,
                                                       JmsActorConfig c)
                                                throws javax.jms.JMSException

Specified by:

createTopicSubscriber in interface VendorImplementationBase

Overrides:

createTopicSubscriber in class VendorImplementationImp

Throws:

javax.jms.JMSException

getSessionProperties

public KeyValuePairSet getSessionProperties()

Returns:

the sessionProperties

setSessionProperties

public void setSessionProperties(KeyValuePairSet sp)

Any additional properties to apply on the session.

Parameters:

sp - the sessionProperties to set

See Also:

VendorImplementationImp.applyVendorSessionProperties(javax.jms.Session)

prepare

public void prepare()
             throws CoreException

Specified by:

prepare in interface ComponentLifecycleExtension

Overrides:

prepare in class VendorImplementationImp

Throws:

CoreException

isEnabled

public boolean isEnabled(License license)

Specified by:

isEnabled in interface LicensedComponent