Package de.xima.fc.workflow.retval.node

Interface IFcHttpRequestDescriptors

All Superinterfaces:

IExecutionResultDescriptor, IRefinedExecutionResultDescriptor<FcHttpRequestProps>

All Known Implementing Classes:

FcHttpRequestHandler

public interface IFcHttpRequestDescriptors

The result descriptors for the data returned by the EWorkflowNodeType.FC_POST_REQUEST action.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_HTTP_ERROR_REDIRECT_URL	Name of the corresponding property of the getErrorValueDescriptor(IValueDescriptorFactory)
static String	ATTR_HTTP_ERROR_REDIRECTED	Name of the corresponding property of the getErrorValueDescriptor(IValueDescriptorFactory)
static String	ATTR_HTTP_ERROR_RESOLVED_REDIRECT_URL	Name of the corresponding property of the getErrorValueDescriptor(IValueDescriptorFactory)
static String	ATTR_HTTP_ERROR_RESPONSE_BODY	Name of the corresponding property of the getErrorValueDescriptor(IValueDescriptorFactory)
static String	ATTR_HTTP_ERROR_RESPONSE_CODE	Name of the corresponding property of the getErrorValueDescriptor(IValueDescriptorFactory)
static String	ATTR_HTTP_ERROR_RESPONSE_HEADERS	Name of the corresponding property of the getErrorValueDescriptor(IValueDescriptorFactory)
static String	ATTR_HTTP_ERROR_RESPONSE_JSON	Name of the corresponding property of the getErrorValueDescriptor(IValueDescriptorFactory)
static String	ATTR_HTTP_ERROR_RESPONSE_REASON_PHRASE	Name of the corresponding property of the getErrorValueDescriptor(IValueDescriptorFactory)
static String	ATTR_HTTP_ERROR_RESPONSE_STATUS_LINE	Name of the corresponding property of the getErrorValueDescriptor(IValueDescriptorFactory)
static String	ATTR_REDIRECT_URL	Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)
static String	ATTR_REDIRECTED	Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)
static String	ATTR_RESOLVED_REDIRECT_URL	Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)
static String	ATTR_RESPONSE_BODY	Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)
static String	ATTR_RESPONSE_CODE	Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)
static String	ATTR_RESPONSE_HEADERS	Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)
static String	ATTR_RESPONSE_JSON	Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)
static String	ATTR_RESPONSE_REASON_PHRASE	Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)
static String	ATTR_RESPONSE_STATUS_LINE	Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)

Method Summary

Modifier and Type	Method	Description
default IFileProvision	extractSingleFileProvision(FcHttpRequestProps props)
default Set<String>	getAttachmentAndFileContentTypes()	Gets the content types of the attachments and files that can be produced by an execution of the node.
default String	getAttachmentAndFileDescriptorI18nPrefix()
default IAttachmentValueDescriptor	getAttachmentValueDescriptor()	Creates the descriptor for the attachment or attachments that are created when the node is executed.
default IAttachmentValueDescriptor	getAttachmentValueDescriptor(Model props)	Same as getAttachmentValueDescriptor without data, but refined depending on the current node's configuration.
default IUnionValueDescriptor<String>	getErrorValueDescriptor(IValueDescriptorFactory f)	The union descriptor for the different error types that may occur when the node is executed.
default IUnionValueDescriptor<String>	getErrorValueDescriptor(IValueDescriptorFactory factory, FcHttpRequestProps props)	Same as getErrorValueDescriptor without data, but refined depending on the current node's configuration.
default IFileValueDescriptor	getFileValueDescriptor()	Creates the descriptor for the file or files that are created and made available to other actions when the node is executed.
default IUnionValueDescriptor<String>	getSoftErrorValueDescriptor(IValueDescriptorFactory f)	The union descriptor for the different soft error types that may occur when the node is executed.
default IUnionValueDescriptor<String>	getSoftErrorValueDescriptor(IValueDescriptorFactory factory, FcHttpRequestProps props)	Same as getSoftErrorValueDescriptor without data, but refined depending on the current node's configuration.
default IValueDescriptor<?,? extends IValueBuilder<?>>	getSuccessValueDescriptor(IValueDescriptorFactory f)	Creates the value descriptor for the data that is made available to the workflow when the node was executed successfully.

Methods inherited from interface de.xima.fc.interfaces.workflow.execution.IExecutionResultDescriptor

getAlwaysValueDescriptor, getCurrentAttachmentValueDescriptor, getCurrentFileValueDescriptor, getCurrentValueDescriptor

Methods inherited from interface de.xima.fc.interfaces.workflow.execution.IRefinedExecutionResultDescriptor

getAlwaysValueDescriptor, getCurrentAttachmentValueDescriptor, getCurrentFileValueDescriptor, getCurrentValueDescriptor, getFileValueDescriptor, getSuccessValueDescriptor

Field Detail

ATTR_HTTP_ERROR_REDIRECTED

static final String ATTR_HTTP_ERROR_REDIRECTED

Name of the corresponding property of the getErrorValueDescriptor(IValueDescriptorFactory)

See Also:

Constant Field Values

ATTR_HTTP_ERROR_REDIRECT_URL

static final String ATTR_HTTP_ERROR_REDIRECT_URL

Name of the corresponding property of the getErrorValueDescriptor(IValueDescriptorFactory)

See Also:

Constant Field Values

ATTR_HTTP_ERROR_RESOLVED_REDIRECT_URL

static final String ATTR_HTTP_ERROR_RESOLVED_REDIRECT_URL

Name of the corresponding property of the getErrorValueDescriptor(IValueDescriptorFactory)

See Also:

Constant Field Values

ATTR_HTTP_ERROR_RESPONSE_BODY

static final String ATTR_HTTP_ERROR_RESPONSE_BODY

Name of the corresponding property of the getErrorValueDescriptor(IValueDescriptorFactory)

See Also:

Constant Field Values

ATTR_HTTP_ERROR_RESPONSE_CODE

static final String ATTR_HTTP_ERROR_RESPONSE_CODE

Name of the corresponding property of the getErrorValueDescriptor(IValueDescriptorFactory)

See Also:

Constant Field Values

ATTR_HTTP_ERROR_RESPONSE_HEADERS

static final String ATTR_HTTP_ERROR_RESPONSE_HEADERS

Name of the corresponding property of the getErrorValueDescriptor(IValueDescriptorFactory)

See Also:

Constant Field Values

ATTR_HTTP_ERROR_RESPONSE_JSON

static final String ATTR_HTTP_ERROR_RESPONSE_JSON

Name of the corresponding property of the getErrorValueDescriptor(IValueDescriptorFactory)

See Also:

Constant Field Values

ATTR_HTTP_ERROR_RESPONSE_REASON_PHRASE

static final String ATTR_HTTP_ERROR_RESPONSE_REASON_PHRASE

Name of the corresponding property of the getErrorValueDescriptor(IValueDescriptorFactory)

See Also:

Constant Field Values

ATTR_HTTP_ERROR_RESPONSE_STATUS_LINE

static final String ATTR_HTTP_ERROR_RESPONSE_STATUS_LINE

Name of the corresponding property of the getErrorValueDescriptor(IValueDescriptorFactory)

See Also:

Constant Field Values

ATTR_REDIRECTED

static final String ATTR_REDIRECTED

Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)

See Also:

Constant Field Values

ATTR_REDIRECT_URL

static final String ATTR_REDIRECT_URL

Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)

See Also:

Constant Field Values

ATTR_RESOLVED_REDIRECT_URL

static final String ATTR_RESOLVED_REDIRECT_URL

Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)

See Also:

Constant Field Values

ATTR_RESPONSE_BODY

static final String ATTR_RESPONSE_BODY

Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)

See Also:

Constant Field Values

ATTR_RESPONSE_CODE

static final String ATTR_RESPONSE_CODE

Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)

See Also:

Constant Field Values

ATTR_RESPONSE_HEADERS

static final String ATTR_RESPONSE_HEADERS

Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)

See Also:

Constant Field Values

ATTR_RESPONSE_JSON

static final String ATTR_RESPONSE_JSON

Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)

See Also:

Constant Field Values

ATTR_RESPONSE_REASON_PHRASE

static final String ATTR_RESPONSE_REASON_PHRASE

Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)

See Also:

Constant Field Values

ATTR_RESPONSE_STATUS_LINE

static final String ATTR_RESPONSE_STATUS_LINE

Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)

See Also:

Constant Field Values

Method Detail

extractSingleFileProvision

default IFileProvision extractSingleFileProvision(FcHttpRequestProps props)

getAttachmentAndFileDescriptorI18nPrefix

default String getAttachmentAndFileDescriptorI18nPrefix()

getErrorValueDescriptor

default IUnionValueDescriptor<String> getErrorValueDescriptor(IValueDescriptorFactory factory,
                                                              FcHttpRequestProps props)

Description copied from interface: IRefinedExecutionResultDescriptor

Same as getErrorValueDescriptor without data, but refined depending on the current node's configuration.

Specified by:

getErrorValueDescriptor in interface IRefinedExecutionResultDescriptor<FcHttpRequestProps>

Parameters:

factory - Factory that may be used for creating the descriptor. You may also use ValueDescriptorFactory.getInstance() if you wish to cache the descriptor in a static or instance field.

props - Current properties model of the node.

Returns:

The value descriptor for the data that is made available to the workflow when the execution of the node failed (such as by throwing an exception). If null, the non-refined descriptor is used.

getErrorValueDescriptor

default IUnionValueDescriptor<String> getErrorValueDescriptor(IValueDescriptorFactory f)

Description copied from interface: IExecutionResultDescriptor

The union descriptor for the different error types that may occur when the node is executed. Each discriminator of the union represents an error or exception type.

 factory.recordBuilder() //
     .requiredProperty("errorCode", factory.integer()) //
     .requiredProperty("errorMessage", factory.string()) //
     .requiredProperty("localizedMessage", factory.integer());
 return factory.add("CONNECT_TIMEOUT", error) //
     .add("READ_TIMEOUT", error);
 

The example above uses the same data type for each error, but you can return different data depending on the error type.

Note that you do not have to include a general error code. When the execute method of a node handler throws an unhandled (runtime) exception, the error code CmnConst.Workflow.ERROR_CODE_GENERAL is set automatically.

Specified by:

getErrorValueDescriptor in interface IExecutionResultDescriptor

Parameters:

f - Factory that may be used for creating the descriptor. You may also use ValueDescriptorFactory.getInstance() if you wish to cache the descriptor in a static or instance field.

Returns:

The value descriptor for the data that is made available to the workflow when the execution of the node failed (such as by throwing an exception).

getSoftErrorValueDescriptor

default IUnionValueDescriptor<String> getSoftErrorValueDescriptor(IValueDescriptorFactory f)

Description copied from interface: IExecutionResultDescriptor

The union descriptor for the different soft error types that may occur when the node is executed. Each discriminator of the union represents an error or exception type.

 factory.recordBuilder() //
     .requiredProperty("errorCode", factory.integer()) //
     .requiredProperty("errorMessage", factory.string()) //
     .requiredProperty("localizedMessage", factory.integer());
 return factory.add("MISSING_UPLOAD", error) //
     .add("CLIENT_ERROR", error);
 

The example above uses the same data type for each error, but you can return different data depending on the error type.

@implNote This interface provides a default implementation that returns an empty descriptor for backwards compatibility so as not to break existing implementation. However, all existing implementations are strongly advised to override and implement this method. The default implementation may be removed at some point.

Specified by:

getSoftErrorValueDescriptor in interface IExecutionResultDescriptor

Parameters:

f - Factory that may be used for creating the descriptor. You may also use ValueDescriptorFactory.getInstance() if you wish to cache the descriptor in a static or instance field.

Returns:

The value descriptor for the data that is made available to the workflow when the execution of the node was successful, but contains one or more soft errors.

getSoftErrorValueDescriptor

default IUnionValueDescriptor<String> getSoftErrorValueDescriptor(IValueDescriptorFactory factory,
                                                                  FcHttpRequestProps props)

Description copied from interface: IRefinedExecutionResultDescriptor

Same as getSoftErrorValueDescriptor without data, but refined depending on the current node's configuration.

Specified by:

getSoftErrorValueDescriptor in interface IRefinedExecutionResultDescriptor<FcHttpRequestProps>

Parameters:

factory - Factory that may be used for creating the descriptor. You may also use ValueDescriptorFactory.getInstance() if you wish to cache the descriptor in a static or instance field.

props - Current properties model of the node.

Returns:

The value descriptor for the data that is made available to the workflow when the execution of the node was successful, but contains one or more soft errors. If null, the non-refined descriptor is used.

getSuccessValueDescriptor

default IValueDescriptor<?,? extends IValueBuilder<?>> getSuccessValueDescriptor(IValueDescriptorFactory f)

Description copied from interface: IExecutionResultDescriptor

Creates the value descriptor for the data that is made available to the workflow when the node was executed successfully.

Specified by:

getSuccessValueDescriptor in interface IExecutionResultDescriptor

Parameters:

f - Factory that may be used for creating the descriptor. Instead of the factory passed in to this method, you may also use ValueDescriptorFactory.getInstance() if you wish to cache the descriptor in a static or instance field.

Returns:

The data provided by the node after having been executed successfully.

getAttachmentAndFileContentTypes

default Set<String> getAttachmentAndFileContentTypes()

Gets the content types of the attachments and files that can be produced by an execution of the node. See FileListDescriptor.getContentTypes()

Returns:

The content types of the attachments and files that can be produced by an execution of the node.

getAttachmentValueDescriptor

default IAttachmentValueDescriptor getAttachmentValueDescriptor()

Description copied from interface: IExecutionResultDescriptor

Creates the descriptor for the attachment or attachments that are created when the node is executed. Should return null when the node never creates attachments.

Specified by:

getAttachmentValueDescriptor in interface IExecutionResultDescriptor

Returns:

The descriptor for the attachment or attachments made available after the node was executed.

getAttachmentValueDescriptor

default IAttachmentValueDescriptor getAttachmentValueDescriptor(Model props)

Description copied from interface: IRefinedExecutionResultDescriptor

Same as getAttachmentValueDescriptor without data, but refined depending on the current node's configuration.

Specified by:

getAttachmentValueDescriptor in interface IRefinedExecutionResultDescriptor<Model>

Parameters:

props - Current properties model of the node.

Returns:

The descriptor for the attachment or attachment made available after the node was executed. If null , the non-refined descriptor is used.

getFileValueDescriptor

default IFileValueDescriptor getFileValueDescriptor()

Description copied from interface: IExecutionResultDescriptor

Creates the descriptor for the file or files that are created and made available to other actions when the node is executed. Should return null when the node provides node files.

Specified by:

getFileValueDescriptor in interface IExecutionResultDescriptor

Returns:

The descriptor for the file or files made available after the node was executed.