XML over HTTP Writer Output Adapter

Introduction

The XML over HTTP output adapter is suitable for posting tuples to an HTTP server. Tuples are posted as HTTP POST transactions where a parameter named tuple is set to the URL encoded version of the serialized source Tuple as XML.

Tuples may be buffered into single POST calls by setting the flushInterval parameter. The number of messages to post in any interval may be limited using the maxMessageCache size. When using maxMessageCache messages above the specified limit will not be delivered.

Properties

All of the following parameters can be defined externally in the sbd.sbconf configuration file, to make adapter configuration machine and environment specific.

Property Description Default
URL (string) The URL to HTTP post to. None
Flush Interval (optional string) How often to deliver messages to the url, in milliseconds. If set to 0, messages are delivered immediately. See next property for the case where this parameter is required. 0, write immediately
Max Message Cache (int) The maximum number of messages to queue each interval. If set to 0, unlimited messages are cached per interval. If this Max Message Cache parameter is set, the Flush Interval parameter must also be set and its value must be greater than 0. 0, unlimited

Typechecking and Error Handling

URL must be a parseable URL.

If Max Message Cache is set, must be 0 or greater, and Flush Interval must be set and greater than 0.

If specified and those conditions are not met, typechecking fails.

Suspend/Resume Behavior

On suspend, all cached messages will be delivered.

On resumption, caching is restarted. The first message delivery will occur at resume time + Flush Interval.