|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.3.0) E17060-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.odi.domain.support.BusinessObject oracle.odi.domain.support.AbstractRepositoryEntity oracle.odi.domain.support.AbstractOdiEntity oracle.odi.domain.runtime.session.OdiSession
public final class OdiSession
An OdiSession
is an execution (of a scenario, an interface, a package or a procedure, ...)
undertaken by an execution agent. OdiSession
is the root entity in OdiSession
- OdiSessionVariable
- OdiSessionStepLog
. It is identified by a unique session ID that
can be obtained from getSessionId()
method call.
Life cycle of an OdiSession
begins when it is created / prepared from a scenario, an interface,
etc. Once prepared, ODI Execution Engine can execute it. Life cycle ends when the session is removed from
runtime repository.
Field Summary |
---|
Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity |
---|
STARTING_INTERNAL_VERSION |
Method Summary | |
---|---|
java.lang.String |
getAgentName()
Returns the name of the agent that manage this se OdiSession ssion. |
int |
getChildSessionCount()
Obtains the count of child OdiSession . |
java.lang.String |
getContextCode()
Returns the execution context code for this OdiSession . |
java.lang.Integer |
getDeleteCount()
Relevant for Interfaces and Procedures and any execution that manipulates data. |
java.lang.Integer |
getDuration()
Returns the duration of the OdiSession execution in second, or null if not yet defined
(i.e. |
java.util.Date |
getEndTime()
Returns the end time of the OdiSession , or null if the session isn't yet finished. |
java.lang.Integer |
getErrorCount()
Obtains number of errors of this session i.e. |
java.lang.String |
getErrorMessage()
Obtains the error message of this OdiSession if failed, or null if the
session successfully ended. |
java.lang.Long |
getEssJobId()
Returns the ID of ESS Job which started this OdiSession . |
int |
getFailedChildSessionCount()
Obtains the count of failed child OdiSession . |
OdiSessionStepLog |
getFailureStepLog()
Return the step log ( OdiSessionStepLog ) that caused the session's failure. |
java.lang.Integer |
getInsertCount()
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. |
java.lang.String |
getKeywordsAsString()
Obtains comma separated list of keywords associated with OdiSession . |
LogLevel |
getLogLevel()
Returns logging level of this session. |
java.lang.String |
getMasterAgentName()
Returns the name of agent received execution request for this session. |
java.lang.String |
getName()
Returns the name of this OdiSession (i.e. |
java.lang.Number |
getParentSessionId()
Obtains the ID of parent OdiSession . |
java.lang.Integer |
getRecordCount()
Relevant for Interfaces and Procedures and any execution that manipulates data. |
java.lang.String |
getReturnCode()
Obtains the return code of this OdiSession . |
OdiSessionStepLog |
getRunningStepLog()
Obtains the current running step log ( OdiSessionStepLog ), or null if the execution is not
yet started or is finished. |
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities. |
java.lang.Number |
getSessionId()
Returns the ID of this OdiSession . |
java.util.List<OdiSessionStepLog> |
getSessionStepLogs()
Obtains the ordered list of executed steps' logs ( OdiSessionStepLog ). |
java.util.Collection<OdiSessionVariable> |
getSessionVariables()
Obtains an unmodifiable collection of the variables that are used inside this OdiSession . |
Tag |
getSourceScenarioTag()
Obtains actual scenario's tag being executed or null if not executed from scenario. |
java.util.Date |
getStartTime()
Returns the start time of the OdiSession , or null if the session isn't started yet. |
Status |
getStatus()
Obtains the status of this OdiSession . |
java.lang.String |
getSubmitterName()
Obtains actual ODI user name that has submitted the OdiSession . |
int |
getSuccessfulChildSessionCount()
Obtains the count of successful child OdiSession . |
java.lang.Integer |
getUpdateCount()
Relevant for Interfaces and Procedures and any execution that manipulates data. |
boolean |
isEssJobSession()
Returns true if this OdiSession was started by ESS Job, false otherwise. |
boolean |
isInstanceLevelSecurityNeeded()
Internal: this method is for internal purpose and must not be considered as part of the public API. |
Methods inherited from class oracle.odi.domain.support.AbstractOdiEntity |
---|
equals, getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, hashCode, isNew, toString |
Methods inherited from class oracle.odi.domain.support.BusinessObject |
---|
clone |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface oracle.odi.domain.IOdiEntity |
---|
getFirstDate, getFirstUser, getLastDate, getLastUser |
Method Detail |
---|
public java.lang.String getAgentName()
OdiSession
ssion.
public int getChildSessionCount()
OdiSession
.
OdiSession
public java.lang.String getContextCode()
OdiSession
.
public java.lang.Integer getDeleteCount()
Relevant for Interfaces and Procedures and any execution that manipulates data.
Obtains overall numbers of rows deleted during execution of this session i.e. the sum of delete made by each steps of this OdiSession
.
OdiSessionStepLog.getDeleteCount()
public java.lang.Integer getDuration()
OdiSession
execution in second, or null
if not yet defined
(i.e. the execution is still running).
OdiSession
execution in secondpublic java.util.Date getEndTime()
OdiSession
, or null
if the session isn't yet finished.
OdiSession
public java.lang.Integer getErrorCount()
Obtains number of errors of this session i.e. the sum of errors of each steps of this OdiSession
.
OdiSessionStepLog.getErrorCount()
public java.lang.String getErrorMessage()
OdiSession
if failed, or null
if the
session successfully ended.
OdiSession
if failedpublic java.lang.Long getEssJobId()
OdiSession
.
OdiSession
java.lang.IllegalStateException
- if this OdiSession
is not ESS Job relatedpublic int getFailedChildSessionCount()
OdiSession
.
OdiSession
public OdiSessionStepLog getFailureStepLog()
OdiSessionStepLog
) that caused the session's failure. If the session didn't
failed, than method will always return null
. However, it can be null
even if
session is failed (e.g. session failed at preparation time).
OdiSessionStepLog
) that caused the session's failure, or null
if the session didn't failedpublic java.lang.Integer getInsertCount()
Relevant for Interfaces and Procedures and any execution that manipulates data.
Obtains overall numbers of rows inserted during execution of this session i.e. the sum of insert made by each steps of this OdiSession
.
OdiSessionStepLog.getInsertCount()
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.
getInternalId
in interface IRepositoryEntity
public java.lang.String getKeywordsAsString()
OdiSession
.
Keywords are used to distribute this OdiSession
into OdiSessionFolder
.
OdiSession
public LogLevel getLogLevel()
public java.lang.String getMasterAgentName()
agentName
if the agent involved in load
balancing.
public java.lang.String getName()
OdiSession
(i.e. the name of the element that produce this
session, this means the package, variable, scenario, etc.).
getName
in interface IOdiEntity
getName
in class oracle.odi.domain.support.AbstractOdiEntity
OdiSession
public java.lang.Number getParentSessionId()
OdiSession
.
OdiSession
public java.lang.Integer getRecordCount()
Relevant for Interfaces and Procedures and any execution that manipulates data.
Obtains overall numbers of records processed by this session i.e. the sum of records processed by each steps of this OdiSession
.
null
if not applicableOdiSessionStepLog.getRecordCount()
public java.lang.String getReturnCode()
OdiSession
.
The return code is obtained from the execution channel of the last task, e.g. operating system code, database error code, etc. It will be "0" (zero) in case of success.
OdiSession
public OdiSessionStepLog getRunningStepLog()
OdiSessionStepLog
), or null
if the execution is not
yet started or is finished.
OdiSessionStepLog
)public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public java.lang.Number getSessionId()
OdiSession
.
OdiSession
public java.util.List<OdiSessionStepLog> getSessionStepLogs()
OdiSessionStepLog
).
If a running step exists it will be the last one in the returned list.
OdiSessionStepLog
)public java.util.Collection<OdiSessionVariable> getSessionVariables()
OdiSession
.
OdiSession
public Tag getSourceScenarioTag()
null
if not executed from scenario.
public java.util.Date getStartTime()
OdiSession
, or null
if the session isn't started yet.
OdiSession
public Status getStatus()
OdiSession
.
OdiSession
public java.lang.String getSubmitterName()
OdiSession
.
OdiSession
public int getSuccessfulChildSessionCount()
OdiSession
.
OdiSession
public java.lang.Integer getUpdateCount()
Relevant for Interfaces and Procedures and any execution that manipulates data.
Obtains overall numbers of rows updated during execution of this session i.e. the sum of update made by each steps of this OdiSession
.
OdiSessionStepLog.getUpdateCount()
public boolean isEssJobSession()
OdiSession
was started by ESS Job, false otherwise.
OdiSession
was started by ESS Job, false otherwisepublic boolean isInstanceLevelSecurityNeeded()
IOdiEntity
Defines a method to capture the info on which object needs instance level privilege.
isInstanceLevelSecurityNeeded
in interface IOdiEntity
isInstanceLevelSecurityNeeded
in class oracle.odi.domain.support.AbstractOdiEntity
true
if instance level security needed,
false
otherwise
|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.3.0) E17060-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |