net.relaysoft.robot.jms.client

Class AbstractJMSClient

java.lang.Object

net.relaysoft.robot.jms.client.AbstractJMSClient

All Implemented Interfaces:

JMSClient

Direct Known Subclasses:

AbstractJMS11Client, AbstractJMS20Client

public abstract class AbstractJMSClient
extends Object
implements JMSClient

Abstract base implementation of JMS client wrapper interface.

Author:

relaysoft.net

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CONNECTION_FACTORY_NAME
protected javax.jms.ConnectionFactory	factory
protected static String	INVALID_MESSAGE_EXCEPTION
protected Map<String,javax.jms.Destination>	temporaryDestinations

Constructor Summary

Constructors

Constructor and Description
AbstractJMSClient(String clientID) Create new abstract JMS client instance.

Method Summary

Modifier and Type	Method and Description
protected String	addMessage(javax.jms.Message message) Add JMS message instance into client's internal storage.
void	clearMessages() Clear all read messages from client's storage.
void	closeConnection() Permanently closes JMS client connection.
protected abstract javax.jms.ConnectionFactory	createConnectionFactory(Map<String,Object> parameters) Create new JMS provider specific connection factory instance.
String	getClientID()
protected javax.jms.Message	getMessage(String messageID) Get read message by this client instance.
protected boolean	isConnected()
void	openConnection() Open new connection into MQ provider/broker.
protected MessageTypeEnum	resolveMessageType(javax.jms.Message message) Resolves JMS message's type.
MessageTypeEnum	resolveMessageType(String messageID) Resolve JMS message's type.

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

createTemporaryQueue, createTemporaryTopic, deleteTemporaryQueue, deleteTemporaryTopic, getMessageByteContent, getMessageCorrelationID, getMessageDestinationName, getMessageExpirationTime, getMessageID, getMessageMapContent, getMessagePriority, getMessageProperty, getMessageReplyToQueue, getMessageTextContent, getMessageTimestamp, getMessageType, getQueueDepth, initializeClient, openConnection, peekFromQueue, publishIntoTopic, publishIntoTopic, publishIntoTopic, purgeQueue, readFromQueue, readFromTopic, subscribeTopic, unsubscribeTopic, writeIntoQueue, writeIntoQueue, writeIntoQueue

Field Detail

CONNECTION_FACTORY_NAME

protected static final String CONNECTION_FACTORY_NAME

See Also:

Constant Field Values

INVALID_MESSAGE_EXCEPTION

protected static final String INVALID_MESSAGE_EXCEPTION

See Also:

Constant Field Values

factory

protected javax.jms.ConnectionFactory factory

temporaryDestinations

protected Map<String,javax.jms.Destination> temporaryDestinations

Constructor Detail

AbstractJMSClient

public AbstractJMSClient(String clientID)

Create new abstract JMS client instance.

Parameters:

clientID - - Unique client ID

Method Detail

createConnectionFactory

protected abstract javax.jms.ConnectionFactory createConnectionFactory(Map<String,Object> parameters)
                                                                throws Exception

Create new JMS provider specific connection factory instance.

Parameters:

parameters - - Parameters used for connection factory creation.

Returns:

New connection factory instance.

Throws:

Exception - If connection factory creation fails.

clearMessages

public void clearMessages()

Description copied from interface: JMSClient

Clear all read messages from client's storage.

Specified by:

clearMessages in interface JMSClient

closeConnection

public void closeConnection()
                     throws javax.jms.JMSException

Description copied from interface: JMSClient

Permanently closes JMS client connection.

Specified by:

closeConnection in interface JMSClient

Throws:

javax.jms.JMSException - If closing of connection fails

getClientID

public String getClientID()

Specified by:

getClientID in interface JMSClient

Returns:

Client's unique ID

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

Throws:

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

resolveMessageType

public MessageTypeEnum resolveMessageType(String messageID)

Description copied from interface: JMSClient

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

Specified by:

resolveMessageType in interface JMSClient

Parameters:

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

Returns:

JMS message's type.

addMessage

protected String addMessage(javax.jms.Message message)
                     throws javax.jms.JMSException

Add JMS message instance into client's internal storage.

Parameters:

message - - Message to add

Returns:

Message's ID.

Throws:

javax.jms.JMSException - If resolving message's ID fails.

getMessage

protected javax.jms.Message getMessage(String messageID)

Get read message by this client instance.

Parameters:

messageID - - JMS message ID. If null or given message ID is not read by this client, latest read message is returned.

Returns:

JMS message or null if client has not read any messages

isConnected

protected boolean isConnected()

Returns:

true if client wrapper is connected to MQ provider.

resolveMessageType

protected MessageTypeEnum resolveMessageType(javax.jms.Message message)

Resolves JMS message's type.

Parameters:

message - - Message to check

Returns:

TEXT for text message, BYTE for bytes message and MAP for map message. In any other case return null.