org.qbroker.jms

Class MessageUtils

java.lang.Object

org.qbroker.jms.MessageUtils

public class MessageUtils
extends java.lang.Object

MessageUtils contains a bunch of constants and static methods on JMSMessage for common uses

Author:

yannanlu@yahoo.com

Field Summary

Fields

Modifier and Type	Field and Description
static float	JAVA_VERSION
static java.lang.String	OS_ARCH
static java.lang.String	OS_NAME
static java.lang.String	OS_VERSION
static int	RC_AUTHERROR auth failure
static int	RC_BADDATA unexpected request data
static int	RC_BADRESP unexpected response
static int	RC_DBERROR Database failure
static int	RC_EXPIRED message expired
static int	RC_IOERROR IO faillure
static int	RC_JMSERROR JMS failure
static int	RC_MSGERROR unexpected message type
static int	RC_NOTFOUND required msg property not found
static int	RC_OK everything is OK
static int	RC_REQERROR illegal request
static int	RC_TIMEOUT request timed out
static int	RC_UNKNOWN unexpected error
static int	SHOW_AGE
static int	SHOW_BODY
static int	SHOW_CORRID
static int	SHOW_DATE
static int	SHOW_DCOUNT
static int	SHOW_DMODE
static int	SHOW_DST
static int	SHOW_EXPIRY
static int	SHOW_FAMILY
static int	SHOW_MSGID
static int	SHOW_MSGTYPE
static int	SHOW_NOTHING
static int	SHOW_PRIORITY
static int	SHOW_PROPS
static int	SHOW_REPLY
static int	SHOW_SIZE
static int	SHOW_TSTAMP
static java.lang.String	USER_NAME
static int	XA_CLIENT
static int	XA_COMMIT

Constructor Summary

Constructors

Constructor and Description
MessageUtils() default constructor for MessageUtils

Method Summary

Modifier and Type	Method and Description
static javax.jms.Message	convert(java.util.Map map, java.lang.String text) converts a set of attributes in the map into a JMS TextEvent
static javax.jms.Message	convert(javax.jms.Message msg, int type, byte[] buffer) converts a message into a JMSEvent in the specific type and returns the new message where type 0 is for BytesMessage, 1 for TextMessage, 2 for MapMessage and 3 for ObjectMessage.
static int	copy(javax.jms.Message msg, javax.jms.Message message, byte[] buffer) copies a message into another message and returns 1 with changes or 0 without changes.
static int	copyBytes(javax.jms.BytesMessage msg, byte[] buffer, java.io.OutputStream out) It copies bytes from the body of the BytesMessage to the output stream.
static int	copyBytes(java.io.InputStream in, byte[] buffer, javax.jms.BytesMessage msg) It copies bytes from the input stream to the body of the BytesMessage.
static void	disableFlowControl(javax.jms.Session s) disables the flow control on the SoniceMQ JMS session
static java.lang.String	display(javax.jms.Message inMessage, java.lang.String msgStr, int displayMask, java.lang.String[] propertyName) returns a string for display purpose
static javax.jms.Message	duplicate(javax.jms.Message msg, byte[] buffer) duplicates a message and returns a JMSEvent in the same type.
static void	enableFlowControl(javax.jms.Session s) enables the flow control on the SoniceMQ JMS session
static java.lang.String	format(javax.jms.MapMessage msg, java.lang.String mapKey, Template template) returns a formatted string of the MapMessage with the given template and an optional key for accessing to the property of Map.
static java.lang.String	format(javax.jms.Message msg, byte[] buffer, Template template) returns a formatted string of the message with the given template
static java.lang.String	format(javax.jms.Message msg, byte[] buffer, Template template, java.util.Map subMap) returns a formatted string of the message with the given template and a set of substitutions
static java.lang.String	format(javax.jms.Message msg, byte[] buffer, Template template, Template repeat, java.util.Map exclude) It returns a formatted string of the message with the given template and a repeated template.
static java.lang.String	format(java.lang.String prefix, Template[] template, TextSubstitution[] substitution, byte[] buffer, javax.jms.Message inMessage) returns a formatted string of the content of the message according to the given set of templates and substitutions.
static java.lang.String[]	getColumns(java.lang.String query) It parses the MSQL query and returns a sorted list of the column names in the query.
static java.lang.Object[]	getPlugins(java.util.Map props, java.lang.String argName, java.lang.String methodName, java.lang.String[] argClassNames, java.lang.String closerName, java.lang.String prefix) It returns an Object array with plugin method, plugin object and a method to close all resources.
static java.lang.String	getProperty(java.lang.String name, javax.jms.Message msg) returns the property value of the name from the message
static java.lang.String	getPropertyID(java.lang.String name) returns the property ID for a JMSProperty
static java.lang.String	getQueue(java.lang.String query) It parses the MSQL query and returns the queue name or null
static int	getResult(int type, int maxMsg, Template temp, XQueue xq, byte[] buffer, java.lang.StringBuffer strBuf) It gets all the messages from the XQueue and packs them into a StringBuffer according to the ResultType.
static java.lang.String	getSelector(java.lang.String query) It parses the MSQL query and returns the message selector or null
static byte[]	hexString2Bytes(java.lang.String hexStr) returns a byte array for the number of the hex string
static java.lang.String	list(javax.jms.Message msg, int type) returns a string on the message for list purpose
static java.util.Map<java.lang.String,java.lang.String>	listXQ(XQueue xq, int type, java.lang.String[] pn) lists all NEW messages in a specific XQ and returns a Map based on the given resultType and the property list.
static byte[]	long2Bytes(long l) returns a byte array for the number
static int	pack(int maxMsg, java.lang.String prefix, Template template, XQueue xq, byte[] buffer, javax.jms.Message inMessage) returns the number of messages packed into inMessage's body on success, or -1 if failed.
static java.lang.Throwable	parse(java.lang.reflect.Method parse, java.lang.Object parser, java.lang.String msgStr, javax.jms.Message message) It parses the text and fills the result into the message.
static void	pause(XQueue xq) sets PAUSE bit on the global mask of the XQueue.
static java.lang.String	processBody(javax.jms.Message inMessage, byte[] buffer) In case of BytesMessages, you may need to reset them before using this method to process message body.
static void	resetMapBody(javax.jms.MapMessage msg) resets the body Map on a MapMessage so its body is writeable.
static void	resetProperties(javax.jms.Message msg) resets JMSProperty on the message so its JMSProperties are writeable.
static int	resetReplyTo(javax.jms.Destination replyTo, javax.jms.Message msg) It resets JMSReplyTo to replyTo and returns 0 for success
static void	resumeRunning(XQueue xq) sets RUNNING bit on the global mask of the XQueue.
static int	setMapProperty(java.lang.String name, int type, java.lang.String value, javax.jms.MapMessage msg) sets the property of a MapMessage.
static int	setProperty(java.lang.String name, int type, java.lang.String value, javax.jms.Message msg) sets the user property of certain type on the message.
static int	setProperty(java.lang.String name, java.lang.String value, javax.jms.Message msg) sets JMSProperty or String property on the message.
static java.lang.String	show(javax.jms.Message msg, int type) returns a string for detail of the message
static void	standby(XQueue xq) sets STANDBY bit on the global mask of the XQueue.
static void	stopRunning(XQueue xq) sets STOP bit on the global mask of the XQueue.
static java.lang.String	substitute(java.lang.String input) substitutes GlobalProperties with ${xxx} as the place holder
static java.lang.String	substitute(java.lang.String input, Template template)
static java.lang.String	substitute(java.lang.String input, Template template, java.util.Map map)
static java.util.List<java.lang.Object>	substituteProperties(java.util.List props) It returns a List with fully cloned and substituted properties
static java.util.Map<java.lang.String,java.lang.Object>	substituteProperties(java.util.Map props) It returns a Map with fully cloned and substituted properties

Methods inherited from class java.lang.Object

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

Field Detail

SHOW_BODY

public static final int SHOW_BODY

See Also:

Constant Field Values

SHOW_DATE

public static final int SHOW_DATE

See Also:

Constant Field Values

SHOW_SIZE

public static final int SHOW_SIZE

See Also:

Constant Field Values

SHOW_DST

public static final int SHOW_DST

See Also:

Constant Field Values

SHOW_MSGID

public static final int SHOW_MSGID

See Also:

Constant Field Values

SHOW_CORRID

public static final int SHOW_CORRID

See Also:

Constant Field Values

SHOW_PROPS

public static final int SHOW_PROPS

See Also:

Constant Field Values

SHOW_EXPIRY

public static final int SHOW_EXPIRY

See Also:

Constant Field Values

SHOW_PRIORITY

public static final int SHOW_PRIORITY

See Also:

Constant Field Values

SHOW_DMODE

public static final int SHOW_DMODE

See Also:

Constant Field Values

SHOW_DCOUNT

public static final int SHOW_DCOUNT

See Also:

Constant Field Values

SHOW_TSTAMP

public static final int SHOW_TSTAMP

See Also:

Constant Field Values

SHOW_MSGTYPE

public static final int SHOW_MSGTYPE

See Also:

Constant Field Values

SHOW_REPLY

public static final int SHOW_REPLY

See Also:

Constant Field Values

SHOW_FAMILY

public static final int SHOW_FAMILY

See Also:

Constant Field Values

SHOW_AGE

public static final int SHOW_AGE

See Also:

Constant Field Values

SHOW_NOTHING

public static final int SHOW_NOTHING

See Also:

Constant Field Values

XA_CLIENT

public static final int XA_CLIENT

See Also:

Constant Field Values

XA_COMMIT

public static final int XA_COMMIT

See Also:

Constant Field Values

RC_OK

public static final int RC_OK

everything is OK

See Also:

Constant Field Values

RC_MSGERROR

public static final int RC_MSGERROR

unexpected message type

See Also:

Constant Field Values

RC_NOTFOUND

public static final int RC_NOTFOUND

required msg property not found

See Also:

Constant Field Values

RC_REQERROR

public static final int RC_REQERROR

illegal request

See Also:

Constant Field Values

RC_BADDATA

public static final int RC_BADDATA

unexpected request data

See Also:

Constant Field Values

RC_JMSERROR

public static final int RC_JMSERROR

JMS failure

See Also:

Constant Field Values

RC_IOERROR

public static final int RC_IOERROR

IO faillure

See Also:

Constant Field Values

RC_DBERROR

public static final int RC_DBERROR

Database failure

See Also:

Constant Field Values

RC_EXPIRED

public static final int RC_EXPIRED

message expired

See Also:

Constant Field Values

RC_TIMEOUT

public static final int RC_TIMEOUT

request timed out

See Also:

Constant Field Values

RC_AUTHERROR

public static final int RC_AUTHERROR

auth failure

See Also:

Constant Field Values

RC_BADRESP

public static final int RC_BADRESP

unexpected response

See Also:

Constant Field Values

RC_UNKNOWN

public static final int RC_UNKNOWN

unexpected error

See Also:

Constant Field Values

JAVA_VERSION

public static final float JAVA_VERSION

OS_NAME

public static final java.lang.String OS_NAME

OS_ARCH

public static final java.lang.String OS_ARCH

OS_VERSION

public static final java.lang.String OS_VERSION

USER_NAME

public static final java.lang.String USER_NAME

Constructor Detail

MessageUtils

public MessageUtils()

default constructor for MessageUtils

Method Detail

substitute

public static java.lang.String substitute(java.lang.String input,
                                          Template template)

substitute

public static java.lang.String substitute(java.lang.String input,
                                          Template template,
                                          java.util.Map map)

substitute

public static java.lang.String substitute(java.lang.String input)

substitutes GlobalProperties with ${xxx} as the place holder

substituteProperties

public static java.util.Map<java.lang.String,java.lang.Object> substituteProperties(java.util.Map props)

It returns a Map with fully cloned and substituted properties

substituteProperties

public static java.util.List<java.lang.Object> substituteProperties(java.util.List props)

It returns a List with fully cloned and substituted properties

getPropertyID

public static java.lang.String getPropertyID(java.lang.String name)

returns the property ID for a JMSProperty

getProperty

public static java.lang.String getProperty(java.lang.String name,
                                           javax.jms.Message msg)
                                    throws javax.jms.JMSException

returns the property value of the name from the message

Throws:

javax.jms.JMSException

setProperty

public static int setProperty(java.lang.String name,
                              java.lang.String value,
                              javax.jms.Message msg)
                       throws javax.jms.JMSException

sets JMSProperty or String property on the message. It returns 0 on success, -1 on illegal arguments or JMSException.

Throws:

javax.jms.JMSException

setProperty

public static int setProperty(java.lang.String name,
                              int type,
                              java.lang.String value,
                              javax.jms.Message msg)
                       throws javax.jms.JMSException

sets the user property of certain type on the message. It returns 0 on success, -1 on illegal arguments or JMSException.

Throws:

javax.jms.JMSException

setMapProperty

public static int setMapProperty(java.lang.String name,
                                 int type,
                                 java.lang.String value,
                                 javax.jms.MapMessage msg)
                          throws javax.jms.JMSException

sets the property of a MapMessage. It returns 0 on success, -1 on illegal arguments or JMSException.

Throws:

javax.jms.JMSException

processBody

public static java.lang.String processBody(javax.jms.Message inMessage,
                                           byte[] buffer)
                                    throws javax.jms.JMSException

In case of BytesMessages, you may need to reset them before using this method to process message body. The previous read will change the starting position of the byte stream.

You need to provide a byte array: buffer[bufferSize] for MT-Safe.

Throws:

javax.jms.JMSException

format

public static java.lang.String format(javax.jms.Message msg,
                                      byte[] buffer,
                                      Template template)
                               throws javax.jms.JMSException

returns a formatted string of the message with the given template

Throws:

javax.jms.JMSException

format

public static java.lang.String format(javax.jms.MapMessage msg,
                                      java.lang.String mapKey,
                                      Template template)
                               throws javax.jms.JMSException

returns a formatted string of the MapMessage with the given template and an optional key for accessing to the property of Map. The value of the Map key will substitute the place holder of ##body##.

Throws:

javax.jms.JMSException

format

public static java.lang.String format(javax.jms.Message msg,
                                      byte[] buffer,
                                      Template template,
                                      java.util.Map subMap)
                               throws javax.jms.JMSException

returns a formatted string of the message with the given template and a set of substitutions

Throws:

javax.jms.JMSException

format

public static java.lang.String format(javax.jms.Message msg,
                                      byte[] buffer,
                                      Template template,
                                      Template repeat,
                                      java.util.Map exclude)
                               throws javax.jms.JMSException

It returns a formatted string of the message with the given template and a repeated template. It is used to format JMSEvents into events in either postable format or collectible format. The postable format of an event is a uri query string ready to be posted to a web server. The collectible format of an event is a log string ready to be parsed into an event by EventParser. But it does not contain the trailing newline chararcter and the leading timestamp as well as the IP address.

Throws:

javax.jms.JMSException

format

public static java.lang.String format(java.lang.String prefix,
                                      Template[] template,
                                      TextSubstitution[] substitution,
                                      byte[] buffer,
                                      javax.jms.Message inMessage)

returns a formatted string of the content of the message according to the given set of templates and substitutions. The prefix is used for the exception message if there is an error.

list

public static java.lang.String list(javax.jms.Message msg,
                                    int type)

returns a string on the message for list purpose

show

public static java.lang.String show(javax.jms.Message msg,
                                    int type)

returns a string for detail of the message

display

public static java.lang.String display(javax.jms.Message inMessage,
                                       java.lang.String msgStr,
                                       int displayMask,
                                       java.lang.String[] propertyName)
                                throws javax.jms.JMSException

returns a string for display purpose

Throws:

javax.jms.JMSException

duplicate

public static javax.jms.Message duplicate(javax.jms.Message msg,
                                          byte[] buffer)
                                   throws javax.jms.JMSException

duplicates a message and returns a JMSEvent in the same type.

You need to provide a byte array: buffer[bufferSize] for MT-Safe.

Throws:

javax.jms.JMSException

convert

public static javax.jms.Message convert(javax.jms.Message msg,
                                        int type,
                                        byte[] buffer)
                                 throws javax.jms.JMSException

converts a message into a JMSEvent in the specific type and returns the new message where type 0 is for BytesMessage, 1 for TextMessage, 2 for MapMessage and 3 for ObjectMessage. In case of failure, it may just return null without exception.

You need to provide a byte array: buffer[bufferSize] for MT-Safe.

Throws:

javax.jms.JMSException

convert

public static javax.jms.Message convert(java.util.Map map,
                                        java.lang.String text)

converts a set of attributes in the map into a JMS TextEvent

copy

public static int copy(javax.jms.Message msg,
                       javax.jms.Message message,
                       byte[] buffer)
                throws javax.jms.JMSException

copies a message into another message and returns 1 with changes or 0 without changes.

Throws:

javax.jms.JMSException

resetProperties

public static void resetProperties(javax.jms.Message msg)
                            throws javax.jms.JMSException

resets JMSProperty on the message so its JMSProperties are writeable. All existing JMSProperties are copied over except for those of JMSX

Throws:

javax.jms.JMSException

resetMapBody

public static void resetMapBody(javax.jms.MapMessage msg)
                         throws javax.jms.JMSException

resets the body Map on a MapMessage so its body is writeable. All existing key-value pairs are copied over.

Throws:

javax.jms.JMSException

hexString2Bytes

public static byte[] hexString2Bytes(java.lang.String hexStr)

returns a byte array for the number of the hex string

long2Bytes

public static byte[] long2Bytes(long l)

returns a byte array for the number

parse

public static java.lang.Throwable parse(java.lang.reflect.Method parse,
                                        java.lang.Object parser,
                                        java.lang.String msgStr,
                                        javax.jms.Message message)

It parses the text and fills the result into the message. Upon success, it returns null, or a throwable object otherwise. The Object of parser is supposed to have a public method of parse() that takes a String as the only input argument. On success, the method of parse() will return either an Event or a Map. For anything else, the method fails.

getResult

public static int getResult(int type,
                            int maxMsg,
                            Template temp,
                            XQueue xq,
                            byte[] buffer,
                            java.lang.StringBuffer strBuf)
                     throws javax.jms.JMSException

It gets all the messages from the XQueue and packs them into a StringBuffer according to the ResultType. The maxMsg determines the maximum number of messages got from the XQueue. It returns the number of messages packed upon success. Otherwise, it returns -1 if any failures.

Throws:

javax.jms.JMSException

pack

public static int pack(int maxMsg,
                       java.lang.String prefix,
                       Template template,
                       XQueue xq,
                       byte[] buffer,
                       javax.jms.Message inMessage)

returns the number of messages packed into inMessage's body on success, or -1 if failed. The prefix is used for the exception message if there is an error.

getSelector

public static java.lang.String getSelector(java.lang.String query)

It parses the MSQL query and returns the message selector or null

getQueue

public static java.lang.String getQueue(java.lang.String query)

It parses the MSQL query and returns the queue name or null

getColumns

public static java.lang.String[] getColumns(java.lang.String query)

It parses the MSQL query and returns a sorted list of the column names in the query. In case of null or empty query, it returns null.

stopRunning

public static void stopRunning(XQueue xq)

sets STOP bit on the global mask of the XQueue.

resumeRunning

public static void resumeRunning(XQueue xq)

sets RUNNING bit on the global mask of the XQueue.

pause

public static void pause(XQueue xq)

sets PAUSE bit on the global mask of the XQueue.

standby

public static void standby(XQueue xq)

sets STANDBY bit on the global mask of the XQueue.

copyBytes

public static int copyBytes(java.io.InputStream in,
                            byte[] buffer,
                            javax.jms.BytesMessage msg)
                     throws javax.jms.JMSException

It copies bytes from the input stream to the body of the BytesMessage. Upon success, it returns number of bytes copied to the message.

Throws:

javax.jms.JMSException

copyBytes

public static int copyBytes(javax.jms.BytesMessage msg,
                            byte[] buffer,
                            java.io.OutputStream out)
                     throws javax.jms.JMSException

It copies bytes from the body of the BytesMessage to the output stream. Upon success, it returns number of bytes copied to the stream.

Throws:

javax.jms.JMSException

listXQ

public static java.util.Map<java.lang.String,java.lang.String> listXQ(XQueue xq,
                                                                      int type,
                                                                      java.lang.String[] pn)

lists all NEW messages in a specific XQ and returns a Map based on the given resultType and the property list.

resetReplyTo

public static int resetReplyTo(javax.jms.Destination replyTo,
                               javax.jms.Message msg)
                        throws javax.jms.JMSException

It resets JMSReplyTo to replyTo and returns 0 for success

Throws:

javax.jms.JMSException

getPlugins

public static java.lang.Object[] getPlugins(java.util.Map props,
                                            java.lang.String argName,
                                            java.lang.String methodName,
                                            java.lang.String[] argClassNames,
                                            java.lang.String closerName,
                                            java.lang.String prefix)

It returns an Object array with plugin method, plugin object and a method to close all resources. The plugin method is supposed to take the arguments of types specified in argClassNames. There is no requirement on what it should return. The plugin object is initialized with the only argument stored in the property hashmap. The property hashmap should contain Name, initial arguments under argName. The closerName is optional and it is OK to be null. The prefix is used for exception.

enableFlowControl

public static void enableFlowControl(javax.jms.Session s)

enables the flow control on the SoniceMQ JMS session

disableFlowControl

public static void disableFlowControl(javax.jms.Session s)

disables the flow control on the SoniceMQ JMS session