io.toro.martini

Class JmsMethods

java.lang.Object

io.toro.martini.JmsMethods

public final class JmsMethods
extends Object

This class provides methods for publishing, and responding to JMS Messages.

Method Summary

Modifier and Type	Method and Description
static void	publishBytes(String destinationName, byte[] bytes) Send a byte array to the JMS broker.
static void	publishBytes(String destinationName, byte[] bytes, Closure replyClosure) Send a byte array to the JMS broker.
static void	publishBytes(String destinationName, byte[] bytes, Map<String,Object> properties) Send a byte array to the JMS broker.
static void	publishObject(String destinationName, Serializable obj) Sends a serializable object to the JMS broker.
static void	publishObject(String destinationName, Serializable obj, Closure replyClosure) Sends a serializable object to the JMS broker.
static void	publishObject(String destinationName, Serializable obj, Map<String,Object> properties) Sends a serializable object to the JMS broker.
static void	publishString(String destinationName, String string) Send a string to the JMS broker.
static void	publishString(String destinationName, String string, Closure replyClosure) Send a string to the JMS broker.
static void	publishString(String destinationName, String string, Map<String,Object> properties) Send a string to the JMS broker.
static void	publishTo(byte[] bytes, String destinationName) Send a byte array to the JMS broker.
static void	publishTo(byte[] bytes, String destinationName, Closure replyClosure) Send a byte array to the JMS broker.
static void	publishTo(byte[] bytes, String destinationName, Map properties) Send a byte array to the JMS broker.
static void	publishTo(Serializable obj, String destinationName) Sends a serializable object to the JMS broker.
static void	publishTo(Serializable obj, String destinationName, Closure replyClosure) Sends a serializable object to the JMS broker.
static void	publishTo(Serializable obj, String destinationName, Map<String,Object> properties) Sends a serializable object to the JMS broker.
static void	publishTo(String string, String destinationName) Send a string to the JMS broker Example usage:
static void	publishTo(String string, String destinationName, Closure replyClosure) Send a string to the JMS broker.
static void	publishTo(String string, String destinationName, Map properties) Send a string to the JMS broker
static void	replyTo(byte[] bytes, Message requestMessage) Send a byte array to the JMS broker.
static void	replyTo(byte[] bytes, Message requestMessage, Map<String,Object> properties) Send a byte array to the JMS broker.
static void	replyTo(Serializable obj, Message requestMessage) Sends a serializable object to the JMS broker.
static void	replyTo(Serializable obj, Message requestMessage, Map<String,Object> properties) Sends a serializable object to the JMS broker.
static void	replyTo(String string, Message requestMessage) Send a string to the JMS broker Example usage:
static void	replyTo(String string, Message requestMessage, Map<String,Object> properties) Send a string to the JMS broker
static void	replyWith(Message requestMessage, byte[] bytes) Send a byte array to the JMS broker.
static void	replyWith(Message requestMessage, byte[] bytes, Map<String,Object> properties) Send a byte array to the JMS broker.
static void	replyWith(Message requestMessage, Serializable obj) Sends a serializable object to the JMS broker.
static void	replyWith(Message requestMessage, Serializable obj, Map<String,Object> properties) Sends a serializable object to the JMS broker.
static void	replyWith(Message requestMessage, String string) Send a string to the JMS broker.
static void	replyWith(Message requestMessage, String string, Map<String,Object> properties) Send a string to the JMS broker.
static void	sendAlert(AlertJMSMessage alertJMSMessage) Sends an AlertJMSMessage object to JMS Topic 'topic://io.toro.martini.alert.AlertQueue' Example usage:
static void	sendAlert(String message) Sends an AlertJMSMessage object to JMS Topic 'topic://io.toro.martini.alert.AlertQueue' Defaults for the AlertJMSMessage to be sent to JMS Broker: Source : Martini Package name Severity: 0 Properties : empty map Example usage:
static void	sendAlert(String message, int severity) Sends an AlertJMSMessage object to JMS Topic 'topic://io.toro.martini.alert.AlertQueue' Defaults for the AlertJMSMessage to be sent to JMS Broker: Source : Martini Package name Properties : empty map Example usage:
static void	sendAlert(String message, String source) Sends an AlertJMSMessage object to JMS Topic 'topic://io.toro.martini.alert.AlertQueue' Defaults for the AlertJMSMessage to be sent to JMS Broker: Severity: 0 Properties : empty map Example usage:
static void	sendAlert(String message, String source, int severity) Sends an AlertJMSMessage object to JMS Topic 'topic://io.toro.martini.alert.AlertQueue' Defaults for the AlertJMSMessage to be sent to JMS Broker: Properties : empty map
static void	sendAlert(String message, String source, int severity, Map<Serializable,Serializable> properties) Sends an AlertJMSMessage object to JMS Topic 'topic://io.toro.martini.alert.AlertQueue' Example usage:

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

publishTo

public static void publishTo(Serializable obj,
                             String destinationName)
                      throws JMSException

Sends a serializable object to the JMS broker.
Example usage:

     'hello world'.publishTo('queue://com.toro.hello.HelloQueue')
 

Parameters:

obj - The object to send

destinationName - The name of the queue/topic to send the object to

Throws:

JMSException

Since:

2.0

publishTo

public static void publishTo(Serializable obj,
                             String destinationName,
                             Closure replyClosure)
                      throws JMSException

Sends a serializable object to the JMS broker. See here for more information
Example usage:

     'hello world'.publishTo('queue://com.toro.hello.HelloQueue'){ message ->
        println 'received a reply: ${message}'
     }
 

Parameters:

obj - The object to send

destinationName - The name of the queue/topic to send the object to

Throws:

JMSException

Since:

2.0

publishTo

public static void publishTo(Serializable obj,
                             String destinationName,
                             Map<String,Object> properties)
                      throws JMSException

Sends a serializable object to the JMS broker.
Example usage:

     'hello world'.publishTo('queue://com.toro.hello.HelloQueue', [ "some" : "property"  ])
 

Parameters:

obj - The object to send

destinationName - The name of the queue/topic to send the object to

properties - Any properties to set on the message. Property values must be a string or primitive. The producer options can also be configured with the following keys: 'persistentDelivery', 'timeToLive', 'priority', 'ackMode'

Throws:

JMSException

Since:

2.0

publishTo

public static void publishTo(String string,
                             String destinationName)
                      throws JMSException

Send a string to the JMS broker Example usage:

     def jmsMessage = 'helloworld'.publishTo('queue://com.toro.hello.HelloQueue')
 

Parameters:

string - The string to send

destinationName - The name of the queue/topic to send the object to

Throws:

JMSException

Since:

2.0

publishTo

public static void publishTo(String string,
                             String destinationName,
                             Map properties)
                      throws JMSException

Send a string to the JMS broker

Parameters:

string - The string to send

destinationName - The name of the queue/topic to send the object to

properties - Any properties to set on the message. Property values must be a string or primitive. The producer options can also be configured with the following keys: 'persistentDelivery', 'timeToLive', 'priority', 'ackMode'

Throws:

JMSException

Since:

2.0

publishTo

public static void publishTo(String string,
                             String destinationName,
                             Closure replyClosure)
                      throws JMSException

Send a string to the JMS broker.
See here for more information Example usage:

     'queue://com.toro.hello.HelloQueue'.publishString('hello world'){
         println 'received a reply: ${message}'
      }
 

Parameters:

destinationName - The name of the queue/topic to send the object to

string - The string to send

Throws:

JMSException

publishTo

public static void publishTo(byte[] bytes,
                             String destinationName)
                      throws JMSException

Send a byte array to the JMS broker.
Example usage:

     def bytes = new byte[];
     ...
     bytes.publishTo('queue://com.toro.bytes.BytesQueue')
 

Parameters:

bytes - The byte array to send

destinationName - the name of the queue/topic to send the object to

Throws:

JMSException

Since:

2.0

publishTo

public static void publishTo(byte[] bytes,
                             String destinationName,
                             Map properties)
                      throws JMSException

Send a byte array to the JMS broker.
Example usage:

     def bytes = new byte[];
     ...
     bytes.publishTo('queue://com.toro.bytes.BytesQueue')
 

Parameters:

bytes - The byte array to send

destinationName - the name of the queue/topic to send the object to

properties - Any properties to set on the message. Property values must be a string or primitive. The producer options can also be configured with the following keys: 'persistentDelivery', 'timeToLive', 'priority', 'ackMode'

Throws:

JMSException

Since:

2.0

publishTo

public static void publishTo(byte[] bytes,
                             String destinationName,
                             Closure replyClosure)
                      throws JMSException

Send a byte array to the JMS broker.
See here for more information Example usage:

     def bytes = new byte[];
     ...
     bytes.publishTo('queue://com.toro.bytes.BytesQueue'){ message ->
        println 'received a reply: ${message}"
     }
 

Parameters:

destinationName - The name of the queue/topic to send the object to

bytes - The byte array to send

Throws:

JMSException

publishObject

public static void publishObject(String destinationName,
                                 Serializable obj,
                                 Map<String,Object> properties)
                          throws JMSException

Sends a serializable object to the JMS broker.
Example usage:

     'queue://com.toro.hello.HelloQueue'.publishObject('hello world', [ "some" : "property"  ])
 

Parameters:

destinationName - The name of the queue/topic to send the object to

obj - The object to send

properties - Any properties to set on the message. Property values must be a string or primitive. The producer options can also be configured with the following keys: 'persistentDelivery', 'timeToLive', 'priority', 'ackMode'

Throws:

JMSException

publishObject

public static void publishObject(String destinationName,
                                 Serializable obj)
                          throws JMSException

Sends a serializable object to the JMS broker.
Example usage:

     'queue://com.toro.hello.HelloQueue'.publishObject('hello world')
 

Parameters:

destinationName - The name of the queue/topic to send the object to

obj - The object to send

Throws:

JMSException

publishObject

public static void publishObject(String destinationName,
                                 Serializable obj,
                                 Closure replyClosure)
                          throws JMSException

Sends a serializable object to the JMS broker.
See here for more information Example usage:

     'queue://com.toro.hello.HelloQueue'.publishObject('hello world'){ message ->
         println 'received a reply: ${message}"
     }
 

Parameters:

destinationName - The name of the queue/topic to send the object to

obj - The object to send

Throws:

JMSException

publishString

public static void publishString(String destinationName,
                                 String string)
                          throws JMSException

Send a string to the JMS broker.
Example usage:

     'queue://com.toro.hello.HelloQueue'.publishString('hello world')
 

Parameters:

destinationName - The name of the queue/topic to send the object to

string - The string to send

Throws:

JMSException

publishString

public static void publishString(String destinationName,
                                 String string,
                                 Closure replyClosure)
                          throws JMSException

Send a string to the JMS broker.
See here for more information Example usage:

     'queue://com.toro.hello.HelloQueue'.publishString('hello world'){ message ->
         println 'received a reply: ${message}'
      }
 

Parameters:

destinationName - The name of the queue/topic to send the object to

string - The string to send

Throws:

JMSException

publishString

public static void publishString(String destinationName,
                                 String string,
                                 Map<String,Object> properties)
                          throws JMSException

Send a string to the JMS broker.
Example usage:

     'queue://com.toro.hello.HelloQueue'.publishString('hello world', [ "some" : "property" ])
 

Parameters:

destinationName - The name of the queue/topic to send the object to

string - The string to send

properties - Any properties to set on the message. Property values must be a string or primitive. The producer options can also be configured with the following keys: 'persistentDelivery', 'timeToLive', 'priority', 'ackMode'

Throws:

JMSException

publishBytes

public static void publishBytes(String destinationName,
                                byte[] bytes)
                         throws JMSException

Send a byte array to the JMS broker.
Example usage:

     def bytes = new byte[];
     ...
     'queue://com.toro.bytes.BytesQueue'.publishBytes(bytes)
 

Parameters:

destinationName - The name of the queue/topic to send the object to

bytes - The byte array to send

Throws:

JMSException

publishBytes

public static void publishBytes(String destinationName,
                                byte[] bytes,
                                Closure replyClosure)
                         throws JMSException

Send a byte array to the JMS broker.
See here for more information Example usage:

     def bytes = new byte[];
     ...
     'queue://com.toro.bytes.BytesQueue'.publishBytes(bytes){ message ->
        println 'received a reply: ${message}'
     }
 

Parameters:

destinationName - The name of the queue/topic to send the object to

bytes - The byte array to send

Throws:

JMSException

publishBytes

public static void publishBytes(String destinationName,
                                byte[] bytes,
                                Map<String,Object> properties)
                         throws JMSException

Send a byte array to the JMS broker.
Example usage:

     def bytes = new byte[];
     ...
     'queue://com.toro.bytes.BytesQueue'.publishBytes(bytes)
 

Parameters:

destinationName - The name of the queue/topic to send the object to

bytes - The byte array to send

properties - Any properties to set on the message. Property values must be a string or primitive. The producer options can also be configured with the following keys: 'persistentDelivery', 'timeToLive', 'priority', 'ackMode'

Throws:

JMSException

replyTo

public static void replyTo(Serializable obj,
                           Message requestMessage)
                    throws JMSException

Sends a serializable object to the JMS broker.
Example usage:

     'hello world'.replyTo( requestMessage )
 

Parameters:

obj - The object to send

requestMessage - The message to reply to.

Throws:

JMSException

Since:

2.0

replyTo

public static void replyTo(Serializable obj,
                           Message requestMessage,
                           Map<String,Object> properties)
                    throws JMSException

Sends a serializable object to the JMS broker.
Example usage:

     'hello world'.replyTo( requestMessage, properties )
 

Parameters:

obj - The object to send

requestMessage - The message to reply to.

properties - Any properties to set on the message. Property values must be a string or primitive. The producer options can also be configured with the following keys: 'persistentDelivery', 'timeToLive', 'priority', 'ackMode'

Throws:

JMSException

Since:

2.0

replyTo

public static void replyTo(String string,
                           Message requestMessage)
                    throws JMSException

Send a string to the JMS broker Example usage:

    'hello world'.publishTo('queue://com.toro.hello.HelloQueue')
 

Parameters:

string - The string to send

requestMessage - The message to reply to.

Throws:

JMSException

Since:

2.0

replyTo

public static void replyTo(String string,
                           Message requestMessage,
                           Map<String,Object> properties)
                    throws JMSException

Send a string to the JMS broker

Parameters:

string - The string to send

requestMessage - The message to reply to.

properties - Any properties to set on the message. Property values must be a string or primitive. The producer options can also be configured with the following keys: 'persistentDelivery', 'timeToLive', 'priority', 'ackMode' Example usage:

Throws:

JMSException

Since:

2.0

replyTo

public static void replyTo(byte[] bytes,
                           Message requestMessage)
                    throws JMSException

Send a byte array to the JMS broker.
Example usage:

     def bytes = new byte[];
     ...
     bytes.publishTo(myDestination)
 

Parameters:

bytes - The byte array to send

requestMessage - The message to reply to.

Throws:

JMSException

Since:

2.0

replyTo

public static void replyTo(byte[] bytes,
                           Message requestMessage,
                           Map<String,Object> properties)
                    throws JMSException

Send a byte array to the JMS broker.
Example usage:

     def bytes = new byte[];
     ...
     bytes.replyTo(myDestination)
 

Parameters:

bytes - The byte array to send

requestMessage - The message to reply to.

properties - Any properties to set on the message. Property values must be a string or primitive. The producer options can also be configured with the following keys: 'persistentDelivery', 'timeToLive', 'priority', 'ackMode'

Throws:

JMSException

Since:

2.0

replyWith

public static void replyWith(Message requestMessage,
                             Serializable obj)
                      throws JMSException

Sends a serializable object to the JMS broker.
Example usage:

     message.replyWith('hello world')
 

Parameters:

requestMessage - The message to reply to.

obj - The object to send

Throws:

JMSException

Since:

2.0

replyWith

public static void replyWith(Message requestMessage,
                             Serializable obj,
                             Map<String,Object> properties)
                      throws JMSException

Sends a serializable object to the JMS broker.
Example usage:

     message.replyWith('hello world', [ "some" : "property" ])
 

Parameters:

requestMessage - The message to reply to.

obj - The object to send

properties - Any properties to set on the message. Property values must be a string or primitive. The producer options can also be configured with the following keys: 'persistentDelivery', 'timeToLive', 'priority', 'ackMode'

Throws:

JMSException

Since:

2.0

replyWith

public static void replyWith(Message requestMessage,
                             String string)
                      throws JMSException

Send a string to the JMS broker.
Example usage:

     message.replyWith('hello world')
 

Parameters:

requestMessage - The message to reply to.

string - The string to send

Throws:

JMSException

Since:

2.0

replyWith

public static void replyWith(Message requestMessage,
                             String string,
                             Map<String,Object> properties)
                      throws JMSException

Send a string to the JMS broker.
Example usage:

     message.replyWith('hello world')
 

Parameters:

requestMessage - The message to reply to.

string - The string to send

properties - Any properties to set on the message. Property values must be a string or primitive. The producer options can also be configured with the following keys: 'persistentDelivery', 'timeToLive', 'priority', 'ackMode'

Throws:

JMSException

replyWith

public static void replyWith(Message requestMessage,
                             byte[] bytes)
                      throws JMSException

Send a byte array to the JMS broker.
Example usage:

     def bytes = new byte[];
     ...
     message.replyWith( bytes )
 

Parameters:

requestMessage - The message to reply to.

bytes - The byte array to send

Throws:

JMSException

Since:

2.0

replyWith

public static void replyWith(Message requestMessage,
                             byte[] bytes,
                             Map<String,Object> properties)
                      throws JMSException

Send a byte array to the JMS broker.
Example usage:

     def bytes = new byte[];
     ...
     message.replyWith(bytes)
 

Parameters:

requestMessage - The message to reply to.

bytes - The byte array to send

properties - Any properties to set on the message. Property values must be a string or primitive. The producer options can also be configured with the following keys: 'persistentDelivery', 'timeToLive', 'priority', 'ackMode'

Throws:

JMSException

sendAlert

public static void sendAlert(String message)
                      throws JMSException

Sends an AlertJMSMessage object to JMS Topic 'topic://io.toro.martini.alert.AlertQueue'
Defaults for the AlertJMSMessage to be sent to JMS Broker:
Source : Martini Package name
Severity: 0
Properties : empty map
Example usage:

     'hello world'.sendAlert()
 

Parameters:

message - alert message

Throws:

JMSException

Since:

2.0

sendAlert

public static void sendAlert(String message,
                             int severity)
                      throws JMSException

Sends an AlertJMSMessage object to JMS Topic 'topic://io.toro.martini.alert.AlertQueue'
Defaults for the AlertJMSMessage to be sent to JMS Broker:
Source : Martini Package name
Properties : empty map
Example usage:

     'hello world'.sendAlert( 1 )
 

Parameters:

message - alert message

Throws:

JMSException

Since:

2.0

sendAlert

public static void sendAlert(String message,
                             String source)
                      throws JMSException

Sends an AlertJMSMessage object to JMS Topic 'topic://io.toro.martini.alert.AlertQueue'
Defaults for the AlertJMSMessage to be sent to JMS Broker:
Severity: 0
Properties : empty map
Example usage:

     'hello world'.sendAlert('Martini Alert Package' )
 

Parameters:

message - alert message

source - The source of the alert

Throws:

JMSException

Since:

2.0

sendAlert

public static void sendAlert(String message,
                             String source,
                             int severity)
                      throws JMSException

Sends an AlertJMSMessage object to JMS Topic 'topic://io.toro.martini.alert.AlertQueue'
Defaults for the AlertJMSMessage to be sent to JMS Broker:
Properties : empty map

     'hello world'.sendAlert('Martini Alert Package', 0 )
 

Parameters:

message - alert message

source - The source of the alert

severity - Severity of the alert

Throws:

JMSException

Since:

2.0

sendAlert

public static void sendAlert(String message,
                             String source,
                             int severity,
                             Map<Serializable,Serializable> properties)
                      throws JMSException

Sends an AlertJMSMessage object to JMS Topic 'topic://io.toro.martini.alert.AlertQueue'
Example usage:

     'hello world'.sendAlert('Martini Alert Package', 0, [ 'data' : 'exampleData' ] )
 

Parameters:

message - alert message

source - The source of the alert

severity - Severity of the alert

properties - properties of the alert

Throws:

JMSException

Since:

2.0

sendAlert

public static void sendAlert(AlertJMSMessage alertJMSMessage)
                      throws JMSException

Sends an AlertJMSMessage object to JMS Topic 'topic://io.toro.martini.alert.AlertQueue'
Example usage:

     def alertJMSMessage = new AlertJMSMessage('My Message','Source',0,[ 'data' : 'exampleData' ] )
     alertJMSMessage.sendAlert()
 

Parameters:

alertJMSMessage - AlertJMSMessage object to be sent to JMS Broker

Throws:

JMSException

Since:

2.0