public interface IRuntimeEngineInvoker
Modifier and Type | Interface and Description |
---|---|
static class |
IRuntimeEngineInvoker.EngineInitOption
Runtime engine initialization options
|
static class |
IRuntimeEngineInvoker.IndLogMethod
Log retention method for session logs and step logs.
|
Modifier and Type | Method and Description |
---|---|
void |
invokeDryrunDeployScenario(java.lang.String pScenName,
java.lang.String pScenVersion,
StartupParams pVariables,
java.lang.String pKeywords,
java.lang.String pContextCode,
java.lang.Integer pLogLevel,
java.lang.String pSessionName,
java.lang.String pWorkRepName,
java.util.Properties pInvocationProperties,
java.lang.Long pParentSessNo,
java.lang.String pMasterRuntimeEngineName)
Invoke a dryrun validation and deploy operation with the given scenario with various parameters.
|
java.lang.String |
invokeIsAlive()
Ping the runtime engine.
|
void |
invokeRefreshAgentConfig(java.util.Set pInitOptions,
java.util.Properties pInitProperties)
Initialize and prepare the runtime engine for ODI operations.
|
ExecutionInfo |
invokeRestartSession(long pSessionId,
StartupParams pVariables,
boolean pSynchronous,
java.lang.String pWorkRepName,
java.util.Properties pInvocationProperties,
boolean pKeepSessionParams,
java.lang.Integer pLogLevel)
Restarts a session with various parameters.
|
ExecutionInfo |
invokeStartScenario(java.lang.String pScenName,
java.lang.String pScenVersion,
StartupParams pVariables,
java.lang.String pKeywords,
java.lang.String pContextCode,
IRuntimeEngineInvoker.IndLogMethod pSessIndLogMethod,
IRuntimeEngineInvoker.IndLogMethod pStepIndLogMethod,
java.lang.Integer pLogLevel,
java.lang.String pSessionName,
boolean pSynchronous,
java.lang.String pWorkRepName,
java.util.Properties pInvocationProperties,
java.lang.Long pParentSessNo,
java.lang.String pMasterRuntimeEngineName)
Starts the given scenario with various parameters.
|
void |
invokeStopSession(long pSessionId,
oracle.odi.runtime.agent.invocation.StopType pStopType,
java.lang.String pWorkRepoName)
Stops a session.
|
java.lang.Object |
invokeTestDataServer(java.lang.Number pDataServerId,
StartupParams pGlobalVariables,
java.lang.String pTransactionId)
Tests a data server defines in the ODI topology.
|
ExecutionInfo invokeStartScenario(java.lang.String pScenName, java.lang.String pScenVersion, StartupParams pVariables, java.lang.String pKeywords, java.lang.String pContextCode, IRuntimeEngineInvoker.IndLogMethod pSessIndLogMethod, IRuntimeEngineInvoker.IndLogMethod pStepIndLogMethod, java.lang.Integer pLogLevel, java.lang.String pSessionName, boolean pSynchronous, java.lang.String pWorkRepName, java.util.Properties pInvocationProperties, java.lang.Long pParentSessNo, java.lang.String pMasterRuntimeEngineName) throws InvocationException
pScenName
- name of the scenario to run. Must not be null or emptypScenVersion
- version of the scenario to run. If null or -1, the last version of the scenario will be executed. Must not be emptypVariables
- execution variables to pass to the scenario. If null, the variables used in this scenario will be replaced by values according to their definition in ODI Designer.pKeywords
- keywords for the sessions createdpContextCode
- code of the context on which to execute. If null, the default context defined in the ODI Topology will be used.pSessIndLogMethod
- the session logging method. null to use default behavior.pStepIndLogMethod
- the session step logging method. null to use default behavior.pLogLevel
- the level of logging for this execution. If null, default is 5.pSessionName
- The name of the sessions created. If null or empty, the name of the scenario is used.pSynchronous
- Is this execution synchronouspWorkRepName
- the name of the work repository containing this scenario. Must not be null.pInvocationProperties
- additional invocation properties, such as the ess job that this was launched frompParentSessNo
- The parent session Id. null if not applicable.pMasterRuntimeEngineName
- The master runtime engine name. null if not applicable.InvocationException
- if the invocation failedvoid invokeDryrunDeployScenario(java.lang.String pScenName, java.lang.String pScenVersion, StartupParams pVariables, java.lang.String pKeywords, java.lang.String pContextCode, java.lang.Integer pLogLevel, java.lang.String pSessionName, java.lang.String pWorkRepName, java.util.Properties pInvocationProperties, java.lang.Long pParentSessNo, java.lang.String pMasterRuntimeEngineName) throws InvocationException
pScenName
- name of the scenario to run. Must not be null or emptypScenVersion
- version of the scenario to run. If null or -1, the last version of the scenario will be executed. Must not be emptypVariables
- execution variables to pass to the scenario. If null, the variables used in this scenario will be replaced by values according to their definition in ODI Designer.pKeywords
- keywords for the sessions createdpContextCode
- code of the context on which to execute. If null, the default context defined in the ODI Topology will be used.pLogLevel
- the level of logging for this execution. If null, default is 5.pSessionName
- The name of the sessions created. If null or empty, the name of the scenario is used.pWorkRepName
- the name of the work repository containing this scenario. Must not be null.pInvocationProperties
- additional invocation properties, such as the ess job that this was launched frompParentSessNo
- The parent session Id. null if not applicable.pMasterRuntimeEngineName
- The master runtime engine name. null if not applicable.InvocationException
- if the invocation failedExecutionInfo invokeRestartSession(long pSessionId, StartupParams pVariables, boolean pSynchronous, java.lang.String pWorkRepName, java.util.Properties pInvocationProperties, boolean pKeepSessionParams, java.lang.Integer pLogLevel) throws InvocationException
pSessionId
- the identifier of the session to restart. The session is only restartable if its status is ERROR or WAITING.pVariables
- the session variables. Define values for variables used in this session.pSynchronous
- is the session execution synchronouspWorkRepName
- the name of the work repository on which this session has been run. Must not be null or empty. The Work Repository must be defined in the Topology. If the session ID doesn't exist in the work repository, the execution will fail.pInvocationProperties
- additional invocation properties, such as the ess job that this was launched frompKeepSessionParams
- if a session variable value is not redefined in pVariables, then if pKeepSessionParams is true then the value used in the last execution will be re-used.pLogLevel
- is logging level for session restart. Uses null as default, which will be eventually set from the previous run.InvocationException
- if the invocation failedvoid invokeStopSession(long pSessionId, oracle.odi.runtime.agent.invocation.StopType pStopType, java.lang.String pWorkRepoName) throws InvocationException
pSessionId
- the identifier of the session which needs to be stoppedpStopType
- the mechanism to the stop the sessionpWorkRepoName
- name of the work repository where the session resides. Must not be null or empty. Must be defined in ODI Topology.InvocationException
- if the invocation failedjava.lang.Object invokeTestDataServer(java.lang.Number pDataServerId, StartupParams pGlobalVariables, java.lang.String pTransactionId) throws InvocationException
pDataServerId
- the ID of the data server as defined in the ODI topology. Must not be null.pGlobalVariables
- List of global variables (for substitution if used in connection definition)pTransactionId
- If OnConnect and OnDisconnect commands are configured for the data server then
this parameter would be used to determine if the OnConnect/OnDisconnect commands need to be executed on the connection
as part of the test.InvocationException
- if the invocation failed or if the data server test didn't succeed or if no data server with this identifier existsjava.lang.String invokeIsAlive() throws InvocationException
InvocationException
- if the runtime engine was unreachablevoid invokeRefreshAgentConfig(java.util.Set pInitOptions, java.util.Properties pInitProperties) throws InvocationException
pInitOptions
- A set of initialization operations to be performed on the runtime engine. May pass in null to imply all applicable init operations.pInitProperties
- additional properties, if any, for the initialization operations. May pass in null if none.InvocationException
- if the invocation failed.