public class OdiSessionCustomStep extends AbstractRuntimeStep
OdiSessionCustomStep
represents the step which is related to only one specific
OdiSession
. This can be OnConnect or OnDisconnect
step, which in general are not common across different sessions with common OdiSessionBlueprint
.
Also OdiSessionCustomStep
can be a step overriding some properties of original
OdiSessionBlueprintStep
. In this case OdiSessionCustomStep
holds reference to
OdiSessionBlueprintStep
, which properties are overridden.There are two Step's properties
available for modification: maxErrorCount (Maximum Error Number Allowed) and
maxErrorCountAsPercentage (Maximum Error Number Allowed as Percentage flag).
It may be useful to modify them between OdiSession
restarts
for debugging/fixing the execution. To override some properties of OdiSessionBlueprintStep
,
new instance of OdiSessionCustomStep
should be created in runtime repository. Runtime
Agent will take its values, instead of using initial values from blueprint then.
OdiSessionCustomStep
can be created by user after OdiSession
executed once at least. It is possible to modify this object during its life-cycle.
It remains in repository until the related OdiSession
is removed.
User can obtain all OdiSessionCustomStep
s of OdiSession
using OdiSession.getSessionCustomSteps()
method.
Modifier and Type | Method and Description |
---|---|
static OdiSessionCustomStep |
createOnConnectStep()
FOR INTERNAL USE ONLY.
|
static OdiSessionCustomStep |
createOnDisconnectStep()
FOR INTERNAL USE ONLY.
|
static OdiSessionCustomStep |
createSessionCustomStep(OdiSessionBlueprintStep pSessionBlueprintStep)
Constructs new
OdiSessionCustomStep overriding the specified
OdiSessionBlueprintStep . |
java.lang.String |
getContextCode()
Returns the context code for underlying
OdiSessionBlueprintStep . |
int |
getFailureRetryDelay()
Returns the delay in milliseconds between retries on failure for underlying.
|
int |
getFailureRetryNumber()
Returns the retry number on failure for underlying
OdiSessionBlueprintStep . |
java.io.Serializable |
getInternalId()
Provides a common getter for the persistence layer to obtain an identity,
irrespective of the actual type of identity used.
|
java.lang.String |
getKoExitCode()
Returns the exit code on failure for underlying
OdiSessionBlueprintStep . |
StepLoggingMethod |
getLogMethod()
Returns the logging method for underlying
OdiSessionBlueprintStep . |
java.lang.String |
getName()
Returns the name of this
OdiSessionCustomStep . |
OdiSessionBlueprintStep |
getNextStepAfterFailure()
Returns the next
OdiSessionBlueprintStep in sequence if this step failed
during execution. |
OdiSessionBlueprintStep |
getNextStepAfterSuccess()
Returns the next
OdiSessionBlueprintStep in successful execution sequence. |
java.lang.String |
getOkExitCode()
Returns the exit code on success for underlying
OdiSessionBlueprintStep . |
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities.
|
OdiSessionBlueprintStep |
getSessionBlueprintStep()
Returns the
OdiSessionBlueprintStep , which values are overridden in this
OdiSessionCustomStep . |
java.lang.Number |
getSessionId()
Returns the ID of
OdiSession . |
java.lang.String |
getTargetLogicalSchemaName()
Returns the target logical schema name for underlying
OdiSessionBlueprintStep . |
java.lang.String |
getTargetModelCode()
Returns the target model code for underlying
OdiSessionBlueprintStep . |
java.lang.String |
getTargetResourceName()
Returns the target resource name for underlying
OdiSessionBlueprintStep . |
java.lang.String |
getTargetTableName()
Returns the target table name for underlying
OdiSessionBlueprintStep . |
StepType |
getType()
Returns the type of this
OdiSessionCustomStep . |
java.lang.Number |
getVariableIncrement()
Returns the variable increment for underlying
OdiSessionBlueprintStep . |
java.lang.String |
getVariableName()
Returns the variable name for underlying
OdiSessionBlueprintStep . |
VariableOperator |
getVariableOperator()
Returns the variable operator for underlying
OdiSessionBlueprintStep . |
java.lang.String |
getVariableValue()
Returns the variable value for underlying
OdiSessionBlueprintStep . |
boolean |
isCleanupOnError()
Returns true if cleanup tasks should be performed on error, false otherwise.
|
boolean |
isContextForced()
Returns true if context is forced for underlying
OdiSessionBlueprintStep ,
false - otherwise. |
boolean |
isKoExit()
Returns
true if exit required on failure, false - otherwise. |
boolean |
isOkExit()
Returns
true if exit required on success, false - otherwise. |
void |
setMaxErrorCount(int pMaxErrorCount)
Specifies the max error allowed for step.
|
void |
setMaxErrorCountAsPercentage(boolean pMaxErrorCountAsPercentage)
Specifies whether max error count value should be percentage.
|
void |
setName(java.lang.String pName)
FOR INTERNAL USE ONLY.
|
getGenerationInfo, getMaxErrorCount, getStepNumber, isMaxErrorCountAsPercentage, setGenerationInfo
public static OdiSessionCustomStep createSessionCustomStep(OdiSessionBlueprintStep pSessionBlueprintStep)
OdiSessionCustomStep
overriding the specified
OdiSessionBlueprintStep
. This will inform the Runtime Agent that modifiable
step's values were overridden between OdiSession
restarts.
The returned overriding step should be added to OdiSession
.
pSessionBlueprintStep
- an OdiSessionBlueprintStep
OdiSession#addSessionCustomStep(OdiSessionCustomStep)}
public static OdiSessionCustomStep createOnConnectStep()
Constructs new OnConnect step. Such step has no related blueprint step.
The returned step should be added to OdiSession
.
OdiSession#addSessionCustomStep(OdiSessionCustomStep)}
public static OdiSessionCustomStep createOnDisconnectStep()
Constructs new OnDisconnect step. Such step has no related blueprint step.
The returned step should be added to OdiSession
.
OdiSession#addSessionCustomStep(OdiSessionCustomStep)}
public java.io.Serializable getInternalId()
IRepositoryEntity
Typically a subclass will delegate to a public
SomePrimitiveWrapper getId()
method. The necessity for the
getInternalId()
abstract method is solely because the
persistence layer needs a way of obtaining the identity irrespective of
the actual identity implementation choice.
Returning null
from this method will indicate the object has
never been saved. This will likely be relied on by some DAO
implementations.
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
public void setMaxErrorCount(int pMaxErrorCount)
pMaxErrorCount
- the max error countAbstractRuntimeStep.getMaxErrorCount()
public void setMaxErrorCountAsPercentage(boolean pMaxErrorCountAsPercentage)
pMaxErrorCountAsPercentage
- max error count as percentageAbstractRuntimeStep.isMaxErrorCountAsPercentage()
public java.lang.Number getSessionId()
OdiSession
.public OdiSessionBlueprintStep getSessionBlueprintStep()
OdiSessionBlueprintStep
, which values are overridden in this
OdiSessionCustomStep
.OdiSessionBlueprintStep
public StepType getType()
OdiSessionCustomStep
. This would be the type of underlying
OdiSessionBlueprintStep
for overriding step.getType
in class AbstractRuntimeStep
public java.lang.String getName()
OdiSessionCustomStep
. This would be the type of underlying
OdiSessionBlueprintStep
for overriding step.getName
in class AbstractRuntimeStep
public void setName(java.lang.String pName)
Specifies the step name for OnConnect/OnDisconnect step.
pName
- step namepublic boolean isContextForced()
OdiSessionBlueprintStep
,
false - otherwise.
This is relevant to overriding OdiSessionCustomStep
only.
False will be always returned for OnConnect / OnDisconnect custom steps.
isContextForced
in class AbstractRuntimeStep
public java.lang.String getContextCode()
OdiSessionBlueprintStep
.
This is relevant to overriding OdiSessionCustomStep
only.
Null will be always returned for OnConnect / OnDisconnect custom steps.
getContextCode
in class AbstractRuntimeStep
public java.lang.String getVariableName()
OdiSessionBlueprintStep
.
This is relevant to overriding OdiSessionCustomStep
only.
Null will be always returned for OnConnect / OnDisconnect custom steps.
getVariableName
in class AbstractRuntimeStep
public VariableOperator getVariableOperator()
OdiSessionBlueprintStep
.
This is relevant to overriding OdiSessionCustomStep
only.
Null will be always returned for OnConnect / OnDisconnect custom steps.
getVariableOperator
in class AbstractRuntimeStep
public java.lang.Number getVariableIncrement()
OdiSessionBlueprintStep
.
This is relevant to overriding OdiSessionCustomStep
only.
Null will be always returned for OnConnect / OnDisconnect custom steps.
getVariableIncrement
in class AbstractRuntimeStep
public java.lang.String getVariableValue()
OdiSessionBlueprintStep
.
This is relevant to overriding OdiSessionCustomStep
only.
Null will be always returned for OnConnect / OnDisconnect custom steps.
getVariableValue
in class AbstractRuntimeStep
public OdiSessionBlueprintStep getNextStepAfterSuccess()
OdiSessionBlueprintStep
in successful execution sequence.
This is relevant to overriding OdiSessionCustomStep
only.
Null will be always returned for OnConnect / OnDisconnect custom steps.
OdiSessionBlueprintStep
after successpublic java.lang.String getOkExitCode()
OdiSessionBlueprintStep
.
This is relevant to overriding OdiSessionCustomStep
only.
Null will be always returned for OnConnect / OnDisconnect custom steps.
getOkExitCode
in class AbstractRuntimeStep
public OdiSessionBlueprintStep getNextStepAfterFailure()
OdiSessionBlueprintStep
in sequence if this step failed
during execution.
This is relevant to overriding OdiSessionCustomStep
only.
Null will be always returned for OnConnect / OnDisconnect custom steps.
OdiSessionBlueprintStep
after failurepublic java.lang.String getKoExitCode()
OdiSessionBlueprintStep
.
This is relevant to overriding OdiSessionCustomStep
only.
Null will be always returned for OnConnect / OnDisconnect custom steps.
getKoExitCode
in class AbstractRuntimeStep
public int getFailureRetryNumber()
OdiSessionBlueprintStep
.
This is relevant to overriding OdiSessionCustomStep
only.
0 will be always returned for OnConnect / OnDisconnect custom steps.
getFailureRetryNumber
in class AbstractRuntimeStep
public int getFailureRetryDelay()
OdiSessionBlueprintStep
.
This is relevant to overriding OdiSessionCustomStep
only.
0 will be always returned for OnConnect / OnDisconnect custom steps.
getFailureRetryDelay
in class AbstractRuntimeStep
public java.lang.String getTargetLogicalSchemaName()
OdiSessionBlueprintStep
.
This is relevant to overriding OdiSessionCustomStep
only.
Null will be always returned for OnConnect / OnDisconnect custom steps.
getTargetLogicalSchemaName
in class AbstractRuntimeStep
public java.lang.String getTargetModelCode()
OdiSessionBlueprintStep
.
This is relevant to overriding OdiSessionCustomStep
only.
Null will be always returned for OnConnect / OnDisconnect custom steps.
getTargetModelCode
in class AbstractRuntimeStep
public java.lang.String getTargetTableName()
OdiSessionBlueprintStep
.
This is relevant to overriding OdiSessionCustomStep
only.
Null will be always returned for OnConnect / OnDisconnect custom steps.
getTargetTableName
in class AbstractRuntimeStep
public java.lang.String getTargetResourceName()
OdiSessionBlueprintStep
.
This is relevant to overriding OdiSessionCustomStep
only.
Null will be always returned for OnConnect / OnDisconnect custom steps.
getTargetResourceName
in class AbstractRuntimeStep
public StepLoggingMethod getLogMethod()
OdiSessionBlueprintStep
.
This is relevant to overriding OdiSessionCustomStep
only.
Null will be always returned for OnConnect / OnDisconnect custom steps.
getLogMethod
in class AbstractRuntimeStep
public boolean isOkExit()
true
if exit required on success, false
- otherwise.
This is relevant to overriding OdiSessionCustomStep
only.
False will be always returned for OnConnect / OnDisconnect custom steps.
isOkExit
in class AbstractRuntimeStep
true
if exit required on success, false
- otherwisepublic boolean isKoExit()
true
if exit required on failure, false
- otherwise.
This is relevant to overriding OdiSessionCustomStep
only.
False will be always returned for OnConnect / OnDisconnect custom steps.
isKoExit
in class AbstractRuntimeStep
true
if exit required on failure, false
- otherwisepublic boolean isCleanupOnError()
This is relevant to overriding OdiSessionCustomStep
only.
False will be always returned for OnConnect / OnDisconnect custom steps.
isCleanupOnError
in class AbstractRuntimeStep