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

Class AndesJMSPublisherClientConfiguration

java.lang.Object

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

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

All Implemented Interfaces:

Cloneable

public class AndesJMSPublisherClientConfiguration
extends AndesJMSClientConfiguration

This class represents the Andes client publisher configuration. The class contains properties related to JMS message publishing/sending.

Constructor Summary

Constructors

Constructor and Description
AndesJMSPublisherClientConfiguration() Creates a connection string with default properties.
AndesJMSPublisherClientConfiguration(AndesJMSClientConfiguration config) The copy constructor for the JMS base class.
AndesJMSPublisherClientConfiguration(ExchangeType exchangeType, String destinationName) Creates a publisher with a given exchange type and destination with default connection string.
AndesJMSPublisherClientConfiguration(int port, ExchangeType exchangeType, String destinationName) Creates a publisher with a given host name, port for connection string and exchange type and destination name.
AndesJMSPublisherClientConfiguration(int port, String userName, String password, ExchangeType exchangeType, String destinationName) Creates a publisher with a given port, username, password, for connection string and exchange type and destination name.
AndesJMSPublisherClientConfiguration(String xmlConfigFilePath) Creates a configuration for a publisher using an xml file.
AndesJMSPublisherClientConfiguration(String hostName, int port, ExchangeType exchangeType, String destinationName) Creates a publisher with a given host name, port for connection string and exchange type and destination name.
AndesJMSPublisherClientConfiguration(String userName, String password, ExchangeType exchangeType, String destinationName) Creates a publisher with a given username, password, for connection string and exchange type and destination name.
AndesJMSPublisherClientConfiguration(String userName, String password, String hostName, int port, ExchangeType exchangeType, String destinationName) Creates a publisher with a given user name, password, host name, password for connection string and exchange type and destination name.
AndesJMSPublisherClientConfiguration(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 publisher with a given AMQP transport connection string for SSL and a given exchange type and destination.

Method Summary

Modifier and Type	Method and Description
AndesJMSPublisherClientConfiguration	clone()
String	getFilePathToWritePublishedMessages() Gets the file path where published messages are written.
List<JMSHeaderProperty>	getJMSHeaderProperties()
long	getJMSMessageExpiryTime() Gets the messages expiry time.
JMSMessageType	getJMSMessageType() Gets JMS message type.
String	getJMSType() Get JMS type
String	getMessagesContentToSet() Get the message content to send
long	getNumberOfMessagesToSend() Gets the number of messages to be sent by the publisher.
String	getReadMessagesFromFilePath() Gets the file path to read a string content which would be used to as message content when publishing.
boolean	isTransactionalSession() Whether the session needs to be transactional or not.
void	setFilePathToWritePublishedMessages(String filePathToWritePublishedMessages) Sets the file path to write messages that are being published by the client.
void	setJMSHeaderProperty(String key, Object value, JMSHeaderPropertyType type) Set a header property to the messages published
void	setJMSMessageExpiryTime(long jmsMessageExpiryTime) Sets the message expiry time.
void	setJMSMessageType(JMSMessageType jmsMessageType) Sets JMS message type.
void	setJMSType(String jmsType) Set JMS Type to be set for publishing messages
void	setMessagesContentOfConfiguration(String messagesContentToSet) Set the message content to send
void	setNumberOfMessagesToSend(long numberOfMessagesToSend) Sets the number of messages to be sent by the publisher
void	setReadMessagesFromFilePath(String readMessagesFromFilePath) Sets the file path to read a string content which would be used to as message content when publishing.
void	setTransactionalSession(boolean transactionalSession) Set the session transactional.
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

AndesJMSPublisherClientConfiguration

public AndesJMSPublisherClientConfiguration()

Creates a connection string with default properties.

AndesJMSPublisherClientConfiguration

public AndesJMSPublisherClientConfiguration(ExchangeType exchangeType,
                                            String destinationName)

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

Parameters:

exchangeType - The exchange type.

destinationName - The destination name.

AndesJMSPublisherClientConfiguration

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

Creates a publisher 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.

AndesJMSPublisherClientConfiguration

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

Creates a publisher with a given host name, 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.

AndesJMSPublisherClientConfiguration

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

Creates a publisher 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.

AndesJMSPublisherClientConfiguration

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

Creates a publisher 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.

AndesJMSPublisherClientConfiguration

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

Creates a publisher with a given user name, password, host name, 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.

hostName - The host name for the connection string.

port - The port for the connection string.

exchangeType - The exchange type.

destinationName - The destination name.

AndesJMSPublisherClientConfiguration

public AndesJMSPublisherClientConfiguration(String xmlConfigFilePath)
                                     throws AndesClientConfigurationException

Creates a configuration for a publisher using an xml file.

Parameters:

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

Throws:

AndesClientConfigurationException

AndesJMSPublisherClientConfiguration

public AndesJMSPublisherClientConfiguration(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.

AndesJMSPublisherClientConfiguration

public AndesJMSPublisherClientConfiguration(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 publisher 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

getReadMessagesFromFilePath

public String getReadMessagesFromFilePath()

Gets the file path to read a string content which would be used to as message content when publishing.

Returns:

The file path.

setReadMessagesFromFilePath

public void setReadMessagesFromFilePath(String readMessagesFromFilePath)
                                 throws AndesClientConfigurationException,
                                        FileNotFoundException

Sets the file path to read a string content which would be used to as message content when publishing.

Parameters:

readMessagesFromFilePath - The file path.

Throws:

AndesClientConfigurationException

FileNotFoundException

getJMSMessageType

public JMSMessageType getJMSMessageType()

Gets JMS message type.

Returns:

JMS message type.

setJMSHeaderProperty

public void setJMSHeaderProperty(String key,
                                 Object value,
                                 JMSHeaderPropertyType type)

Set a header property to the messages published

Parameters:

key - key of the header

value - value of the header

type - type of the header (Boolean, Integer, Long etc)

setJMSType

public void setJMSType(String jmsType)

Set JMS Type to be set for publishing messages

Parameters:

jmsType - jmsType to set

getJMSType

public String getJMSType()

Get JMS type

Returns:

JMS type as a string

setJMSMessageType

public void setJMSMessageType(JMSMessageType jmsMessageType)

Sets JMS message type.

Parameters:

jmsMessageType - JMS message type

getNumberOfMessagesToSend

public long getNumberOfMessagesToSend()

Gets the number of messages to be sent by the publisher.

Returns:

The number of messages.

setNumberOfMessagesToSend

public void setNumberOfMessagesToSend(long numberOfMessagesToSend)
                               throws AndesClientConfigurationException

Sets the number of messages to be sent by the publisher

Parameters:

numberOfMessagesToSend - The number of messages.

Throws:

AndesClientConfigurationException

getFilePathToWritePublishedMessages

public String getFilePathToWritePublishedMessages()

Gets the file path where published messages are written.

Returns:

The file path.

setFilePathToWritePublishedMessages

public void setFilePathToWritePublishedMessages(String filePathToWritePublishedMessages)

Sets the file path to write messages that are being published by the client. Suppressing "UnusedDeclaration" warning as the client can be exported and used.

Parameters:

filePathToWritePublishedMessages - The file path

getJMSMessageExpiryTime

public long getJMSMessageExpiryTime()

Gets the messages expiry time.

Returns:

The message expiry time.

setJMSMessageExpiryTime

public void setJMSMessageExpiryTime(long jmsMessageExpiryTime)
                             throws AndesClientConfigurationException

Sets the message expiry time.

Parameters:

jmsMessageExpiryTime - The message expiry time.

Throws:

AndesClientConfigurationException

toString

public String toString()

Overrides:

toString in class AndesJMSClientConfiguration

clone

public AndesJMSPublisherClientConfiguration clone()
                                           throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

isTransactionalSession

public boolean isTransactionalSession()

Whether the session needs to be transactional or not.

setTransactionalSession

public void setTransactionalSession(boolean transactionalSession)

Set the session transactional. This is for publishers

Parameters:

transactionalSession - true if session needs to be transactional and false otherwise

getJMSHeaderProperties

public List<JMSHeaderProperty> getJMSHeaderProperties()

getMessagesContentToSet

public String getMessagesContentToSet()

Get the message content to send

Returns:

The message content to send

setMessagesContentOfConfiguration

public void setMessagesContentOfConfiguration(String messagesContentToSet)

Set the message content to send

Parameters:

messagesContentToSet - The message content to send