com.solacesystems.jms

Class SolJmsUtility

java.lang.Object

com.solacesystems.jms.SolJmsUtility

public class SolJmsUtility
extends Object

Utility functions for working with Solace JMS.

Method Summary

Methods

Modifier and Type	Method and Description
static com.solacesystems.jms.SolConnectionFactory	createConnectionFactory() Creates a Solace proprietary implementation of a ConnectionFactory.
static com.solacesystems.jms.SolConnectionFactory	createConnectionFactory(Hashtable<?,?> environment) Creates a Solace proprietary implementation of a ConnectionFactory given an environment.
static com.solacesystems.jms.SolConnectionFactory	createConnectionFactory(String host, String username, String password, String vpn, Hashtable<?,?> environment) Creates a Solace proprietary implementation of a ConnectionFactory given connection parameters and an environment.
static SolQueue	createQueue(String queueName) Creates a Solace proprietary implementation of a queue given a queue name.
static SolTopic	createTopic(String topicName) Creates a Solace proprietary implementation of a topic given a topic name.
static com.solacesystems.jms.SolXAConnectionFactory	createXAConnectionFactory() Creates a Solace proprietary implementation of an XAConnectionFactory.
static com.solacesystems.jms.SolXAConnectionFactory	createXAConnectionFactory(Hashtable<?,?> environment) Creates a Solace proprietary implementation of an XAConnectionFactory given an environment.
static com.solacesystems.jms.SolXAConnectionFactory	createXAConnectionFactory(String host, String username, String password, String vpn, Hashtable<?,?> environment) Creates a Solace proprietary implementation of an XAConnectionFactory given connection parameters and an environment.
static String	dumpMessage(javax.jms.Message msg) Produces a human-readable dump of the message properties and its contents (can be quite large).
static javax.jms.Message	fromByteArray(byte[] data) Converts a byte array representing a serialized JMS Message into a JMS Message.
static long	getMessageSize(javax.jms.Message msg) Gets the encoded size of the message payload in bytes.
static SolReferenceableDelegate	getReferenceableDelegate() Gets the Referenceable delegate for ConnectionFactorys, Topics, and Queues.
static void	setReferenceableDelegate(SolReferenceableDelegate referenceableDelegate) Sets the Referenceable delegate for ConnectionFactorys, Topics, and Queues.
static byte[]	toByteArray(javax.jms.Message msg) Serializes a JMS Message into a byte array.

Methods inherited from class java.lang.Object

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

Method Detail

dumpMessage

public static String dumpMessage(javax.jms.Message msg)

Produces a human-readable dump of the message properties and its contents (can be quite large). Applications must not parse the output as its format is undefined.

The textual dump includes JMS message fields and properties, followed by Solace-message-specific attributes as reported by the underlying messaging provider.

Parameters:

msg - A Solace JMS Message instance.

Returns:

A String representation of the message, to be used for debugging.

getMessageSize

public static long getMessageSize(javax.jms.Message msg)
                           throws javax.jms.JMSException

Gets the encoded size of the message payload in bytes. It is an approximate size because some message headers are not included. This method can only be used on a received message and throws a javax.jms.IllegalStateException for a message created using the local javax.jms.Session.

Parameters:

msg - The message to get the payload size of.

Returns:

The encoded size of the message payload in bytes.

Throws:

javax.jms.JMSException - on error

toByteArray

public static byte[] toByteArray(javax.jms.Message msg)
                          throws javax.jms.JMSException

Serializes a JMS Message into a byte array.

Parameters:

msg - The message to be serialized.

Returns:

The serialized message.

Throws:

javax.jms.JMSException - If conversion fails.

fromByteArray

public static javax.jms.Message fromByteArray(byte[] data)
                                       throws javax.jms.JMSException

Converts a byte array representing a serialized JMS Message into a JMS Message. The Bytes and Stream messages returned from this call are in write-only mode. An attempt to read the body of a Bytes or Stream message in this mode throws a MessageNotReadableException. Calling reset puts their bodies in read-only mode.

Parameters:

data - The serialized JMS Message.

Returns:

The JMS Message

Throws:

javax.jms.JMSException - If conversion fails.

createConnectionFactory

public static com.solacesystems.jms.SolConnectionFactory createConnectionFactory()
                                                                          throws Exception

Creates a Solace proprietary implementation of a ConnectionFactory.

Returns:

A Solace proprietary implementation of a ConnectionFactory.

Throws:

Exception - on error

createConnectionFactory

public static com.solacesystems.jms.SolConnectionFactory createConnectionFactory(Hashtable<?,?> environment)
                                                                          throws Exception

Creates a Solace proprietary implementation of a ConnectionFactory given an environment.

Parameters:

environment - Environment table

Returns:

A Solace proprietary implementation of a ConnectionFactory.

Throws:

Exception - on error

createConnectionFactory

public static com.solacesystems.jms.SolConnectionFactory createConnectionFactory(String host,
                                                                 String username,
                                                                 String password,
                                                                 String vpn,
                                                                 Hashtable<?,?> environment)
                                                                          throws Exception

Creates a Solace proprietary implementation of a ConnectionFactory given connection parameters and an environment.

Parameters:

host - Appliance host to be used for any connections created from this factory.

username - Appliance username to be used for any connections created from this factory.

password - Appliance password to be used for any connections created from this factory.

vpn - Appliance vpn to be used for any connections created from this factory.

environment - Environment table

Returns:

A Solace proprietary implementation of a ConnectionFactory.

Throws:

Exception - on error

createXAConnectionFactory

public static com.solacesystems.jms.SolXAConnectionFactory createXAConnectionFactory()
                                                                              throws Exception

Creates a Solace proprietary implementation of an XAConnectionFactory.

Returns:

A Solace proprietary implementation of an XAConnectionFactory.

Throws:

Exception - on error

createXAConnectionFactory

public static com.solacesystems.jms.SolXAConnectionFactory createXAConnectionFactory(Hashtable<?,?> environment)
                                                                              throws Exception

Creates a Solace proprietary implementation of an XAConnectionFactory given an environment.

Parameters:

environment - Environment table

Returns:

A Solace proprietary implementation of an XAConnectionFactory.

Throws:

Exception - on error

createXAConnectionFactory

public static com.solacesystems.jms.SolXAConnectionFactory createXAConnectionFactory(String host,
                                                                     String username,
                                                                     String password,
                                                                     String vpn,
                                                                     Hashtable<?,?> environment)
                                                                              throws Exception

Creates a Solace proprietary implementation of an XAConnectionFactory given connection parameters and an environment.

Parameters:

host - Appliance host to be used for any connections created from this factory.

username - Appliance username to be used for any connections created from this factory.

password - Appliance password to be used for any connections created from this factory.

vpn - Appliance vpn to be used for any connections created from this factory.

environment - Environment table

Returns:

A Solace proprietary implementation of an XAConnectionFactory.

Throws:

Exception - on error

createTopic

public static SolTopic createTopic(String topicName)

Creates a Solace proprietary implementation of a topic given a topic name.

Parameters:

topicName - parameter

Returns:

A Solace proprietary implementation of a Topic.

createQueue

public static SolQueue createQueue(String queueName)

Creates a Solace proprietary implementation of a queue given a queue name.

Parameters:

queueName - parameter

Returns:

A Solace proprietary implementation of a Queue.

setReferenceableDelegate

public static void setReferenceableDelegate(SolReferenceableDelegate referenceableDelegate)

Sets the Referenceable delegate for ConnectionFactorys, Topics, and Queues. Setting the referenceable delgate means that whenever Referenceable.getReference() is called on a ConnectionFactory, Topic, or Queue the delegate will be called to return a Reference.

Parameters:

referenceableDelegate - The referenceable delegate

getReferenceableDelegate

public static SolReferenceableDelegate getReferenceableDelegate()

Gets the Referenceable delegate for ConnectionFactorys, Topics, and Queues. Setting the referenceable delgate means that whenever Referenceable.getReference() is called on a ConnectionFactory, Topic, or Queue the delegate will be called to return a Reference.

Returns:

the referenceable delegate