public final class OdiSessionTaskLog
extends oracle.odi.domain.support.AbstractRepositoryEntity
Execution log of an OdiSession
's task. The task is the smallest execution unit. It corresponds
to a procedure command, assignment of a variable, etc. It is part of the OdiSessionStepLog
-
OdiSessionTaskLog
aggregate.
An OdiSessionTaskLog
life cycle begins when an ODI session's step is run by ODI
Execution Engine. Its life cycle ends when enclosing OdiSessionStepLog
(or OdiSession
) is
removed from runtime repository.
Modifier and Type | Class and Description |
---|---|
static class |
OdiSessionTaskLog.CommitMode
Type safe enum that represents commit mode applied to a task when executed.
|
static class |
OdiSessionTaskLog.IsolationLevel
Type safe enum that represents DB isolation level applied to a task when executed.
|
static class |
OdiSessionTaskLog.LogCounter
Type safe enum that represents different log counter types defined for a task.
|
static class |
OdiSessionTaskLog.ValueTrackingMode
Type safe enum that represents OdiSessionVariable and OdiSessionSequence value tracking mode.
|
Constructor and Description |
---|
OdiSessionTaskLog(OdiSessionStepLog stepLog,
OdiSessionBlueprintTask task) |
Modifier and Type | Method and Description |
---|---|
java.util.List |
getChildTaskLogs()
Convenience method to obtain the list of
OdiSessionTaskLog s of direct child
OdiSessionBluepintTask s. |
java.lang.Integer |
getDeleteCount()
Deprecated.
consider using
getDeleteCountLong() instead. |
java.lang.Long |
getDeleteCountLong()
Relevant for Interfaces and Procedures and any execution that manipulates data.
|
java.lang.Integer |
getDuration()
Returns duration of this
OdiSessionTaskLog , or null if undefined. |
java.util.Date |
getEndTime()
Returns end time of this
OdiSessionTaskLog , or null if not yet finished. |
java.lang.Integer |
getErrorCount()
Deprecated.
consider using
getErrorCountLong() instead. |
java.lang.Long |
getErrorCountLong()
Returns the error count.
|
java.lang.String |
getErrorMessage()
Returns error message of this
OdiSessionTaskLog . |
int |
getExecutionCount()
Deprecated.
As of ODI 11.1.1.5 this method is not supported anymore and the
executionCount of a task log must now be obtained from the enclosing
OdiSessionStepLog
since executionCount of a setp log and task log are the same |
java.lang.String |
getExternalId()
Obtains the Oozie task Id for this task
|
java.lang.String |
getExternalUrl()
Obtains the Url of the Oozie TaskTracker for this
OdiSessionTaskLog for Oozie sessions and returns null for ODI native sessions. |
java.lang.Integer |
getInsertCount()
Deprecated.
consider using
getInsertCountLong() instead. |
java.lang.Long |
getInsertCountLong()
Relevant for Interfaces and Procedures and any execution that manipulates data.
|
java.io.Serializable |
getInternalId()
Provides a common getter for the persistence layer to obtain an identity,
irrespective of the actual type of identity used.
|
int |
getInternalOrder()
Deprecated.
replaced by
#getTask()#getOrigOrder() |
java.util.Date |
getLastUpdated()
Obtains the date that this
OdiSessionTaskLog was last updated. |
OdiSessionTaskLog.LogCounter |
getLogCounter()
Returns LogCounter used by this
OdiSessionTaskLog . |
boolean |
getLogFinalCommand()
Returns whether the final execution command text should be logged for this
OdiSessionTaskLog . |
LogLevel |
getLogLevel()
Deprecated.
replaced by
#getTask()#getLogLevel() |
OdiSessionTaskLog |
getParentTaskLog()
Convenience method to obtain the
OdiSessionTaskLog of direct parent
OdiSessionBluepintTask . |
java.lang.Number |
getProgress()
Obtains the progress of this
OdiSessionTaskLog
where decimal number representing an amount completed. |
java.lang.Integer |
getRecordCount()
Deprecated.
consider using
getRecordCountLong() instead. |
java.lang.Long |
getRecordCountLong()
Relevant for Interfaces and Procedures and any execution that manipulates data.
|
java.lang.String |
getResolvedSourceCommand()
Obtains the source command where variable and sequence substitutions (e.g.
|
java.lang.String |
getResolvedTargetCommand()
Obtains the target command where variable and sequence substitutions
(e.g.
|
java.lang.String |
getReturnCode()
Returns return code of this
OdiSessionTaskLog . |
int |
getScenarioTaskNumber()
Deprecated.
replaced by
#getTask()#getOrder() |
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities.
|
OdiSessionBlueprintTask |
getSessionBlueprintTask()
Returns the related task object from session blueprint (
OdiSessionBlueprintTask ). |
OdiSessionCustomTask |
getSessionCustomTask()
Returns the related
OdiSessionCustomTask , if some blueprint values were
overridden between restarts, or if related task is of OnConnect/OnDisconnect type;
null - otherwise. |
OdiSessionStepLog |
getSessionStepLog()
Obtains the enclosing step execution.
|
java.lang.String |
getSourceCommand()
Returns the actual command executed on source.
|
OdiSessionTaskLog.CommitMode |
getSourceCommitMode()
Deprecated.
replaced by
#getTask()#getSourceCommitMode() |
java.lang.String |
getSourceContextCode()
Deprecated.
replaced by
#getTask()#getSourceContextCode() |
java.lang.String |
getSourceDataServerName()
Returns computed source data server name, or null if undefined.
|
OdiSessionTaskLog.IsolationLevel |
getSourceIsolationLevel()
Deprecated.
replaced by
#getTask()#getSourceIsolationLevel() |
java.lang.String |
getSourceLogicalSchemaName()
Deprecated.
replaced by
#getTask()#getSourceLogicalSchemaName() |
java.lang.String |
getSourceTransactionId()
Deprecated.
replaced by
#getTask()#getSourceTransactionChannel() |
java.util.Date |
getStartTime()
Returns start time of this
OdiSessionTaskLog , or null if not yet started. |
Status |
getStatus()
Returns status of this
OdiSessionTaskLog . |
java.lang.String |
getSummaryMessage()
Obtains the Summary Message of the task.
|
java.lang.String |
getTargetCommand()
Returns the actual command executed on target.
|
OdiSessionTaskLog.CommitMode |
getTargetCommitMode()
Deprecated.
replaced by
#getTask()#getTargetCommitMode() |
java.lang.String |
getTargetContextCode()
Deprecated.
replaced by
#getTask()#getTargetContextCode() |
java.lang.String |
getTargetDataServerName()
Returns computed target data server name, or null if undefined.
|
OdiSessionTaskLog.IsolationLevel |
getTargetIsolationLevel()
Deprecated.
replaced by
#getTask()#getTargetIsolationLevel() |
java.lang.String |
getTargetLogicalSchemaName()
Deprecated.
replaced by
#getTask()#getTargetLogicalSchemaName() |
java.lang.String |
getTargetTransactionId()
Deprecated.
replaced by
#getTask()#getTargetTransactionChannel() |
AbstractRuntimeTask |
getTask()
Returns the task which this
OdiSessionTaskLog is related to. |
int |
getTaskLogNumber()
Deprecated.
As of ODI 11.1.1.5 this method is not supported anymore and the
taskLogNumber of a task log must now be obtained from the enclosing
OdiSessionStepLog
since stepNumber of a step log and taskLogNumber are the same |
java.lang.String |
getTaskName1()
Deprecated.
replaced by
#getTask()#getTaskName1() |
java.lang.String |
getTaskName2()
Deprecated.
replaced by
#getTask()#getTaskName2() |
java.lang.String |
getTaskName3()
Gets task name 3 of this
OdiSessionTaskLog , or null if undefined. |
java.util.Collection |
getTrackedSequenceValues()
Obtains the tracked values of session's sequences for this task execution.
|
TaskType |
getType()
Deprecated.
replaced by
#getTask()#getType() |
java.lang.Integer |
getUpdateCount()
Deprecated.
consider using
getUpdateCountLong() instead. |
java.lang.Long |
getUpdateCountLong()
Relevant for Interfaces and Procedures and any execution that manipulates data.
|
OdiSessionTaskLog.ValueTrackingMode |
getValueTrackingMode()
Returns value tracking mode used for this task log.
|
boolean |
isIgnoreError()
Deprecated.
replaced by
#getTask()#isIgnoreError() |
void |
setIgnoreError(boolean pIgnoreError)
Deprecated.
consider creation/editing of
OdiSessionCustomTask instead. |
void |
setSourceCommand(java.lang.String pSourceCmd)
Deprecated.
consider using
OdiSessionCustomTask.setSourceCommand(String) instead |
void |
setSourceDataServerName(java.lang.String pSourceDataServerName)
Set source data server name.
|
void |
setStatus(Status pStatus)
Set the current status of this task execution.
|
void |
setTargetCommand(java.lang.String pTargetCmd)
Deprecated.
consider using
OdiSessionCustomTask.setTargetCommand(String) instead |
void |
setTargetDataServerName(java.lang.String pTargetDataServerName)
Set target data server name.
|
void |
setTaskName3(java.lang.String taskName3) |
public OdiSessionTaskLog(OdiSessionStepLog stepLog, OdiSessionBlueprintTask task)
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 int getInternalOrder()
#getTask()#getOrigOrder()
public TaskType getType()
#getTask()#getType()
public java.lang.String getTaskName1()
#getTask()#getTaskName1()
OdiSessionTaskLog
, or null if undefined.OdiSessionTaskLog
, or null if undefinedpublic java.lang.String getTaskName2()
#getTask()#getTaskName2()
OdiSessionTaskLog
, or null if undefined.OdiSessionTaskLog
, or null if undefinedpublic java.lang.String getTaskName3()
OdiSessionTaskLog
, or null if undefined.OdiSessionTaskLog
, or null if undefinedpublic void setTaskName3(java.lang.String taskName3)
public java.util.Date getStartTime()
OdiSessionTaskLog
, or null if not yet started.OdiSessionTaskLog
, or null if not yet startedpublic java.util.Date getEndTime()
OdiSessionTaskLog
, or null if not yet finished.OdiSessionTaskLog
, or null if not yet finishedpublic java.lang.Integer getDuration()
OdiSessionTaskLog
, or null if undefined.OdiSessionTaskLog
, or null if undefinedpublic Status getStatus()
OdiSessionTaskLog
.OdiSessionTaskLog
setStatus(Status)
public void setStatus(Status pStatus)
pStatus
- the statusgetStatus()
public java.lang.String getReturnCode()
OdiSessionTaskLog
.
The return code is obtained from the execution channel of the task, e.g. operating system code,
database error code, etc. It will be "0" (zero) in case of success.OdiSessionTaskLog
public java.lang.String getErrorMessage()
OdiSessionTaskLog
. Will always be null if not failed.OdiSessionTaskLog
. Will always be null if not failedpublic OdiSessionTaskLog.LogCounter getLogCounter()
OdiSessionTaskLog
.OdiSessionTaskLog
public java.lang.Long getInsertCountLong()
public java.lang.Integer getInsertCount()
getInsertCountLong()
instead.public java.lang.Long getUpdateCountLong()
public java.lang.Integer getUpdateCount()
getUpdateCountLong()
instead.public java.lang.Long getDeleteCountLong()
public java.lang.Integer getDeleteCount()
getDeleteCountLong()
instead.public java.lang.Long getRecordCountLong()
null
if not applicablepublic java.lang.Integer getRecordCount()
getRecordCountLong()
instead.null
if not applicablepublic java.lang.Long getErrorCountLong()
public java.lang.Integer getErrorCount()
getErrorCountLong()
instead.public java.lang.String getSourceContextCode()
#getTask()#getSourceContextCode()
public java.lang.String getSourceLogicalSchemaName()
#getTask()#getSourceLogicalSchemaName()
public java.lang.String getSourceDataServerName()
public void setSourceDataServerName(java.lang.String pSourceDataServerName)
pSourceDataServerName
- public java.lang.String getSourceTransactionId()
#getTask()#getSourceTransactionChannel()
public OdiSessionTaskLog.IsolationLevel getSourceIsolationLevel()
#getTask()#getSourceIsolationLevel()
public OdiSessionTaskLog.CommitMode getSourceCommitMode()
#getTask()#getSourceCommitMode()
public java.lang.String getSourceCommand()
null
if undefinedsetSourceCommand(String)
public void setSourceCommand(java.lang.String pSourceCmd)
OdiSessionCustomTask.setSourceCommand(String)
insteadpSourceCmd
- the source commandgetSourceCommand()
public java.lang.String getTargetContextCode()
#getTask()#getTargetContextCode()
public java.lang.String getTargetLogicalSchemaName()
#getTask()#getTargetLogicalSchemaName()
public java.lang.String getTargetDataServerName()
public void setTargetDataServerName(java.lang.String pTargetDataServerName)
pTargetDataServerName
- public java.lang.String getTargetTransactionId()
#getTask()#getTargetTransactionChannel()
public OdiSessionTaskLog.IsolationLevel getTargetIsolationLevel()
#getTask()#getTargetIsolationLevel()
public OdiSessionTaskLog.CommitMode getTargetCommitMode()
#getTask()#getTargetCommitMode()
public java.lang.String getTargetCommand()
null
if undefinedsetTargetCommand(String)
public void setTargetCommand(java.lang.String pTargetCmd)
OdiSessionCustomTask.setTargetCommand(String)
insteadpTargetCmd
- the target commandgetTargetCommand()
public int getScenarioTaskNumber()
#getTask()#getOrder()
public int getExecutionCount()
OdiSessionStepLog
since executionCount of a setp log and task log are the sameOdiSessionTaskLog
.OdiSessionTaskLog
public int getTaskLogNumber()
OdiSessionStepLog
since stepNumber of a step log and taskLogNumber are the sameOdiSessionTaskLog
's number.OdiSessionTaskLog
's numberpublic LogLevel getLogLevel()
#getTask()#getLogLevel()
OdiSessionTaskLog
.OdiSessionTaskLog
public boolean isIgnoreError()
#getTask()#isIgnoreError()
OdiSessionTaskLog
.true
if errors are ignored, false
otherwisesetIgnoreError(boolean)
public void setIgnoreError(boolean pIgnoreError)
OdiSessionCustomTask
instead.OdiSessionTaskLog
.pIgnoreError
- true
to ignore errors, false
otherwiseisIgnoreError()
public boolean getLogFinalCommand()
OdiSessionTaskLog
.true
if final command text should be logged, false
otherwise.OdiProcedureLine.getLogFinalCommand()
,
OdiProcedureLine.setLogFinalCommand(boolean)
public OdiSessionStepLog getSessionStepLog()
public java.lang.String getResolvedSourceCommand()
Beware, this method is only relevant for debug purpose and must not be used during session execution as the actual task command to be executed.
getSourceCommand()
,
OdiSessionStepLog.getTrackedVariableValues()
public java.lang.String getResolvedTargetCommand()
Beware, this method is only relevant for debug purpose and must not be used during session execution as the actual task command to be executed.
getTargetCommand()
,
OdiSessionStepLog.getTrackedVariableValues()
public java.util.Collection getTrackedSequenceValues()
OdiSessionStepLog.isTrackingEnabled()
,
OdiSessionStepLog#getTrackedSequenceValues()
public java.lang.Number getProgress()
OdiSessionTaskLog
where decimal number representing an amount completed.
0.0 means 0%,
0.5 represents 50% and
1.0 means 100%public java.lang.String getExternalId()
public java.lang.String getExternalUrl()
OdiSessionTaskLog
for Oozie sessions and returns null for ODI native sessions.public java.lang.String getSummaryMessage()
public java.util.Date getLastUpdated()
OdiSessionTaskLog
was last updated.public OdiSessionTaskLog.ValueTrackingMode getValueTrackingMode()
public OdiSessionBlueprintTask getSessionBlueprintTask()
OdiSessionBlueprintTask
).public OdiSessionCustomTask getSessionCustomTask()
OdiSessionCustomTask
, if some blueprint values were
overridden between restarts, or if related task is of OnConnect/OnDisconnect type;
null - otherwise.OdiSessionCustomTask
public OdiSessionTaskLog getParentTaskLog()
OdiSessionTaskLog
of direct parent
OdiSessionBluepintTask
.public java.util.List getChildTaskLogs()
OdiSessionTaskLog
s of direct child
OdiSessionBluepintTask
s.public AbstractRuntimeTask getTask()
OdiSessionTaskLog
is related to.
This could be an instance of OdiSessionBlueprintTask
or OdiSessionCustomTask
in case of OnConnect/OnDisconnect or overridden task.