JMSWrapper

java.lang.Object
- org.transitime.ipc.jms.JMSWrapper

```
public class JMSWrapper
extends java.lang.Object
```
This class is a intended to make JMS easy to use. This class is hornetq specific. If another JMS implementation is to be used then the class would need to be modified. A key feature of this class is that it allows topics and queues to be created dynamically. This goes against the normal idea that JMS queues and topics should managed administratively, using management tools. But for some applications this would be too burdensome. The user would have to additionally know about the administration tools as well. Given that might be creating quite a few AVL feeds, each one being a separate topic, this could be a real nuisance. To be able to dynamically create topics had to modify the hornetq config file hornetq/config/stand-alone/non-clustered/hornetq-configuration.xml to comment out the xxx part and also add false TODO: Fix logging for hortnetq jars so hopefully using default. Don't show DEBUG or FINE messages document NOTE: truly useful documentation on using hornetQ is at http://www.packtpub.com/article/basic-coding-hornetq-creating-consuming-messages http://my.safaribooksonline.com/book/-/9781849518406/1dot-getting-started-with-hornetq/id286697617#X2ludGVybmFsX0h0bWxWaWV3P3htbGlkPTk3ODE4NDk1MTg0MDYlMkZpZDI4NjY5ODA3OCZxdWVyeT0= Basically they are online versions of the HornetQ book.

Author:

SkiBu Smith

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`javax.jms.MessageConsumer`	`createQueueConsumer(java.lang.String queueName)` This is how a Queue consumer is typically created.
`RestartableMessageProducer`	`createQueueProducer(java.lang.String queueName)` This is how a Queue producer is typically created.
`javax.jms.MessageConsumer`	`createTopicConsumer(java.lang.String topicName)` This is how a Topic consumer is typically created.
`RestartableMessageProducer`	`createTopicProducer(java.lang.String topicName)` This is how a Topic producer is typically created.
`static java.lang.String`	`getHornetqServerURL()`
`static JMSWrapper`	`getJMSWrapper()` Creating a JMSWrapper is a heavyweight operation.
`javax.jms.Queue`	`getQueue(java.lang.String queueName)` Returns named Queue.
`javax.jms.Session`	`getSession()` Needed for classes such as RestartableMessageProducer which needs Session to create message objects.
`javax.jms.Topic`	`getTopic(java.lang.String topicName)` Returns named Topic.
`void`	`initiateConnection()` Does all the initialization.
`static void`	`main(java.lang.String[] args)` For testing
`static java.io.Serializable`	`receiveObjectMessage(javax.jms.MessageConsumer consumer)` For reading a message from a Topic or a Queue.
`static java.lang.String`	`receiveTextMessage(javax.jms.MessageConsumer consumer)` For reading a string message from a Topic or a Queue.

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

- Method Detail
  - getHornetqServerURL
```
public static java.lang.String getHornetqServerURL()
```
  - initiateConnection
```
public void initiateConnection()
                        throws javax.naming.NamingException,
                               javax.jms.JMSException
```
    Does all the initialization. Called by constructor but sometimes needs to be called by another class if the session had closed down and needs to be restarted again.
    
    Throws:
    
    javax.naming.NamingException
    
    javax.jms.JMSException
  - getJMSWrapper
```
public static JMSWrapper getJMSWrapper()
                                throws javax.jms.JMSException,
                                       javax.naming.NamingException
```
    Creating a JMSWrapper is a heavyweight operation. Therefore initially tried making this class a singleton and reusing the JMSWrapper. But then was using it in different threads because have separate threads for producer and consumer. Therefore changed so this method always returns a new JMSWrapper.
    
    Returns:
    
    Throws:
    
    javax.jms.JMSException
    
    javax.naming.NamingException
  - getSession
```
public javax.jms.Session getSession()
```
    Needed for classes such as RestartableMessageProducer which needs Session to create message objects.
    
    Returns:
  - getQueue
```
public javax.jms.Queue getQueue(java.lang.String queueName)
```
    Returns named Queue. Note: Unlike getTopic(), getQueue currently does not create the queue if it doesn't already exist.
    
    Parameters:
    
    queueName -
    
    Returns:
  - getTopic
```
public javax.jms.Topic getTopic(java.lang.String topicName)
```
    Returns named Topic. If Topic not already configured as part of JMS server than that Topic is created dynamically. Usually don't need to call this method directly. Instead would use createTopicProducer(), createQueueProducer(), createTopicConsumer(), and createQueueConsumer().
    
    Parameters:
    
    topicName -
    
    Returns:
  - createTopicProducer
```
public RestartableMessageProducer createTopicProducer(java.lang.String topicName)
```
    This is how a Topic producer is typically created. If topic doesn't already exist it will be dynamically created.
    
    Parameters:
    
    topicName -
    
    Returns:
  - createQueueProducer
```
public RestartableMessageProducer createQueueProducer(java.lang.String queueName)
```
    This is how a Queue producer is typically created.
    
    Parameters:
    
    queueName -
    
    Returns:
  - createTopicConsumer
```
public javax.jms.MessageConsumer createTopicConsumer(java.lang.String topicName)
```
    This is how a Topic consumer is typically created. If topic doesn't already exist it will be dynamically created.
    
    Parameters:
    
    topicName -
    
    Returns:
  - createQueueConsumer
```
public javax.jms.MessageConsumer createQueueConsumer(java.lang.String queueName)
```
    This is how a Queue consumer is typically created.
    
    Parameters:
    
    queueName -
    
    Returns:
  - receiveObjectMessage
```
public static java.io.Serializable receiveObjectMessage(javax.jms.MessageConsumer consumer)
                                                 throws javax.jms.JMSException
```
    For reading a message from a Topic or a Queue. The message can be any serializable object. Will block until a message can be read.
    
    Parameters:
    
    consumer -
    
    Returns:
    
    the read serializable object
    
    Throws:
    
    javax.jms.JMSException
  - receiveTextMessage
```
public static java.lang.String receiveTextMessage(javax.jms.MessageConsumer consumer)
                                           throws javax.jms.JMSException
```
    For reading a string message from a Topic or a Queue.
    
    Parameters:
    
    consumer -
    
    Returns:
    
    the read string object
    
    Throws:
    
    javax.jms.JMSException
  - main
```
public static void main(java.lang.String[] args)
```
    For testing
    
    Parameters:
    
    args -

Class JMSWrapper

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getHornetqServerURL

initiateConnection

getJMSWrapper

getSession

getQueue

getTopic

createTopicProducer

createQueueProducer

createTopicConsumer

createQueueConsumer

receiveObjectMessage

receiveTextMessage

main