oracle.odi.domain.runtime.session

Class OdiSessionCustomTask

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.runtime.common.AbstractRuntimeTask

oracle.odi.domain.runtime.session.OdiSessionCustomTask

All Implemented Interfaces:

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

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 OdiSessionCustomTasks of OdiSession using OdiSession.getSessionCustomTasks() method.

Since:

12.1

See Also:

OdiSessionBlueprintTask, OdiSession.getSessionCustomTasks(), OdiSession.addSessionCustomTask(OdiSessionCustomTask), Serialized Form

Method Summary

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.
OdiSessionBlueprintTask	getSessionBlueprintTask() Returns the OdiSessionBlueprintTask, which values are overridden in this OdiSessionCustomTask.
java.lang.Number	getSessionId() Returns the ID of OdiSession.
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.
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.

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

getName, getOrder, getSourceCommand, getTargetCommand, isIgnoreError, setLogCounter

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

createSessionCustomTask

public static OdiSessionCustomTask createSessionCustomTask(OdiSessionBlueprintTask pSessionBlueprintTask)

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

Parameters:

pSessionBlueprintTask - an OdiSessionBlueprintTask

Returns:

new overriding task

See Also:

OdiSession#addSessionCustomTask(OdiSessionCustomTask)}

createOnConnectTask

public static OdiSessionCustomTask createOnConnectTask(int pOrder)

FOR INTERNAL USE ONLY.

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

The returned task should be added to OdiSession.

Parameters:

pOrder - task order in OnConnect step

Returns:

new OnConnect task

See Also:

OdiSession#addSessionCustomTask(OdiSessionCustomTask)}

createOnDisconnectTask

public static OdiSessionCustomTask createOnDisconnectTask(int pOrder)

FOR INTERNAL USE ONLY.

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

The returned task should be added to OdiSession.

Parameters:

pOrder - task order in OnDisconnect step

Returns:

new OnDisconnect task

See Also:

OdiSession#addSessionCustomTask(OdiSessionCustomTask)}

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

getSessionId

public java.lang.Number getSessionId()

Returns the ID of OdiSession.

Returns:

session ID

getSessionBlueprintTask

public OdiSessionBlueprintTask getSessionBlueprintTask()

Returns the OdiSessionBlueprintTask, which values are overridden in this OdiSessionCustomTask.

Returns null in case of OnConnect or OnDisconect task.

Returns:

OdiSessionBlueprintTask

setSourceCommand

public void setSourceCommand(java.lang.String pSourceCommand)

Specifies the command on source for this task.

Parameters:

pSourceCommand - source command

See Also:

AbstractRuntimeTask.getSourceCommand()

setTargetCommand

public void setTargetCommand(java.lang.String pTargetCommand)

Specifies the command on target for this task.

Parameters:

pTargetCommand - target command

See Also:

AbstractRuntimeTask.getTargetCommand()

setIgnoreError

public void setIgnoreError(boolean pIgnoreError)

Specifies if error should be ignored for this task.

Parameters:

pIgnoreError - whether error should be ignored

See Also:

AbstractRuntimeTask.isIgnoreError()

getType

public TaskType getType()

Returns the type of this OdiSessionCustomTask. This can be ON_CONNECT, ON_DISCONNECT, or the type of underlying OdiSessionBlueprintTask.

Overrides:

getType in class AbstractRuntimeTask

Returns:

task type

getTaskName1

public java.lang.String getTaskName1()

Returns the name1 of this OdiSessionCustomTask. This would be the name1 of underlying OdiSessionBlueprintTask for overriding task.

Overrides:

getTaskName1 in class AbstractRuntimeTask

Returns:

task's name1

setTaskName1

public void setTaskName1(java.lang.String pTaskName1)

FOR INTERNAL USE ONLY.

Specifies the task name1 for OnConnect/OnDisconnect task.

Parameters:

pTaskName1 - task name1

getTaskName2

public java.lang.String getTaskName2()

Returns the name2 of this OdiSessionCustomTask. This would be the name2 of underlying OdiSessionBlueprintTask for overriding task.

Overrides:

getTaskName2 in class AbstractRuntimeTask

Returns:

task's name2

setTaskName2

public void setTaskName2(java.lang.String pTaskName2)

FOR INTERNAL USE ONLY.

Specifies the task name2 for OnConnect/OnDisconnect task.

Parameters:

pTaskName1 - task name2

getTargetTransactionChannel

public TransactionChannel getTargetTransactionChannel()

Returns the target transaction channel of this OdiSessionCustomTask. This would be the target transaction channel of underlying OdiSessionBlueprintTask for overriding task.

Overrides:

getTargetTransactionChannel in class AbstractRuntimeTask

Returns:

target transaction channel

setTargetTransactionChannel

public void setTargetTransactionChannel(TransactionChannel pTargetTransactionChannel)

FOR INTERNAL USE ONLY.

Specifies the transaction channel for OnConnect/OnDisconnect task.

Parameters:

pTargetTransactionChannel - transaction channel

getLogLevel

public LogLevel getLogLevel()

Returns the log level of this OdiSessionCustomTask. This would be the log level of underlying OdiSessionBlueprintTask for overriding task.

Overrides:

getLogLevel in class AbstractRuntimeTask

Returns:

log level

setLogLevel

public void setLogLevel(LogLevel pLogLevel)

FOR INTERNAL USE ONLY.

Specifies the log level for OnConnect/OnDisconnect task.

Parameters:

pLogLevel - log level

getTargetCommitMode

public OdiSessionTaskLog.CommitMode getTargetCommitMode()

Returns the target commit mode of this OdiSessionCustomTask. This would be the target commit mode of underlying OdiSessionBlueprintTask for overriding task.

Overrides:

getTargetCommitMode in class AbstractRuntimeTask

Returns:

target commit mode

setTargetCommitMode

public void setTargetCommitMode(OdiSessionTaskLog.CommitMode pTargetCommitMode)

FOR INTERNAL USE ONLY.

Specifies the commit mode for OnConnect/OnDisconnect task.

Parameters:

pTargetCommitMode - commit mode

getOrigOrder

public int getOrigOrder()

Returns the original task order in procedure for underlying OdiSessionBlueprintTask.

This is relevant to overriding OdiSessionCustomTask only.

Overrides:

getOrigOrder in class AbstractRuntimeTask

Returns:

the original task order of OdiSessionBlueprintTask

getTaskName3

public java.lang.String getTaskName3()

Returns the third name of underlying OdiSessionBlueprintTask.

This is relevant to overriding OdiSessionCustomTask only. Null will be always returned for OnConnect OnDisconnect custom tasks.

Overrides:

getTaskName3 in class AbstractRuntimeTask

Returns:

the third name of OdiSessionBlueprintTask

getSourceContextCode

public java.lang.String getSourceContextCode()

Returns the context code for source of underlying OdiSessionBlueprintTask.

This is relevant to overriding OdiSessionCustomTask only. Null will be always returned for OnConnect OnDisconnect custom tasks.

Overrides:

getSourceContextCode in class AbstractRuntimeTask

Returns:

the source context code of OdiSessionBlueprintTask

getSourceLogicalSchemaName

public java.lang.String getSourceLogicalSchemaName()

Returns the logical schema name for source of underlying OdiSessionBlueprintTask.

This is relevant to overriding OdiSessionCustomTask only. Null will be always returned for OnConnect OnDisconnect custom tasks.

Overrides:

getSourceLogicalSchemaName in class AbstractRuntimeTask

Returns:

the source logical schema name of OdiSessionBlueprintTask

getSourceTransactionChannel

public TransactionChannel getSourceTransactionChannel()

Returns the transaction channel for source of underlying OdiSessionBlueprintTask.

This is relevant to overriding OdiSessionCustomTask only. Null will be always returned for OnConnect OnDisconnect custom tasks.

Overrides:

getSourceTransactionChannel in class AbstractRuntimeTask

Returns:

the source transaction channel of OdiSessionBlueprintTask

getSourceIsolationLevel

public OdiSessionTaskLog.IsolationLevel getSourceIsolationLevel()

Returns the isolation level for source of underlying OdiSessionBlueprintTask.

This is relevant to overriding OdiSessionCustomTask only. Null will be always returned for OnConnect OnDisconnect custom tasks.

Overrides:

getSourceIsolationLevel in class AbstractRuntimeTask

Returns:

the source isolation level of OdiSessionBlueprintTask

getSourceCommitMode

public OdiSessionTaskLog.CommitMode getSourceCommitMode()

Returns the commit mode for source of underlying OdiSessionBlueprintTask.

This is relevant to overriding OdiSessionCustomTask only. Null will be always returned for OnConnect OnDisconnect custom tasks.

Overrides:

getSourceCommitMode in class AbstractRuntimeTask

Returns:

the source commit mode of OdiSessionBlueprintTask

getSourceTechnoCode

public java.lang.String getSourceTechnoCode()

Returns the technology code for source of underlying OdiSessionBlueprintTask.

This is relevant to overriding OdiSessionCustomTask only. Null will be always returned for OnConnect OnDisconnect custom tasks.

Overrides:

getSourceTechnoCode in class AbstractRuntimeTask

Returns:

the source technology code of OdiSessionBlueprintTask

getTargetContextCode

public java.lang.String getTargetContextCode()

Returns the context code for target of underlying OdiSessionBlueprintTask.

This is relevant to overriding OdiSessionCustomTask only. Null will be always returned for OnConnect OnDisconnect custom tasks.

Overrides:

getTargetContextCode in class AbstractRuntimeTask

Returns:

the target context code of OdiSessionBlueprintTask

getTargetLogicalSchemaName

public java.lang.String getTargetLogicalSchemaName()

Returns the logical schema name for target of underlying OdiSessionBlueprintTask.

This is relevant to overriding OdiSessionCustomTask only. Null will be always returned for OnConnect OnDisconnect custom tasks.

Overrides:

getTargetLogicalSchemaName in class AbstractRuntimeTask

Returns:

the target logical schema name of OdiSessionBlueprintTask

getTargetIsolationLevel

public OdiSessionTaskLog.IsolationLevel getTargetIsolationLevel()

Returns the isolation level for target of underlying OdiSessionBlueprintTask.

This is relevant to overriding OdiSessionCustomTask only. Null will be always returned for OnConnect OnDisconnect custom tasks.

Overrides:

getTargetIsolationLevel in class AbstractRuntimeTask

Returns:

the target isolation level of OdiSessionBlueprintTask

getTargetTechnoCode

public java.lang.String getTargetTechnoCode()

Returns the technology code for target of underlying OdiSessionBlueprintTask.

This is relevant to overriding OdiSessionCustomTask only. Null will be always returned for OnConnect OnDisconnect custom tasks.

Overrides:

getTargetTechnoCode in class AbstractRuntimeTask

Returns:

the target technology code of OdiSessionBlueprintTask

getLogCounter

public OdiSessionTaskLog.LogCounter getLogCounter()

Returns the log counter of underlying OdiSessionBlueprintTask.

This is relevant to overriding OdiSessionCustomTask only. Null will be always returned for OnConnect OnDisconnect custom tasks.

Overrides:

getLogCounter in class AbstractRuntimeTask

Returns:

the log counter of OdiSessionBlueprintTask

getExecutionChannel

public OdiTechnology.ExecutionChannel getExecutionChannel()

Returns the execution channel of underlying OdiSessionBlueprintTask.

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

Overrides:

getExecutionChannel in class AbstractRuntimeTask

Returns:

the execution channel of OdiSessionBlueprintTask

isSourceCommandEncrypted

public boolean isSourceCommandEncrypted()

Indicates whether source command is encrypted for this task.

Overrides:

isSourceCommandEncrypted in class AbstractRuntimeTask

Returns:

true if source command is encrypted, false - otherwise

isTargetCommandEncrypted

public boolean isTargetCommandEncrypted()

Indicates whether target command is encrypted for this task.

Overrides:

isTargetCommandEncrypted in class AbstractRuntimeTask

Returns:

true if target command is encrypted, false - otherwise

isLogFinalCommand

public boolean isLogFinalCommand()

Indicates whether final command is logged for this task.

This is relevant to overriding OdiSessionCustomTask only. True will be always returned for OnConnect / OnDisconnect custom tasks.

Overrides:

isLogFinalCommand in class AbstractRuntimeTask

Returns:

true if final command is logged, false - otherwise

getTaskType

public IProcedureLine.LineType getTaskType()

Returns the type of the task. See IProcedureLine.LineType for details.

This is relevant to overriding OdiSessionCustomTask only. Null will be always returned for OnConnect OnDisconnect custom tasks.

Overrides:

getTaskType in class AbstractRuntimeTask

Returns:

the type of the task TODO: bad naming!!