Specifying header fields in the HTTP adapter

This section explains how to specify header fields needed for an HTTP request using the HTTP adapter.

The header fields are specified in the < http-connection-properties> element of the HTTP adapter request. The header fields are set in the request header of the HTTP request. The <include-expect-header-in-request> element is used to specify whether to use the expect header in the adapter request. 

Note

The <user-name> and <password> elements are not set in the HTTP request header. They are used for basic authentication only.


The following figure shows an XML sample of the HTTP adapter request with the header fields.

XML sample of the HTTP adapter request with header fields

<httpadapterRequest>
    <action>http://www.someURL.com</action>
    <use-ssl-certificate></use-ssl-certificate>
    <install-certificate></install-certificate>
    <allow-unsigned-certificate></allow-unsigned-certificate>
    <passphrase></passphrase>
    <data-format>XHTML</data-format>
    <http-connection-properties>
            <user-name></user-name>
            <password></password>
            <Content-Type>text/html</Content-Type>
            <Connection>close</Connection>
            <include-expect-header-in-request>true</include-expect-header-in-request>
    </http-connection-properties>
</httpadapterRequest>


The following table describes the format of the HTTP adapter response based on the values provided in the <data-format> and <Content-Type> elements of the HTTP adapter request.

< data-format > < Content-Type > Perform JTidy on HTTP response Perform post processing Returned response is a well formed XML or XHTMLYes (Success) Returned response is a well formed XML or XHTMLNo (Failure)
HTML TEXT or HTML, or */XML Not applicable Not applicable Not applicable Not applicable HTTP response is added as TEXT to the <message-body> element.
XHTML TEXT or HTML Yes Tags are eliminated (if present) The response is added as a child of the <message-body> element in the HTTP adapter response. The response is added as TEXT to the <non-xml-data-response> element. The <non-xml-data-response> element is added as a child of the <message-body> element in the HTTP adapter response.
XHTML */XML Not applicable Not applicable  
XML TEXT or HTML Yes Not processed  
XML */XML Not applicable Not applicable  


HTTP actions

Was this page helpful? Yes No Submitting... Thank you

Comments