com.taleo.integration.client.customstep.xml
Class ReplaceSymbolsInQueryPreStep

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.xml.ReplaceSymbolsInQueryPreStep
All Implemented Interfaces:
com.taleo.integration.client.step.CustomStep, com.taleo.integration.client.step.Step

public class ReplaceSymbolsInQueryPreStep
extends BaseCustomStep

Pre-processing step to replace symbols in a SQ-XML request file. Symbols are strings surrounded with square brackets, just like in the configuration files.

This step takes all parameters from its base class BaseCustomStep.

The current implementation gets symbols from the configuration board as well as from Java properties, with the com.taleo.client.symbol prefix. This excludes the default runtime symbols like [CFGFOLDER] and [NOW].

One level of indirection is allowed where a symbol value itself contains a symbol which will be replaced in sequence.

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

Author:
Romain Guay, Taleo Corporation

Field Summary
static java.lang.String PREFIX_SYMBOL_SYSTEM_PROPERTY
           
 
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
ReplaceSymbolsInQueryPreStep()
          Constructor without arguments.
 
Method Summary
 void execute(com.taleo.ws.integration.client.Pipeline pipeline)
           
 java.lang.String getDescription()
           
 java.lang.String getIdentifier()
           
 java.lang.String getName()
           
 com.taleo.ws.integration.client.SupportedPipeline getSupportedPipeline()
           
protected  void transform(java.io.File queryFile, java.io.File outFile)
          Transform the query file.
 
Methods inherited from class com.taleo.integration.client.customstep.BaseCustomStep
createTempFile, createTempFile, getEncoding, getTempFolder, init, isActive, registerParameterName, setActive, setEncoding, validateParameterNames
 
Methods inherited from class com.taleo.integration.client.step.BaseCustomStep
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
 

Field Detail

PREFIX_SYMBOL_SYSTEM_PROPERTY

public static final java.lang.String PREFIX_SYMBOL_SYSTEM_PROPERTY
See Also:
Constant Field Values
Constructor Detail

ReplaceSymbolsInQueryPreStep

public ReplaceSymbolsInQueryPreStep()
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

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

getSupportedPipeline

public com.taleo.ws.integration.client.SupportedPipeline getSupportedPipeline()
Specified by:
getSupportedPipeline in interface com.taleo.integration.client.step.Step
Overrides:
getSupportedPipeline in class com.taleo.integration.client.step.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

transform

protected void transform(java.io.File queryFile,
                         java.io.File outFile)
                  throws javax.xml.transform.TransformerException,
                         java.io.IOException
Transform the query file.

Parameters:
queryFile - The query file.
outFile - The output file.
Throws:
javax.xml.transform.TransformerException
java.io.IOException