net.relaysoft.robot.jms.client

Class AbstractJMS20Client

java.lang.Object

net.relaysoft.robot.jms.client.AbstractJMSClient

net.relaysoft.robot.jms.client.AbstractJMS20Client

All Implemented Interfaces:

JMSClient

Direct Known Subclasses:

DefaultJMS20Client, IBMMQ20Client

public abstract class AbstractJMS20Client
extends AbstractJMSClient
implements JMSClient

Abstract JMS API 2.x version specific implementation of JMS client wrapper interface.

Author:

relaysoft.net

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,javax.jms.JMSConsumer>	temporaryConsumers

Fields inherited from class net.relaysoft.robot.jms.client.AbstractJMSClient

CONNECTION_FACTORY_NAME, factory, INVALID_MESSAGE_EXCEPTION, temporaryDestinations

Constructor Summary

Constructors

Constructor and Description
AbstractJMS20Client(String clientID) Create new JMS client version 2.0 instance.

Method Summary

Modifier and Type	Method and Description
void	closeConnection() Permanently closes JMS client connection.
String	createTemporaryQueue() Create new temporary queue.
String	createTemporaryTopic() Create new temporary topic.
void	deleteTemporaryQueue(String queueName) Deletes temporary queue.
void	deleteTemporaryTopic(String queueName) Deletes temporary topic.
byte[]	getMessageByteContent(String messageID) Return byte message's byte content.
String	getMessageCorrelationID(String messageID) Return message's correlation ID
String	getMessageDestinationName(String messageID) Return message's target destination (Queue or Topic) name.
long	getMessageExpirationTime(String messageID) Return message's expiration time in milliseconds.
String	getMessageID(String messageID) Return message's unique ID.
Map<String,Object>	getMessageMapContent(String messageID) Return map message's map content.
int	getMessagePriority(String messageID) Return message's priority value from 1-9.
Object	getMessageProperty(String propertyName, String messageID) Return message property value
String	getMessageReplyToQueue(String messageID) Return message's reply to queue (or topic) target destination.
String	getMessageTextContent(String messageID) Return text message's string content.
long	getMessageTimestamp(String messageID) Return message's latest timestamp.
String	getMessageType(String messageID) Return message's JMS type.
int	getQueueDepth(String queueName) Return specified queue current depth (Amount of unread messages in queue).
void	initializeClient(Map<String,Object> parameters) Initializes current JMS client wrapper.
void	openConnection() Open new connection into MQ provider/broker.
void	openConnection(String userName, String password) Open new connection into MQ provider/broker.
String	peekFromQueue(String queueName, String messageSelector) Peek first message from the queue.
void	publishIntoTopic(String topicName, byte[] content, Map<String,Object> parameters, Map<String,Object> properties) Publish new message into topic.
void	publishIntoTopic(String topicName, Map<String,Object> content, Map<String,Object> parameters, Map<String,Object> properties) Publish new message into topic.
void	publishIntoTopic(String topicName, String content, Map<String,Object> parameters, Map<String,Object> properties) Publish new message into topic.
void	purgeQueue(String queueName) Remove all messages from specified queue.
String	readFromQueue(String queueName, long timeout, String messageSelector) Read single message from the queue.
String	readFromTopic(String name, long timeout) Read single message from the topic.
void	subscribeTopic(String topicName, String name, String messageSelector) Make new durable subscription into topic.
void	unsubscribeTopic(String name) Cancel made durable subscription for the topic.
void	writeIntoQueue(String queueName, byte[] content, Map<String,Object> parameters, Map<String,Object> properties) Write new message into queue
void	writeIntoQueue(String queueName, Map<String,Object> content, Map<String,Object> parameters, Map<String,Object> properties) Write new message into queue
void	writeIntoQueue(String queueName, String content, Map<String,Object> parameters, Map<String,Object> properties) Write new message into queue

Methods inherited from class net.relaysoft.robot.jms.client.AbstractJMSClient

addMessage, clearMessages, createConnectionFactory, getClientID, getMessage, isConnected, resolveMessageType, resolveMessageType

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.relaysoft.robot.jms.client.JMSClient

clearMessages, getClientID, resolveMessageType

Field Detail

temporaryConsumers

protected Map<String,javax.jms.JMSConsumer> temporaryConsumers

Constructor Detail

AbstractJMS20Client

public AbstractJMS20Client(String clientID)

Create new JMS client version 2.0 instance.

Parameters:

clientID - - Unique client ID

Method Detail

closeConnection

public void closeConnection()
                     throws javax.jms.JMSException

Description copied from interface: JMSClient

Permanently closes JMS client connection.

Specified by:

closeConnection in interface JMSClient

Overrides:

closeConnection in class AbstractJMSClient

Throws:

javax.jms.JMSException - If closing of connection fails

createTemporaryQueue

public String createTemporaryQueue()
                            throws javax.jms.JMSException

Description copied from interface: JMSClient

Create new temporary queue.

Specified by:

createTemporaryQueue in interface JMSClient

Returns:

Created temporary queue's name.

Throws:

javax.jms.JMSException - If temporary queue creation fails.

createTemporaryTopic

public String createTemporaryTopic()
                            throws javax.jms.JMSException

Description copied from interface: JMSClient

Create new temporary topic.

Specified by:

createTemporaryTopic in interface JMSClient

Returns:

Created temporary topic's name

Throws:

javax.jms.JMSException - If temporary topic creation fails.

deleteTemporaryQueue

public void deleteTemporaryQueue(String queueName)
                          throws javax.jms.JMSException

Description copied from interface: JMSClient

Deletes temporary queue.

Specified by:

deleteTemporaryQueue in interface JMSClient

Parameters:

queueName - - Temporary queue name

Throws:

javax.jms.JMSException - If deletion fails.

deleteTemporaryTopic

public void deleteTemporaryTopic(String queueName)
                          throws javax.jms.JMSException

Description copied from interface: JMSClient

Deletes temporary topic.

Specified by:

deleteTemporaryTopic in interface JMSClient

Parameters:

queueName - - Temporary topic name

Throws:

javax.jms.JMSException - If deletion fails.

getMessageByteContent

public byte[] getMessageByteContent(String messageID)
                             throws javax.jms.JMSException

Description copied from interface: JMSClient

Return byte message's byte content.

Specified by:

getMessageByteContent in interface JMSClient

Parameters:

messageID - - Optional message ID. If not given then method attempt to read content from latest read message

Returns:

Byte message's byte content.

Throws:

javax.jms.JMSException - If reading bytes from message fails.

getMessageMapContent

public Map<String,Object> getMessageMapContent(String messageID)
                                        throws javax.jms.JMSException

Description copied from interface: JMSClient

Return map message's map content.

Specified by:

getMessageMapContent in interface JMSClient

Parameters:

messageID - - Optional message ID. If not given then method attempt to read content from latest read message

Returns:

Map message's map content.

Throws:

javax.jms.JMSException - If reading map from message fails.

getMessageCorrelationID

public String getMessageCorrelationID(String messageID)
                               throws javax.jms.JMSException

Description copied from interface: JMSClient

Return message's correlation ID

Specified by:

getMessageCorrelationID in interface JMSClient

Parameters:

messageID - - Optional message ID. If not given then method attempt to read content from latest read message

Returns:

Message's correlation ID.

Throws:

javax.jms.JMSException - If getting message's meta data fails.

getMessageDestinationName

public String getMessageDestinationName(String messageID)
                                 throws javax.jms.JMSException

Description copied from interface: JMSClient

Return message's target destination (Queue or Topic) name.

Specified by:

getMessageDestinationName in interface JMSClient

Parameters:

messageID - - Optional message ID. If not given then method attempt to read content from latest read message

Returns:

Message's destination name.

Throws:

javax.jms.JMSException - If getting message's meta data fails.

getMessageExpirationTime

public long getMessageExpirationTime(String messageID)
                              throws javax.jms.JMSException

Description copied from interface: JMSClient

Return message's expiration time in milliseconds.

Specified by:

getMessageExpirationTime in interface JMSClient

Parameters:

messageID - - Optional message ID. If not given then method attempt to read content from latest read message

Returns:

Message's expiration time.

Throws:

javax.jms.JMSException - If getting message's meta data fails.

getMessageID

public String getMessageID(String messageID)
                    throws javax.jms.JMSException

Description copied from interface: JMSClient

Return message's unique ID.

Specified by:

getMessageID in interface JMSClient

Parameters:

messageID - - Optional message ID. If not given then method attempt to read content from latest read message

Returns:

Message's ID.

Throws:

javax.jms.JMSException - If getting message's meta data fails.

getMessagePriority

public int getMessagePriority(String messageID)
                       throws javax.jms.JMSException

Description copied from interface: JMSClient

Return message's priority value from 1-9.

Specified by:

getMessagePriority in interface JMSClient

Parameters:

messageID - - Optional message ID. If not given then method attempt to read content from latest read message

Returns:

Message's priority value.

Throws:

javax.jms.JMSException - If getting message's meta data fails.

getMessageProperty

public Object getMessageProperty(String propertyName,
                                 String messageID)
                          throws javax.jms.JMSException

Description copied from interface: JMSClient

Return message property value

Specified by:

getMessageProperty in interface JMSClient

Parameters:

propertyName - - Name of the property

messageID - - Optional message ID. If not given then method attempt to read content from latest read message

Returns:

Message property value.

Throws:

javax.jms.JMSException - If getting message's meta data fails.

getMessageReplyToQueue

public String getMessageReplyToQueue(String messageID)
                              throws javax.jms.JMSException

Description copied from interface: JMSClient

Return message's reply to queue (or topic) target destination.

Specified by:

getMessageReplyToQueue in interface JMSClient

Parameters:

messageID - - Optional message ID. If not given then method attempt to read content from latest read message

Returns:

Message's reply to destination name.

Throws:

javax.jms.JMSException - If getting message's meta data fails.

getMessageTextContent

public String getMessageTextContent(String messageID)
                             throws javax.jms.JMSException

Description copied from interface: JMSClient

Return text message's string content.

Specified by:

getMessageTextContent in interface JMSClient

Parameters:

messageID - - Optional message ID. If not given then method attempt to read content from latest read message

Returns:

Text message's content as string.

Throws:

javax.jms.JMSException - - If getting message content fails for any reason.

getMessageTimestamp

public long getMessageTimestamp(String messageID)
                         throws javax.jms.JMSException

Description copied from interface: JMSClient

Return message's latest timestamp.

Specified by:

getMessageTimestamp in interface JMSClient

Parameters:

messageID - - Optional message ID. If not given then method attempt to read content from latest read message

Returns:

Message's timestamp.

Throws:

javax.jms.JMSException - If getting message's meta data fails.

getMessageType

public String getMessageType(String messageID)
                      throws javax.jms.JMSException

Description copied from interface: JMSClient

Return message's JMS type.

Specified by:

getMessageType in interface JMSClient

Parameters:

messageID - - Optional message ID. If not given then method attempt to read content from latest read message

Returns:

Message's type

Throws:

javax.jms.JMSException - If getting message's meta data fails.

getQueueDepth

public int getQueueDepth(String queueName)
                  throws javax.jms.JMSException

Description copied from interface: JMSClient

Return specified queue current depth (Amount of unread messages in queue).

Specified by:

getQueueDepth in interface JMSClient

Parameters:

queueName - - Name of the queue to check

Returns:

Current queue depth.

Throws:

javax.jms.JMSException - If getting queue depth fails for any reason.

initializeClient

public void initializeClient(Map<String,Object> parameters)
                      throws Exception

Description copied from interface: JMSClient

Initializes current JMS client wrapper. Client need to be initialized before opening any connections. Initialization parameters can contain any provider specific connection factory initialization variables or JNDI properties for the JMS connection factory.

Specified by:

initializeClient in interface JMSClient

Parameters:

parameters - - Parameters for client initialization.

Throws:

Exception - If initializing the client fails for any reason.

openConnection

public void openConnection()
                    throws javax.jms.JMSException

Description copied from interface: JMSClient

Open new connection into MQ provider/broker. If connection already exists, this method call has no any effect.

Specified by:

openConnection in interface JMSClient

Overrides:

openConnection in class AbstractJMSClient

Throws:

javax.jms.JMSException - If opening the connection fails.

openConnection

public void openConnection(String userName,
                           String password)
                    throws javax.jms.JMSException

Description copied from interface: JMSClient

Open new connection into MQ provider/broker. If connection already exists, this method call has no any effect.

Specified by:

openConnection in interface JMSClient

Parameters:

userName - - User name used for connection authentication

password - - Password used for connection authentication

Throws:

javax.jms.JMSException - If opening the connection fails.

peekFromQueue

public String peekFromQueue(String queueName,
                            String messageSelector)
                     throws javax.jms.JMSException

Description copied from interface: JMSClient

Peek first message from the queue. Peeking message does not remove message from queue.

Specified by:

peekFromQueue in interface JMSClient

Parameters:

queueName - - Queue to peek from

messageSelector - - Optional message selector to filter queue content

Returns:

Message's ID or null if no message was peeked from the queue.

Throws:

javax.jms.JMSException - If reading the message fails.

publishIntoTopic

public void publishIntoTopic(String topicName,
                             String content,
                             Map<String,Object> parameters,
                             Map<String,Object> properties)

Description copied from interface: JMSClient

Publish new message into topic.

Specified by:

publishIntoTopic in interface JMSClient

Parameters:

topicName - - Topic name into which message is published

content - - Message's content

parameters - - Optional message's JMS parameters. Key values are defined in MessageParameterNames

properties - - Optional JMS message properties

See Also:

MessageParameterNames

publishIntoTopic

public void publishIntoTopic(String topicName,
                             byte[] content,
                             Map<String,Object> parameters,
                             Map<String,Object> properties)

Description copied from interface: JMSClient

Publish new message into topic.

Specified by:

publishIntoTopic in interface JMSClient

Parameters:

topicName - - Topic name into which message is published

content - - Message's content

parameters - - Optional message's JMS parameters. Key values are defined in MessageParameterNames

properties - - Optional JMS message properties

See Also:

MessageParameterNames

publishIntoTopic

public void publishIntoTopic(String topicName,
                             Map<String,Object> content,
                             Map<String,Object> parameters,
                             Map<String,Object> properties)

Description copied from interface: JMSClient

Publish new message into topic.

Specified by:

publishIntoTopic in interface JMSClient

Parameters:

topicName - - Topic name into which message is published

content - - Message's content

parameters - - Optional message's JMS parameters. Key values are defined in MessageParameterNames

properties - - Optional JMS message properties

See Also:

MessageParameterNames

purgeQueue

public void purgeQueue(String queueName)
                throws javax.jms.JMSException

Description copied from interface: JMSClient

Remove all messages from specified queue.

Specified by:

purgeQueue in interface JMSClient

Parameters:

queueName - - Name of the queue to purge from messages

Throws:

javax.jms.JMSException - If purging the queue fails for any reason.

readFromQueue

public String readFromQueue(String queueName,
                            long timeout,
                            String messageSelector)
                     throws javax.jms.JMSException

Description copied from interface: JMSClient

Read single message from the queue.

Specified by:

readFromQueue in interface JMSClient

Parameters:

queueName - - Name of the queue to read from

timeout - - Timeout in milliseconds to wait for message to appear into queue

messageSelector - - Optional message selector string for filtering messages

Returns:

Message's ID or null if no message was read from the queue.

Throws:

javax.jms.JMSException - If reading the message fails.

readFromTopic

public String readFromTopic(String name,
                            long timeout)
                     throws javax.jms.JMSException

Description copied from interface: JMSClient

Read single message from the topic.

Specified by:

readFromTopic in interface JMSClient

Parameters:

name - - Name of the durable subscription made for the topic or name of the temporary topic

timeout - - Timeout in milliseconds to wait for message to appear into topic

Returns:

Message's ID or null if no message was read from the topic.

Throws:

javax.jms.JMSException - If reading the message fails.

subscribeTopic

public void subscribeTopic(String topicName,
                           String name,
                           String messageSelector)
                    throws javax.jms.JMSException

Description copied from interface: JMSClient

Make new durable subscription into topic.

Specified by:

subscribeTopic in interface JMSClient

Parameters:

topicName - - Name of the topic

name - - Unique name for the durable subscription

messageSelector - - Optional message selector string for filtering messages

Throws:

javax.jms.JMSException - If subscribing the topic fails.

unsubscribeTopic

public void unsubscribeTopic(String name)

Description copied from interface: JMSClient

Cancel made durable subscription for the topic.

Specified by:

unsubscribeTopic in interface JMSClient

Parameters:

name - - Unique subscription name to cancel

writeIntoQueue

public void writeIntoQueue(String queueName,
                           String content,
                           Map<String,Object> parameters,
                           Map<String,Object> properties)

Description copied from interface: JMSClient

Write new message into queue

Specified by:

writeIntoQueue in interface JMSClient

Parameters:

queueName - - Name of the queue to write

content - - Message's content

parameters - - Optional message's JMS parameters. Key values are defined in MessageParameterNames

properties - - Optional JMS message properties

See Also:

MessageParameterNames

writeIntoQueue

public void writeIntoQueue(String queueName,
                           byte[] content,
                           Map<String,Object> parameters,
                           Map<String,Object> properties)

Description copied from interface: JMSClient

Write new message into queue

Specified by:

writeIntoQueue in interface JMSClient

Parameters:

queueName - - Name of the queue to write

content - - Message's content

parameters - - Optional message's JMS parameters. Key values are defined in MessageParameterNames

properties - - Optional JMS message properties

See Also:

MessageParameterNames

writeIntoQueue

public void writeIntoQueue(String queueName,
                           Map<String,Object> content,
                           Map<String,Object> parameters,
                           Map<String,Object> properties)

Description copied from interface: JMSClient

Write new message into queue

Specified by:

writeIntoQueue in interface JMSClient

Parameters:

queueName - - Name of the queue to write

content - - Message's content

parameters - - Optional message's JMS parameters. Key values are defined in MessageParameterNames

properties - - Optional JMS message properties

See Also:

MessageParameterNames