public class OdiSessionCustomTask extends AbstractRuntimeTask
OdiSessionCustomTask
represents the task which is related to only one specific
OdiSession
. This can be OnConnect or OnDisconnect
task, which in general are not common across different sessions with common OdiSessionBlueprint
.
Also OdiSessionCustomTask
can be a task overriding some properties of original
OdiSessionBlueprintTask
. In this case OdiSessionCustomTask
holds reference to
OdiSessionBlueprintTask
, which properties are overridden. There are three Task properties
available for modification: sourceCommand (Task Command on Source),
targetCommand (Task Command on Target) and ignoreError
(Ignore Error flag). It may be useful to modify them between OdiSession
restarts
for debugging/fixing the execution. To override some properties of OdiSessionBlueprintTask
,
new instance of OdiSessionCustomTask
should be created in runtime repository. Runtime
Agent will take its values, instead of using initial values from blueprint then.
OdiSessionCustomTask
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 OdiSessionCustomTask
s of OdiSession
using OdiSession.getSessionCustomTasks()
method.
Modifier and Type | Method and Description |
---|---|
static OdiSessionCustomTask |
createOnConnectTask(int pOrder)
FOR INTERNAL USE ONLY.
|
static OdiSessionCustomTask |
createOnDisconnectTask(int pOrder)
FOR INTERNAL USE ONLY.
|
static OdiSessionCustomTask |
createSessionCustomTask(OdiSessionBlueprintTask pSessionBlueprintTask)
Constructs new
OdiSessionCustomTask overriding the specified
OdiSessionBlueprintTask . |
OdiTechnology.ExecutionChannel |
getExecutionChannel()
Returns the execution channel of underlying
OdiSessionBlueprintTask . |
java.io.Serializable |
getInternalId()
Provides a common getter for the persistence layer to obtain an identity,
irrespective of the actual type of identity used.
|
OdiSessionTaskLog.LogCounter |
getLogCounter()
Returns the log counter of underlying
OdiSessionBlueprintTask . |
LogLevel |
getLogLevel()
Returns the log level of this
OdiSessionCustomTask . |
int |
getOrigOrder()
Returns the original task order in procedure for underlying
OdiSessionBlueprintTask . |
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities.
|
OdiSessionBlueprintTask |
getSessionBlueprintTask()
Returns the
OdiSessionBlueprintTask , which values are overridden in this
OdiSessionCustomTask . |
java.lang.Number |
getSessionId()
Returns the ID of
OdiSession . |
java.lang.String |
getSourceCommandEncryptionKey()
Returns the encryption key for source command of this task.
|
OdiSessionTaskLog.CommitMode |
getSourceCommitMode()
Returns the commit mode for source of underlying
OdiSessionBlueprintTask . |
java.lang.String |
getSourceContextCode()
Returns the context code for source of underlying
OdiSessionBlueprintTask . |
OdiSessionTaskLog.IsolationLevel |
getSourceIsolationLevel()
Returns the isolation level for source of underlying
OdiSessionBlueprintTask . |
java.lang.String |
getSourceLogicalSchemaName()
Returns the logical schema name for source of underlying
OdiSessionBlueprintTask . |
java.lang.String |
getSourceTechnoCode()
Returns the technology code for source of underlying
OdiSessionBlueprintTask . |
TransactionChannel |
getSourceTransactionChannel()
Returns the transaction channel for source of underlying
OdiSessionBlueprintTask . |
java.lang.String |
getTargetCommandEncryptionKey()
Returns the encryption key for target command of this task.
|
OdiSessionTaskLog.CommitMode |
getTargetCommitMode()
Returns the target commit mode of this
OdiSessionCustomTask . |
java.lang.String |
getTargetContextCode()
Returns the context code for target of underlying
OdiSessionBlueprintTask . |
OdiSessionTaskLog.IsolationLevel |
getTargetIsolationLevel()
Returns the isolation level for target of underlying
OdiSessionBlueprintTask . |
java.lang.String |
getTargetLogicalSchemaName()
Returns the logical schema name for target of underlying
OdiSessionBlueprintTask . |
java.lang.String |
getTargetTechnoCode()
Returns the technology code for target of underlying
OdiSessionBlueprintTask . |
TransactionChannel |
getTargetTransactionChannel()
Returns the target transaction channel of this
OdiSessionCustomTask . |
java.lang.String |
getTaskName1()
Returns the name1 of this
OdiSessionCustomTask . |
java.lang.String |
getTaskName2()
Returns the name2 of this
OdiSessionCustomTask . |
java.lang.String |
getTaskName3()
Returns the third name of underlying
OdiSessionBlueprintTask . |
IProcedureLine.LineType |
getTaskType()
Returns the type of the task.
|
TaskType |
getType()
Returns the type of this
OdiSessionCustomTask . |
boolean |
isLogFinalCommand()
Indicates whether final command is logged for this task.
|
boolean |
isSourceCommandEncrypted()
Indicates whether source command is encrypted for this task.
|
boolean |
isTargetCommandEncrypted()
Indicates whether target command is encrypted for this task.
|
void |
setIgnoreError(boolean pIgnoreError)
Specifies if error should be ignored for this task.
|
void |
setLogLevel(LogLevel pLogLevel)
FOR INTERNAL USE ONLY.
|
void |
setSourceCommand(java.lang.String pSourceCommand)
Specifies the command on source for this task.
|
void |
setTargetCommand(java.lang.String pTargetCommand)
Specifies the command on target for this task.
|
void |
setTargetCommitMode(OdiSessionTaskLog.CommitMode pTargetCommitMode)
FOR INTERNAL USE ONLY.
|
void |
setTargetTransactionChannel(TransactionChannel pTargetTransactionChannel)
FOR INTERNAL USE ONLY.
|
void |
setTaskName1(java.lang.String pTaskName1)
FOR INTERNAL USE ONLY.
|
void |
setTaskName2(java.lang.String pTaskName2)
FOR INTERNAL USE ONLY.
|
getName, getOrder, getSourceCommand, getTargetCommand, isIgnoreError, setLogCounter
public static OdiSessionCustomTask createSessionCustomTask(OdiSessionBlueprintTask pSessionBlueprintTask)
OdiSessionCustomTask
overriding the specified
OdiSessionBlueprintTask
. This will inform the Runtime Agent that modifiable
task's values were overridden between OdiSession
restarts.
The returned overriding task should be added to OdiSession
.
pSessionBlueprintTask
- an OdiSessionBlueprintTask
OdiSession#addSessionCustomTask(OdiSessionCustomTask)}
public static OdiSessionCustomTask createOnConnectTask(int pOrder)
Constructs new OnConnect task. Such task has no related blueprint task.
The returned task should be added to OdiSession
.
pOrder
- task order in OnConnect stepOdiSession#addSessionCustomTask(OdiSessionCustomTask)}
public static OdiSessionCustomTask createOnDisconnectTask(int pOrder)
Constructs new OnDisconnect task. Such task has no related blueprint task.
The returned task should be added to OdiSession
.
pOrder
- task order in OnDisconnect stepOdiSession#addSessionCustomTask(OdiSessionCustomTask)}
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 java.lang.Number getSessionId()
OdiSession
.public OdiSessionBlueprintTask getSessionBlueprintTask()
OdiSessionBlueprintTask
, which values are overridden in this
OdiSessionCustomTask
.
Returns null in case of OnConnect or OnDisconect task.
OdiSessionBlueprintTask
public void setSourceCommand(java.lang.String pSourceCommand)
pSourceCommand
- source commandAbstractRuntimeTask.getSourceCommand()
public void setTargetCommand(java.lang.String pTargetCommand)
pTargetCommand
- target commandAbstractRuntimeTask.getTargetCommand()
public void setIgnoreError(boolean pIgnoreError)
pIgnoreError
- whether error should be ignoredAbstractRuntimeTask.isIgnoreError()
public TaskType getType()
OdiSessionCustomTask
. This can be ON_CONNECT, ON_DISCONNECT,
or the type of underlying OdiSessionBlueprintTask
.getType
in class AbstractRuntimeTask
public java.lang.String getTaskName1()
OdiSessionCustomTask
. This would be the name1 of underlying
OdiSessionBlueprintTask
for overriding task.getTaskName1
in class AbstractRuntimeTask
public void setTaskName1(java.lang.String pTaskName1)
Specifies the task name1 for OnConnect/OnDisconnect task.
pTaskName1
- task name1public java.lang.String getTaskName2()
OdiSessionCustomTask
. This would be the name2 of underlying
OdiSessionBlueprintTask
for overriding task.getTaskName2
in class AbstractRuntimeTask
public void setTaskName2(java.lang.String pTaskName2)
Specifies the task name2 for OnConnect/OnDisconnect task.
pTaskName1
- task name2public TransactionChannel getTargetTransactionChannel()
OdiSessionCustomTask
. This would be the
target transaction channel of underlying OdiSessionBlueprintTask
for overriding task.getTargetTransactionChannel
in class AbstractRuntimeTask
public void setTargetTransactionChannel(TransactionChannel pTargetTransactionChannel)
Specifies the transaction channel for OnConnect/OnDisconnect task.
pTargetTransactionChannel
- transaction channelpublic LogLevel getLogLevel()
OdiSessionCustomTask
. This would be the
log level of underlying OdiSessionBlueprintTask
for overriding task.getLogLevel
in class AbstractRuntimeTask
public void setLogLevel(LogLevel pLogLevel)
Specifies the log level for OnConnect/OnDisconnect task.
pLogLevel
- log levelpublic OdiSessionTaskLog.CommitMode getTargetCommitMode()
OdiSessionCustomTask
. This would be the
target commit mode of underlying OdiSessionBlueprintTask
for overriding task.getTargetCommitMode
in class AbstractRuntimeTask
public void setTargetCommitMode(OdiSessionTaskLog.CommitMode pTargetCommitMode)
Specifies the commit mode for OnConnect/OnDisconnect task.
pTargetCommitMode
- commit modepublic int getOrigOrder()
OdiSessionBlueprintTask
.
This is relevant to overriding OdiSessionCustomTask
only.
getOrigOrder
in class AbstractRuntimeTask
OdiSessionBlueprintTask
public java.lang.String getTaskName3()
OdiSessionBlueprintTask
.
This is relevant to overriding OdiSessionCustomTask
only.
Null will be always returned for OnConnect OnDisconnect custom tasks.
getTaskName3
in class AbstractRuntimeTask
OdiSessionBlueprintTask
public java.lang.String getSourceContextCode()
OdiSessionBlueprintTask
.
This is relevant to overriding OdiSessionCustomTask
only.
Null will be always returned for OnConnect OnDisconnect custom tasks.
getSourceContextCode
in class AbstractRuntimeTask
OdiSessionBlueprintTask
public java.lang.String getSourceLogicalSchemaName()
OdiSessionBlueprintTask
.
This is relevant to overriding OdiSessionCustomTask
only.
Null will be always returned for OnConnect OnDisconnect custom tasks.
getSourceLogicalSchemaName
in class AbstractRuntimeTask
OdiSessionBlueprintTask
public TransactionChannel getSourceTransactionChannel()
OdiSessionBlueprintTask
.
This is relevant to overriding OdiSessionCustomTask
only.
Null will be always returned for OnConnect OnDisconnect custom tasks.
getSourceTransactionChannel
in class AbstractRuntimeTask
OdiSessionBlueprintTask
public OdiSessionTaskLog.IsolationLevel getSourceIsolationLevel()
OdiSessionBlueprintTask
.
This is relevant to overriding OdiSessionCustomTask
only.
Null will be always returned for OnConnect OnDisconnect custom tasks.
getSourceIsolationLevel
in class AbstractRuntimeTask
OdiSessionBlueprintTask
public OdiSessionTaskLog.CommitMode getSourceCommitMode()
OdiSessionBlueprintTask
.
This is relevant to overriding OdiSessionCustomTask
only.
Null will be always returned for OnConnect OnDisconnect custom tasks.
getSourceCommitMode
in class AbstractRuntimeTask
OdiSessionBlueprintTask
public java.lang.String getSourceTechnoCode()
OdiSessionBlueprintTask
.
This is relevant to overriding OdiSessionCustomTask
only.
Null will be always returned for OnConnect OnDisconnect custom tasks.
getSourceTechnoCode
in class AbstractRuntimeTask
OdiSessionBlueprintTask
public java.lang.String getTargetContextCode()
OdiSessionBlueprintTask
.
This is relevant to overriding OdiSessionCustomTask
only.
Null will be always returned for OnConnect OnDisconnect custom tasks.
getTargetContextCode
in class AbstractRuntimeTask
OdiSessionBlueprintTask
public java.lang.String getTargetLogicalSchemaName()
OdiSessionBlueprintTask
.
This is relevant to overriding OdiSessionCustomTask
only.
Null will be always returned for OnConnect OnDisconnect custom tasks.
getTargetLogicalSchemaName
in class AbstractRuntimeTask
OdiSessionBlueprintTask
public OdiSessionTaskLog.IsolationLevel getTargetIsolationLevel()
OdiSessionBlueprintTask
.
This is relevant to overriding OdiSessionCustomTask
only.
Null will be always returned for OnConnect OnDisconnect custom tasks.
getTargetIsolationLevel
in class AbstractRuntimeTask
OdiSessionBlueprintTask
public java.lang.String getTargetTechnoCode()
OdiSessionBlueprintTask
.
This is relevant to overriding OdiSessionCustomTask
only.
Null will be always returned for OnConnect OnDisconnect custom tasks.
getTargetTechnoCode
in class AbstractRuntimeTask
OdiSessionBlueprintTask
public OdiSessionTaskLog.LogCounter getLogCounter()
OdiSessionBlueprintTask
.
This is relevant to overriding OdiSessionCustomTask
only.
Null will be always returned for OnConnect OnDisconnect custom tasks.
getLogCounter
in class AbstractRuntimeTask
OdiSessionBlueprintTask
public OdiTechnology.ExecutionChannel getExecutionChannel()
OdiSessionBlueprintTask
.
This is relevant to overriding OdiSessionCustomTask
only.
Null will be always returned for OnConnect / OnDisconnect custom tasks.
getExecutionChannel
in class AbstractRuntimeTask
OdiSessionBlueprintTask
public boolean isSourceCommandEncrypted()
isSourceCommandEncrypted
in class AbstractRuntimeTask
public boolean isTargetCommandEncrypted()
isTargetCommandEncrypted
in class AbstractRuntimeTask
public java.lang.String getSourceCommandEncryptionKey()
getSourceCommandEncryptionKey
in class AbstractRuntimeTask
public java.lang.String getTargetCommandEncryptionKey()
getTargetCommandEncryptionKey
in class AbstractRuntimeTask
public boolean isLogFinalCommand()
This is relevant to overriding OdiSessionCustomTask
only.
True will be always returned for OnConnect / OnDisconnect custom tasks.
isLogFinalCommand
in class AbstractRuntimeTask
public IProcedureLine.LineType getTaskType()
IProcedureLine.LineType
for details.
This is relevant to overriding OdiSessionCustomTask
only.
Null will be always returned for OnConnect OnDisconnect custom tasks.
getTaskType
in class AbstractRuntimeTask