The CamelSender can be used to send messages to any Apache Camel endpoint. The endpoint is defined in the target attribute in the configuration. Any Camel endpoints are allowed. Just make sure the corresponding Camel component JAR file and its dependencies are on the classpath. In the binary distribution, this means putting the JAR files in the lib/ext directory.

Endpoints can be usually configured by using message headers. To set the headers use the header element of the particular message element in the messages section of the scenario definition.

There are no extra configuration properties for CamelSender.

  1    <sender class="CamelSender">
  2       <target>http:127.0.0.1:8283/perfcake?param1=value1</target>
  3    </sender>
  4    ...
  5    <messages>
  6       <message content="Hello from Camel">
  7          <header name="CamelHttpMethod" value="POST" />
  8       </message>
  9    </messages>

The sender can be used to send a single message using CoAP protocol ^[6] .

The target of the sender is a CoAP endpoint in a form of CoAP URI ^[7] .

  1    <sender class="CoapSender">
  2       <target>coap://${server.host}:5683/resource</target>
  3       <property name="method" value="GET"/>
  4       <property name="requestType" value="confirmable"/>
  5    </sender>

The sender is able to invoke an external command (specified by the target property) in a separate process to send a message payload. The payload can be passed to the standard input of the process (default behavior) or as the command argument. That is configurable via messageFrom proerty.

The target of the sender is a path to the file containing the commands that are to be executed.

Message properties and headers are passed to the process as the environmental variables.

  1    <sender class="CommandSender">
  2       <target>/tmp/script.sh</target>
  3    </sender>
  4    ...
  5    <messages>
  6       <message>
  7          <property name="GREETINGS" value="Be well!"/>
  8       </message>
  9    </messages>

This sender is intended to work as a dummy sender and to be used for testing scenarios and developing purposes. It does not actually send any message. It can simulate a synchronous waiting for a reply by setting the delay property.

While the target of the sender is mandatory for all senders, it is irrelevant for the DummySender so it can be anything.

  1    <sender class="DummySender">
  2       <target>out there!</target>
  3       <property name="delay" value="500"/>
  4    </sender>

Groovy sender can be used to implement the message sending in a Groovy script. By default the sender uses the groovy installed on the system, where the PerfCake is executed. PerfCake would try to find it at the following path: $GROOVY_HOME/bin/groovy on UNIX systems or %GROOVY_HOME%\bin\groovy in case of Windows, where GROOVY_HOME is an environment variable.

The Groovy binary doesn't have to be the one, that is installed on the system. There is a possibility to use groovyExecutable property to specify, what Groovy binaries would be used to execute the target script.

The message configured in the scenario is passed to the Groovy script through standard input, so it can be accessed via System.in . The response is supposed to be passed back through a standard output via System.out .

The target of the sender is a path or URL to the Groovy script that is to be executed.

The following table describes all the GroovySender's properties.

  1    <sender class="GroovySender">
  2       <target>/tmp/script.groovy"</target>
  3       <property name="classpath" value="~/common-classes"/>
  4    </sender>

The HttpSender can be used to send messages via HTTP protocol using POST method as default to the URL specified by the 'target' property. The HTTP method can be changed using the method property.

Various scenarios can lead to different HTTP response codes that are expected. The scenario can be set to expect one or more response codes. It can be set via the expectedResponseCodes property. Default expected response code is 200.

To set headers of the HTTP request use the header element of the particular message element in the messages section of the scenario definition.

The Content-Type header is set automatically by the sender for all messages to the value of text/plain; charset=utf-8 by default. Also Content-Length header is generated and set automatically to the value of message payload size if the payload is not empty.

The target of the sender is an URL, where the message is send.

Following table shows the properties of the HttpSender:

  1    <sender class="HttpSender">
  2       <target>http://domain.com/cool-url</target>
  3       <property name="method" value="GET"/>
  4       <property name="expectedResponseCodes" value="200,202"/>
  5    </sender>

HttpsSender is similar to the HttpSender (see Section 4.2.6, “HttpSender” ), thus it inherits the same properties. The difference is that the HttpsSender uses HTTPS instead of plain HTTP protocol to send messages.

The HttpsSender's properties are described in the following table:

  1    <sender class="HttpsSender">
  2       <target>https://domain.com/secured_url</target>
  3       <property name="method" value="POST"/>
  4       <property name="trustStore" value="${my.keystores}/cacert.jks"/>
  5       <property name="trustStorePassword" value="ts_passsword"/>
  6    </sender>

Sends messages through NIO ^[8] DatagramChannel ^[9] .

The sender's target is an URL of a datagram socket in a form of <host>:<port>.

Sends messages through NIO ^[8] FileChannel ^[10] .

The sender's target is a path to the file to which message is sent (written) or received (read).

Sends messages through NIO ^[8]> SocketChannel ^[11] .

The sender's target is an URL of a socket in a form of<host>:<port>.

As the name of the sender clues JdbcSender is meant to be used to send JDBC queries. It can handle any query the JDBC is capable of.

The target of the sender is a JDBC URL of the target, where the query is send.

  1    <sender class="JdbcSender">
  2       <target>jdbc:postgresql://localhost:5432/db</target>
  3       <property name="username" value="me-the-first"/>
  4       <property name="password" value="guess_me"/>
  5       <property name="driverClass" value="org.postgresql.Driver"/>
  6    </sender>

There are two versions of JMS (Java Message Service) sender. An older one supporting JMS API 1.1 - Jms11Sender (introduced in PerfCake 7.0, previously known as JmsSender). And a new one supporting JMS API 2.0 - JmsSender (new in PerfCake 7.0). Except for the API version they use, there is no difference in their functionality and properties. They should also have the same performance, depending on the client driver used.

The Jms[11]Sender can be used to send a single JMS message.

The target of the sender is a JNDI name of the JMS destination where the JMS message is send. Both JNDI and messaging can be secured independently.

For the sender to work properly, you need to have a JMS client adaptor on the class path. In PerfCake, this means placing the messaging client driver to the lib/ext directory.

The following table describes the JmsSender's properties:

  1    <sender class="JmsSender">
  2       <target>jms/queue/YourQueue</target>
  3       <property name="connectionFactory" value="jms/ConnFactory"/>
  4       <property name="username" value="KingRoland"/>
  5       <property name="password" value="12345"/>
  6       <!-- JNDI properties-->
  7       <property name="jndiContextFactory" value="pkg.InitCtxFactory"/>
  8       <property name="jndiUrl" value="remote://${server.host}:4447"/>
  9       <property name="jndiSecurityPrincipal" value="KingRoland"/>
 10       <property name="jndiSecurityCredentials" value="12345"/>
 11    </sender>

The sender is able to query an LDAP server ^[12] .

The target of the sender is an URL of the LDAP server in the form of ldap://<server-host>:<server-port> .

Following table shows the properties of the HttpSender:

  1    <sender class="LdapSender">
  2       <target>ldap://localhost:389</target>
  3       <property name="searchBase" value="dc=example,dc=org"/>
  4       <property name="filter" value="(objectclass=*)"/>
  5    </sender>

The sender is capable to send MQTT ^[13] messages to a remote broker and receiving responses if needed. The response is expected only if responseTarget property is set.

The target of the sender is an URL of the remote broker with the topic name in a form of <protocol>://<host>:<port>/<topic name> , where the message is send.

Following table shows the properties of the MqttSender:

  1    <sender class="MqttSender">
  2       <target>tcp://localhost:1883/request.topic</target>
  3       <property name="responseTarget" value="response.topic"/>
  4    </sender>

OauthHttpSender is similar to the HttpSender (see Section 4.2.6, “HttpSender” ), thus it inherits the same properties. The difference is that the OauthHttpSender allows token authentication to an HTTP based service using OAuth2^[14] protocol.

The OauthHttpSender's properties are described in the following table, where the defaults works with Keycloak:^[15]:

  1    <sender class="OauthHttpSender">
  2       <target>http://domain.com/secured_url</target>
  3       <property name="method" value="POST"/>
  4       <property name="tokenServerUrl" value="http://127.0.0.1:8180/auth/realms/demo/protocol/openid-connect/token"/>
  5       <property name="tokenServerData" value="grant_type=password&amp;client_id=jboss-javaee-webapp&amp;username=marvec&amp;password=abc123"/>
  6       <property name="responseParser" value=".*&quot;access_token&quot;:&quot;([^&quot;]*)&quot;.*"/>
  7       <property name="oauthHeader" value="Authorization"/>
  8       <property name="oauthHeaderFormat" value="Bearer %s"/>
  9       <property name="tokenTimeout" value="60000"/>
 10    </sender>

The sender uses a socket to send the message to and receive a response from.

The target of the sender is a socket in a form of "<host>:<port>"

  1    <sender class="PlainSocketSender">
  2       <target>127.0.0.1:12345</target>
  3    </sender>

Similarily to JmsSender, there are two variants of this sender for both JMS API 1.1 (RequestResponseJms11Sender, new in PerfCake 7.0, formerly known as RequestResponseJmsSender) and 2.0 (RequestResponseJmsSender, new in PerfCake 7.0).

The RequestResponse[11]JmsSender is supposed to be used in request-response scenarios. First it sends a JMS message to the target destination (specified by the target property) and then waits to receive the response message from the response destination (specified by the responseTarget property).

It is based on Jms[11]Sender (see Section 4.2.12, “Jms[11]Sender” ) and inherits all its configuration properties. Some properties, when not specified, use the same value as those present in Jms[11]Sender. However, security credentials always need to be set separately. The following table contains additional properties of the RequestResponseJms[11]Sender:

  1    <sender class="RequestResponseJmsSender">
  2       <target>jms/queue/RequestQueue</target>
  3       <property name="responseTarget" value="jms/queue/ResponseQueue"/>
  4       <property name="receivingTimeout" value="30000"/>
  5       <property name="receiveAttempts" value="1"/>
  6       <property name="connectionFactory" value="jms/ConnFactory"/>
  7       <property name="username" value="KingRoland"/>
  8       <property name="password" value="12345"/>
  9       <property name="responseUsername" value="KingRoland"/>
 10       <property name="responsePassword" value="12345"/>
 11       <!-- JNDI properties-->
 12       <property name="jndiContextFactory" value="pkg.InitCtxFactory"/>
 13       <property name="jndiUrl" value="remote://${server.host}:4447"/>
 14       <property name="jndiSecurityPrincipal" value="KingRoland"/>
 15       <property name="jndiSecurityCredentials" value="12345"/>
 16       <property name="responseJndiSecurityPrincipal" value="KingRoland"/>
 17       <property name="responseJndiSecurityCredentials" value="12345"/>
 18    </sender>

The sender can be used to send a single message using a JSR 223 ^[16] compliant script.

The target of the sender is a path to the file where the script is implemented. To specify the scripting language engine there is a engine property. The message and it's headers are passed to the script via script binding and should be available as variables or objects instances, according to the scripting language.

The following table shows the senders properties.

  1    <sender class="ScriptSender">
  2       <target>/tmp/script.groovy</target>
  3       <property name="engine" value="groovy"/>
  4    </sender>
  5    ...
  6    <messages>
  7       <message content="Soylent green">
  8          <header name="what" value="people"/>
  9       </message>
 10    </messages>

  1 println message.payload + " is made out of " + message.headers['what']; 

SslSocketSender is similar to the PlainSocketSender (see Section 4.2.16, “PlainSocketSender” ) and so it shares the same properties. The difference is that the SslSocketSender uses a SSL socket.

If neither keyStore or trustStore are set, the default Java SSLSocketFactory is used. Its configuration depends on system properties.

  1    <sender class="SslSocketSender">
  2       <target>127.0.0.1:12345</target>
  3    </sender>

The WebSocketSender can be used to send a simple messages via websocket protocol to a remote websocket server endpoint. The websocket technology creates a full-duplex connection over TCP and is suitable for applications requiring fast responses. It was standardized as RFC 6455 and it is a part of Java EE 7 (JSR-356). Connections are initiated by sending an HTTP upgrade header. It is event driven on both client and server sides. Load of requests is generated after the connection session is successfully established.

There are two forms of remote endpoints, which can be set - basic and async. To set content of message payload, set the message element in the messages section of the scenario definition. Payload can be set text, binary and ping. In PerfCake 5.x only text messages are supported.

The target of the sender is an URL of the remote endpoint, where the message is send.

The following table shows the properties of the WebSocketSender:

  1    <sender class="WebSocketSender">
  2       <target>ws://domain.com/ws-ctx/ws-ep</target>
  3       <property name="remoteEndpointType" value="basic"/>
  4       <property name="payloadType" value="text"/>
  5    </sender>