```
public interface IHttpRequestNodeBuilder
```
Builder for configuring a EWorkflowNodeType.FC_POST_REQUEST action.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`IHttpRequestNodeBuilder`	`asResponsePage(boolean asResponsePage)`
`IHttpRequestNodeBuilder`	`attachToFormRecord(boolean attachToFormRecord)`
`IHttpRequestNodeBuilder`	`basicAuth(String username, String password)`	Sets up basic authentication for the HTTP request.
`WorkflowNode`	`build()`	Creates a new workflow node for a `EWorkflowNodeType.FC_POST_REQUEST` that sends a HTTP request to the given URL.
`IHttpRequestNodeBuilder`	`customBodyContent(String customBodyContent)`
`IHttpRequestNodeBuilder`	`customLocationResolutionUri(String customLocationResolutionUri)`	When the `resolution type` for the `Location` header is set to `RESOLVE_AGAINST_CUSTOM_URI`: the custom URI against which to resolve the URI from the `Location` header.
`IHttpRequestNodeBuilder`	`disallowMessageBody(boolean disallowMessageBody)`	Lets you decide whether a custom HTTP verb supports a message body.
`IHttpRequestNodeBuilder`	`filesToTransmit(MultiFile filesToTransmit)`
`IHttpRequestNodeBuilder`	`header(String name, String value)`	Includes an additional header in the HTTP request.
`IHttpRequestNodeBuilder`	`headers(Map<String,List<String>> headers)`
`IHttpRequestNodeBuilder`	`httpBodyType(EHttpRequestType httpBodyType)`
`IHttpRequestNodeBuilder`	`inputCharset(String inputCharset)`
`IHttpRequestNodeBuilder`	`locationResolutionType(EHttpLocationResolutionType locationResolutionType)`	When the HTTP response has a 3xx status code with a `Location` header, controls how to resolve the URI in that header.
`IHttpRequestNodeBuilder`	`outputCharset(String outputCharset)`
`IHttpRequestNodeBuilder`	`parameter(String name, String value)`	Includes an additional form parameter in the HTTP request.
`IHttpRequestNodeBuilder`	`parameters(Map<String,List<String>> parameters)`	Includes additional form parameters to send with the HTTP request.
`IHttpRequestNodeBuilder`	`proxy(String host, int port)`	Sets up a proxy for transmitting the HTTP request.
`IHttpRequestNodeBuilder`	`proxy(String host, int port, String username, String password)`	Sets up a proxy for transmitting the HTTP request.
`IHttpRequestNodeBuilder`	`sendAllFormValues(boolean sendAllFormValues, boolean useFieldAlias)`
`IHttpRequestNodeBuilder`	`singleFileToTransmit(SingleFile singleFileToTransmit)`
`IHttpRequestNodeBuilder`	`treat4xxAsNormal(boolean treat4xxAsNormal)`	Lets you decide whether HTTP status codes in the 400-499 range are treated as errors.
`IHttpRequestNodeBuilder`	`treat5xxAsNormal(boolean treat5xxAsNormal)`	Lets you decide whether HTTP status codes in the 500-599 range are treated as errors.
`IHttpRequestNodeBuilder`	`xslTemplate(Textbaustein xslTemplate)`

- Method Detail
  - asResponsePage
```
IHttpRequestNodeBuilder asResponsePage(boolean asResponsePage)
```
    Parameters:
    
    asResponsePage - If true, returns the response from the HTTP request as the workflow response. That is, when the user submits a form and the workflow is triggered, send the response back to the user.
    
    Returns:
    
    This builder for chaining methods calls.
  - attachToFormRecord
```
IHttpRequestNodeBuilder attachToFormRecord(boolean attachToFormRecord)
```
    Parameters:
    
    attachToFormRecord - Whether to attach the HTTP request response as a file to the current form record.
    
    Returns:
    
    This builder for chaining methods calls.
  - basicAuth
```
IHttpRequestNodeBuilder basicAuth(String username,
                                  String password)
```
    Sets up basic authentication for the HTTP request.
    
    Parameters:
    
    username - Username for the basic authentication.
    
    password - Password for the basic authentication.
    
    Returns:
    
    This builder for chaining methods calls.
  - build
```
WorkflowNode build()
            throws FastJsonException
```
    Creates a new workflow node for a EWorkflowNodeType.FC_POST_REQUEST that sends a HTTP request to the given URL.
    
    Returns:
    
    The workflow node for a provide resource action.
    
    Throws:
    
    FastJsonException - When the properties model could not be serialized.
  - customBodyContent
```
IHttpRequestNodeBuilder customBodyContent(String customBodyContent)
```
    Parameters:
    
    customBodyContent - The custom body content to send with the HTTP request, e.g. to make custom REST API calls.
    
    Returns:
    
    This builder for chaining methods calls.
  - customLocationResolutionUri
```
IHttpRequestNodeBuilder customLocationResolutionUri(String customLocationResolutionUri)
```
    When the resolution type for the Location header is set to RESOLVE_AGAINST_CUSTOM_URI: the custom URI against which to resolve the URI from the Location header.
    
    Parameters:
    
    customLocationResolutionUri - Custom URI against which to resolve the URI from the Location header.
    
    Returns:
    
    This builder for chaining methods calls.
  - disallowMessageBody
```
IHttpRequestNodeBuilder disallowMessageBody(boolean disallowMessageBody)
```
    Lets you decide whether a custom HTTP verb supports a message body. Has no effect for standard HTTP verbs such as POST or GET.
    
    Parameters:
    
    disallowMessageBody - When a custom HTTP verb is selected, indicates whether a message body is allowed. If no message body is allowed, parameters will be added as URL parameters and no files will be sent.
    
    Returns:
    
    This builder for chaining methods calls.
  - filesToTransmit
```
IHttpRequestNodeBuilder filesToTransmit(MultiFile filesToTransmit)
```
    Parameters:
    
    filesToTransmit - Files to transmit with the HTTP request (requires a multipart request, see httpBodyType(EHttpRequestType)).
    
    Returns:
    
    This builder for chaining methods calls.
  - header
```
IHttpRequestNodeBuilder header(String name,
                               String value)
```
    Includes an additional header in the HTTP request.
    
    Parameters:
    
    name - Name of the header.
    
    value - Value of the header.
    
    Returns:
    
    This builder for chaining methods calls.
  - headers
```
IHttpRequestNodeBuilder headers(Map<String,List<String>> headers)
```
    Parameters:
    
    headers - Headers to send with the HTTP request. Replaces all headers that were set on this builder.
    
    Returns:
    
    This builder for chaining methods calls.
  - httpBodyType
```
IHttpRequestNodeBuilder httpBodyType(EHttpRequestType httpBodyType)
```
    Parameters:
    
    httpBodyType - How to create the content of the HTTP request body.
    
    Returns:
    
    This builder for chaining methods calls.
  - inputCharset
```
IHttpRequestNodeBuilder inputCharset(String inputCharset)
```
    Parameters:
    
    inputCharset - Input character set, i.e. the encoding used for sending the HTTP request.
    
    Returns:
    
    This builder for chaining methods calls.
  - locationResolutionType
```
IHttpRequestNodeBuilder locationResolutionType(EHttpLocationResolutionType locationResolutionType)
```
    When the HTTP response has a 3xx status code with a Location header, controls how to resolve the URI in that header. Defaults to RESOLVE_AGAINST_REQUEST_URI according to RFC 7231.
    
    Parameters:
    
    locationResolutionType - How to handle URIs in the Location header.
    
    Returns:
    
    This builder for chaining methods calls.
  - outputCharset
```
IHttpRequestNodeBuilder outputCharset(String outputCharset)
```
    Parameters:
    
    outputCharset - Output character set, e.g. the expected encoding of the response.
    
    Returns:
    
    This builder for chaining methods calls.
  - parameter
```
IHttpRequestNodeBuilder parameter(String name,
                                  String value)
```
    Includes an additional form parameter in the HTTP request.
    
    Parameters:
    
    name - Name of the parameter.
    
    value - Value of the parameter.
    
    Returns:
    
    This builder for chaining methods calls.
  - parameters
```
IHttpRequestNodeBuilder parameters(Map<String,List<String>> parameters)
```
    Includes additional form parameters to send with the HTTP request. Replaces existing parameters set on this builder.
    
    Parameters:
    
    parameters - Form parameters to send with the HTTP request.
    
    Returns:
    
    This builder for chaining methods calls.
  - proxy
```
IHttpRequestNodeBuilder proxy(String host,
                              int port)
```
    Sets up a proxy for transmitting the HTTP request.
    
    Parameters:
    
    host - Host of the proxy.
    
    port - Port of the proxy.
    
    Returns:
    
    This builder for chaining methods calls.
  - proxy
```
IHttpRequestNodeBuilder proxy(String host,
                              int port,
                              String username,
                              String password)
```
    Sets up a proxy for transmitting the HTTP request.
    
    Parameters:
    
    host - Host of the proxy.
    
    port - Port of the proxy.
    
    username - Username for authorizing against the proxy.
    
    password - Password for authorizing against the proxy.
    
    Returns:
    
    This builder for chaining methods calls.
  - sendAllFormValues
```
IHttpRequestNodeBuilder sendAllFormValues(boolean sendAllFormValues,
                                          boolean useFieldAlias)
```
    Parameters:
    
    sendAllFormValues - Whether to send the values of all form fields as form parameters with the HTTP request.
    
    useFieldAlias - When true, uses the alias of a form element instead of its name.
    
    Returns:
    
    This builder for chaining methods calls.
  - singleFileToTransmit
```
IHttpRequestNodeBuilder singleFileToTransmit(SingleFile singleFileToTransmit)
```
    Parameters:
    
    singleFileToTransmit - For the request type EHttpRequestType.FILE, the file to send as the body of the HTTP request.
    
    Returns:
    
    This builder for chaining methods calls.
  - treat4xxAsNormal
```
IHttpRequestNodeBuilder treat4xxAsNormal(boolean treat4xxAsNormal)
```
    Lets you decide whether HTTP status codes in the 400-499 range are treated as errors.
    
    Parameters:
    
    treat4xxAsNormal - When true, treats responses with 4xx status codes as normal. When false, throws an error instead (the default behavior).
    
    Returns:
    
    This builder for chaining methods calls.
  - treat5xxAsNormal
```
IHttpRequestNodeBuilder treat5xxAsNormal(boolean treat5xxAsNormal)
```
    Lets you decide whether HTTP status codes in the 500-599 range are treated as errors.
    
    Parameters:
    
    treat5xxAsNormal - When true, treats responses with 5xx status codes as normal. When false, throws an error instead (the default behavior).
    
    Returns:
    
    This builder for chaining methods calls.
  - xslTemplate
```
IHttpRequestNodeBuilder xslTemplate(Textbaustein xslTemplate)
```
    Parameters:
    
    xslTemplate - Optional XSL template for transforming the received response.
    
    Returns:
    
    This builder for chaining methods calls.

Interface IHttpRequestNodeBuilder

Method Summary

Method Detail

asResponsePage

attachToFormRecord

basicAuth

build

customBodyContent

customLocationResolutionUri

disallowMessageBody

filesToTransmit

header

headers

httpBodyType

inputCharset

locationResolutionType

outputCharset

parameter

parameters

proxy

proxy

sendAllFormValues

singleFileToTransmit

treat4xxAsNormal

treat5xxAsNormal

xslTemplate