net.relaysoft.robot.jms.client

Interface JMSClient

All Known Implementing Classes:

AbstractJMS11Client, AbstractJMS20Client, AbstractJMSClient, ActiveMQ11Client, DefaultJMS11Client, DefaultJMS20Client, IBMMQ11Client, IBMMQ20Client

public interface JMSClient

JMS client for controlling operations against message queue provider.

Author:

relaysoft.net

Method Summary

Modifier and Type	Method and Description
void	clearMessages() Clear all read messages from client's storage.
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 topicName) Deletes temporary topic.
String	getClientID()
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.
MessageTypeEnum	resolveMessageType(String messageID) Resolve JMS message's type.
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

Method Detail

clearMessages

void clearMessages()

Clear all read messages from client's storage.

closeConnection

void closeConnection()
              throws javax.jms.JMSException

Permanently closes JMS client connection.

Throws:

javax.jms.JMSException - If closing of connection fails

createTemporaryQueue

String createTemporaryQueue()
                     throws javax.jms.JMSException

Create new temporary queue.

Returns:

Created temporary queue's name.

Throws:

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

createTemporaryTopic

String createTemporaryTopic()
                     throws javax.jms.JMSException

Create new temporary topic.

Returns:

Created temporary topic's name

Throws:

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

deleteTemporaryQueue

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

Deletes temporary queue.

Parameters:

queueName - - Temporary queue name

Throws:

javax.jms.JMSException - If deletion fails.

deleteTemporaryTopic

void deleteTemporaryTopic(String topicName)
                   throws javax.jms.JMSException

Deletes temporary topic.

Parameters:

topicName - - Temporary topic name

Throws:

javax.jms.JMSException - If deletion fails.

getClientID

String getClientID()

Returns:

Client's unique ID

getMessageByteContent

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

Return byte message's byte content.

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

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

Return map message's map content.

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

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

Return message's correlation ID

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

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

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

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

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

Return message's expiration time in milliseconds.

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

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

Return message's unique ID.

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

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

Return message's priority value from 1-9.

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

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

Return message property value

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

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

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

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

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

Return text message's string content.

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

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

Return message's latest timestamp.

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

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

Return message's JMS type.

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

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

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

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

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

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.

Parameters:

parameters - - Parameters for client initialization.

Throws:

Exception - If initializing the client fails for any reason.

openConnection

void openConnection()
             throws javax.jms.JMSException

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

Throws:

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

openConnection

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

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

Parameters:

userName - - User name used for connection authentication

password - - Password used for connection authentication

Throws:

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

peekFromQueue

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

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

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

void publishIntoTopic(String topicName,
                      String content,
                      Map<String,Object> parameters,
                      Map<String,Object> properties)
               throws javax.jms.JMSException

Publish new message into topic.

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

Throws:

javax.jms.JMSException - If message creation or publish it into topic fails.

See Also:

MessageParameterNames

publishIntoTopic

void publishIntoTopic(String topicName,
                      byte[] content,
                      Map<String,Object> parameters,
                      Map<String,Object> properties)
               throws javax.jms.JMSException

Publish new message into topic.

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

Throws:

javax.jms.JMSException - If message creation or publish it into topic fails.

See Also:

MessageParameterNames

publishIntoTopic

void publishIntoTopic(String topicName,
                      Map<String,Object> content,
                      Map<String,Object> parameters,
                      Map<String,Object> properties)
               throws javax.jms.JMSException

Publish new message into topic.

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

Throws:

javax.jms.JMSException - If message creation or publish it into topic fails.

See Also:

MessageParameterNames

purgeQueue

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

Remove all messages from specified queue.

Parameters:

queueName - - Name of the queue to purge from messages

Throws:

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

readFromQueue

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

Read single message from the queue.

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

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

Read single message from the topic.

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.

resolveMessageType

MessageTypeEnum resolveMessageType(String messageID)

Resolve JMS message's type. TEXT, BYTE or MAP.

Parameters:

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

Returns:

JMS message's type.

subscribeTopic

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

Make new durable subscription into topic.

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

void unsubscribeTopic(String name)
               throws javax.jms.JMSException

Cancel made durable subscription for the topic.

Parameters:

name - - Unique subscription name to cancel

Throws:

javax.jms.JMSException - If canceling the subscription fails.

writeIntoQueue

void writeIntoQueue(String queueName,
                    String content,
                    Map<String,Object> parameters,
                    Map<String,Object> properties)
             throws javax.jms.JMSException

Write new message into queue

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

Throws:

javax.jms.JMSException - If message creation or write it into queue fails.

See Also:

MessageParameterNames

writeIntoQueue

void writeIntoQueue(String queueName,
                    byte[] content,
                    Map<String,Object> parameters,
                    Map<String,Object> properties)
             throws javax.jms.JMSException

Write new message into queue

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

Throws:

javax.jms.JMSException - If message creation or write it into queue fails.

See Also:

MessageParameterNames

writeIntoQueue

void writeIntoQueue(String queueName,
                    Map<String,Object> content,
                    Map<String,Object> parameters,
                    Map<String,Object> properties)
             throws javax.jms.JMSException

Write new message into queue

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

Throws:

javax.jms.JMSException - If message creation or write it into queue fails.

See Also:

MessageParameterNames