org.perfcake.message.sender

Class HttpSender

java.lang.Object

org.perfcake.message.sender.AbstractSender

org.perfcake.message.sender.HttpSender

All Implemented Interfaces:

MessageSender

Direct Known Subclasses:

HttpsSender, OauthHttpSender

public class HttpSender
extends AbstractSender

Sends messages via HTTP protocol.

Author:

Martin Večeřa, Pavel Macík

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpSender.Method Enumeration on available HTTP methods.

Constructor Summary

Constructors

Constructor and Description
HttpSender()

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.
HttpSender.Method	getDynamicMethod(Properties placeholders) Gets the template used to determine HTTP method dynamically.
List<Integer>	getExpectedResponseCodeList() Gets the list of expected response codes.
String	getExpectedResponseCodes() Gets the value of expectedResponseCodes property.
HttpSender.Method	getMethod() Gets the value of HTTP method.
boolean	isStoreCookies() Gets whether the sender will store cookies between requests.
void	postSend(Message message) Performs any action that needs to be done to complete the sending of the message but is not directly related to the sending operation and thus not measured.
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.
HttpSender	setDynamicMethod(String dynamicMethod) Sets the template used to determine HTTP method dynamically.
HttpSender	setExpectedResponseCodes(String expectedResponseCodes) Sets the value of expectedResponseCodes property.
HttpSender	setMethod(HttpSender.Method method) Sets the value of HTTP method.
HttpSender	setStoreCookies(boolean storeCookies) Sets whether the sender will store cookies between requests.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpSender

public HttpSender()

Method Detail

doInit

public void doInit(Properties messageAttributes)
            throws PerfCakeException

Specified by:

doInit in class AbstractSender

Throws:

PerfCakeException

doClose

public void doClose()

Specified by:

doClose in class AbstractSender

setExpectedResponseCodes

public HttpSender setExpectedResponseCodes(String expectedResponseCodes)

Sets the value of expectedResponseCodes property.

Parameters:

expectedResponseCodes - The expectedResponseCodes property to set.

Returns:

Instance of this to support fluent API.

getExpectedResponseCodeList

public List<Integer> getExpectedResponseCodeList()

Gets the list of expected response codes.

Returns:

The list of expected response codes.

getExpectedResponseCodes

public String getExpectedResponseCodes()

Gets the value of expectedResponseCodes property.

Returns:

The expectedResponseCodes.

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)

postSend

public void postSend(Message message)
              throws Exception

Description copied from interface: MessageSender

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

Specified by:

postSend in interface MessageSender

Overrides:

postSend in class AbstractSender

Parameters:

message - Message that was sent.

Throws:

Exception - In case anything fails during the finalization.

getMethod

public HttpSender.Method getMethod()

Gets the value of HTTP method.

Returns:

The HTTP method.

setMethod

public HttpSender setMethod(HttpSender.Method method)

Sets the value of HTTP method.

Parameters:

method - The HTTP method to set.

Returns:

Instance of this to support fluent API.

setDynamicMethod

public HttpSender setDynamicMethod(String dynamicMethod)

Sets the template used to determine HTTP method dynamically.

Parameters:

dynamicMethod - The string template to dynamically determine HTTP method.

Returns:

Instance of this to support fluent API.

getDynamicMethod

public HttpSender.Method getDynamicMethod(Properties placeholders)

Gets the template used to determine HTTP method dynamically.

Parameters:

placeholders - The properties to render the string template.

Returns:

The HTTP method.

isStoreCookies

public boolean isStoreCookies()

Gets whether the sender will store cookies between requests.

Returns:

If and only if the cookies will be stored between requests.

setStoreCookies

public HttpSender setStoreCookies(boolean storeCookies)

Sets whether the sender will store cookies between requests.

Parameters:

storeCookies - True if and only if the cookies should be stored between requests.

Returns:

Instance of this to support fluent API.