Package de.xima.fc.workflow.model.nodes

Class FcHttpRequestProps

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 post request action.
static class	FcHttpRequestProps.ProxyAuthProps	POJO model class for the credentials to use with the proxy of the HTTP post request action (applicable only when a proxy is used).
static class	FcHttpRequestProps.ProxyProps	POJO model class for the proxy configuration of the HTTP post 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

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	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	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()

getFilesToTransmit

public MultiFile getFilesToTransmit()

getHeaderParameters

public List<Setting<String>> getHeaderParameters()

getHttpVerb

public String getHttpVerb()

Returns:

The HTTP verb to use for the HTTP request.

getInputCharset

public String getInputCharset()

getOutputCharset

public String getOutputCharset()

getPostUrl

public String getPostUrl()

getProxyProps

public FcHttpRequestProps.ProxyProps getProxyProps()

getRequestParameters

public List<Setting<String>> getRequestParameters()

getXslTemplate

public UuidEntityRef getXslTemplate()

isAsResponsePage

public boolean isAsResponsePage()

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()

isShowBasicAuthProps

public boolean isShowBasicAuthProps()

isShowDisallowMessageBody

public boolean isShowDisallowMessageBody()

isShowFilesToTransmit

public boolean isShowFilesToTransmit()

isShowProxyProps

public boolean isShowProxyProps()

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()

isUseFieldAlias

public boolean isUseFieldAlias()

isUseProxy

public boolean isUseProxy()

setAsResponsePage

public void setAsResponsePage(boolean asResponsePage)

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)

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)

setHeaderParameters

public void setHeaderParameters(List<Setting<String>> headerParameters)

setHttpVerb

public void setHttpVerb(String httpVerb)

Parameters:

httpVerb - The HTTP verb to use for the HTTP request.

setInputCharset

public void setInputCharset(String inputCharset)

setOutputCharset

public void setOutputCharset(String outputCharset)

setPostUrl

public void setPostUrl(String postUrl)

setProxyProps

public void setProxyProps(FcHttpRequestProps.ProxyProps proxyProps)

setRequestParameters

public void setRequestParameters(List<Setting<String>> requestParameters)

setSendAllFormValues

public void setSendAllFormValues(boolean sendAllFormValues)

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)

setUseFieldAlias

public void setUseFieldAlias(boolean useFieldAlias)

setUseProxy

public void setUseProxy(boolean useProxy)

setXslTemplate

public void setXslTemplate(UuidEntityRef xslTemplate)