org.wso2.transport.jms.contract

Interface JMSClientConnector

All Known Implementing Classes:

JMSClientConnectorImpl

public interface JMSClientConnector

Allows to send outbound messages

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 message, 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.

Method Detail

send

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

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.

Parameters:

message - 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.

poll

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

Deprecated.

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

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.

Since:

Transport-JMS 6.0.49.

poll

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

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

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.

Since:

Transport-JMS 6.0.50.

createDestination

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

Create a Destination instance using a Session.

Parameters:

destinationName - Name of the destination.

Returns:

Created destination object.

Throws:

JMSConnectorException - Error when creating a Destination.

Since:

Transport-JMS 6.0.49.

createMessage

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

Create a Message instance using a Session.

Parameters:

messageType - Type of the JMS Message.

Returns:

Created JMS Message instance.

Throws:

JMSConnectorException - Error when creating a Message.

acquireSession

SessionWrapper acquireSession()
                       throws JMSConnectorException

Get a SessionWrapper instance on this particular connection factory.

Returns:

a SessionWrapper.

Throws:

JMSConnectorException - Error when acquiring a session wrapper instance.

sendTransactedMessage

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

Send a message using provided transacted session.

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.

pollTransacted

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

Deprecated.

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.

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.

Since:

Transport-JMS 6.0.49.

pollTransacted

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

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.

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.

Since:

Transport-JMS 6.0.50.

releaseSession

void releaseSession(SessionWrapper sessionWrapper)
             throws JMSConnectorException

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

Parameters:

sessionWrapper - SessionWrapper to be released.

Throws:

JMSConnectorException - error when releasing the session wrapper instance.

closeConnectionFactory

void closeConnectionFactory()
                     throws JMSConnectorException

Close the Client Connection factory resources.

Throws:

JMSConnectorException - error when closing the connection factory resources.