org.wso2.mb.integration.common.clients.configurations

Class AndesJMSConsumerClientConfiguration

java.lang.Object

org.wso2.mb.integration.common.clients.configurations.AndesJMSClientConfiguration

org.wso2.mb.integration.common.clients.configurations.AndesJMSConsumerClientConfiguration

All Implemented Interfaces:

Cloneable

public class AndesJMSConsumerClientConfiguration
extends AndesJMSClientConfiguration

This class represents the Andes client consumer configuration. The class contains properties related to JMS message consuming.

Constructor Summary

Constructors

Constructor and Description
AndesJMSConsumerClientConfiguration() Creates a consumer configuration with default values.
AndesJMSConsumerClientConfiguration(AndesJMSClientConfiguration config) The copy constructor for the JMS base class.
AndesJMSConsumerClientConfiguration(ExchangeType exchangeType, String destinationName) Creates a consumer with a given exchange type and destination with default connection string.
AndesJMSConsumerClientConfiguration(int port, ExchangeType exchangeType, String destinationName) Creates a consumer with a given port for connection string and exchange type and destination name.
AndesJMSConsumerClientConfiguration(int port, String userName, String password, ExchangeType exchangeType, String destinationName) Creates a consumer with a given port, username, password, for connection string and exchange type and destination name.
AndesJMSConsumerClientConfiguration(String xmlConfigFilePath) Creates a configuration for a consumer using an xml file.
AndesJMSConsumerClientConfiguration(String hostName, int port, ExchangeType exchangeType, String destinationName) Creates a consumer with a given host name, port for connection string and exchange type and destination name.
AndesJMSConsumerClientConfiguration(String userName, String password, ExchangeType exchangeType, String destinationName) Creates a consumer with a given username, password, for connection string and exchange type and destination name.
AndesJMSConsumerClientConfiguration(String userName, String password, String hostName, int port, ExchangeType exchangeType, String destinationName) Creates a consumer with a given user name, password, host name, port for connection string and exchange type and destination name.
AndesJMSConsumerClientConfiguration(String userName, String password, String hostName, int port, ExchangeType exchangeType, String destinationName, String sslAlias, String trustStorePath, String trustStorePassword, String keyStorePath, String keyStorePassword) Creates a JMS message consumer with a given AMQP transport connection string for SSL and a given exchange type and destination.

Method Summary

Modifier and Type	Method and Description
void	addReceivedMessage(String receivedMessages) Adding the message content to the received messages list, after receiving the message, for this consumer.
AndesJMSConsumerClientConfiguration	clone()
long	getAcknowledgeAfterEachMessageCount() Gets the message count at which a message should be acknowledged after.
JMSAcknowledgeMode	getAcknowledgeMode() Gets acknowledge mode for messages.
long	getCommitAfterEachMessageCount() Gets the message count at which the session should be committed.
String	getFilePathToWriteReceivedMessages() Gets the file path where the received messages should be written to,
long	getMaximumMessagesToReceived() Gets the maximum number of messages to received.
List<String>	getReceivedMessages() This method returns received messages for this consumer.
long	getRecoverAfterEachMessageCount() Gets the message count at which the session should be recovered.
long	getRollbackAfterEachMessageCount() Gets the message count at which the session should be rolled-back.
String	getSelectors() Gets the selectors query used by the consumer for filtering.
String	getSubscriptionID() Gets the subscription ID.
long	getUnSubscribeAfterEachMessageCount() Gets the message count to un-subscribe the consumer.
boolean	isAsync() Checks whether consumer is asynchronously reading messages.
boolean	isDurable() Checks whether the subscriber/consumer is durable.
void	setAcknowledgeAfterEachMessageCount(long acknowledgeAfterEachMessageCount) Sets the message count at which a message should be acknowledged after.
void	setAcknowledgeMode(JMSAcknowledgeMode acknowledgeMode) Sets acknowledge mode for messages.
void	setAsync(boolean async) Sets the consumer to read message asynchronously.
void	setCommitAfterEachMessageCount(long commitAfterEachMessageCount) Sets the message count at which the session should be committed.
void	setDurable(boolean durable, String subscriptionID) Sets values for a durable subscription
void	setFilePathToWriteReceivedMessages(String filePathToWriteReceivedMessages) Sets the file path where the received messages should be written to,
void	setMaximumMessagesToReceived(long maximumMessagesToReceived) Sets the maximum number of messages to received.
void	setRecoverAfterEachMessageCount(long recoverAfterEachMessageCount) Sets message count at which the session should be recovered.
void	setRollbackAfterEachMessageCount(long rollbackAfterEachMessageCount) Sets message count at which the session should be rolled-back.
void	setSelectors(String selectors) Sets the selectors query used by the consumer for filtering.
void	setSubscriptionID(String subscriptionID) Sets the subscription ID
void	setUnSubscribeAfterEachMessageCount(long unSubscribeAfterEachMessageCount) Sets message count to un-subscribe the consumer.
String	toString()

Methods inherited from class org.wso2.mb.integration.common.clients.configurations.AndesJMSClientConfiguration

getConnectionString, getDestinationName, getExchangeType, getFilePathToWriteStatistics, getHostName, getPassword, getPort, getPrintsPerMessageCount, getRunningDelay, getUserName, setConnectionString, setDestinationName, setExchangeType, setFilePathToWriteStatistics, setHostName, setPassword, setPort, setPrintsPerMessageCount, setRunningDelay, setUserName

Methods inherited from class java.lang.Object

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

Constructor Detail

AndesJMSConsumerClientConfiguration

public AndesJMSConsumerClientConfiguration()

Creates a consumer configuration with default values.

AndesJMSConsumerClientConfiguration

public AndesJMSConsumerClientConfiguration(ExchangeType exchangeType,
                                           String destinationName)

Creates a consumer with a given exchange type and destination with default connection string.

Parameters:

exchangeType - The exchange type.

destinationName - The destination name.

AndesJMSConsumerClientConfiguration

public AndesJMSConsumerClientConfiguration(String hostName,
                                           int port,
                                           ExchangeType exchangeType,
                                           String destinationName)

Creates a consumer with a given host name, port for connection string and exchange type and destination name.

Parameters:

hostName - The host name for connection string.

port - The port for the connection string.

exchangeType - The exchange type.

destinationName - The destination name.

AndesJMSConsumerClientConfiguration

public AndesJMSConsumerClientConfiguration(int port,
                                           ExchangeType exchangeType,
                                           String destinationName)

Creates a consumer with a given port for connection string and exchange type and destination name.

Parameters:

port - The port for the connection string.

exchangeType - The exchange type.

destinationName - The destination name.

AndesJMSConsumerClientConfiguration

public AndesJMSConsumerClientConfiguration(String userName,
                                           String password,
                                           ExchangeType exchangeType,
                                           String destinationName)

Creates a consumer with a given username, password, for connection string and exchange type and destination name.

Parameters:

userName - The user name for the connection string.

password - The password for the connection string.

exchangeType - The exchange type.

destinationName - The destination name.

AndesJMSConsumerClientConfiguration

public AndesJMSConsumerClientConfiguration(int port,
                                           String userName,
                                           String password,
                                           ExchangeType exchangeType,
                                           String destinationName)

Creates a consumer with a given port, username, password, for connection string and exchange type and destination name.

Parameters:

userName - The user name for the connection string.

password - The password for the connection string.

exchangeType - The exchange type.

destinationName - The destination name.

AndesJMSConsumerClientConfiguration

public AndesJMSConsumerClientConfiguration(String userName,
                                           String password,
                                           String hostName,
                                           int port,
                                           ExchangeType exchangeType,
                                           String destinationName)

Creates a consumer with a given user name, password, host name, port for connection string and exchange type and destination name.

Parameters:

userName - The user name for the connection string.

password - The password for the connection string.

hostName - The host name for the connection string.

port - The port for the connection string.

exchangeType - The exchange type.

destinationName - The destination name.

AndesJMSConsumerClientConfiguration

public AndesJMSConsumerClientConfiguration(String xmlConfigFilePath)
                                    throws AndesClientConfigurationException

Creates a configuration for a consumer using an xml file.

Parameters:

xmlConfigFilePath - The file path for the xml configuration file path.

Throws:

AndesClientConfigurationException

AndesJMSConsumerClientConfiguration

public AndesJMSConsumerClientConfiguration(AndesJMSClientConfiguration config)

The copy constructor for the JMS base class. This will copy all attributes defined in another configuration only for the base client.

Parameters:

config - The configuration to be copied.

AndesJMSConsumerClientConfiguration

public AndesJMSConsumerClientConfiguration(String userName,
                                           String password,
                                           String hostName,
                                           int port,
                                           ExchangeType exchangeType,
                                           String destinationName,
                                           String sslAlias,
                                           String trustStorePath,
                                           String trustStorePassword,
                                           String keyStorePath,
                                           String keyStorePassword)

Creates a JMS message consumer with a given AMQP transport connection string for SSL and a given exchange type and destination.

Parameters:

userName - The user name for the connection string.

password - The password for the connection string.

hostName - The host name for the connection string.

port - The port for the connection string.

exchangeType - The exchange type.

destinationName - The destination name.

sslAlias - The ssl alias to use in ssl connection.

trustStorePath - The file path for trust store to use in ssl connection.

trustStorePassword - The trust store password to use in ssl connection.

keyStorePath - The file path for key store to use in ssl connection.

keyStorePassword - The key store password to use in ssl connection.

Method Detail

getUnSubscribeAfterEachMessageCount

public long getUnSubscribeAfterEachMessageCount()

Gets the message count to un-subscribe the consumer.

Returns:

The message count to un-subscribe the consumer.

setUnSubscribeAfterEachMessageCount

public void setUnSubscribeAfterEachMessageCount(long unSubscribeAfterEachMessageCount)
                                         throws AndesClientConfigurationException

Sets message count to un-subscribe the consumer.

Parameters:

unSubscribeAfterEachMessageCount - The message count to un-subscribe the consumer.

Throws:

AndesClientConfigurationException

getRollbackAfterEachMessageCount

public long getRollbackAfterEachMessageCount()

Gets the message count at which the session should be rolled-back.

Returns:

The message count at which the session should be rolled-back.

getRecoverAfterEachMessageCount

public long getRecoverAfterEachMessageCount()

Gets the message count at which the session should be recovered.

Returns:

The message count at which the session should be recovered.

setRollbackAfterEachMessageCount

public void setRollbackAfterEachMessageCount(long rollbackAfterEachMessageCount)
                                      throws AndesClientConfigurationException

Sets message count at which the session should be rolled-back.

Parameters:

rollbackAfterEachMessageCount - The message count at which the session should be rolled-back.

Throws:

AndesClientConfigurationException

setRecoverAfterEachMessageCount

public void setRecoverAfterEachMessageCount(long recoverAfterEachMessageCount)
                                     throws AndesClientConfigurationException

Sets message count at which the session should be recovered.

Parameters:

recoverAfterEachMessageCount - The message count at which the session should be recovered.

Throws:

AndesClientConfigurationException - on in-applicable value passed

getCommitAfterEachMessageCount

public long getCommitAfterEachMessageCount()

Gets the message count at which the session should be committed.

Returns:

The message count at which the session should be committed.

setCommitAfterEachMessageCount

public void setCommitAfterEachMessageCount(long commitAfterEachMessageCount)
                                    throws AndesClientConfigurationException

Sets the message count at which the session should be committed.

Parameters:

commitAfterEachMessageCount - The message count at which the session should be committed.

Throws:

AndesClientConfigurationException

getAcknowledgeAfterEachMessageCount

public long getAcknowledgeAfterEachMessageCount()

Gets the message count at which a message should be acknowledged after.

Returns:

The the message count at which a message should be acknowledged after.

setAcknowledgeAfterEachMessageCount

public void setAcknowledgeAfterEachMessageCount(long acknowledgeAfterEachMessageCount)
                                         throws AndesClientConfigurationException

Sets the message count at which a message should be acknowledged after.

Parameters:

acknowledgeAfterEachMessageCount - The the message count at which a message should be acknowledged after.

Throws:

AndesClientConfigurationException

getFilePathToWriteReceivedMessages

public String getFilePathToWriteReceivedMessages()

Gets the file path where the received messages should be written to,

Returns:

The file path where the received messages should be written to,

setFilePathToWriteReceivedMessages

public void setFilePathToWriteReceivedMessages(String filePathToWriteReceivedMessages)

Sets the file path where the received messages should be written to,

Parameters:

filePathToWriteReceivedMessages - The file path where the received messages should be written to,

getMaximumMessagesToReceived

public long getMaximumMessagesToReceived()

Gets the maximum number of messages to received.

Returns:

The maximum number of messages to received.

setMaximumMessagesToReceived

public void setMaximumMessagesToReceived(long maximumMessagesToReceived)
                                  throws AndesClientConfigurationException

Sets the maximum number of messages to received.

Parameters:

maximumMessagesToReceived - The maximum number of messages to received.

Throws:

AndesClientConfigurationException

getSubscriptionID

public String getSubscriptionID()

Gets the subscription ID.

Returns:

The subscription ID.

setSubscriptionID

public void setSubscriptionID(String subscriptionID)
                       throws AndesClientConfigurationException

Sets the subscription ID

Parameters:

subscriptionID - The subscription ID

Throws:

AndesClientConfigurationException

isDurable

public boolean isDurable()

Checks whether the subscriber/consumer is durable.

Returns:

true if subscriber/consumer is durable, false otherwise.

setDurable

public void setDurable(boolean durable,
                       String subscriptionID)
                throws AndesClientConfigurationException

Sets values for a durable subscription

Parameters:

durable - True if subscription is durable, false otherwise.

subscriptionID - The subscription ID.

Throws:

AndesClientConfigurationException

getAcknowledgeMode

public JMSAcknowledgeMode getAcknowledgeMode()

Gets acknowledge mode for messages.

Returns:

The acknowledge mode for messages.

setAcknowledgeMode

public void setAcknowledgeMode(JMSAcknowledgeMode acknowledgeMode)
                        throws AndesClientConfigurationException

Sets acknowledge mode for messages.

Parameters:

acknowledgeMode - The acknowledge mode for messages.

Throws:

AndesClientConfigurationException

isAsync

public boolean isAsync()

Checks whether consumer is asynchronously reading messages.

Returns:

true if messages are read asynchronously, false otherwise. Asynchronously message reading implies that it uses MessageListener to listen to receiving messages.

setAsync

public void setAsync(boolean async)

Sets the consumer to read message asynchronously. Asynchronously message reading implies that it uses MessageListener to listen to receiving messages. Suppressing "UnusedDeclaration" as this is a configuration

Parameters:

async - true if messages should be read asynchronously, false otherwise.

getSelectors

public String getSelectors()

Gets the selectors query used by the consumer for filtering.

Returns:

The selectors query used by the consumer for filtering.

setSelectors

public void setSelectors(String selectors)

Sets the selectors query used by the consumer for filtering.

Parameters:

selectors - The selectors query used by the consumer for filtering.

getReceivedMessages

public List<String> getReceivedMessages()

This method returns received messages for this consumer. This is not valid when write to files before compare message contents.

Returns:

Received message contents.

addReceivedMessage

public void addReceivedMessage(String receivedMessages)

Adding the message content to the received messages list, after receiving the message, for this consumer. This is not valid when write to files before compare message contents.

toString

public String toString()

Overrides:

toString in class AndesJMSClientConfiguration

clone

public AndesJMSConsumerClientConfiguration clone()
                                          throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException