com.taleo.integration.client.customstep.control
Class LogContextStep
java.lang.Object
com.taleo.integration.client.step.BaseStep
com.taleo.integration.client.step.BaseCustomStep
com.taleo.integration.client.customstep.BaseCustomStep
com.taleo.integration.client.customstep.csv.BaseCustomCsvStep
com.taleo.integration.client.customstep.control.LogContextStep
- All Implemented Interfaces:
- com.taleo.integration.client.step.CustomStep, com.taleo.integration.client.step.Step
public class LogContextStep
- extends BaseCustomCsvStep
Processing step to set logging context variables.
This step takes all parameters from its base class
BaseCustomCsvStep
and the
following additional parameters:
- All other parameters are added to the Mapped Diagnostic Context (MDC) and which can be used in the PatternLayout within the log
configuration file (log4j.xml). Those variables can be retrieved using %X{*},
where * is the variable name.
For example, by setting a parameter named TouchpointID
to
something identifying the touchpoint, %X{TouchpointID} can be used in the
PatternLayout so that each line in the log identifies the touchpoint. This
improves readability, especially when multiple touchpoints are run
simultaneously.
- Author:
- Romain Guay, Oracle Corporation
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 |
Method Summary |
java.lang.String |
getDescription()
|
java.lang.String |
getIdentifier()
|
java.lang.String |
getMDC(java.lang.String name)
Get an MDC variable by its name. |
java.lang.String |
getName()
|
void |
init(com.taleo.ws.integration.client.GlobalConfig config)
|
void |
setMDC(java.lang.String name,
java.lang.String value)
Set an MDC variable by its name. |
protected void |
validateParameterNames()
Validate the parameters names. |
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 |
LogContextStep
public LogContextStep()
validateParameterNames
protected void validateParameterNames()
- Validate the parameters names.
Override the default method to allow any parameter.
- Overrides:
validateParameterNames
in class BaseCustomStep
getMDC
public java.lang.String getMDC(java.lang.String name)
- Get an MDC variable by its name.
- Parameters:
name
-
- Returns:
setMDC
public void setMDC(java.lang.String name,
java.lang.String value)
- Set an MDC variable by its name.
- Parameters:
name
- value
-
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
init
public void init(com.taleo.ws.integration.client.GlobalConfig config)
- Overrides:
init
in class BaseCustomCsvStep