com.adaptris.core.jms.wmq

Class AdvancedMqSeriesImplementation

java.lang.Object

com.adaptris.core.jms.VendorImplementationImp

com.adaptris.core.jms.wmq.AdvancedMqSeriesImplementation

All Implemented Interfaces:

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

public class AdvancedMqSeriesImplementation
extends VendorImplementationImp
implements LicensedComponent

Advanced IBM MQ Series implementation.

Depending on your WebsphereMQ configuration you will need at least com.ibm.mq.jar, com.ibm.mqjms.jar, connector.jar, dhbcore.jar and jta.jar from your WebsphereMQ installation. If you intend on using bindings mode, then you may need to include additional jars such as com.ibm.mqbind.jar

This vendor implementation class directly exposes all the primitive and String getter and setters that are available in the MQConnectionFactory for maximum flexibility in configuration.

The key from the connection-factory-properties element should match the name of the underlying MQConnectionFactory property/method.

   <connection-factory-properties>
     <key-value-pair>
        <key>SendExitInit</key>
        <value>SomeData</value>
     </key-value-pair>
   </connection-factory-properties>
 

would call MQConnectionFactory.setSendExitInit(String).

This vendor implementation also overrides VendorImplementationImp.applyVendorSessionProperties(javax.jms.Session) so that specific MQ session properties can be applied. The way of doing this is exactly the same as setting properties on the ConnectionFactory. Note that session properties are deprecated. After MQ version 7+, brokerTimeout no longer exists and the remaining properties can be set on the connection fgactory.

   <session-properties>
     <key-value-pair>
        <key>OptimisticPublication</key>
        <value>true</value>
     </key-value-pair>
   </session-properties>
 

would invoke MQSession.setOptimisticPublication(boolean) with true.

If you require SSL support then you should review this developerWorks article which contains a good primer about the settings that will be required for using SSL with the adapter.

By default, all JMS clients to MQ Series will create what is known as an MQRFH2 Header that will form part of the Websphere MQ message. This is used to store (amongst other things) some of the JMS headers that you wanted to preserve using MessageTypeTranslatorImp.setMoveJmsHeaders(Boolean), and all the custom JMS properties that you may have chosen to preserve from AdaptrisMessage metadata by configuring com.adaptris.core.jms.MessageTypeTranslatorImp#setMoveMetadata(Boolean) to be true.This means that the message format internally within WebpshereMQ is MQRFH2 and not MQSTR format. Accordingly the receiving application needs to be able to parse MQRFH2 headers which may not be possible.

If the MQRFH2 Header/format is not required or you need to change the message type to MQSTR, then you need to tell MQSeries to omit the MQRFH2 Header; this will mean that you'll lose all the JMS properties that are mapped into MQRFH2 as standard by MQSeries and also any custom JMS Properties that you might be sending. To omit the MQRFH2 header, then you need to add ?targetClient=1 after the queue name in your ProduceDestination implementation. For example, if the queue that you need to produce to is called SampleQ1 then the string you need to use is queue:///SampleQ1?targetClient=1. More information about the mapping of JMS messages onto MQ Messages can be found at this link

More generally speaking, the more powerful form of specifying a destination using uniform resource identifiers (URIs) is preferred. This form allows you to specify remote queues (queues on a queue manager other than the one to which you are connected). It also allows you to set the other properties contained in a com.ibm.mq.jms.MQQueue object. The URI for a queue begins with the sequence queue://, followed by the name of the queue manager on which the queue resides. This is followed by a further /, the name of the queue, and optionally, a list of name-value pairs that set the remaining Queue properties. For example: queue://Some_Other_Queue_Manager/SampleQ1?key1=value1&key2=value2. If you don't specify a queue manager in the URI then it is interpreted to be the queue manager to which you are currently connected to e.g. queue:///SampleQ1?key1=value1&key2=value2).

Various name value pairs can be used as part of the URI; these include, but is not limited to (some of these values may have a direct correlation to standard JMS headers, if you specify both, then behaviour is dependent on how WebsphereMQ JMS is configured)

Property	Description	Values
CCSID	Character set of the destination	integers - valid values listed in base WebSphere MQ documentation
encoding	How to represent numeric fields	An integer value as described in the base WebSphere MQ documentation
expiry	Lifetime of the message in milliseconds	0 for unlimited, positive integers for timeout (ms) - This might interfere with any TTL value you configure in the producer.
multicast	Sets multicast mode for direct connections	-1=ASCF, 0=DISABLED, 3=NOTR, 5=RELIABLE, 7=ENABLED
persistence	Whether the message should be hardened to disk	1=non-persistent, 2=persistent, -1=QDEF (use the queue definition)
priority	Priority of the message	0 through 9, -1=QDEF (use the queue definition)- This might interfere with any priority value you configure in the producer.
targetClient	Whether the receiving application is JMS compliant	0=JMS, 1=MQ

This was built against WebsphereMQ 6.x, but tested against both Websphere 6.x and 7.x

See Also:

MQConnectionFactory

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

License Required: BASIC

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AdvancedMqSeriesImplementation.ConnectionFactoryProperty Properties matched against various MQConnectionFactory methods.
static class	AdvancedMqSeriesImplementation.SessionProperty Deprecated.

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
AdvancedMqSeriesImplementation() Creates a new instance.

Method Summary

Modifier and Type	Method and Description
protected void	applyProperties(com.ibm.mq.jms.MQConnectionFactory cf)
void	applyVendorSessionProperties(javax.jms.Session s)
boolean	connectionEquals(VendorImplementationBase comparable)
javax.jms.ConnectionFactory	createConnectionFactory()
KeyValuePairSet	getConnectionFactoryProperties()
KeyValuePairSet	getSessionProperties()
boolean	isEnabled(License license)
void	prepare()
void	setConnectionFactoryProperties(KeyValuePairSet crp)
void	setSessionProperties(KeyValuePairSet s) Set any additional session properties to be applied.

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

createConsumer, createDestination, createQueue, createQueueReceiver, createSession, createTopic, createTopicSubscriber, retrieveBrokerDetailsForLogging

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

AdvancedMqSeriesImplementation

public AdvancedMqSeriesImplementation()

Creates a new instance.

• TransportType = JMSC.MQJMS_TP_CLIENT_MQ_TCPIP

Method Detail

createConnectionFactory

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

Specified by:

createConnectionFactory in interface VendorImplementation

Throws:

javax.jms.JMSException

applyProperties

protected void applyProperties(com.ibm.mq.jms.MQConnectionFactory cf)
                        throws javax.jms.JMSException

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)

getConnectionFactoryProperties

public KeyValuePairSet getConnectionFactoryProperties()

Returns:

the connectionFactoryProperties

setConnectionFactoryProperties

public void setConnectionFactoryProperties(KeyValuePairSet crp)

Parameters:

crp - the additional connectionFactoryProperties to set

See Also:

AdvancedMqSeriesImplementation.ConnectionFactoryProperty

getSessionProperties

public KeyValuePairSet getSessionProperties()

Returns:

the sessionProperties

setSessionProperties

public void setSessionProperties(KeyValuePairSet s)

Set any additional session properties to be applied.

Parameters:

s - the sessionProperties to set

See Also:

AdvancedMqSeriesImplementation.SessionProperty

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

connectionEquals

public boolean connectionEquals(VendorImplementationBase comparable)

Specified by:

connectionEquals in interface ConnectionComparator<VendorImplementationBase>