Package de.xima.fc.workflow.processor.factory

Interface IPostRequestNodeBuilder

public interface IPostRequestNodeBuilder

Builder for configuring a EWorkflowNodeType.FC_POST_REQUEST action.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
IPostRequestNodeBuilder	asResponsePage(boolean asResponsePage)
IPostRequestNodeBuilder	attachToFormRecord(boolean attachToFormRecord)
IPostRequestNodeBuilder	basicAuth(String username, String password)	Sets up basic authentication for the POST request.
WorkflowNode	build()	Creates a new workflow node for a EWorkflowNodeType.FC_POST_REQUEST that sends a POST request to the given URL.
IPostRequestNodeBuilder	filesToTransmit(MultiFile filesToTransmit)
IPostRequestNodeBuilder	header(String name, String value)	Includes an additional header in the POST request.
IPostRequestNodeBuilder	headers(Map<String,List<String>> headers)
IPostRequestNodeBuilder	inputCharset(String inputCharset)
IPostRequestNodeBuilder	outputCharset(String outputCharset)
IPostRequestNodeBuilder	parameter(String name, String value)	Includes an additional form parameter in the POST request.
IPostRequestNodeBuilder	parameters(Map<String,List<String>> parameters)	Includes additional form parameters to send with the POST request.
IPostRequestNodeBuilder	proxy(String host, int port)	Sets up a proxy for transmitting the POST request.
IPostRequestNodeBuilder	proxy(String host, int port, String username, String password)	Sets up a proxy for transmitting the POST request.
IPostRequestNodeBuilder	sendAllFormValues(boolean sendAllFormValues, boolean useFieldAlias)
IPostRequestNodeBuilder	xslTemplate(Textbaustein xslTemplate)

Method Detail

asResponsePage

IPostRequestNodeBuilder asResponsePage(boolean asResponsePage)

Parameters:

asResponsePage - If true, returns the response from the

Returns:

This builder for chaining methods calls.

attachToFormRecord

IPostRequestNodeBuilder attachToFormRecord(boolean attachToFormRecord)

Parameters:

attachToFormRecord - Whether to attach the POST request response as a file to the current form record.

Returns:

This builder for chaining methods calls.

basicAuth

IPostRequestNodeBuilder basicAuth(String username,
                                  String password)

Sets up basic authentication for the POST request.

Parameters:

username - Username for the basic authorization.

password - Password for the basic authorization.

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 POST request to the given URL.

Returns:

The workflow node for a provide resource action.

Throws:

FastJsonException - When the properties model could not be serialized.

filesToTransmit

IPostRequestNodeBuilder filesToTransmit(MultiFile filesToTransmit)

Parameters:

filesToTransmit - Files to transmit with the POST request (turns the request into a multipart request).

Returns:

This builder for chaining methods calls.

header

IPostRequestNodeBuilder header(String name,
                               String value)

Includes an additional header in the POST request.

Parameters:

name - Name of the header.

value - Value of the header.

Returns:

This builder for chaining methods calls.

headers

IPostRequestNodeBuilder headers(Map<String,List<String>> headers)

Parameters:

headers - Headers to send with the post request. Replaces all headers that were set on this builder.

Returns:

This builder for chaining methods calls.

inputCharset

IPostRequestNodeBuilder inputCharset(String inputCharset)

Parameters:

inputCharset - Input character set, i.e. the encoding used for sending the POST request.

Returns:

This builder for chaining methods calls.

outputCharset

IPostRequestNodeBuilder outputCharset(String outputCharset)

Parameters:

outputCharset - Output character set, e.g. the expected encoding of the response.

Returns:

This builder for chaining methods calls.

parameter

IPostRequestNodeBuilder parameter(String name,
                                  String value)

Includes an additional form parameter in the POST request.

Parameters:

name - Name of the parameter.

value - Value of the parameter.

Returns:

This builder for chaining methods calls.

parameters

IPostRequestNodeBuilder parameters(Map<String,List<String>> parameters)

Includes additional form parameters to send with the POST request. Replaces existing parameters set on this builder.

Parameters:

parameters - Form parameters to send with the POST request.

Returns:

This builder for chaining methods calls.

proxy

IPostRequestNodeBuilder proxy(String host,
                              int port)

Sets up a proxy for transmitting the POST request.

Parameters:

host - Host of the proxy.

port - Port of the proxy.

Returns:

This builder for chaining methods calls.

proxy

IPostRequestNodeBuilder proxy(String host,
                              int port,
                              String username,
                              String password)

Sets up a proxy for transmitting the POST 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

IPostRequestNodeBuilder sendAllFormValues(boolean sendAllFormValues,
                                          boolean useFieldAlias)

Parameters:

sendAllFormValues - Whether to send the values of all form fields as form parameters with the POST request.

useFieldAlias - When true, uses the alias of a form element instead of its name.

Returns:

This builder for chaining methods calls.

xslTemplate

IPostRequestNodeBuilder xslTemplate(Textbaustein xslTemplate)

Parameters:

xslTemplate - Optional XSL template for transforming the received response.

Returns:

This builder for chaining methods calls.