oracle.odi.domain.runtime.session

Class OdiSessionCustomStep

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.runtime.common.AbstractRuntimeStep

oracle.odi.domain.runtime.session.OdiSessionCustomStep

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IRepositoryEntity

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 OdiSessionCustomSteps of OdiSession using OdiSession.getSessionCustomSteps() method.

Since:

12.1

See Also:

OdiSessionBlueprintStep, OdiSession.getSessionCustomSteps(), OdiSession.addSessionCustomStep(OdiSessionCustomStep), Serialized Form

Method Summary

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.
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.

Methods inherited from class oracle.odi.domain.runtime.common.AbstractRuntimeStep

getGenerationInfo, getMaxErrorCount, getStepNumber, isMaxErrorCountAsPercentage, setGenerationInfo

Methods inherited from class oracle.odi.domain.support.AbstractRepositoryEntity

equals, getBigNumericId, getGlobalId, getNumericId, getParent, hashCode, toString

Methods inherited from class oracle.odi.domain.support.BusinessObject

clone

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

createSessionCustomStep

public static OdiSessionCustomStep createSessionCustomStep(OdiSessionBlueprintStep pSessionBlueprintStep)

Constructs new 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.

Parameters:

pSessionBlueprintStep - an OdiSessionBlueprintStep

Returns:

new overriding step

See Also:

OdiSession#addSessionCustomStep(OdiSessionCustomStep)}

createOnConnectStep

public static OdiSessionCustomStep createOnConnectStep()

FOR INTERNAL USE ONLY.

Constructs new OnConnect step. Such step has no related blueprint step.

The returned step should be added to OdiSession.

Returns:

new OnConnect step

See Also:

OdiSession#addSessionCustomStep(OdiSessionCustomStep)}

createOnDisconnectStep

public static OdiSessionCustomStep createOnDisconnectStep()

FOR INTERNAL USE ONLY.

Constructs new OnDisconnect step. Such step has no related blueprint step.

The returned step should be added to OdiSession.

Returns:

new OnDisconnect step

See Also:

OdiSession#addSessionCustomStep(OdiSessionCustomStep)}

getInternalId

public java.io.Serializable getInternalId()

Description copied from interface: IRepositoryEntity

Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.

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.

Returns:

the persistence identity of this instance

setMaxErrorCount

public void setMaxErrorCount(int pMaxErrorCount)

Specifies the max error allowed for step.

Parameters:

pMaxErrorCount - the max error count

See Also:

AbstractRuntimeStep.getMaxErrorCount()

setMaxErrorCountAsPercentage

public void setMaxErrorCountAsPercentage(boolean pMaxErrorCountAsPercentage)

Specifies whether max error count value should be percentage.

Parameters:

pMaxErrorCountAsPercentage - max error count as percentage

See Also:

AbstractRuntimeStep.isMaxErrorCountAsPercentage()

getSessionId

public java.lang.Number getSessionId()

Returns the ID of OdiSession.

Returns:

session ID

getSessionBlueprintStep

public OdiSessionBlueprintStep getSessionBlueprintStep()

Returns the OdiSessionBlueprintStep, which values are overridden in this OdiSessionCustomStep.

Returns:

OdiSessionBlueprintStep

getType

public StepType getType()

Returns the type of this OdiSessionCustomStep. This would be the type of underlying OdiSessionBlueprintStep for overriding step.

Overrides:

getType in class AbstractRuntimeStep

Returns:

step type

getName

public java.lang.String getName()

Returns the name of this OdiSessionCustomStep. This would be the type of underlying OdiSessionBlueprintStep for overriding step.

Overrides:

getName in class AbstractRuntimeStep

Returns:

step name

setName

public void setName(java.lang.String pName)

FOR INTERNAL USE ONLY.

Specifies the step name for OnConnect/OnDisconnect step.

Parameters:

pName - step name

isContextForced

public boolean isContextForced()

Returns true if context is forced for underlying OdiSessionBlueprintStep, false - otherwise.

This is relevant to overriding OdiSessionCustomStep only. False will be always returned for OnConnect / OnDisconnect custom steps.

Overrides:

isContextForced in class AbstractRuntimeStep

Returns:

whether context is forced

getContextCode

public java.lang.String getContextCode()

Returns the context code for underlying OdiSessionBlueprintStep.

This is relevant to overriding OdiSessionCustomStep only. Null will be always returned for OnConnect / OnDisconnect custom steps.

Overrides:

getContextCode in class AbstractRuntimeStep

Returns:

the context code

getVariableName

public java.lang.String getVariableName()

Returns the variable name for underlying OdiSessionBlueprintStep.

This is relevant to overriding OdiSessionCustomStep only. Null will be always returned for OnConnect / OnDisconnect custom steps.

Overrides:

getVariableName in class AbstractRuntimeStep

Returns:

the variable name

getVariableOperator

public VariableOperator getVariableOperator()

Returns the variable operator for underlying OdiSessionBlueprintStep.

This is relevant to overriding OdiSessionCustomStep only. Null will be always returned for OnConnect / OnDisconnect custom steps.

Overrides:

getVariableOperator in class AbstractRuntimeStep

Returns:

the variable operator

getVariableIncrement

public java.lang.Number getVariableIncrement()

Returns the variable increment for underlying OdiSessionBlueprintStep.

This is relevant to overriding OdiSessionCustomStep only. Null will be always returned for OnConnect / OnDisconnect custom steps.

Overrides:

getVariableIncrement in class AbstractRuntimeStep

Returns:

the variable increment

getVariableValue

public java.lang.String getVariableValue()

Returns the variable value for underlying OdiSessionBlueprintStep.

This is relevant to overriding OdiSessionCustomStep only. Null will be always returned for OnConnect / OnDisconnect custom steps.

Overrides:

getVariableValue in class AbstractRuntimeStep

Returns:

the variable value

getNextStepAfterSuccess

public OdiSessionBlueprintStep getNextStepAfterSuccess()

Returns the next OdiSessionBlueprintStep in successful execution sequence.

This is relevant to overriding OdiSessionCustomStep only. Null will be always returned for OnConnect / OnDisconnect custom steps.

Returns:

the next OdiSessionBlueprintStep after success

getOkExitCode

public java.lang.String getOkExitCode()

Returns the exit code on success for underlying OdiSessionBlueprintStep.

This is relevant to overriding OdiSessionCustomStep only. Null will be always returned for OnConnect / OnDisconnect custom steps.

Overrides:

getOkExitCode in class AbstractRuntimeStep

Returns:

the exit code on success

getNextStepAfterFailure

public OdiSessionBlueprintStep getNextStepAfterFailure()

Returns the next 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.

Returns:

the next OdiSessionBlueprintStep after failure

getKoExitCode

public java.lang.String getKoExitCode()

Returns the exit code on failure for underlying OdiSessionBlueprintStep.

This is relevant to overriding OdiSessionCustomStep only. Null will be always returned for OnConnect / OnDisconnect custom steps.

Overrides:

getKoExitCode in class AbstractRuntimeStep

Returns:

the exit code on failure

getFailureRetryNumber

public int getFailureRetryNumber()

Returns the retry number on failure for underlying OdiSessionBlueprintStep.

This is relevant to overriding OdiSessionCustomStep only. 0 will be always returned for OnConnect / OnDisconnect custom steps.

Overrides:

getFailureRetryNumber in class AbstractRuntimeStep

Returns:

the retry number on failure

getFailureRetryDelay

public int getFailureRetryDelay()

Returns the delay in milliseconds between retries on failure for underlying. OdiSessionBlueprintStep.

This is relevant to overriding OdiSessionCustomStep only. 0 will be always returned for OnConnect / OnDisconnect custom steps.

Overrides:

getFailureRetryDelay in class AbstractRuntimeStep

Returns:

the delay between retries

getTargetLogicalSchemaName

public java.lang.String getTargetLogicalSchemaName()

Returns the target logical schema name for underlying OdiSessionBlueprintStep.

This is relevant to overriding OdiSessionCustomStep only. Null will be always returned for OnConnect / OnDisconnect custom steps.

Overrides:

getTargetLogicalSchemaName in class AbstractRuntimeStep

Returns:

the target logical schema name

getTargetModelCode

public java.lang.String getTargetModelCode()

Returns the target model code for underlying OdiSessionBlueprintStep.

This is relevant to overriding OdiSessionCustomStep only. Null will be always returned for OnConnect / OnDisconnect custom steps.

Overrides:

getTargetModelCode in class AbstractRuntimeStep

Returns:

the target model code

getTargetTableName

public java.lang.String getTargetTableName()

Returns the target table name for underlying OdiSessionBlueprintStep.

This is relevant to overriding OdiSessionCustomStep only. Null will be always returned for OnConnect / OnDisconnect custom steps.

Overrides:

getTargetTableName in class AbstractRuntimeStep

Returns:

the target table name

getTargetResourceName

public java.lang.String getTargetResourceName()

Returns the target resource name for underlying OdiSessionBlueprintStep.

This is relevant to overriding OdiSessionCustomStep only. Null will be always returned for OnConnect / OnDisconnect custom steps.

Overrides:

getTargetResourceName in class AbstractRuntimeStep

Returns:

the target resource name

getLogMethod

public StepLoggingMethod getLogMethod()

Returns the logging method for underlying OdiSessionBlueprintStep.

This is relevant to overriding OdiSessionCustomStep only. Null will be always returned for OnConnect / OnDisconnect custom steps.

Overrides:

getLogMethod in class AbstractRuntimeStep

Returns:

the logging method

isOkExit

public boolean isOkExit()

Returns 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.

Overrides:

isOkExit in class AbstractRuntimeStep

Returns:

true if exit required on success, false - otherwise

isKoExit

public boolean isKoExit()

Returns 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.

Overrides:

isKoExit in class AbstractRuntimeStep

Returns:

true if exit required on failure, false - otherwise

isCleanupOnError

public boolean isCleanupOnError()

Returns true if cleanup tasks should be performed on error, false otherwise.

This is relevant to overriding OdiSessionCustomStep only. False will be always returned for OnConnect / OnDisconnect custom steps.

Overrides:

isCleanupOnError in class AbstractRuntimeStep

Returns:

if cleanup tasks should be performed