JMSQConnector

java.lang.Object
- org.qbroker.jms.JMSQConnector

All Implemented Interfaces:

javax.jms.ExceptionListener, QueueConnector

Direct Known Subclasses:

QConnector, QConnector
```
public abstract class JMSQConnector
extends java.lang.Object
implements QueueConnector
```
JMSQConnector is an abstract class partially implements QueueConnector. It has only one abstract methods, initialize() that is vendor specific. It creates a QueueConnectionFactory for all the operations. JMSQConnector has implemented all the public methods of QueueConnector. But they can be overriden if it is neccessary. Most important methods are connect(), get(), put(), browse(), query(), request(), and reply(). It supports repeated browsing on a queue with auto increment of JMSTimestamp. But it requires Mode is set to daemon and SequentialSearch is on. The application is supposed to reset the browser every time with null string as the only argument. If ReferenceFile is defined, the state info will be persisted to the file for restart.

For put operations, Overwrite mask controls whether to reset the persistence, the priority, and the expiration time on each incoming message. 0 means no overwrite. In this case, the persistence, the priority, and the time-to-live will be recovered from each incoming message for send action. 1 is to reset the persistence to a specific value. 2 is to reset the priority to a certain value. 4 is to reset the expiration time with a given time-to-live.

Author:

yannanlu@yahoo.com

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`batchSize`
`protected javax.jms.QueueBrowser`	`bBrowser`
`protected int`	`boundary`
`protected javax.jms.QueueReceiver`	`bReceiver`
`protected javax.jms.QueueSender`	`bSender`
`protected javax.jms.QueueSession`	`bSession`
`protected int`	`bufferSize`
`protected QuickCache`	`cache`
`protected int`	`displayMask`
`protected boolean`	`enable_exlsnr`
`protected long`	`endTime`
`protected byte[]`	`eotBytes`
`protected long`	`expiry`
`protected boolean`	`isPhysical`
`protected int`	`maxIdleTime`
`protected int`	`maxMsgLength`
`protected int`	`maxNumberMsg`
`protected int`	`mode`
`protected static int`	`MS_EOT`
`protected static int`	`MS_SOT`
`protected java.lang.String`	`msField`
`protected Msg2Text`	`msg2Text`
`protected MessageFilter[]`	`msgFilters`
`protected java.lang.String`	`msgID`
`protected java.lang.String`	`msgSelector`
`protected int`	`offhead`
`protected int`	`offtail`
`protected java.lang.String`	`operation`
`protected int`	`overwrite`
`protected int[]`	`partition`
`protected java.lang.String`	`password`
`protected int`	`persistence`
`protected int`	`priority`
`protected java.lang.String[]`	`propertyName`
`protected java.lang.String[]`	`propertyValue`
`protected javax.jms.QueueBrowser`	`qBrowser`
`protected javax.jms.QueueConnection`	`qConnection`
`protected java.lang.String`	`qName`
`protected javax.jms.QueueReceiver`	`qReceiver`
`protected javax.jms.QueueSender`	`qSender`
`protected javax.jms.QueueSession`	`qSession`
`protected javax.jms.Queue`	`queue`
`protected java.lang.String`	`rcField`
`protected int`	`receiveTime`
`protected java.io.File`	`referenceFile`
`protected boolean`	`resetOption`
`protected java.lang.String[]`	`respPropertyName`
`protected java.lang.String`	`resultField`
`protected int`	`resultType`
`protected int`	`sequentialSearch`
`protected int`	`sleepTime`
`protected byte[]`	`sotBytes`
`protected long`	`startTime`
`protected Template`	`template`
`protected int`	`textMode`
`protected int`	`timeout`
`protected long`	`timestamp`
`protected java.lang.String`	`username`
`protected long`	`waitTime`
`protected boolean`	`withFlowControlDisabled`
`protected int`	`xaMode`

Fields inherited from interface org.qbroker.jms.QueueConnector
QC_QUEUE, QC_STREAM, QC_TOPIC, QC_XQ, XA_CLIENT, XA_COMMIT

Constructor Summary

Constructors
Constructor and Description

JMSQConnector()

Constructors
Constructor and Description
`JMSQConnector()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`browse(java.lang.Object out)` It browses JMS messages from the JMS queue and sends them into a output channel that may be a JMS destination, an OutputStream or an XQueue.
`void`	`close()` closes all opened resources
`protected javax.jms.JMSException`	`commit(XQueue xq, int[] batch, int size)` commits messages sent in the batch and returns exception upon failure
`protected void`	`connect()` establishes the queue connection to the JMS service
`javax.jms.Message`	`createMessage(int type)` returns a JMS Message with the initialized JMSSession
`javax.jms.Queue`	`createQueue(java.lang.String queueName)` returns the queue created for the given name
`javax.jms.TemporaryQueue`	`createTemporaryQueue()` returns the temporary queue created
`void`	`get(java.lang.Object out)` It gets JMS messages from the JMS queue and sends them into a output channel that may be a JMS destination, an OutputStream or an XQueue.
`java.lang.String`	`getOperation()` returns the string of the operation
`javax.jms.QueueBrowser`	`getQueueBrowser()` returns an on-demand browser in a separate session
`javax.jms.QueueReceiver`	`getQueueReceiver()` returns an on-demand receiver in a separate session
`javax.jms.QueueSender`	`getQueueSender()` returns an on-demand sender in a separate session
`protected abstract javax.jms.QueueConnectionFactory`	`initialize()` initializes the QueueConnectionFactory and returns it
`void`	`onException(javax.jms.JMSException e)` catches JMSException of Connection asynchronously
`void`	`put(java.io.InputStream in)` It reads bytes from the InputStream and put them into a JMS queue as JMS messages.
`void`	`put(XQueue xq)` It gets JMS messages from the XQueue and puts them into a JMS queue.
`void`	`qClose()` closes the JMS queue resources
`void`	`qOpen()` opens the queue resources
`int`	`qReopen()` reopens the queue
`void`	`query(XQueue xq)` It listens to an XQueue for incoming JMS messages and extracts the query statement from each message.
`java.lang.String`	`reconnect()` reconnects to the JMS queue and returns null if success
`void`	`reply(XQueue xq)` It gets JMS messages from the XQueue and sends them to their ReplyTo queues.
`void`	`request(XQueue xq, java.lang.String responseQueueName)` It gets JMS messages from the XQueue and puts them into a JMS queue as requests.
`protected int`	`resetQueueBrowser(java.lang.String name, java.lang.String mSelector)` closes the current qBrowser and creates a new qBrowser on the queue with the given physical queue name and the message selector
`protected void`	`rollback(XQueue xq, int[] batch, int size)` rolls back the messages sent in the batch
`protected void`	`saveReference()` flushes the current reference info to a given file for tracking the browser state if the ReferenceFile is defined.
`protected static java.lang.String`	`toKey(java.lang.String[] keys)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - qConnection
```
protected javax.jms.QueueConnection qConnection
```
  - qSession
```
protected javax.jms.QueueSession qSession
```
  - bSession
```
protected javax.jms.QueueSession bSession
```
  - qReceiver
```
protected javax.jms.QueueReceiver qReceiver
```
  - bReceiver
```
protected javax.jms.QueueReceiver bReceiver
```
  - qBrowser
```
protected javax.jms.QueueBrowser qBrowser
```
  - bBrowser
```
protected javax.jms.QueueBrowser bBrowser
```
  - qSender
```
protected javax.jms.QueueSender qSender
```
  - bSender
```
protected javax.jms.QueueSender bSender
```
  - queue
```
protected javax.jms.Queue queue
```
  - msgID
```
protected java.lang.String msgID
```
  - timestamp
```
protected long timestamp
```
  - bufferSize
```
protected int bufferSize
```
  - qName
```
protected java.lang.String qName
```
  - referenceFile
```
protected java.io.File referenceFile
```
  - username
```
protected java.lang.String username
```
  - password
```
protected java.lang.String password
```
  - partition
```
protected int[] partition
```
  - displayMask
```
protected int displayMask
```
  - expiry
```
protected long expiry
```
  - persistence
```
protected int persistence
```
  - priority
```
protected int priority
```
  - resultType
```
protected int resultType
```
  - overwrite
```
protected int overwrite
```
  - mode
```
protected int mode
```
  - sequentialSearch
```
protected int sequentialSearch
```
  - propertyName
```
protected java.lang.String[] propertyName
```
  - propertyValue
```
protected java.lang.String[] propertyValue
```
  - respPropertyName
```
protected java.lang.String[] respPropertyName
```
  - msgSelector
```
protected java.lang.String msgSelector
```
  - operation
```
protected java.lang.String operation
```
  - msField
```
protected java.lang.String msField
```
  - rcField
```
protected java.lang.String rcField
```
  - resultField
```
protected java.lang.String resultField
```
  - template
```
protected Template template
```
  - cache
```
protected QuickCache cache
```
  - msg2Text
```
protected Msg2Text msg2Text
```
  - startTime
```
protected long startTime
```
  - endTime
```
protected long endTime
```
  - waitTime
```
protected long waitTime
```
  - maxIdleTime
```
protected int maxIdleTime
```
  - maxNumberMsg
```
protected int maxNumberMsg
```
  - maxMsgLength
```
protected int maxMsgLength
```
  - sleepTime
```
protected int sleepTime
```
  - receiveTime
```
protected int receiveTime
```
  - timeout
```
protected int timeout
```
  - textMode
```
protected int textMode
```
  - xaMode
```
protected int xaMode
```
  - batchSize
```
protected int batchSize
```
  - boundary
```
protected int boundary
```
  - offhead
```
protected int offhead
```
  - offtail
```
protected int offtail
```
  - sotBytes
```
protected byte[] sotBytes
```
  - eotBytes
```
protected byte[] eotBytes
```
  - MS_SOT
```
protected static final int MS_SOT
```
    See Also:
    
    Constant Field Values
  - MS_EOT
```
protected static final int MS_EOT
```
    See Also:
    
    Constant Field Values
  - msgFilters
```
protected MessageFilter[] msgFilters
```
  - enable_exlsnr
```
protected boolean enable_exlsnr
```
  - isPhysical
```
protected boolean isPhysical
```
  - resetOption
```
protected boolean resetOption
```
  - withFlowControlDisabled
```
protected boolean withFlowControlDisabled
```
- Constructor Detail
  - JMSQConnector
```
public JMSQConnector()
```
- Method Detail
  - initialize
```
protected abstract javax.jms.QueueConnectionFactory initialize()
                                                        throws javax.jms.JMSException
```
    initializes the QueueConnectionFactory and returns it
    
    Throws:
    
    javax.jms.JMSException
  - connect
```
protected void connect()
                throws javax.jms.JMSException
```
    establishes the queue connection to the JMS service
    
    Throws:
    
    javax.jms.JMSException
  - qOpen
```
public void qOpen()
           throws javax.jms.JMSException
```
    opens the queue resources
    
    Specified by:
    
    qOpen in interface QueueConnector
    
    Throws:
    
    javax.jms.JMSException
  - resetQueueBrowser
```
protected int resetQueueBrowser(java.lang.String name,
                                java.lang.String mSelector)
```
    closes the current qBrowser and creates a new qBrowser on the queue with the given physical queue name and the message selector
  - qReopen
```
public int qReopen()
```
    reopens the queue
    
    Specified by:
    
    qReopen in interface QueueConnector
  - qClose
```
public void qClose()
            throws javax.jms.JMSException
```
    closes the JMS queue resources
    
    Specified by:
    
    qClose in interface QueueConnector
    
    Throws:
    
    javax.jms.JMSException
  - reconnect
```
public java.lang.String reconnect()
```
    reconnects to the JMS queue and returns null if success
    
    Specified by:
    
    reconnect in interface QueueConnector
  - browse
```
public void browse(java.lang.Object out)
            throws java.io.IOException,
                   javax.jms.JMSException
```
    It browses JMS messages from the JMS queue and sends them into a output channel that may be a JMS destination, an OutputStream or an XQueue.
    
    Specified by:
    
    browse in interface QueueConnector
    
    Throws:
    
    java.io.IOException
    
    javax.jms.JMSException
  - saveReference
```
protected void saveReference()
                      throws java.io.IOException
```
    flushes the current reference info to a given file for tracking the browser state if the ReferenceFile is defined.
    
    Throws:
    
    java.io.IOException
  - query
```
public void query(XQueue xq)
           throws javax.jms.JMSException,
                  TimeoutException
```
    It listens to an XQueue for incoming JMS messages and extracts the query statement from each message. The query statement contains a list of column names, a physical queue name and an optional message selector. After creation of a new queue browser, it browses the messages from the queue. Each message will be formatted into a structured text according to the column list and the ResultType. The content of each message will be appended into the body of the incoming message as the response. Please always to set a reasonable MaxNumberMsg to limit maximum number of messages for the query.
    
    It also supports the dynamic content filter and the formatter on queried messages. The filter and the formatter are defined via a JSON text with Ruleset defined as a list. The JSON text is stored in the body of the request message. If the filter is defined, it will be used to select certain messages based on the content and the header. If the formatter is defined, it will be used to format the messages.
    
    Specified by:
    
    query in interface QueueConnector
    
    Throws:
    
    javax.jms.JMSException
    
    TimeoutException
  - toKey
```
protected static java.lang.String toKey(java.lang.String[] keys)
```
  - get
```
public void get(java.lang.Object out)
         throws java.io.IOException,
                javax.jms.JMSException
```
    It gets JMS messages from the JMS queue and sends them into a output channel that may be a JMS destination, an OutputStream or an XQueue. It supports the message acknowledgement at the consumer end.
    
    It catches JMSException in the operations regarding to the message itself, like get/set JMS properties. In this case, it still tries to send the message to the output channel and logs the errors. It does not catch the JMSException or IOException from the message transport operations, like receive and send. Such Exception will be thrown so that the caller can handle it either to reset the connection or to do something else.
    
    Specified by:
    
    get in interface QueueConnector
    
    Throws:
    
    java.io.IOException
    
    javax.jms.JMSException
  - put
```
public void put(java.io.InputStream in)
         throws java.io.IOException,
                javax.jms.JMSException
```
    It reads bytes from the InputStream and put them into a JMS queue as JMS messages. It supports flexable but static delimiters at either or both ends. It also has the blind trim support at both ends.
    
    This is MT-Safe as long as the threads share the same offhead, offtail, sotBytes and eotBytes.
    
    Specified by:
    
    put in interface QueueConnector
    
    Throws:
    
    java.io.IOException
    
    javax.jms.JMSException
  - put
```
public void put(XQueue xq)
         throws TimeoutException,
                javax.jms.JMSException
```
    It gets JMS messages from the XQueue and puts them into a JMS queue. It supports both transaction in the delivery session and the message acknowledgement at the source. In the send operation, the persistence, the priority, and the expiration time of each message may get reset according to the overwrite mask. If overwrite mask is 0, the persistence, the priority, and the time-to-live will be recovered from each message for send operation. Otherwise, certain configuration values will be used. In this case, the overwrite mask of 1 is to reset the persistence to a specific value. 2 is to reset the priority to a certain value. 4 is to reset the expiration time with a given time-to-live.
    
    It catches JMSException in the operations regarding to the message itself, like get/set JMS properties or acknowlegement. In this case, it removes the message from the XQueue and logs the errors. It does not catch the JMSException from the message transport operations, like send or commit. Such JMSException will be thrown so that the caller can handle it either to reset the connection or to do something else.
    
    If the MaxIdleTime is set to none-zero, it will monitor the idle time and will throw TimeoutException once the idle time exceeds MaxIdleTime. it is up to the caller to handle this exception.
    
    Specified by:
    
    put in interface QueueConnector
    
    Throws:
    
    TimeoutException
    
    javax.jms.JMSException
  - request
```
public void request(XQueue xq,
                    java.lang.String responseQueueName)
             throws TimeoutException,
                    javax.jms.JMSException
```
    It gets JMS messages from the XQueue and puts them into a JMS queue as requests. Then it receives response messages one by one and copies the message body from the response to the request message and reset its rcField with a success code before removing it from the XQueue.
    
    It supports the message acknowledgement at the source. In the send operation, the persistence, the priority, and the expiration time of each message may get reset according to the overwrite mask. If overwrite mask is 0, the persistence, the priority, and the time-to-live will be recovered from each message for send operation. Otherwise, certain configuration values will be used. In this case, the overwrite mask of 1 is to reset the persistence to a specific value. 2 is to reset the priority to a certain value. 4 is to reset the expiration time with a given time-to-live.
    
    For each sent request, it tries to receive the response message from the given response queue without message selectors. If the response queue name is null, a temporary queue will be created for each of the request. Once the response is received, the message body will be copied into the request message as the response. The rcField of the message will be reset to the value of "0". In case of timeout on the receive process, the expRC will be set to indicate the failure. In case of failure, the error text will be set to the request body.
    
    It catches JMSException in the operations regarding to the message itself, like get/set JMS properties or acknowlegement. In this case, it removes the message from the XQueue and logs the errors.
    
    If the MaxIdleTime is set to none-zero, it will monitor the idle time and will throw TimeoutException once the idle time exceeds MaxIdleTime. It is up to the caller to handle this exception.
    
    Specified by:
    
    request in interface QueueConnector
    
    Throws:
    
    TimeoutException
    
    javax.jms.JMSException
  - reply
```
public void reply(XQueue xq)
           throws TimeoutException,
                  javax.jms.JMSException
```
    It gets JMS messages from the XQueue and sends them to their ReplyTo queues. If it fails to get the ReplyTo queue, just sents the message to the default destination. It supports the message acknowledgement at the source.
    
    It catches JMSException in the operations regarding to the message itself, like get/set JMS properties or acknowlegement. In this case, it removes the message from the XQueue and logs the errors.
    
    If the MaxIdleTime is set to none-zero, it will monitor the idle time and will throw TimeoutException once the idle time exceeds MaxIdleTime. It is up to the caller to handle this exception.
    
    Specified by:
    
    reply in interface QueueConnector
    
    Throws:
    
    TimeoutException
    
    javax.jms.JMSException
  - commit
```
protected javax.jms.JMSException commit(XQueue xq,
                                        int[] batch,
                                        int size)
```
    commits messages sent in the batch and returns exception upon failure
  - rollback
```
protected void rollback(XQueue xq,
                        int[] batch,
                        int size)
```
    rolls back the messages sent in the batch
  - getOperation
```
public java.lang.String getOperation()
```
    Description copied from interface: QueueConnector
    
    returns the string of the operation
    
    Specified by:
    
    getOperation in interface QueueConnector
  - getQueueBrowser
```
public javax.jms.QueueBrowser getQueueBrowser()
```
    returns an on-demand browser in a separate session
    
    Specified by:
    
    getQueueBrowser in interface QueueConnector
  - getQueueReceiver
```
public javax.jms.QueueReceiver getQueueReceiver()
```
    returns an on-demand receiver in a separate session
    
    Specified by:
    
    getQueueReceiver in interface QueueConnector
  - getQueueSender
```
public javax.jms.QueueSender getQueueSender()
```
    returns an on-demand sender in a separate session
    
    Specified by:
    
    getQueueSender in interface QueueConnector
  - createMessage
```
public javax.jms.Message createMessage(int type)
                                throws javax.jms.JMSException
```
    Description copied from interface: QueueConnector
    
    returns a JMS Message with the initialized JMSSession
    
    Specified by:
    
    createMessage in interface QueueConnector
    
    Throws:
    
    javax.jms.JMSException
  - createQueue
```
public javax.jms.Queue createQueue(java.lang.String queueName)
                            throws javax.jms.JMSException
```
    Description copied from interface: QueueConnector
    
    returns the queue created for the given name
    
    Specified by:
    
    createQueue in interface QueueConnector
    
    Throws:
    
    javax.jms.JMSException
  - createTemporaryQueue
```
public javax.jms.TemporaryQueue createTemporaryQueue()
                                              throws javax.jms.JMSException
```
    Description copied from interface: QueueConnector
    
    returns the temporary queue created
    
    Specified by:
    
    createTemporaryQueue in interface QueueConnector
    
    Throws:
    
    javax.jms.JMSException
  - onException
```
public void onException(javax.jms.JMSException e)
```
    Description copied from interface: QueueConnector
    
    catches JMSException of Connection asynchronously
    
    Specified by:
    
    onException in interface javax.jms.ExceptionListener
    
    Specified by:
    
    onException in interface QueueConnector
  - close
```
public void close()
```
    Description copied from interface: QueueConnector
    
    closes all opened resources
    
    Specified by:
    
    close in interface QueueConnector

Class JMSQConnector

Field Summary

Fields inherited from interface org.qbroker.jms.QueueConnector

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

qConnection

qSession

bSession

qReceiver

bReceiver

qBrowser

bBrowser

qSender

bSender

queue

msgID

timestamp

bufferSize

qName

referenceFile

username

password

partition

displayMask

expiry

persistence

priority

resultType

overwrite

mode

sequentialSearch

propertyName

propertyValue

respPropertyName

msgSelector

operation

msField

rcField

resultField

template

cache

msg2Text

startTime

endTime

waitTime

maxIdleTime

maxNumberMsg

maxMsgLength

sleepTime

receiveTime

timeout

textMode

xaMode

batchSize

boundary

offhead

offtail

sotBytes

eotBytes

MS_SOT

MS_EOT

msgFilters

enable_exlsnr

isPhysical

resetOption

withFlowControlDisabled

Constructor Detail

JMSQConnector

Method Detail

initialize

connect

qOpen

resetQueueBrowser

qReopen

qClose

reconnect

browse

saveReference