JMSTConnector

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

All Implemented Interfaces:

javax.jms.ExceptionListener, TopicConnector

Direct Known Subclasses:

TConnector
```
public abstract class JMSTConnector
extends java.lang.Object
implements TopicConnector
```
JMSTConnector connects to a JMS topic and initializes one of the operations, such as sub, pub.

For durable subscriptions, you have to specify SubscriptionID. On the other hand, if SubscriptionID is defined, it is assumed to be durable subscription.

For pub 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 int`	`boundary`
`protected javax.jms.TopicPublisher`	`bPublisher`
`protected javax.jms.TopicSession`	`bSession`
`protected javax.jms.TopicSubscriber`	`bSubscriber`
`protected int`	`bufferSize`
`protected int`	`cellID`
`protected boolean`	`check_body`
`protected java.lang.String`	`clientID`
`protected java.lang.String`	`connectionFactoryName`
`protected int`	`displayMask`
`protected boolean`	`enable_exlsnr`
`protected long`	`endTime`
`protected byte[]`	`eotBytes`
`protected long`	`expiry`
`protected boolean`	`isDurable`
`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`	`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 int`	`receiveTime`
`protected boolean`	`resetOption`
`protected int`	`sleepTime`
`protected byte[]`	`sotBytes`
`protected long`	`startTime`
`protected java.lang.String`	`subscriptionID`
`protected javax.jms.TopicConnection`	`tConnection`
`protected int`	`textMode`
`protected java.lang.String`	`tName`
`protected javax.jms.Topic`	`topic`
`protected javax.jms.TopicPublisher`	`tPublisher`
`protected javax.jms.TopicSession`	`tSession`
`protected javax.jms.TopicSubscriber`	`tSubscriber`
`protected java.lang.String`	`username`
`protected long`	`waitTime`
`protected boolean`	`withFlowControlDisabled`
`protected int`	`xaMode`

Fields inherited from interface org.qbroker.jms.TopicConnector
TC_QUEUE, TC_STREAM, TC_TOPIC, TC_XQ, XA_CLIENT, XA_COMMIT

Constructor Summary

Constructors
Constructor and Description

JMSTConnector()

Constructors
Constructor and Description
`JMSTConnector()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` closes all opened resources
`protected javax.jms.JMSException`	`commit(XQueue xq, int[] batch, int size)`
`protected void`	`connect()`
`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
`java.lang.String`	`getOperation()` returns the string of the operation
`javax.jms.TopicPublisher`	`getTopicPublisher()` returns an on-demand publisher in a separate session
`javax.jms.TopicSubscriber`	`getTopicSubscriber()` returns an on-demand non-durable subscriber in a separate session
`protected abstract javax.jms.TopicConnectionFactory`	`initialize()` Initializes the JMS components (TopicConnectionFactory, TopicConnection, TopicPublisher, BytesMessage) for use later in the application
`void`	`onException(javax.jms.JMSException e)` catches JMSException of Connection asynchronously
`void`	`pub(java.io.InputStream in)` read bytes from the InputStream and publish them into a JMS topic as JMS messages.
`void`	`pub(XQueue xq)` It gets JMS messages from the XQueue and publishes them on a given JMS topic.
`java.lang.String`	`reconnect()` reconnects to the JMS topic and returns null upon success
`protected void`	`rollback(XQueue xq, int[] batch, int size)`
`void`	`sub(java.lang.Object out)` It subscribes a JMS topic and sends the JMS messages into a output channel that may be a JMS destination, an OutputStream or an XQueue.
`void`	`tClose()` closes the JMS topic resources
`void`	`tOpen()` opens the topic resources
`int`	`tReopen()` reopens the topic

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

- Field Detail
  - tConnection
```
protected javax.jms.TopicConnection tConnection
```
  - tSession
```
protected javax.jms.TopicSession tSession
```
  - bSession
```
protected javax.jms.TopicSession bSession
```
  - tPublisher
```
protected javax.jms.TopicPublisher tPublisher
```
  - bPublisher
```
protected javax.jms.TopicPublisher bPublisher
```
  - tSubscriber
```
protected javax.jms.TopicSubscriber tSubscriber
```
  - bSubscriber
```
protected javax.jms.TopicSubscriber bSubscriber
```
  - topic
```
protected javax.jms.Topic topic
```
  - bufferSize
```
protected int bufferSize
```
  - connectionFactoryName
```
protected java.lang.String connectionFactoryName
```
  - tName
```
protected java.lang.String tName
```
  - username
```
protected java.lang.String username
```
  - password
```
protected java.lang.String password
```
  - clientID
```
protected java.lang.String clientID
```
  - subscriptionID
```
protected java.lang.String subscriptionID
```
  - msgID
```
protected java.lang.String msgID
```
  - partition
```
protected int[] partition
```
  - displayMask
```
protected int displayMask
```
  - expiry
```
protected long expiry
```
  - persistence
```
protected int persistence
```
  - priority
```
protected int priority
```
  - overwrite
```
protected int overwrite
```
  - mode
```
protected int mode
```
  - propertyName
```
protected java.lang.String[] propertyName
```
  - propertyValue
```
protected java.lang.String[] propertyValue
```
  - msgSelector
```
protected java.lang.String msgSelector
```
  - operation
```
protected java.lang.String operation
```
  - maxMsgLength
```
protected int maxMsgLength
```
  - maxNumberMsg
```
protected int maxNumberMsg
```
  - maxIdleTime
```
protected int maxIdleTime
```
  - startTime
```
protected long startTime
```
  - endTime
```
protected long endTime
```
  - waitTime
```
protected long waitTime
```
  - receiveTime
```
protected int receiveTime
```
  - sleepTime
```
protected int sleepTime
```
  - textMode
```
protected int textMode
```
  - xaMode
```
protected int xaMode
```
  - cellID
```
protected int cellID
```
  - 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
  - isPhysical
```
protected boolean isPhysical
```
  - enable_exlsnr
```
protected boolean enable_exlsnr
```
  - isDurable
```
protected boolean isDurable
```
  - check_body
```
protected boolean check_body
```
  - resetOption
```
protected boolean resetOption
```
  - withFlowControlDisabled
```
protected boolean withFlowControlDisabled
```
- Constructor Detail
  - JMSTConnector
```
public JMSTConnector()
```
- Method Detail
  - initialize
```
protected abstract javax.jms.TopicConnectionFactory initialize()
                                                        throws javax.jms.JMSException
```
    Initializes the JMS components (TopicConnectionFactory, TopicConnection, TopicPublisher, BytesMessage) for use later in the application
    
    Throws:
    
    javax.jms.JMSException - occurs on any JMS Error
  - connect
```
protected void connect()
                throws javax.jms.JMSException
```
    Throws:
    
    javax.jms.JMSException
  - tOpen
```
public void tOpen()
           throws javax.jms.JMSException
```
    opens the topic resources
    
    Specified by:
    
    tOpen in interface TopicConnector
    
    Throws:
    
    javax.jms.JMSException
  - tReopen
```
public int tReopen()
```
    reopens the topic
    
    Specified by:
    
    tReopen in interface TopicConnector
  - tClose
```
public void tClose()
            throws javax.jms.JMSException
```
    closes the JMS topic resources
    
    Specified by:
    
    tClose in interface TopicConnector
    
    Throws:
    
    javax.jms.JMSException
  - reconnect
```
public java.lang.String reconnect()
```
    reconnects to the JMS topic and returns null upon success
    
    Specified by:
    
    reconnect in interface TopicConnector
  - sub
```
public void sub(java.lang.Object out)
         throws java.io.IOException,
                javax.jms.JMSException
```
    It subscribes a JMS topic and sends the JMS messages 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 subscribe 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:
    
    sub in interface TopicConnector
    
    Throws:
    
    java.io.IOException
    
    javax.jms.JMSException
  - pub
```
public void pub(java.io.InputStream in)
         throws java.io.IOException,
                javax.jms.JMSException
```
    read bytes from the InputStream and publish them into a JMS topic 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:
    
    pub in interface TopicConnector
    
    Throws:
    
    java.io.IOException
    
    javax.jms.JMSException
  - pub
```
public void pub(XQueue xq)
         throws TimeoutException,
                javax.jms.JMSException
```
    It gets JMS messages from the XQueue and publishes them on a given JMS topic. It supports both transaction in the delivery session and the message acknowledgement at the source. In the publish 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 publish 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 publish 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:
    
    pub in interface TopicConnector
    
    Throws:
    
    TimeoutException
    
    javax.jms.JMSException
  - commit
```
protected javax.jms.JMSException commit(XQueue xq,
                                        int[] batch,
                                        int size)
```
  - rollback
```
protected void rollback(XQueue xq,
                        int[] batch,
                        int size)
```
  - getOperation
```
public java.lang.String getOperation()
```
    Description copied from interface: TopicConnector
    
    returns the string of the operation
    
    Specified by:
    
    getOperation in interface TopicConnector
  - getTopicPublisher
```
public javax.jms.TopicPublisher getTopicPublisher()
```
    returns an on-demand publisher in a separate session
    
    Specified by:
    
    getTopicPublisher in interface TopicConnector
  - getTopicSubscriber
```
public javax.jms.TopicSubscriber getTopicSubscriber()
```
    returns an on-demand non-durable subscriber in a separate session
    
    Specified by:
    
    getTopicSubscriber in interface TopicConnector
  - createMessage
```
public javax.jms.Message createMessage(int type)
                                throws javax.jms.JMSException
```
    Description copied from interface: TopicConnector
    
    returns a JMS Message with the initialized JMSSession
    
    Specified by:
    
    createMessage in interface TopicConnector
    
    Throws:
    
    javax.jms.JMSException
  - createQueue
```
public javax.jms.Queue createQueue(java.lang.String queueName)
                            throws javax.jms.JMSException
```
    Description copied from interface: TopicConnector
    
    returns the queue created for the given name
    
    Specified by:
    
    createQueue in interface TopicConnector
    
    Throws:
    
    javax.jms.JMSException
  - onException
```
public void onException(javax.jms.JMSException e)
```
    Description copied from interface: TopicConnector
    
    catches JMSException of Connection asynchronously
    
    Specified by:
    
    onException in interface javax.jms.ExceptionListener
    
    Specified by:
    
    onException in interface TopicConnector
  - close
```
public void close()
```
    Description copied from interface: TopicConnector
    
    closes all opened resources
    
    Specified by:
    
    close in interface TopicConnector

Class JMSTConnector

Field Summary

Fields inherited from interface org.qbroker.jms.TopicConnector

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

tConnection

tSession

bSession

tPublisher

bPublisher

tSubscriber

bSubscriber

topic

bufferSize

connectionFactoryName

tName

username

password

clientID

subscriptionID

msgID

partition

displayMask

expiry

persistence

priority

overwrite

mode

propertyName

propertyValue

msgSelector

operation

maxMsgLength

maxNumberMsg

maxIdleTime

startTime

endTime

waitTime

receiveTime

sleepTime

textMode

xaMode

cellID

batchSize

boundary

offhead

offtail

sotBytes

eotBytes

MS_SOT

MS_EOT

isPhysical

enable_exlsnr

isDurable

check_body

resetOption

withFlowControlDisabled

Constructor Detail

JMSTConnector

Method Detail

initialize

connect

tOpen

tReopen

tClose

reconnect

sub

pub

pub

commit

rollback

getOperation

getTopicPublisher

getTopicSubscriber

createMessage

createQueue

onException

close