java.lang.Object
- de.xima.fc.workflow.taglib.model.BaseActionProps
- - de.xima.fc.workflow.model.nodes.FcHttpRequestProps

All Implemented Interfaces:: IDescriptionProviding, INameProviding, IAttachableFile, Serializable

@NotNullIf(field="basicAuthProps",dependants="useBasicAuth",target=FcHttpRequestProps.class) @NotNullIf(field="proxyProps",dependants="useProxy",target=FcHttpRequestProps.class) @NotNullIf(field="filesToTransmit",dependants={"httpVerb","disallowMessageBody"},target=FcHttpRequestProps.class)
public final class FcHttpRequestProps
extends BaseActionProps
implements Serializable, IAttachableFile

Model class for the HTTP request workflow action (EWorkflowNodeType.FC_POST_REQUEST).

Since:: 7.0.0
Author:: XIMA MEDIA GmbH
See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`FcHttpRequestProps.BasicAuthProps`	POJO model class for the basic auth credentials of the HTTP request action.
`static class`	`FcHttpRequestProps.ProxyAuthProps`	POJO model class for the credentials to use with the proxy of the HTTP request action (applicable only when a proxy is used).
`static class`	`FcHttpRequestProps.ProxyProps`	POJO model class for the proxy configuration of the HTTP request action.

Field Summary
- Fields inherited from interface de.xima.fc.entities.interfaces.IDescriptionProviding
  ATTR_BESCHREIBUNG, ATTR_DESCRIPTION, COL_DESCRIPTION
- Fields inherited from interface de.xima.fc.entities.interfaces.INameProviding
  ATTR_NAME, COL_NAME

Constructor Summary

Constructors
Constructor Description

FcHttpRequestProps()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`FcHttpRequestProps.BasicAuthProps`	`getBasicAuthProps()`
`MultiFile`	`getFilesToTransmit()`
`List<Setting<String>>`	`getHeaderParameters()`
`String`	`getHttpVerb()`
`String`	`getInputCharset()`
`String`	`getOutputCharset()`
`String`	`getPostUrl()`
`FcHttpRequestProps.ProxyProps`	`getProxyProps()`
`List<Setting<String>>`	`getRequestParameters()`
`UuidEntityRef`	`getXslTemplate()`
`boolean`	`isAsResponsePage()`
`boolean`	`isAttachToFormRecord()`
`boolean`	`isDisallowMessageBody()`
`boolean`	`isForceMultipart()`
`boolean`	`isSendAllFormValues()`
`boolean`	`isShowBasicAuthProps()`
`boolean`	`isShowDisallowMessageBody()`
`boolean`	`isShowFilesToTransmit()`
`boolean`	`isShowProxyProps()`
`boolean`	`isTreat4xxAsNormal()`
`boolean`	`isTreat5xxAsNormal()`
`boolean`	`isUseBasicAuth()`
`boolean`	`isUseFieldAlias()`
`boolean`	`isUseProxy()`
`void`	`setAsResponsePage(boolean asResponsePage)`
`void`	`setAttachToFormRecord(boolean attachToFormRecord)`
`void`	`setBasicAuthProps(FcHttpRequestProps.BasicAuthProps basicAuthProps)`
`void`	`setDisallowMessageBody(boolean disallowMessageBody)`
`void`	`setFilesToTransmit(MultiFile filesToTransmit)`
`void`	`setForceMultipart(boolean forceMultipart)`
`void`	`setHeaderParameters(List<Setting<String>> headerParameters)`
`void`	`setHttpVerb(String httpVerb)`
`void`	`setInputCharset(String inputCharset)`
`void`	`setOutputCharset(String outputCharset)`
`void`	`setPostUrl(String postUrl)`
`void`	`setProxyProps(FcHttpRequestProps.ProxyProps proxyProps)`
`void`	`setRequestParameters(List<Setting<String>> requestParameters)`
`void`	`setSendAllFormValues(boolean sendAllFormValues)`
`void`	`setTreat4xxAsNormal(boolean treat4xxAsNormal)`
`void`	`setTreat5xxAsNormal(boolean treat5xxAsNormal)`
`void`	`setUseBasicAuth(boolean useBasicAuth)`
`void`	`setUseFieldAlias(boolean useFieldAlias)`
`void`	`setUseProxy(boolean useProxy)`
`void`	`setXslTemplate(UuidEntityRef xslTemplate)`

Methods inherited from class de.xima.fc.workflow.taglib.model.BaseActionProps
getBeschreibung, getColor, getDescription, getIcon, getName, setColor, setDescription, setIcon, setName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FcHttpRequestProps
```
public FcHttpRequestProps()
```
- Method Detail
  - getBasicAuthProps
```
public FcHttpRequestProps.BasicAuthProps getBasicAuthProps()
```
    Returns:
    
    Basic authentication settings when enabled for the request, see isUseBasicAuth().
  - getFilesToTransmit
```
public MultiFile getFilesToTransmit()
```
    Returns:
    
    Files to transmit with the HTTP request (requires a multipart request, see isForceMultipart()).
  - getHeaderParameters
```
public List<Setting<String>> getHeaderParameters()
```
    Returns:
    
    Headers to send with the HTTP request.
  - getHttpVerb
```
public String getHttpVerb()
```
    Returns:
    
    The HTTP verb to use for the HTTP request.
  - getInputCharset
```
public String getInputCharset()
```
    Returns:
    
    Input character set, i.e. the encoding used for sending the HTTP request.
  - getOutputCharset
```
public String getOutputCharset()
```
    Returns:
    
    Output character set, e.g. the expected encoding of the response.
  - getPostUrl
```
public String getPostUrl()
```
    Returns:
    
    URL to which to direct the HTTP request.
  - getProxyProps
```
public FcHttpRequestProps.ProxyProps getProxyProps()
```
    Returns:
    
    Proxy settings when a proxy is used for the request, see isUseProxy().
  - getRequestParameters
```
public List<Setting<String>> getRequestParameters()
```
    Returns:
    
    Additional form parameters to send with the HTTP request.
  - getXslTemplate
```
public UuidEntityRef getXslTemplate()
```
    Returns:
    
    Optional XSL template for transforming the received response.
  - isAsResponsePage
```
public boolean isAsResponsePage()
```
    Returns:
    
    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.
  - isAttachToFormRecord
```
public boolean isAttachToFormRecord()
```
    Specified by:
    
    isAttachToFormRecord in interface IAttachableFile
    
    Returns:
    
    Whether files created by this file providing action are attached to the form record.
  - isDisallowMessageBody
```
public boolean isDisallowMessageBody()
```
    Returns:
    
    When a custom getHttpVerb() is selected, 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.
  - isSendAllFormValues
```
public boolean isSendAllFormValues()
```
    Returns:
    
    Whether to send the values of all form fields as form parameters with the HTTP request.
  - isShowBasicAuthProps
```
public boolean isShowBasicAuthProps()
```
    Returns:
    
    Whether the user can configure the basic authentication settings in the UI.
  - isShowDisallowMessageBody
```
public boolean isShowDisallowMessageBody()
```
    Returns:
    
    Whether the user can configure the body message setting in the UI.
  - isShowFilesToTransmit
```
public boolean isShowFilesToTransmit()
```
    Returns:
    
    Whether the user can configure the files to transmit setting in the UI.
  - isShowProxyProps
```
public boolean isShowProxyProps()
```
    Returns:
    
    Whether the user can configure the proxy settings in the UI.
  - isTreat4xxAsNormal
```
public boolean isTreat4xxAsNormal()
```
    Returns:
    
    When true, treats responses with 4xx status codes as normal. When false, throws an error instead (the default behavior).
  - isTreat5xxAsNormal
```
public boolean isTreat5xxAsNormal()
```
    Returns:
    
    When true, treats responses with 5xx status codes as normal. When false, throws an error instead (the default behavior).
  - isUseBasicAuth
```
public boolean isUseBasicAuth()
```
    Returns:
    
    Whether to use basic authentication via a username and password.
  - isUseFieldAlias
```
public boolean isUseFieldAlias()
```
    Returns:
    
    When true, uses the alias of a form element instead of its name.
  - isForceMultipart
```
public boolean isForceMultipart()
```
    Returns:
    
    When true, always uses a multipart/form-data content type, even when no files to transmit are selected. Otherwise, when this is set to false and no files to transmit are selected, application/x-www-form-urlencoded is used.
  - isUseProxy
```
public boolean isUseProxy()
```
    Returns:
    
    Whether to use a proxy when sending the HTTP request.
  - setAsResponsePage
```
public void setAsResponsePage(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.
  - setAttachToFormRecord
```
public void setAttachToFormRecord(boolean attachToFormRecord)
```
    Specified by:
    
    setAttachToFormRecord in interface IAttachableFile
    
    Parameters:
    
    attachToFormRecord - Whether files created by this file providing action are attached to the form record.
  - setBasicAuthProps
```
public void setBasicAuthProps(FcHttpRequestProps.BasicAuthProps basicAuthProps)
```
    Parameters:
    
    basicAuthProps - Basic authentication settings when enabled for the request, see isUseBasicAuth().
  - setDisallowMessageBody
```
public void setDisallowMessageBody(boolean disallowMessageBody)
```
    Parameters:
    
    disallowMessageBody - When a custom getHttpVerb() is selected, 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.
  - setFilesToTransmit
```
public void setFilesToTransmit(MultiFile filesToTransmit)
```
    Parameters:
    
    filesToTransmit - Files to transmit with the HTTP request.
  - setHeaderParameters
```
public void setHeaderParameters(List<Setting<String>> headerParameters)
```
    Parameters:
    
    headerParameters - Headers to send with the HTTP request. Replaces all headers that were set on this instance.
  - setHttpVerb
```
public void setHttpVerb(String httpVerb)
```
    Parameters:
    
    httpVerb - The HTTP verb to use for the HTTP request.
  - setInputCharset
```
public void setInputCharset(String inputCharset)
```
    Parameters:
    
    inputCharset - Input character set, i.e. the encoding used for sending the HTTP request.
  - setOutputCharset
```
public void setOutputCharset(String outputCharset)
```
    Parameters:
    
    outputCharset - Output character set, e.g. the expected encoding of the response.
  - setPostUrl
```
public void setPostUrl(String postUrl)
```
    Parameters:
    
    postUrl - URL to which to direct the HTTP request.
  - setProxyProps
```
public void setProxyProps(FcHttpRequestProps.ProxyProps proxyProps)
```
    Parameters:
    
    proxyProps - Proxy settings when a proxy is used for the request, see isUseProxy().
  - setRequestParameters
```
public void setRequestParameters(List<Setting<String>> requestParameters)
```
    Parameters:
    
    requestParameters - Additional form parameters to send with the HTTP request. Replaces existing parameters set on this instance.
  - setSendAllFormValues
```
public void setSendAllFormValues(boolean sendAllFormValues)
```
    Parameters:
    
    sendAllFormValues - Whether to send the values of all form fields as form parameters with the HTTP request.
  - setTreat4xxAsNormal
```
public void setTreat4xxAsNormal(boolean treat4xxAsNormal)
```
    Parameters:
    
    treat4xxAsNormal - When true, treats responses with 4xx status codes as normal. When false, throws an error instead (the default behavior).
  - setTreat5xxAsNormal
```
public void setTreat5xxAsNormal(boolean treat5xxAsNormal)
```
    Parameters:
    
    treat5xxAsNormal - When true, treats responses with 5xx status codes as normal. When false, throws an error instead (the default behavior).
  - setUseBasicAuth
```
public void setUseBasicAuth(boolean useBasicAuth)
```
    Parameters:
    
    useBasicAuth - Whether to use basic authentication via a username and password.
  - setUseFieldAlias
```
public void setUseFieldAlias(boolean useFieldAlias)
```
    Parameters:
    
    useFieldAlias - When true, uses the alias of a form element instead of its name.
  - setForceMultipart
```
public void setForceMultipart(boolean forceMultipart)
```
    Parameters:
    
    forceMultipart - When true, always uses a multipart/form-data content type, even when no files to transmit are selected. Otherwise, when this is set to false and no files to transmit are selected, application/x-www-form-urlencoded is used.
  - setUseProxy
```
public void setUseProxy(boolean useProxy)
```
    Parameters:
    
    useProxy - Whether to use a proxy when sending the HTTP request.
  - setXslTemplate
```
public void setXslTemplate(UuidEntityRef xslTemplate)
```
    Parameters:
    
    xslTemplate - Optional XSL template for transforming the received response.

Class FcHttpRequestProps

Nested Class Summary

Field Summary

Fields inherited from interface de.xima.fc.entities.interfaces.IDescriptionProviding

Fields inherited from interface de.xima.fc.entities.interfaces.INameProviding

Constructor Summary

Method Summary

Methods inherited from class de.xima.fc.workflow.taglib.model.BaseActionProps

Methods inherited from class java.lang.Object

Constructor Detail

FcHttpRequestProps

Method Detail

getBasicAuthProps

getFilesToTransmit

getHeaderParameters

getHttpVerb

getInputCharset

getOutputCharset

getPostUrl

getProxyProps

getRequestParameters

getXslTemplate

isAsResponsePage

isAttachToFormRecord

isDisallowMessageBody

isSendAllFormValues

isShowBasicAuthProps

isShowDisallowMessageBody

isShowFilesToTransmit

isShowProxyProps

isTreat4xxAsNormal

isTreat5xxAsNormal

isUseBasicAuth

isUseFieldAlias

isForceMultipart

isUseProxy

setAsResponsePage

setAttachToFormRecord

setBasicAuthProps

setDisallowMessageBody

setFilesToTransmit

setHeaderParameters

setHttpVerb

setInputCharset

setOutputCharset

setPostUrl

setProxyProps

setRequestParameters

setSendAllFormValues

setTreat4xxAsNormal

setTreat5xxAsNormal

setUseBasicAuth

setUseFieldAlias

setForceMultipart

setUseProxy

setXslTemplate