Description

The RESTDirectoryReceiver traverses one or more payload subdirectory and for each file found it creates request headers and payload, passes generated data to the given target and upon receiving a response, stores the response payload to a file. This Receiver requires an XML configuration file to read request URL and header metadata in order to create request headers. 


Receiver Parameters

The following parameters can be defined for the RESTDirectoryReceiver. Items with an asterisk (*) are required. 

  • payloadFilesPath* - Defines the base location of the files to send. 
  • payloadFilesSubDir* - Defines the naming convention for subdirectories within the payloadFilesPath.
  • configFilePath* - Defines the location of the configuration file.
  • configFileName* - Defines the name of the configuration file.
  • responseOutput* - Defines if an output response file should be produced and if so, how it should be produced.
  • responseFilePath - Defines the location where the response file will be saved.
  • responseFileName - Defines the name of the Response file.
  • requestContentType*- Defines the HTTP content type for the request:
    • ANY, TEXT, JSON, XML, HTML, BINARY
  • responseContentType*- Defines the HTTP content type for the response:
    • ANY, TEXT, JSON, XML, HTML, BINARY  
  • logRequestCount* - Defines the number of requests that are executed before logging a message to the console.
  • threadCount* - Defines the number of requests that may be sent simultaneously.


Configuration File

The RealtimeTestReceiver must read from a configuration file to attain the request URL and other request header information.


The format of the configuration file is as follows:


<config>   
  <requestURL>https://someurl</requestURL>
  <headers>
    <header type="constant" name="Accept-Encoding">compress, gzip</header>
    <header type="timestamp" format="yyyyMMdd" name="Accept-Datetime"></header>
    <header type="UUID" name="If-Match"></header>
  </headers>
</config>


Receiver Attributes Property Keys

The Receiver defines only one property key that can be modified on any of its associated Domain Attributes:

  • aliasName - Enables the user to define a different name for the Attribute. 
  • body - Defines if the value of the Attribute should be automatically added to the body: true/false.
  • header - Defines if the value of the Attribute will be automatically added to the request header: false/true.
  • xmlStyle - Whether the Attribute should be element or attribute in xml.