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

Class AndesJMSClientConfiguration

java.lang.Object

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

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

AndesJMSConsumerClientConfiguration, AndesJMSPublisherClientConfiguration

public class AndesJMSClientConfiguration
extends Object
implements Cloneable

This class acts as a configuration class for the Andes Client. The class contains configuration that is common for both JMS publishers and consumer. The configuration mentioned are related to JMS only.

Constructor Summary

Constructors

Constructor and Description
AndesJMSClientConfiguration() The empty constructor which will create a queue related test case.
AndesJMSClientConfiguration(AndesJMSClientConfiguration config) Copy constructor for the client.
AndesJMSClientConfiguration(ExchangeType exchangeType, String destinationName) Creates a connection string with the default username, password, hostname, port.
AndesJMSClientConfiguration(int port, ExchangeType exchangeType, String destinationName) Creates a connection string with default username, password, hostname and a given port.
AndesJMSClientConfiguration(int port, String userName, String password, ExchangeType exchangeType, String destinationName) Creates a connection string with a given port, username, password, exchange type and destination name.
AndesJMSClientConfiguration(String xmlConfigFilePath) Creates a connection string using an xml file.
AndesJMSClientConfiguration(String hostName, int port, ExchangeType exchangeType, String destinationName) Creates a connection string with default username, password and a given host name, port.
AndesJMSClientConfiguration(String userName, String password, ExchangeType exchangeType, String destinationName) Creates a connection string with a given username, password, exchange type and destination name.
AndesJMSClientConfiguration(String userName, String password, String hostName, int port, ExchangeType exchangeType, String destinationName) Creates a connection string with a given username, password, hostname, port, exchange type and destination name.
AndesJMSClientConfiguration(String userName, String password, String hostName, int port, ExchangeType exchangeType, String destinationName, String sslAlias, String trustStorePath, String trustStorePassword, String keyStorePath, String keyStorePassword) Creates an SSL connection string with a given username, password, hostname, port, exchange type and destination name.

Method Summary

Modifier and Type	Method and Description
String	getConnectionString() Gets the AMQP connection string.
String	getDestinationName() Gets the destination name for publishing/consuming jms messages.
ExchangeType	getExchangeType() Gets the exchange type used for publishing/consuming jms messages.
String	getFilePathToWriteStatistics() Gets the file path to write statistics such as TPS, Average latency against Timestamp.
String	getHostName() Gets the host name used in the AMQP connection string.
String	getPassword() Gets the password used in the AMQP connection string.
int	getPort() Gets the port used in the AMQP connection string.
long	getPrintsPerMessageCount() Gets the number of console logging per message count
long	getRunningDelay() Gets the delay used in publishing/consuming messages in milliseconds.
String	getUserName() Gets the user name used in the AMQP connection string.
void	setConnectionString(String connectionString) Sets the AMQP transport connection string.
void	setDestinationName(String destinationName) Sets the destination name for publishing/consuming jms messages.
void	setExchangeType(ExchangeType exchangeType) Sets the exchange type used for publishing/consuming jms messages Suppressing "UnusedDeclaration" as this is a configuration
void	setFilePathToWriteStatistics(String filePathToPrintStatistics) Sets the file path to write statistics such as TPS, Average latency against Timestamp Suppressing "UnusedDeclaration" as this is a configuration
void	setHostName(String hostName) Sets host name for the AMQP connection string.
void	setPassword(String password) Sets password for the AMQP connection string
void	setPort(int port) Sets the AMQP connection string port.
void	setPrintsPerMessageCount(long printsPerMessageCount) Sets the number of console logging per message count
void	setRunningDelay(long runningDelay) Sets the delay used in publishing/consuming messages in milliseconds.
void	setUserName(String userName) Sets user name for the AMQP connection string
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AndesJMSClientConfiguration

public AndesJMSClientConfiguration()

The empty constructor which will create a queue related test case.

AndesJMSClientConfiguration

public AndesJMSClientConfiguration(ExchangeType exchangeType,
                                   String destinationName)

Creates a connection string with the default username, password, hostname, port. Also sets the exchange type and destination name for publishing/consuming jms messages.

Parameters:

exchangeType - The exchange type.

destinationName - The destination name.

AndesJMSClientConfiguration

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

Creates a connection string with default username, password and a given host name, port. Also sets exchangeType and destination name used for publishing/consuming jms messages.

Parameters:

hostName - The host name used in the AMQP transport connection string.

port - The port used in the AMQP transport connection string.

exchangeType - The exchange type used for publishing/consuming jms messages.

destinationName - The destination name used for publishing/consuming jms messages.

AndesJMSClientConfiguration

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

Creates a connection string with default username, password, hostname and a given port. Also sets exchangeType and destination name used for publishing/consuming jms messages.

Parameters:

port - The port used in the AMQP transport connection string.

exchangeType - The exchange type used for publishing/consuming jms messages.

destinationName - The destination name used for publishing/consuming jms messages.

AndesJMSClientConfiguration

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

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

Parameters:

userName - The username to be used in creating the connection string.

password - The password to be used in creating the connection string.

exchangeType - The exchange type.

destinationName - The destination name.

AndesJMSClientConfiguration

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

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

Parameters:

userName - The username to be used in creating the connection string.

password - The password to be used in creating the connection string.

exchangeType - The exchange type.

destinationName - The destination name.

AndesJMSClientConfiguration

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

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

Parameters:

userName - The username to be used in creating the connection string.

password - The password to be used in creating the connection string.

hostName - The host name to be used in creating the connection string.

port - The AMQP transport port used in creating the connection string

exchangeType - The exchange type.

destinationName - The destination name.

AndesJMSClientConfiguration

public AndesJMSClientConfiguration(String xmlConfigFilePath)
                            throws AndesClientConfigurationException

Creates a connection string using an xml file.

Parameters:

xmlConfigFilePath - The file path for the xml configuration file.

Throws:

AndesClientConfigurationException

AndesJMSClientConfiguration

public AndesJMSClientConfiguration(AndesJMSClientConfiguration config)

Copy constructor for the client.

Parameters:

config - The configuration file.

AndesJMSClientConfiguration

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

Creates an SSL connection string with a given username, password, hostname, port, exchange type and destination name.

Parameters:

userName - The username to be used in creating the connection string.

password - The password to be used in creating the connection string.

hostName - The host name to be used in creating the connection string.

port - The AMQP transport port used in creating 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

setUserName

public void setUserName(String userName)

Sets user name for the AMQP connection string

Parameters:

userName - The user name.

setPassword

public void setPassword(String password)

Sets password for the AMQP connection string

Parameters:

password - The password

setHostName

public void setHostName(String hostName)

Sets host name for the AMQP connection string. Suppressing "UnusedDeclaration" warning as the client can be exported and used.

Parameters:

hostName - The host name

setPort

public void setPort(int port)

Sets the AMQP connection string port.

Parameters:

port - the port.

getUserName

public String getUserName()

Gets the user name used in the AMQP connection string.

Returns:

The user name.

getPassword

public String getPassword()

Gets the password used in the AMQP connection string.

Returns:

The password.

getHostName

public String getHostName()

Gets the host name used in the AMQP connection string. Suppressing "UnusedDeclaration" warning as the client can be exported and used.

Returns:

The host name.

getPort

public int getPort()

Gets the port used in the AMQP connection string.

Returns:

The port name.

getConnectionString

public String getConnectionString()

Gets the AMQP connection string.

Returns:

The connection string.

setConnectionString

public void setConnectionString(String connectionString)

Sets the AMQP transport connection string.

Parameters:

connectionString - The connection string.

getExchangeType

public ExchangeType getExchangeType()

Gets the exchange type used for publishing/consuming jms messages.

Returns:

The exchange type

setExchangeType

public void setExchangeType(ExchangeType exchangeType)

Sets the exchange type used for publishing/consuming jms messages Suppressing "UnusedDeclaration" as this is a configuration

Parameters:

exchangeType - The exchange type

getDestinationName

public String getDestinationName()

Gets the destination name for publishing/consuming jms messages.

Returns:

The destination name.

setDestinationName

public void setDestinationName(String destinationName)

Sets the destination name for publishing/consuming jms messages.

Parameters:

destinationName - The destination name

getPrintsPerMessageCount

public long getPrintsPerMessageCount()

Gets the number of console logging per message count

Returns:

The number of console logging per message count

setPrintsPerMessageCount

public void setPrintsPerMessageCount(long printsPerMessageCount)
                              throws AndesClientConfigurationException

Sets the number of console logging per message count

Parameters:

printsPerMessageCount - The number of console logging per message count

Throws:

AndesClientConfigurationException

getRunningDelay

public long getRunningDelay()

Gets the delay used in publishing/consuming messages in milliseconds.

Returns:

the delay used in publishing/consuming messages in milliseconds.

setRunningDelay

public void setRunningDelay(long runningDelay)
                     throws AndesClientConfigurationException

Sets the delay used in publishing/consuming messages in milliseconds.

Parameters:

runningDelay - The delay used in publishing/consuming messages in milliseconds.

Throws:

AndesClientConfigurationException

getFilePathToWriteStatistics

public String getFilePathToWriteStatistics()

Gets the file path to write statistics such as TPS, Average latency against Timestamp.

Returns:

The file path used for writing statistics.

setFilePathToWriteStatistics

public void setFilePathToWriteStatistics(String filePathToPrintStatistics)

Sets the file path to write statistics such as TPS, Average latency against Timestamp Suppressing "UnusedDeclaration" as this is a configuration

Parameters:

filePathToPrintStatistics - The file path used for writing statistics.

toString

public String toString()

Overrides:

toString in class Object