org.perfcake.message.sender

Class LdapSender

java.lang.Object

org.perfcake.message.sender.AbstractSender

org.perfcake.message.sender.LdapSender

All Implemented Interfaces:

MessageSender

public class LdapSender
extends AbstractSender

Queries LDAP server.

Author:

Vojtěch Juránek

Constructor Summary

Constructors

Constructor and Description
LdapSender()

Method Summary

Modifier and Type	Method and Description
void	doClose()
void	doInit(Properties messageAttributes)
Serializable	doSend(Message message, MeasurementUnit measurementUnit) Actually performs the send operation.
String	getFilter() Gets the LDAP filter.
String	getLdapPassword() Gets the LDAP password.
String	getLdapUsername() Gets the LDAP username.
String	getSearchBase() Gets the LDAP search base.
void	preSend(Message message, Properties messageAttributes) Performs any action that needs to be done to send the message but is not directly related to the sending operation and thus not measured.
LdapSender	setFilter(String filter) Sets the LDAP filter.
LdapSender	setLdapPassword(String ldapPassword) Sets the LDAP password.
LdapSender	setLdapUsername(String ldapUsername) Sets the LDAP username.
LdapSender	setSearchBase(String searchBase) Sets the LDAP search base.

Methods inherited from class org.perfcake.message.sender.AbstractSender

close, getTarget, getTarget, init, isKeepConnection, postSend, safeGetTarget, send, setKeepConnection, setTarget

Methods inherited from class java.lang.Object

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

Constructor Detail

LdapSender

public LdapSender()

Method Detail

getLdapUsername

public String getLdapUsername()

Gets the LDAP username.

Returns:

The LDAP username.

setLdapUsername

public LdapSender setLdapUsername(String ldapUsername)

Sets the LDAP username.

Parameters:

ldapUsername - The LDAP username.

Returns:

Instance of this to support fluent API.

getLdapPassword

public String getLdapPassword()

Gets the LDAP password.

Returns:

The LDAP password.

setLdapPassword

public LdapSender setLdapPassword(String ldapPassword)

Sets the LDAP password.

Parameters:

ldapPassword - The LDAP password.

Returns:

Instance of this to support fluent API.

getSearchBase

public String getSearchBase()

Gets the LDAP search base.

Returns:

The LDAP search base.

setSearchBase

public LdapSender setSearchBase(String searchBase)

Sets the LDAP search base.

Parameters:

searchBase - The LDAP search base.

Returns:

Instance of this to support fluent API.

getFilter

public String getFilter()

Gets the LDAP filter.

Returns:

The LDAP filter.

setFilter

public LdapSender setFilter(String filter)

Sets the LDAP filter.

Parameters:

filter - The LDAP filter.

Returns:

Instance of this to support fluent API.

doInit

public void doInit(Properties messageAttributes)
            throws PerfCakeException

Specified by:

doInit in class AbstractSender

Throws:

PerfCakeException

doClose

public void doClose()
             throws PerfCakeException

Specified by:

doClose in class AbstractSender

Throws:

PerfCakeException

preSend

public void preSend(Message message,
                    Properties messageAttributes)
             throws Exception

Description copied from interface: MessageSender

Performs any action that needs to be done to send the message but is not directly related to the sending operation and thus not measured.

Specified by:

preSend in interface MessageSender

Overrides:

preSend in class AbstractSender

Parameters:

message - Message to be sent.

messageAttributes - Attributes that can be used to replace placeholders in message and or target.

Throws:

Exception - In case anything fails during the preparation.

doSend

public Serializable doSend(Message message,
                           MeasurementUnit measurementUnit)
                    throws Exception

Description copied from class: AbstractSender

Actually performs the send operation. Should be overridden by specific implementations.

Specified by:

doSend in class AbstractSender

Parameters:

message - Message to be sent.

measurementUnit - Measurement unit carrying the current stop-watch.

Returns:

Response to the message.

Throws:

Exception - When the sending operation failed.

See Also:

MessageSender.send(org.perfcake.message.Message, org.perfcake.reporting.MeasurementUnit)