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
FieldsModifier and TypeFieldDescriptionstatic final StringName of the corresponding property of thegetErrorValueDescriptors(IValueDescriptorFactory)static final StringName of the corresponding property of thegetErrorValueDescriptors(IValueDescriptorFactory)static final StringName of the corresponding property of thegetErrorValueDescriptors(IValueDescriptorFactory)static final StringName of the corresponding property of thegetErrorValueDescriptors(IValueDescriptorFactory)static final StringName of the corresponding property of thegetErrorValueDescriptors(IValueDescriptorFactory)static final StringName of the corresponding property of thegetErrorValueDescriptors(IValueDescriptorFactory)static final StringName of the corresponding property of thegetErrorValueDescriptors(IValueDescriptorFactory)static final StringName of the corresponding property of thegetErrorValueDescriptors(IValueDescriptorFactory)static final StringName of the corresponding property of thegetErrorValueDescriptors(IValueDescriptorFactory)static final StringName of the corresponding property of thegetSuccessValueDescriptor(IValueDescriptorFactory)static final StringName of the corresponding property of thegetSuccessValueDescriptor(IValueDescriptorFactory)static final StringName of the corresponding property of thegetSuccessValueDescriptor(IValueDescriptorFactory)static final StringName of the corresponding property of thegetSuccessValueDescriptor(IValueDescriptorFactory)static final StringName of the corresponding property of thegetSuccessValueDescriptor(IValueDescriptorFactory)static final StringName of the corresponding property of thegetSuccessValueDescriptor(IValueDescriptorFactory)static final StringName of the corresponding property of thegetSuccessValueDescriptor(IValueDescriptorFactory)static final StringName of the corresponding property of thegetSuccessValueDescriptor(IValueDescriptorFactory)static final StringName of the corresponding property of thegetSuccessValueDescriptor(IValueDescriptorFactory) -
Method Summary
Modifier and TypeMethodDescriptiondefault IFileProvisionGets the content types of the attachments and files that can be produced by an execution of the node.default Stringdefault IAttachmentValueDescriptorCreates the descriptor for the attachment or attachments that are created when the node is executed.default IAttachmentValueDescriptorSame asgetAttachmentValueDescriptorwithout data, but refined depending on the current node's configuration.default Map<String, IValueDescriptor<?, ?>> The descriptors for the different error types that may occur when the node is executed.default Map<String, IValueDescriptor<?, ?>> getErrorValueDescriptors(IValueDescriptorFactory factory, IRefinedExecutionResultDescriptorParams<FcHttpRequestProps> params) Same asgetErrorValueDescriptorswithout data, but refined depending on the current node's configuration.default IFileValueDescriptorCreates the descriptor for the file or files that are created and made available to other actions when the node is executed.default Map<String, IValueDescriptor<?, ?>> The descriptors for the differentsoft errortypes that may occur when the node is executed.default Map<String, IValueDescriptor<?, ?>> getSoftErrorValueDescriptors(IValueDescriptorFactory factory, IRefinedExecutionResultDescriptorParams<FcHttpRequestProps> params) Same asgetSoftErrorValueDescriptorswithout data, but refined depending on the current node's configuration.default IValueDescriptor<?, ? extends IValueBuilder<?>> Creates the value descriptor for the data that is made available to the workflow when the node was executed successfully.Methods inherited from interface IExecutionResultDescriptor
getAlwaysValueDescriptor, getCurrentAttachmentValueDescriptor, getCurrentFileValueDescriptor, getCurrentValueDescriptor, getErrorValueDescriptor, getSoftErrorValueDescriptorMethods inherited from interface IRefinedExecutionResultDescriptor
getAlwaysValueDescriptor, getAlwaysValueDescriptor, getAttachmentValueDescriptor, getCurrentAttachmentValueDescriptor, getCurrentAttachmentValueDescriptor, getCurrentFileValueDescriptor, getCurrentFileValueDescriptor, getCurrentValueDescriptor, getCurrentValueDescriptor, getErrorValueDescriptor, getFileValueDescriptor, getFileValueDescriptor, getSoftErrorValueDescriptor, getSuccessValueDescriptor, getSuccessValueDescriptor
-
Field Details
-
ATTR_HTTP_ERROR_REDIRECTED
Name of the corresponding property of thegetErrorValueDescriptors(IValueDescriptorFactory)- See Also:
-
ATTR_HTTP_ERROR_REDIRECT_URL
Name of the corresponding property of thegetErrorValueDescriptors(IValueDescriptorFactory)- See Also:
-
ATTR_HTTP_ERROR_RESOLVED_REDIRECT_URL
Name of the corresponding property of thegetErrorValueDescriptors(IValueDescriptorFactory)- See Also:
-
ATTR_HTTP_ERROR_RESPONSE_BODY
Name of the corresponding property of thegetErrorValueDescriptors(IValueDescriptorFactory)- See Also:
-
ATTR_HTTP_ERROR_RESPONSE_CODE
Name of the corresponding property of thegetErrorValueDescriptors(IValueDescriptorFactory)- See Also:
-
ATTR_HTTP_ERROR_RESPONSE_HEADERS
Name of the corresponding property of thegetErrorValueDescriptors(IValueDescriptorFactory)- See Also:
-
ATTR_HTTP_ERROR_RESPONSE_JSON
Name of the corresponding property of thegetErrorValueDescriptors(IValueDescriptorFactory)- See Also:
-
ATTR_HTTP_ERROR_RESPONSE_REASON_PHRASE
Name of the corresponding property of thegetErrorValueDescriptors(IValueDescriptorFactory)- See Also:
-
ATTR_HTTP_ERROR_RESPONSE_STATUS_LINE
Name of the corresponding property of thegetErrorValueDescriptors(IValueDescriptorFactory)- See Also:
-
ATTR_REDIRECTED
Name of the corresponding property of thegetSuccessValueDescriptor(IValueDescriptorFactory)- See Also:
-
ATTR_REDIRECT_URL
Name of the corresponding property of thegetSuccessValueDescriptor(IValueDescriptorFactory)- See Also:
-
ATTR_RESOLVED_REDIRECT_URL
Name of the corresponding property of thegetSuccessValueDescriptor(IValueDescriptorFactory)- See Also:
-
ATTR_RESPONSE_BODY
Name of the corresponding property of thegetSuccessValueDescriptor(IValueDescriptorFactory)- See Also:
-
ATTR_RESPONSE_CODE
Name of the corresponding property of thegetSuccessValueDescriptor(IValueDescriptorFactory)- See Also:
-
ATTR_RESPONSE_HEADERS
Name of the corresponding property of thegetSuccessValueDescriptor(IValueDescriptorFactory)- See Also:
-
ATTR_RESPONSE_JSON
Name of the corresponding property of thegetSuccessValueDescriptor(IValueDescriptorFactory)- See Also:
-
ATTR_RESPONSE_REASON_PHRASE
Name of the corresponding property of thegetSuccessValueDescriptor(IValueDescriptorFactory)- See Also:
-
ATTR_RESPONSE_STATUS_LINE
Name of the corresponding property of thegetSuccessValueDescriptor(IValueDescriptorFactory)- See Also:
-
-
Method Details
-
extractSingleFileProvision
-
getAttachmentAndFileDescriptorI18nPrefix
-
getErrorValueDescriptors
default Map<String, IValueDescriptor<?,?>> getErrorValueDescriptors(IValueDescriptorFactory factory, IRefinedExecutionResultDescriptorParams<FcHttpRequestProps> params) Description copied from interface:IRefinedExecutionResultDescriptorSame asgetErrorValueDescriptorswithout data, but refined depending on the current node's configuration.- Specified by:
getErrorValueDescriptorsin interfaceIRefinedExecutionResultDescriptor<FcHttpRequestProps>- Parameters:
factory- Factory that may be used for creating the descriptor. You may also useValueDescriptorFactory.getInstance()if you wish to cache the descriptor in a static or instance field.params- Parameters with the 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.
-
getErrorValueDescriptors
Description copied from interface:IExecutionResultDescriptorThe descriptors for the different error types that may occur when the node is executed. Each discriminator of the union represents an error or exception type.var connectTimeoutError = factory.recordBuilder().requiredProperty("connectTimeoutMs", factory.integer()); var readTimeoutError = factory.recordBuilder().requiredProperty("readTimeoutMs", factory.integer()); return Map.of("CONNECT_TIMEOUT", connectTimeoutError, "READ_TIMEOUT", readTimeoutError);The example above uses a different set of data each type of error.Note that you do not have to include a general error code. When the
executemethod of a node handler throws an unhandled (runtime) exception, the error codeCmnConst.Workflow.ERROR_CODE_GENERALis set automatically.- Specified by:
getErrorValueDescriptorsin interfaceIExecutionResultDescriptor- Parameters:
f- Factory that may be used for creating the descriptor. You may also useValueDescriptorFactory.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).
-
getSoftErrorValueDescriptors
Description copied from interface:IExecutionResultDescriptorThe descriptors for the differentsoft errortypes that may occur when the node is executed. Each discriminator of the union represents an error or exception type.var missingUploadError = factory.recordBuilder().requiredProperty("elementName", factory.string()); var clientError = factory.recordBuilder().requiredProperty("statusCode", factory.integer()); return Map.of("MISSING_UPLOAD", missingUploadError, "CLIENT_ERROR", clientError);The example above uses a different data type for each type of error.@implNote This interface provides a default implementation for backwards compatibility so as not to break existing implementations. However, all existing implementations are strongly advised to override and implement this method. The default implementation may be removed at some point.
- Specified by:
getSoftErrorValueDescriptorsin interfaceIExecutionResultDescriptor- Parameters:
f- Factory that may be used for creating the descriptor. You may also useValueDescriptorFactory.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.
-
getSoftErrorValueDescriptors
default Map<String, IValueDescriptor<?,?>> getSoftErrorValueDescriptors(IValueDescriptorFactory factory, IRefinedExecutionResultDescriptorParams<FcHttpRequestProps> params) Description copied from interface:IRefinedExecutionResultDescriptorSame asgetSoftErrorValueDescriptorswithout data, but refined depending on the current node's configuration.- Specified by:
getSoftErrorValueDescriptorsin interfaceIRefinedExecutionResultDescriptor<FcHttpRequestProps>- Parameters:
factory- Factory that may be used for creating the descriptor. You may also useValueDescriptorFactory.getInstance()if you wish to cache the descriptor in a static or instance field.params- Parameters with the 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:IExecutionResultDescriptorCreates the value descriptor for the data that is made available to the workflow when the node was executed successfully.- Specified by:
getSuccessValueDescriptorin interfaceIExecutionResultDescriptor- Parameters:
f- Factory that may be used for creating the descriptor. Instead of the factory passed in to this method, you may also useValueDescriptorFactory.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
Gets the content types of the attachments and files that can be produced by an execution of the node. SeeFileListDescriptor.getContentTypes()- Returns:
- The content types of the attachments and files that can be produced by an execution of the node.
-
getAttachmentValueDescriptor
Description copied from interface:IExecutionResultDescriptorCreates the descriptor for the attachment or attachments that are created when the node is executed. Should returnnullwhen the node never creates attachments.- Specified by:
getAttachmentValueDescriptorin interfaceIExecutionResultDescriptor- Returns:
- The descriptor for the attachment or attachments made available after the node was executed.
-
getAttachmentValueDescriptor
default IAttachmentValueDescriptor getAttachmentValueDescriptor(IRefinedExecutionResultDescriptorParams<FcHttpRequestProps> params) Description copied from interface:IRefinedExecutionResultDescriptorSame asgetAttachmentValueDescriptorwithout data, but refined depending on the current node's configuration.- Specified by:
getAttachmentValueDescriptorin interfaceIRefinedExecutionResultDescriptor<Model>- Parameters:
params- Parameters with the 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
Description copied from interface:IExecutionResultDescriptorCreates the descriptor for the file or files that are created and made available to other actions when the node is executed. Should returnnullwhen the node provides node files.- Specified by:
getFileValueDescriptorin interfaceIExecutionResultDescriptor- Returns:
- The descriptor for the file or files made available after the node was executed.
-