Package de.xima.fc.workflow.executor

Class FcCompressAsZipExecutor

java.lang.Object

de.xima.fc.workflow.executor.FcCompressAsZipExecutor

All Implemented Interfaces:

IWorkflowActionExecutor

public final class FcCompressAsZipExecutor
extends Object

Handler for executing a workflow action of type EWorkflowNodeType.FC_COMPRESS_AS_ZIP.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Field Summary

Fields

Modifier and Type	Field	Description
protected IWorkflowExecutionContext	ctx
protected static org.slf4j.Logger	LOG
protected WorkflowNode	node
protected INodeExecutionParams<TData>	params
protected TData	props

Constructor Summary

Constructors

Constructor	Description
FcCompressAsZipExecutor(INodeExecutionParams<FcCompressAsZipProps> params)	Creates a new executor for executing a compress as ZIP action with the given params.

Method Summary

Modifier and Type	Method	Description
protected NodeThrewException	createException(TError code, String message, Throwable cause, Consumer<IRecordValueBuilder> errorData)
protected <T> NodeThrewException	createException(TError code, String message, Consumer<IRecordValueBuilder> errorData)
protected NodeThrewException	createException(TError code, Throwable cause, Consumer<IRecordValueBuilder> errorData)
protected <T> NodeThrewException	createException(TError code, Consumer<IRecordValueBuilder> errorData)
protected INormalCompletionResult	exec()
INormalCompletionResult	execute()	Executes the workflow action, and creates the result.
protected String	getCombinedFileName(List<IResolvedFile> files, String defaultFileName, String extension)
protected void	writeToForm(IWorkflowExecutionContext ctx, Map<String,String> params, Vorgang formRecord)	Writes the specified values to the form record data, if the key from the parameter mapping has the same value as a form field in the form record data

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

protected static final org.slf4j.Logger LOG

ctx

protected final IWorkflowExecutionContext ctx

node

protected final WorkflowNode node

params

protected final INodeExecutionParams<TData> params

props

protected final TData props

Constructor Detail

FcCompressAsZipExecutor

public FcCompressAsZipExecutor(INodeExecutionParams<FcCompressAsZipProps> params)

Creates a new executor for executing a compress as ZIP action with the given params.

Parameters:

params - Parameters as provided the node handler, with the environment data and the action's properties model.

Method Detail

exec

protected INormalCompletionResult exec()
                                throws NodeThrewException

Throws:

NodeThrewException

execute

public final INormalCompletionResult execute()
                                      throws AbstractAbruptCompletionException

Description copied from interface: IWorkflowActionExecutor

Executes the workflow action, and creates the result.

Returns:

The success result to be returned by the post action.

Throws:

NodeThrewException - When the workflow action failed, as described by TError.

AbstractAbruptCompletionException - When the action could not be completed normally for another reason (such as when it needs to return).

writeToForm

protected void writeToForm(IWorkflowExecutionContext ctx,
                           Map<String,String> params,
                           Vorgang formRecord)

Writes the specified values to the form record data, if the key from the parameter mapping has the same value as a form field in the form record data

Parameters:

ctx - the IWorkflowExecutionContext

params - the params that should as form record data

formRecord - the form record

createException

protected <T> NodeThrewException createException(TError code,
                                                 Consumer<IRecordValueBuilder> errorData)

createException

protected <T> NodeThrewException createException(TError code,
                                                 String message,
                                                 Consumer<IRecordValueBuilder> errorData)

createException

protected NodeThrewException createException(TError code,
                                             String message,
                                             Throwable cause,
                                             Consumer<IRecordValueBuilder> errorData)

createException

protected NodeThrewException createException(TError code,
                                             Throwable cause,
                                             Consumer<IRecordValueBuilder> errorData)

getCombinedFileName

protected String getCombinedFileName(List<IResolvedFile> files,
                                     String defaultFileName,
                                     String extension)

Parameters:

files - File names to combine.

defaultFileName - Default file name to use.

extension - Extension of the combined file name.

Returns:

A file name with the given extension. When there is exactly one input file, the name of that file is taken, otherwise the default file name is used.