org.perfcake.message.sender

Class MessageSenderManager

java.lang.Object

org.perfcake.message.sender.MessageSenderManager

public class MessageSenderManager
extends Object

Manages concurrent friendly pool of senders.

Author:

Pavel Macík, Martin Večeřa

Constructor Summary

Constructors

Constructor and Description
MessageSenderManager()

Method Summary

Modifier and Type	Method and Description
MessageSender	acquireSender() Gets a free sender from the pool.
void	addMessageSenderProperties(Properties properties) Copies properties to message sender properties.
void	addSenderInstance(MessageSender sender) Adds MessageSender into available senders and initializes it.
int	availableSenderCount() Gets the number of available senders in the pool.
void	close() Finalizes the message sender manager and disconnects all message senders from their target.
String	getSenderClass() Gets the name of the class implementing the message sender.
int	getSenderPoolSize() Gets the size of the pool of senders.
void	init() Initializes the message sender by creating all the message sender instances.
void	releaseAllSenders() Release all senders that has been acquired previously.
void	releaseSender(MessageSender messageSender) Returns a sender that has been already used to the pool of available senders for later reuse.
void	setMessageSenderProperty(Object property, Object value) Sets a message sender property.
void	setMessageSenderProperty(String property, String value) Sets a message sender property.
void	setSenderClass(String senderClass) Sets the name of the class implementing the message sender.
void	setSenderPoolSize(int senderPoolSize) Sets the size of the pool of senders.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageSenderManager

public MessageSenderManager()

Method Detail

setMessageSenderProperty

public void setMessageSenderProperty(String property,
                                     String value)

Sets a message sender property.

Parameters:

property - Property name to be set.

value - A new property string value.

setMessageSenderProperty

public void setMessageSenderProperty(Object property,
                                     Object value)

Sets a message sender property.

Parameters:

property - Object referencing the property to be set.

value - A new property value.

addMessageSenderProperties

public void addMessageSenderProperties(Properties properties)

Copies properties to message sender properties.

Parameters:

properties - Properties to be added.

init

public void init()
          throws PerfCakeException

Initializes the message sender by creating all the message sender instances.

Throws:

PerfCakeException - When it was not possible to create the instances.

addSenderInstance

public void addSenderInstance(MessageSender sender)
                       throws PerfCakeException

Adds MessageSender into available senders and initializes it.

Parameters:

sender - Sender to be registered with this manager.

Throws:

PerfCakeException - When the initialization of the sender fails.

acquireSender

public MessageSender acquireSender()
                            throws PerfCakeException

Gets a free sender from the pool.

Returns:

A sender that is ready to send a message.

Throws:

PerfCakeException - When the pool is empty.

releaseSender

public void releaseSender(MessageSender messageSender)

Returns a sender that has been already used to the pool of available senders for later reuse.

Parameters:

messageSender - The sender to be returned to the pool.

releaseAllSenders

public void releaseAllSenders()

Release all senders that has been acquired previously.

availableSenderCount

public int availableSenderCount()

Gets the number of available senders in the pool.

Returns:

The number of available senders in the pool.

close

public void close()
           throws PerfCakeException

Finalizes the message sender manager and disconnects all message senders from their target.

Throws:

PerfCakeException - When the disconnection operation failed.

getSenderPoolSize

public int getSenderPoolSize()

Gets the size of the pool of senders.

Returns:

The size of the pool of senders.

setSenderPoolSize

public void setSenderPoolSize(int senderPoolSize)

Sets the size of the pool of senders.

Parameters:

senderPoolSize - The size of the pool of senders.

getSenderClass

public String getSenderClass()

Gets the name of the class implementing the message sender.

Returns:

The name of the class implementing the message sender.

setSenderClass

public void setSenderClass(String senderClass)

Sets the name of the class implementing the message sender.

Parameters:

senderClass - The name of the class implementing the message sender.