com.taleo.integration.client.customstep.control
Class FilterExportErrorPostStep

java.lang.Object
  extended by com.taleo.integration.client.step.BaseStep
      extended by com.taleo.integration.client.step.BaseCustomStep
          extended by com.taleo.integration.client.customstep.BaseCustomStep
              extended by com.taleo.integration.client.customstep.control.FilterExportErrorPostStep
All Implemented Interfaces:
com.taleo.integration.client.step.CustomStep, com.taleo.integration.client.step.Step

public class FilterExportErrorPostStep
extends BaseCustomStep

Post-processing step to filter export errors matching a pattern and exit the process with a given code.

This step is useful to allow interpreting errors in the calling job using a specific error code.

This step takes all parameters from its base class BaseCustomStep and the following additional parameters:

Many of those steps can be chained in sequence to catch different errors and exit with different codes. Typically, this step or step chain will be ended with a RaiseExportErrorPostStep, so that if none of the filters match, an exception will be raised.

When setting the pattern, make sure to follow RegEx syntax, taking into consideration that some characters may need to be escaped. Also, multiple patterns can be separated with the | character meaning OR in RegEx. If an error has multiple reasons, the pattern will be tested with each of them for the first one that matches.

This class is dependent on:

Here is an example of how to define this custom step in the TCC configuration file:

Author:
Romain Guay, Taleo Corporation

Field Summary
 
Fields inherited from class com.taleo.integration.client.customstep.BaseCustomStep
parameterNames
 
Fields inherited from class com.taleo.integration.client.step.BaseCustomStep
parameters
 
Fields inherited from class com.taleo.integration.client.step.BaseStep
commType, ERROR_NULL_GLOBAL_CONFIG, ERROR_NULL_PIPELINE, ERROR_NULL_STEP_CONFIG, productCode, tempFolder, type, version
 
Constructor Summary
FilterExportErrorPostStep()
          Constructor without arguments.
 
Method Summary
 void execute(java.io.File file)
          Execute the step by matching error message.
 void execute(com.taleo.ws.integration.client.Pipeline pipeline)
           
 java.lang.String getDescription()
           
 int getExitCode()
          Get the exit code.
 java.lang.String getIdentifier()
           
 java.lang.String getName()
           
 java.lang.String getPattern()
          Get the pattern.
 void init(com.taleo.ws.integration.client.GlobalConfig config)
           
 void setExitCode(int exitCode)
          Set the exit code.
 void setPattern(java.lang.String pattern)
          Set the pattern.
 
Methods inherited from class com.taleo.integration.client.customstep.BaseCustomStep
createTempFile, createTempFile, getEncoding, getTempFolder, isActive, registerParameterName, setActive, setEncoding, validateParameterNames
 
Methods inherited from class com.taleo.integration.client.step.BaseCustomStep
getSupportedPipeline, getType, init
 
Methods inherited from class com.taleo.integration.client.step.BaseStep
getAllProcessSupportPipeline, getCurrentFile, getCurrentFile, getCurrentMessage, getPostProcessSupportPipeline, getPreProcessSupportPipeline, isOriginalFile, validateLastStepType, validateMessageType, validatePipeline
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.taleo.integration.client.step.Step
validatePipeline
 

Constructor Detail

FilterExportErrorPostStep

public FilterExportErrorPostStep()
Constructor without arguments.

Method Detail

getIdentifier

public java.lang.String getIdentifier()
Specified by:
getIdentifier in interface com.taleo.integration.client.step.CustomStep
Specified by:
getIdentifier in interface com.taleo.integration.client.step.Step
Specified by:
getIdentifier in class com.taleo.integration.client.step.BaseCustomStep

getPattern

public java.lang.String getPattern()
Get the pattern.

Returns:

setPattern

public void setPattern(java.lang.String pattern)
Set the pattern.

Parameters:
pattern -

getExitCode

public int getExitCode()
Get the exit code.

Returns:

setExitCode

public void setExitCode(int exitCode)
Set the exit code.

Parameters:
exitCode -

getDescription

public java.lang.String getDescription()
Specified by:
getDescription in interface com.taleo.integration.client.step.CustomStep
Specified by:
getDescription in interface com.taleo.integration.client.step.Step
Specified by:
getDescription in class com.taleo.integration.client.step.BaseCustomStep

getName

public java.lang.String getName()
Specified by:
getName in interface com.taleo.integration.client.step.CustomStep
Specified by:
getName in interface com.taleo.integration.client.step.Step
Specified by:
getName in class com.taleo.integration.client.step.BaseCustomStep

init

public void init(com.taleo.ws.integration.client.GlobalConfig config)
Overrides:
init in class BaseCustomStep

execute

public void execute(com.taleo.ws.integration.client.Pipeline pipeline)
             throws com.taleo.integration.client.step.StepException
Throws:
com.taleo.integration.client.step.StepException

execute

public void execute(java.io.File file)
             throws java.io.IOException,
                    com.taleo.integration.client.workflow.WorkflowException
Execute the step by matching error message.

Parameters:
file - The result file being processed.
Throws:
java.io.IOException
com.taleo.integration.client.workflow.WorkflowException