com.adaptris.core.jms.wmq

Class BasicMqSeriesImplementation

java.lang.Object

com.adaptris.core.jms.VendorImplementationImp

com.adaptris.core.jms.wmq.BasicMqSeriesImplementation

All Implemented Interfaces:

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

public class BasicMqSeriesImplementation
extends VendorImplementationImp
implements LicensedComponent

Basic IBM MQ Series implementation.

Depending on your WebsphereMQ configuration you will need at least the 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

Note that if you require SSL support then you should use AdvancedMqSeriesImplementation which allows greater flexibility in configuration

WebsphereMQ requires you to set the transport type for your connection. Although the transport type is an integer, we have provided a string mapping to make configuration more readable. So your transport type should be set to one of the following (for reference we include the internal integer mapping);

Transport Type Value	Internal integer mapping
MQJMS_TP_BINDINGS_MQ	0
MQJMS_TP_CLIENT_MQ_TCPIP	1
MQJMS_TP_DIRECT_TCPIP	2
MQJMS_TP_MQJD	3
MQJMS_TP_DIRECT_HTTP	4

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

In the adapter configuration file this class is aliased as basic-mq-series-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
BasicMqSeriesImplementation() Creates a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	connectionEquals(VendorImplementationBase comparable)
javax.jms.ConnectionFactory	createConnectionFactory()
java.lang.String	getBrokerHost()
int	getBrokerPort()
int	getCcsid() Returns ccsid.
java.lang.String	getChannel() Returns channel.
java.lang.String	getQueueManager() Returns queueManager.
java.lang.String	getTemporaryModel() Returns temporaryModel.
java.lang.String	getTransportType() Returns transportType.
boolean	isEnabled(License license)
void	prepare()
java.lang.String	retrieveBrokerDetailsForLogging()
void	setBrokerHost(java.lang.String brokerHost)
void	setBrokerPort(int port)
void	setCcsid(int i) Sets ccsid.
void	setChannel(java.lang.String s) Sets channel.
void	setQueueManager(java.lang.String s) Sets queueManager.
void	setTemporaryModel(java.lang.String s) Sets temporaryModel.
void	setTransportType(java.lang.String i) Sets transportType.

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

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

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

BasicMqSeriesImplementation

public BasicMqSeriesImplementation()

Creates a new instance.

Defaults are:
• ccsid = -1
• transport type = MQJMS_TP_CLIENT_MQ_TCPIP (which is equivalent to 1)
• queue manager, channel and temporary model are all null.

Method Detail

createConnectionFactory

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

Specified by:

createConnectionFactory in interface VendorImplementation

Throws:

javax.jms.JMSException

getCcsid

public int getCcsid()

Returns ccsid.

Returns:

ccsid

setCcsid

public void setCcsid(int i)

Sets ccsid.

Parameters:

i - the ccsid to set

getTransportType

public java.lang.String getTransportType()

Returns transportType.

Returns:

transportType

setTransportType

public void setTransportType(java.lang.String i)

Sets transportType.

Parameters:

i - the transportType to set

getChannel

public java.lang.String getChannel()

Returns channel.

Returns:

channel

setChannel

public void setChannel(java.lang.String s)

Sets channel.

Parameters:

s - the channel to set

getQueueManager

public java.lang.String getQueueManager()

Returns queueManager.

Returns:

queueManager

setQueueManager

public void setQueueManager(java.lang.String s)

Sets queueManager.

Parameters:

s - the queueManager to set

getTemporaryModel

public java.lang.String getTemporaryModel()

Returns temporaryModel.

Returns:

temporaryModel

setTemporaryModel

public void setTemporaryModel(java.lang.String s)

Sets temporaryModel.

Parameters:

s - the temporaryModel to set

getBrokerHost

public java.lang.String getBrokerHost()

setBrokerHost

public void setBrokerHost(java.lang.String brokerHost)

getBrokerPort

public int getBrokerPort()

setBrokerPort

public void setBrokerPort(int port)

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>

retrieveBrokerDetailsForLogging

public java.lang.String retrieveBrokerDetailsForLogging()

Specified by:

retrieveBrokerDetailsForLogging in interface VendorImplementationBase

Overrides:

retrieveBrokerDetailsForLogging in class VendorImplementationImp