com.botronsoft.cmj.spitools.workflow

Class AbstractWorkflowParticipantHandler

java.lang.Object

com.botronsoft.cmj.spitools.workflow.AbstractWorkflowParticipantHandler

All Implemented Interfaces:

com.botronsoft.cmj.spi.configuration.workflow.WorkflowParticipantHandler

@PublicApi
public abstract class AbstractWorkflowParticipantHandler
extends Object
implements com.botronsoft.cmj.spi.configuration.workflow.WorkflowParticipantHandler

Base class for WorkflowParticipantHandler implementations that want to use the DSL for describing the syntax of transition participant arguments. Transition participants are conditions, validators and post-functions. Extend this class and implement the describeArguments() method to describe the syntax of all arguments by invoking the condition(String), validator(String), postFunction(String) methods.

Constructor Summary

Constructors

Constructor and Description
AbstractWorkflowParticipantHandler() Non-argument constructor for implementations.

Method Summary

Modifier and Type	Method and Description
protected ArgumentContainerDescriptor	condition(String className) Describes the syntax of the different arguments of a condition.
protected abstract void	describeArguments() Implement this method to describe the syntax of transition participant arguments.
protected void	handleError(String className, String argumentName, Throwable t) This method will be invoked when an exception is caught during processing of an argument.
protected ArgumentContainerDescriptor	postFunction(String className) Describes the syntax of the different arguments of a post-function.
Map<String,String>	transformArgumentsForExport(String className, Map<String,String> args, com.botronsoft.cmj.spi.configuration.ExportContext exportContext)
Map<String,String>	transformArgumentsForImport(String className, Map<String,String> args, com.botronsoft.cmj.spi.configuration.ImportContext importContext)
protected String	transformUnhandledArgumentForExport(String className, String argName, String argValue, com.botronsoft.cmj.spi.configuration.ExportContext exportContext) This method will be invoked for each argument that has not been described in describeArguments().
protected String	transformUnhandledArgumentForImport(String className, String argName, String argValue, com.botronsoft.cmj.spi.configuration.ImportContext importContext) This method will be invoked for each argument that has not been described in describeArguments().
protected ArgumentContainerDescriptor	validator(String className) Describes the syntax of the different arguments of a validator.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractWorkflowParticipantHandler

public AbstractWorkflowParticipantHandler()

Non-argument constructor for implementations.

Method Detail

transformArgumentsForExport

public Map<String,String> transformArgumentsForExport(String className,
                                                      Map<String,String> args,
                                                      com.botronsoft.cmj.spi.configuration.ExportContext exportContext)

Specified by:

transformArgumentsForExport in interface com.botronsoft.cmj.spi.configuration.workflow.WorkflowParticipantHandler

transformArgumentsForImport

public Map<String,String> transformArgumentsForImport(String className,
                                                      Map<String,String> args,
                                                      com.botronsoft.cmj.spi.configuration.ImportContext importContext)

Specified by:

transformArgumentsForImport in interface com.botronsoft.cmj.spi.configuration.workflow.WorkflowParticipantHandler

describeArguments

protected abstract void describeArguments()

Implement this method to describe the syntax of transition participant arguments.

See Also:

#condition(String)}, {@link #validator(String)}, {@link #postFunction(String)}.

handleError

protected void handleError(String className,
                           String argumentName,
                           Throwable t)

This method will be invoked when an exception is caught during processing of an argument. The default implementation is to log an error - in this case the original value will be preserved.

Parameters:

className - the fully qualified class name of the currently exported workflow transition participant.

argumentName - the name of the argument that failed to export.

t - throwable when an object is not found.

transformUnhandledArgumentForExport

protected String transformUnhandledArgumentForExport(String className,
                                                     String argName,
                                                     String argValue,
                                                     com.botronsoft.cmj.spi.configuration.ExportContext exportContext)

This method will be invoked for each argument that has not been described in describeArguments(). The default behavior is to return the same value.

Parameters:

className - the fully qualified class name of the currently exported workflow transition participant.

argName - the name of the argument.

argValue - the raw value of the argument.

exportContext - the context of the export operation.

Returns:

the transformed value of the argument.

transformUnhandledArgumentForImport

protected String transformUnhandledArgumentForImport(String className,
                                                     String argName,
                                                     String argValue,
                                                     com.botronsoft.cmj.spi.configuration.ImportContext importContext)

This method will be invoked for each argument that has not been described in describeArguments(). The default behavior is to return the same value.

Parameters:

className - the fully qualified class name of the currently imported workflow transition participant.

argName - the name of the argument.

argValue - the value of the argument.

importContext - the context of the import operation.

Returns:

the transformed value of the argument that will be effectively stored for the corresponding transition participant.

condition

protected final ArgumentContainerDescriptor condition(String className)

Describes the syntax of the different arguments of a condition.

Parameters:

className - the fully qualified class name of the condition.

Returns:

the descriptor which can be used to further describe the arguments.

validator

protected final ArgumentContainerDescriptor validator(String className)

Describes the syntax of the different arguments of a validator.

Parameters:

className - the fully qualified class name of the validator.

Returns:

the descriptor which can be used to further describe the arguments.

postFunction

protected final ArgumentContainerDescriptor postFunction(String className)

Describes the syntax of the different arguments of a post-function.

Parameters:

className - the fully qualified class name of the post-function.

Returns:

the descriptor which can be used to further describe the arguments.