org.wso2.transport.jms.sender

Class JMSClientConnectorImpl

java.lang.Object

org.wso2.transport.jms.sender.JMSClientConnectorImpl

All Implemented Interfaces:

JMSClientConnector

public class JMSClientConnectorImpl
extends Object
implements JMSClientConnector

JMS sender Connector API Implementation. JMS transport sender is invoked through this API.

Constructor Summary

Constructors

Constructor and Description
JMSClientConnectorImpl(Map<String,String> propertyMap)

Method Summary

Modifier and Type	Method and Description
SessionWrapper	acquireSession() Get a SessionWrapper instance on this particular connection factory.
void	closeConnectionFactory() Close the Client Connection factory resources.
javax.jms.Destination	createDestination(String destinationName) Create a Destination instance using a Session.
javax.jms.Message	createMessage(String messageType) Create a Message instance using a Session.
javax.jms.Message	poll(String destinationName, int timeout) Deprecated.
javax.jms.Message	poll(String destinationName, int timeout, String messageSelector) Method to use to poll messages from a destination with the provided timeout.
javax.jms.Message	pollTransacted(String destinationName, int timeout, SessionWrapper sessionWrapper) Deprecated.
javax.jms.Message	pollTransacted(String destinationName, int timeout, SessionWrapper sessionWrapper, String messageSelector) Poll method for a transacted session.
void	releaseSession(SessionWrapper sessionWrapper) Release a SessionWrapper instance to the pool after completing the task.
boolean	send(javax.jms.Message jmsMessage, String destinationName) Message sending logic to send message to a backend endpoint.
boolean	sendTransactedMessage(javax.jms.Message jmsMessage, String destinationName, SessionWrapper sessionWrapper) Send a message using provided transacted session.

Methods inherited from class java.lang.Object

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

Constructor Detail

JMSClientConnectorImpl

public JMSClientConnectorImpl(Map<String,String> propertyMap)
                       throws JMSConnectorException

Throws:

JMSConnectorException

Method Detail

send

public boolean send(javax.jms.Message jmsMessage,
                    String destinationName)
             throws JMSConnectorException

Description copied from interface: JMSClientConnector

Message sending logic to send message to a backend endpoint. Additionally, this method accepts a map of parameters that is used as data to create the connection and construct the message to be send.

Specified by:

send in interface JMSClientConnector

Parameters:

jmsMessage - the carbon message used with sending the a message to backend.

destinationName - name of the queue/topic message should be sent

Returns:

return true if the sending was successful, false otherwise.

Throws:

JMSConnectorException - on error while trying to send message to backend.

sendTransactedMessage

public boolean sendTransactedMessage(javax.jms.Message jmsMessage,
                                     String destinationName,
                                     SessionWrapper sessionWrapper)
                              throws JMSConnectorException

Description copied from interface: JMSClientConnector

Send a message using provided transacted session.

Specified by:

sendTransactedMessage in interface JMSClientConnector

Parameters:

jmsMessage - JMS Message instance.

destinationName - Name of the outbound queue/topic.

sessionWrapper - SessionWrapper instance.

Returns:

return true if the sending was successful, false otherwise.

Throws:

JMSConnectorException - error when sending the transacted message.

poll

@Deprecated
public javax.jms.Message poll(String destinationName,
                                          int timeout)
                                   throws JMSConnectorException

Deprecated.

Description copied from interface: JMSClientConnector

Method to use to poll messages from a destination with the provided timeout. Polling support included for queues only.

Specified by:

poll in interface JMSClientConnector

Parameters:

destinationName - Name of the destination.

timeout - timeout value that will blocked for a message.

Returns:

Received Message from the broker (null if nothing received).

Throws:

JMSConnectorException - errors when acquiring session, polling or closing resources.

poll

public javax.jms.Message poll(String destinationName,
                              int timeout,
                              String messageSelector)
                       throws JMSConnectorException

Description copied from interface: JMSClientConnector

Method to use to poll messages from a destination with the provided timeout. Polling support included for queues only.

Specified by:

poll in interface JMSClientConnector

Parameters:

destinationName - Name of the destination.

timeout - timeout value that will blocked for a message.

messageSelector - message selector filter, set null if no message selector is used.

Returns:

Received Message from the broker (null if nothing received).

Throws:

JMSConnectorException - errors when acquiring session, polling or closing resources.

pollTransacted

@Deprecated
public javax.jms.Message pollTransacted(String destinationName,
                                                    int timeout,
                                                    SessionWrapper sessionWrapper)
                                             throws JMSConnectorException

Deprecated.

Description copied from interface: JMSClientConnector

Poll method for a transacted session. Difference of this from Poll method is that we have tp pass a SessionWrapper instance as an argument. Polling will be done on that.

Specified by:

pollTransacted in interface JMSClientConnector

Parameters:

destinationName - Name of the destination.

timeout - timeout value that will blocked for a message.

sessionWrapper - already acquired SessionWrapper instance.

Returns:

Received Message from the broker (null if nothing received).

Throws:

JMSConnectorException - errors when polling or closing resources.

pollTransacted

public javax.jms.Message pollTransacted(String destinationName,
                                        int timeout,
                                        SessionWrapper sessionWrapper,
                                        String messageSelector)
                                 throws JMSConnectorException

Description copied from interface: JMSClientConnector

Poll method for a transacted session. Difference of this from Poll method is that we have to pass a SessionWrapper instance as an argument. Polling will be done on that.

Specified by:

pollTransacted in interface JMSClientConnector

Parameters:

destinationName - Name of the destination.

timeout - timeout value that will blocked for a message.

sessionWrapper - already acquired SessionWrapper instance.

messageSelector - message selector filter, set null if no message selector is used.

Returns:

Received Message from the broker (null if nothing received).

Throws:

JMSConnectorException - errors when polling or closing resources.

createDestination

public javax.jms.Destination createDestination(String destinationName)
                                        throws JMSConnectorException

Description copied from interface: JMSClientConnector

Create a Destination instance using a Session.

Specified by:

createDestination in interface JMSClientConnector

Parameters:

destinationName - Name of the destination.

Returns:

Created destination object.

Throws:

JMSConnectorException - Error when creating a Destination.

createMessage

public javax.jms.Message createMessage(String messageType)
                                throws JMSConnectorException

Description copied from interface: JMSClientConnector

Create a Message instance using a Session.

Specified by:

createMessage in interface JMSClientConnector

Parameters:

messageType - Type of the JMS Message.

Returns:

Created JMS Message instance.

Throws:

JMSConnectorException - Error when creating a Message.

acquireSession

public SessionWrapper acquireSession()
                              throws JMSConnectorException

Description copied from interface: JMSClientConnector

Get a SessionWrapper instance on this particular connection factory.

Specified by:

acquireSession in interface JMSClientConnector

Returns:

a SessionWrapper.

Throws:

JMSConnectorException - Error when acquiring a session wrapper instance.

releaseSession

public void releaseSession(SessionWrapper sessionWrapper)
                    throws JMSConnectorException

Description copied from interface: JMSClientConnector

Release a SessionWrapper instance to the pool after completing the task.

Specified by:

releaseSession in interface JMSClientConnector

Parameters:

sessionWrapper - SessionWrapper to be released.

Throws:

JMSConnectorException - error when releasing the session wrapper instance.

closeConnectionFactory

public void closeConnectionFactory()
                            throws JMSConnectorException

Description copied from interface: JMSClientConnector

Close the Client Connection factory resources.

Specified by:

closeConnectionFactory in interface JMSClientConnector

Throws:

JMSConnectorException - error when closing the connection factory resources.