com.highqsoft.moma.rules.utils

Class FinalizerRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.moma.rules.utils.FinalizerRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF

public class FinalizerRule
extends AbstractImplementation
implements ExecutableIF

\page UtilsRules \section rules_com_highqsoft_moma_rules_utils_FinalizerRule FinalizerRule \addindex FinalizerRule \addindex finalize Return writer for the Kiss import project. Does all the cleanup like moving the files out of the way, writing the logfile and so on. Type: Implementation \par Properties \li \b ZipFileRef (required, no default, DT_STRING)
Reference to the Zipfile handler in the context. \li \b ResultLogFile (required, no default, DT_STRING)
File where the overall result is written to. \li \b FailedDirectory (required, no default, DT_STRING)
Directory to write not imported files to. \li \b SuccessDirectory (required, no default, DT_STRING)
Directory to write successfully imported files to. \li \b FileHandling (optional, default "MOVE", DT_STRING)
Indicates the action that should be used to handle files after operations. Possible values are MOVE, COPY, NONE \li \b ReasonForErrorRef (required, no default, DT_STRING)
Reference to a String that holds the reason of the error in case of a failure. \li \b IgnoreIncompleteLogErrors (optional, default false, DT_BOOLEAN)
If you set this true the testruns with incomplete logfiles are not reported in the import logfile. \li \b UsedTargetPathProperty (required, no default, DT_STRING)
Name of the property where the used target path is stored (The path the zip file was copied or moved to).

Field Summary

Fields inherited from class com.highqsoft.xsd.AbstractImplementation

arguments, ctx, descriptor, NEW_LINE

Constructor Summary

Constructors

Constructor and Description
FinalizerRule() Constructur of the FinalizerRule.

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() The execute method that does all the finalization - Write a log entry to the result logfile - Copy or Move the zip- and logfile to another directory (target depends on success or failure) - Delete the extracted files
void	init() Initialize the FinalizerRule
void	terminate() Terminate the execution.

Methods inherited from class com.highqsoft.xsd.AbstractImplementation

addAttributesToNameValueUnitArray, addAttributeToNameValueUnitArray, addStringValueToNameValueUnitArray, checkDirectoy, checkDirectoy, checkDirectoy, checkFile, checkFile, checkFile, checkIntValue, checkStringValue, compressNvuArray, createMessageFromPropertyFile, createMessageFromPropertyFile, createMessageFromPropertyFile, createTsUnionFromObject, deleteRowWithAttributes, getArguments, getContext, getDescriptor, getListFromProperty, getMandatoryProperty, getMandatoryProperty, getMandatoryPropertyAsInt, getMandatoryPropertyAsList, getMandatoryPropertyWithRuleException, getNvuArrayFromMap, getNvuArrayFromMap, getNvuObjectWithName, getNvuObjectWithName, getNvuObjectWithName, getOdsCacheFromProperty, getOptioanlPropertyAsInt, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsList, makeUpperCaseKeyword, removeAttributeFromNameValueUnitArray, removeAttributeFromNameValueUnitArray, setArguments, setContext, setDescriptor

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highqsoft.xsd.ImplementationIF

getContext, getDescriptor, setArguments, setContext, setDescriptor

Constructor Detail

FinalizerRule

public FinalizerRule()

Constructur of the FinalizerRule.

Method Detail

execute

public void execute()
             throws ExecutableException

The execute method that does all the finalization - Write a log entry to the result logfile - Copy or Move the zip- and logfile to another directory (target depends on success or failure) - Delete the extracted files

Specified by:

execute in interface ExecutableIF

Throws:

ExecutableException - if execution fails.

See Also:

ExecutableIF.execute()

terminate

public void terminate()
               throws TerminationException

Description copied from interface: ExecutableIF

Terminate the execution.

Specified by:

terminate in interface ExecutableIF

Throws:

TerminationException - if termination fails.

init

public void init()
          throws InitializationFailedException

Initialize the FinalizerRule

Specified by:

init in interface ImplementationIF

Specified by:

init in class AbstractImplementation

Throws:

InitializationFailedException - - When one of the required arguments does not exist.

See Also:

com.highqsoft.xsd.ImplentationIF#init()