oracle.odi.runtime.agent.invocation

Class RemoteRuntimeAgentInvoker

java.lang.Object

oracle.odi.runtime.agent.invocation.RemoteRuntimeAgentInvoker

All Implemented Interfaces:

IRuntimeEngineInvoker

public class RemoteRuntimeAgentInvoker
extends java.lang.Object
implements IRuntimeEngineInvoker

The RemoteRuntimeAgentInvoker is the utility class allowing to invoke operations on a remote ODI agent.
It is instantiated by passing the agent URL and the ODI credentials. The operations offered are:

• Ping this agent
• Get the agent version
• Start a scenario
• Get a session's status
• Stop a session
• Restart a session
• Clean the stale sessions
• Ask the agent to compute its planning
• Get the schedules defined on this agent
• Update the schedules
• Kill the agent (if the server supports this feature)
• Get the JMX information
• Start a load plan
• Stop a load plan instance run
• Restart a load plan instance
• Get status information for one or more load plans

Since:

11.1.1.3.0

Version:

11.1.1.5.0

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.odi.runtime.agent.invocation.IRuntimeEngineInvoker

IRuntimeEngineInvoker.EngineInitOption, IRuntimeEngineInvoker.IndLogMethod

Constructor Summary

Constructors

Constructor and Description
RemoteRuntimeAgentInvoker(OdiInstance odiInst, java.lang.String pEngineUrl, java.lang.String pUser, char[] pPassword, java.lang.String pEngineName, java.lang.String pMasterRepoSignature) This constructor requires ODI repo connectivities.
RemoteRuntimeAgentInvoker(java.lang.String pAgentUrl, java.lang.String pUser, char[] pPassword) Constructs a RemoteRuntimeAgentInvoker object.
RemoteRuntimeAgentInvoker(java.lang.String pAgentUrl, java.lang.String pUser, char[] pPassword, java.lang.String pAgentName, java.lang.String pMasterRepositorySignature) Constructs a RemoteRuntimeAgentInvoker object.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAgentURL() Returns the agent URL value.
char[]	getCharArrayPassword() Returns the decrypted user password used to connect to the ODI instance.
java.lang.String	getUser() Returns the user name value.
WorkRepositoryInfo	invokeCleanStaleSessions(java.lang.String pWorkRepositoryName) Cleans the stale sessions in the specified work repository.
java.util.List	invokeCleanStaleSessionsForAllWorkRepositories() Cleans the stale sessions for all work repositories defined in connected master repository.
void	invokeComputePlanning() Asks the agent to recompute its schedules for all the work repositories. The ODI agent will take into account all the new data defined in the ODI work repositories to compute and manage a new list of schedules.
void	invokeComputePlanning(java.lang.String pWorkrep) Asks the agent to recompute its schedules for the given work repository.
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	invokeGetAgentVersion() Returns the version of the agent.
oracle.odi.runtime.agent.invocation.response.OdiGetJMXServiceInfoAckType	invokeGetJMXServiceInfo() Returns the JMXServiceInfo details about the current agent.
java.util.List	invokeGetLoadPlanStatus(java.util.List pLoadPlanInstanceIds, java.util.List pLoadPlanRunNumbers, java.lang.String pWorkRepositoryName) Returns the status of the specified load plans.
SchedulingInfo	invokeGetSchedules(long pStart, long pEnd) Returns the schedules information for the agent in the interval defined between the two parameters and for all the work repositories linked to the master repository to which the ODI agent is connected.
SchedulingInfo	invokeGetSchedules(java.lang.String pWorkrep, long pStart, long pEnd) Returns the schedules information for the agent in the interval defined between the two parameters.
java.util.List	invokeGetSessionStatus(java.util.List pSessionIds, java.lang.String pWorkRepositoryName) Return the status of given session ids.
java.lang.String	invokeIsAlive() Ping the agent.
java.lang.String	invokeIsAlive(java.lang.String pSignature) Deprecated. invokeIsAlive Ping the agent.
void	invokeKillAgent(boolean pImmediate, long pMaxWait) Kills the agent.
void	invokeRefreshAgentConfig() Notifies the Agent to synchronize the agent configuration with repository, such as the Session Blueprint cache configuration and the agent Max Threads and Max Threads Per Session settings.
void	invokeRefreshAgentConfig(java.util.Set pInitOptions, java.util.Properties pInitProperties) Initialize and prepare the runtime engine for ODI operations.
RemoteObjectResult	invokeRemoteObject(java.lang.String pObjectId, java.lang.String pClassName, java.lang.String pMethodName, java.lang.String pParameter) Remotely invoke the given method with the given parameter on the remote object instance (class and ID).
LoadPlanExecutionInfo	invokeRestartLoadPlanInstance(java.lang.Number pLoadPlanInstanceId, java.lang.String pWorkRepositoryName) Deprecated. Since 11.1.1.6.0. Instead use invokeRestartLoadPlanInstance(Number pLoadPlanInstanceId, String pWorkRepositoryName, Integer pLogLevel). This method uses default log level null. If log level is not set, restartLoadPlan will use the log level from the previous run.
LoadPlanExecutionInfo	invokeRestartLoadPlanInstance(java.lang.Number pLoadPlanInstanceId, java.lang.String pWorkRepositoryName, java.lang.Integer pLogLevel) Restarts a load plan instance that was previously stopped manually or due to an error.
LoadPlanExecutionInfo	invokeRestartLoadPlanInstance(java.lang.Number pLoadPlanInstanceId, java.lang.String pWorkRepositoryName, java.lang.Integer pLogLevel, java.util.Properties pInvocationProperties) Restarts a load plan instance that was previously stopped manually or due to an error.
ExecutionInfo	invokeRestartSession(long pSessionId, StartupParams pVariables, boolean pSynchronous, java.lang.String pWorkRepName) Deprecated. Since 11.1.1.6.0. Instead use invokeRestartSession(long pSessionId, StartupParams pVariables, boolean pSynchronous, String pWorkRepName, Integer pLogLevel) This method uses default log level of null.
ExecutionInfo	invokeRestartSession(long pSessionId, StartupParams pVariables, boolean pSynchronous, java.lang.String pWorkRepName, boolean pKeepSessionParams) Deprecated. Since 11.1.1.6.0. Instead use invokeRestartSession(long pSessionId, StartupParams pVariables, boolean pSynchronous, String pWorkRepName,boolean pKeepSessionParams, Integer pLogLevel) This method uses default log level of null.
ExecutionInfo	invokeRestartSession(long pSessionId, StartupParams pVariables, boolean pSynchronous, java.lang.String pWorkRepName, boolean pKeepSessionParams, java.lang.Integer pLogLevel) Restarts a session with various parameters.
ExecutionInfo	invokeRestartSession(long pSessionId, StartupParams pVariables, boolean pSynchronous, java.lang.String pWorkRepName, boolean pKeepSessionParams, java.lang.Integer pLogLevel, DebugParams pDebugParams) Restarts a session with various parameters.
ExecutionInfo	invokeRestartSession(long pSessionId, StartupParams pVariables, boolean pSynchronous, java.lang.String pWorkRepName, java.lang.Integer pLogLevel) Restarts a session with various parameters. If a variable value is not redefined in pVariables, then the last execution value will be used.
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.
LoadPlanExecutionInfo	invokeStartLoadPlan(java.lang.String pLoadPlanName, java.lang.String pContextCode, LoadPlanStartupParams pStartupParams, java.lang.String pKeywords, java.lang.String pWorkRepositoryName) Deprecated. Since 11.1.1.6.0. Instead use invokeStartLoadPlan(String pLoadPlanName, String pContextCode, LoadPlanStartupParams pStartupParams, String pKeywords, String pWorkRepositoryName, Integer pLogLevel) This method uses default log level of null.
LoadPlanExecutionInfo	invokeStartLoadPlan(java.lang.String pLoadPlanName, java.lang.String pContextCode, LoadPlanStartupParams pStartupParams, java.lang.String pKeywords, java.lang.String pWorkRepositoryName, java.lang.Integer pLogLevel) Starts a load plan instance run with various parameters.
LoadPlanExecutionInfo	invokeStartLoadPlan(java.lang.String pLoadPlanName, java.lang.String pContextCode, LoadPlanStartupParams pStartupParams, java.lang.String pKeywords, java.lang.String pWorkRepositoryName, java.util.Properties pInvocationProperties) Deprecated. Since 11.1.1.6.0. Instead use invokeStartLoadPlan(String pLoadPlanName, String pContextCode, LoadPlanStartupParams pStartupParams, String pKeywords, String pWorkRepositoryName, Properties pInvocationProperties, Integer pLogLevel) This method uses default log level of null to maintain 11.1.1.5.0 behavior.
LoadPlanExecutionInfo	invokeStartLoadPlan(java.lang.String pLoadPlanName, java.lang.String pContextCode, LoadPlanStartupParams pStartupParams, java.lang.String pKeywords, java.lang.String pWorkRepositoryName, java.util.Properties pInvocationProperties, java.lang.Integer pLogLevel) Starts a load plan instance run with various parameters.
ExecutionInfo	invokeStartScenario(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, boolean pSynchronous, java.lang.String pWorkRepName) Starts the given scenario with various parameters.
ExecutionInfo	invokeStartScenario(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, boolean pSynchronous, java.lang.String pWorkRepName, java.util.Properties pInvocationProperties) Starts the given scenario with various parameters.
ExecutionInfo	invokeStartScenario(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, boolean pSynchronous, java.lang.String pWorkRepName, java.util.Properties pInvocationProperties, DebugParams pDebugParams) Starts the given scenario 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 pSessLogMethod, IRuntimeEngineInvoker.IndLogMethod pStepLogMethod, java.lang.Integer pLogLevel, java.lang.String pSessionName, boolean pSynchronous, java.lang.String pWorkRepName, java.util.Properties pInvocationProperties, java.lang.Long pParentSession, java.lang.String pMasterAgentName) Starts the given scenario with various parameters.
LoadPlanExecutionInfo	invokeStopLoadPlan(java.lang.Number pLoadPlanInstanceId, java.lang.Number pLoadPlanInstanceRunCount, oracle.odi.runtime.agent.invocation.StopType pStopType, java.lang.String pWorkRepositoryName) Stops a load plan instance run.
void	invokeStopSession(long pSessionId, oracle.odi.runtime.agent.invocation.StopType pStopType, java.lang.String pWorkRepoName) Stops a session.
void	invokeStopSession(long pSessionId, oracle.odi.runtime.agent.invocation.StopType pStopType, java.lang.String pWorkRepoName, java.util.Properties pInvocationProperties) Stops a session.
java.lang.Object	invokeTestDataServer(java.lang.Number pDataServerId) Tests a data server defines in the ODI topology.
java.lang.Object	invokeTestDataServer(java.lang.Number pDataServerId, StartupParams pGlobalVariables) Tests a data server defines in the ODI topology.
java.lang.Object	invokeTestDataServer(java.lang.Number pDataServerId, StartupParams pGlobalVariables, java.lang.String pTransactionId) Tests a data server defines in the ODI topology.
java.lang.Object	invokeTestDataServer(java.lang.Number pDataServerId, java.lang.String pTransactionId) Tests a data server defines in the ODI topology.
java.lang.Object	invokeTestDataServer(java.lang.String pUser, java.lang.String pEncPassword, java.lang.String pDriver, java.lang.String pUrl, java.lang.String pTechno, StartupParams pGlobalVariables, java.lang.String pTransactionId) Tests a data server that is not yet defined in the Topology.
java.lang.Object	invokeTestEnterpriseScheduler(java.lang.String pEnterpriseSchedulerName) Tests a data server defines in the ODI topology.
void	invokeUpdateSchedules() Asks the agent to compute its planning.
void	setPassword(char[] pPassword) sets the decrypted user password used to connect to the ODI instance.
void	setSSLConfiguration(java.util.HashMap lsSSLParameters) If this instance, needs to communicate with SSL-enabled agents, SSL parameters must be set by calling this method.
void	setUser(java.lang.String pUser) sets the ODI user name used to connect to the ODI instance.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RemoteRuntimeAgentInvoker

public RemoteRuntimeAgentInvoker(OdiInstance odiInst,
                                 java.lang.String pEngineUrl,
                                 java.lang.String pUser,
                                 char[] pPassword,
                                 java.lang.String pEngineName,
                                 java.lang.String pMasterRepoSignature)

This constructor requires ODI repo connectivities. It creates an invoker that supports invoking scenarios and design-time objects on a runtime engine as referenced by the runtime engine name. The named runtime engine could be an ODI Runtime agent engine or an external runtime engine, such as Oozie.

Parameters:

odiInst - ODI instance used for connecting to ODI repo for determining the runtime engine type and for other external runtime engine processing (e.g. workflow generation)

pEngineUrl - URL of the agent/external runtime engine that will be invoked. Must not be null or empty. It is defined in the ODI topology. A typical ODI Agent URL is http://managedservername:managedserverport/oraclediagent A typical ODI Oozie URL runtime engine is http://oozieHostName:11000/oozie

pUser - ODI user name used to connect to the ODI instance. must not be null or empty. The User must be defined in ODI Security.

pPassword - Decrypted user password used to connect to the ODI instance. The password must be defined in ODI Security.

pEngineName - Name of the runtime engine that will be invoked.

pMasterRepositorySignature - master repo signature of the runtime engine

RemoteRuntimeAgentInvoker

public RemoteRuntimeAgentInvoker(java.lang.String pAgentUrl,
                                 java.lang.String pUser,
                                 char[] pPassword,
                                 java.lang.String pAgentName,
                                 java.lang.String pMasterRepositorySignature)

Constructs a RemoteRuntimeAgentInvoker object.

Parameters:

pAgentUrl - URL of the agent that will be invoked. must not be null or empty. A typical URL is http://managedservername:managedserverport/oraclediagent. It is defined in the ODI topology.

pUser - ODI user name used to connect to the ODI instance. must not be null or empty. The User must be defined in ODI Security.

pPassword - Decrypted user password used to connect to the ODI instance. The password must be defined in ODI Security.

pAgentName - physical agent name that will be invoked. If not null, the name of the agent listening at pAgentUrl must be same as pAgentName.
Parameters values may be null.

pMasterRepositorySignature - master repository signature of the agent. If not null, the agent listening at pAgentUrl must be connected to the same master repository as specified by pMasterRepositorySignature.
Parameters values may be null.

RemoteRuntimeAgentInvoker

public RemoteRuntimeAgentInvoker(java.lang.String pAgentUrl,
                                 java.lang.String pUser,
                                 char[] pPassword)

Constructs a RemoteRuntimeAgentInvoker object.

Parameters:

pAgentUrl - URL of the agent that will be invoked. must not be null or empty. A typical URL is http://managedservername:managedserverport/oraclediagent. It is defined in the ODI topology.

pUser - ODI user name used to connect to the ODI instance. must not be null or empty. The User must be defined in ODI Security.

pPassword - Decrypted user password used to connect to the ODI instance. The password must be defined in ODI Security.

Method Detail

getAgentURL

public java.lang.String getAgentURL()

Returns the agent URL value.

Returns:

the URL of the agent that will be invoked

getUser

public java.lang.String getUser()

Returns the user name value.

Returns:

ODI user name used to connect to the ODI instance

See Also:

setUser(java.lang.String)

setUser

public void setUser(java.lang.String pUser)

sets the ODI user name used to connect to the ODI instance.

Parameters:

pUser - the ODI user name used to connect to the ODI instance

See Also:

getUser()

getCharArrayPassword

public char[] getCharArrayPassword()

Returns the decrypted user password used to connect to the ODI instance.

Returns:

the decrypted user password used to connect to the ODI instance

setPassword

public void setPassword(char[] pPassword)

sets the decrypted user password used to connect to the ODI instance.

Parameters:

pPassword - the decrypted user password used to connect to the ODI instance

See Also:

#getPassword

invokeGetSchedules

public SchedulingInfo invokeGetSchedules(long pStart,
                                         long pEnd)
                                  throws InvocationException

Returns the schedules information for the agent in the interval defined between the two parameters and for all the work repositories linked to the master repository to which the ODI agent is connected.

Parameters:

pStart - lower limit of the time interval for schedules searched

pEnd - upper limit of the time interval for schedules searched

Returns:

SchedulingInfo the detail on the schedules defined on this agent for all work repositories.

Throws:

InvocationException - if the schedules retrieval didn't succeed.

invokeGetSchedules

public SchedulingInfo invokeGetSchedules(java.lang.String pWorkrep,
                                         long pStart,
                                         long pEnd)
                                  throws InvocationException

Returns the schedules information for the agent in the interval defined between the two parameters. If workrep is not null then the schedules would be retrieved for the given work repository otherwise schedules would be retrieved from all work repositories.

Parameters:

pWorkrep - the name of the work repository to use

pStart - lower limit of the time interval for schedules searched

pEnd - upper limit of the time interval for schedules searched

Returns:

a SchedulingInfo object holding the schedules information

Throws:

InvocationException - if the schedules retrieval didn't succeed.

invokeComputePlanning

public void invokeComputePlanning()
                           throws InvocationException

Asks the agent to recompute its schedules for all the work repositories.
The ODI agent will take into account all the new data defined in the ODI work repositories to compute and manage a new list of schedules.

Throws:

InvocationException

invokeComputePlanning

public void invokeComputePlanning(java.lang.String pWorkrep)
                           throws InvocationException

Asks the agent to recompute its schedules for the given work repository. The work repository must be defined in ODI Topology.

Parameters:

pWorkrep - the name of the work repository on which the plannings will computed

Throws:

InvocationException

invokeIsAlive

public java.lang.String invokeIsAlive()
                               throws InvocationException

Ping the agent.

Specified by:

invokeIsAlive in interface IRuntimeEngineInvoker

Returns:

the version of the agent

Throws:

InvocationException - if the agent was unreachable

invokeIsAlive

public java.lang.String invokeIsAlive(java.lang.String pSignature)
                               throws InvocationException

Deprecated. invokeIsAlive Ping the agent.

Parameters:

pSignature - the signature of the master repository

Returns:

the version of the agent

Throws:

InvocationException - if the agent was unreachable

invokeGetAgentVersion

public java.lang.String invokeGetAgentVersion()
                                       throws InvocationException

Returns the version of the agent.

Returns:

the version of the agent.

Throws:

InvocationException - if the agent was unreachable

invokeRemoteObject

public RemoteObjectResult invokeRemoteObject(java.lang.String pObjectId,
                                             java.lang.String pClassName,
                                             java.lang.String pMethodName,
                                             java.lang.String pParameter)
                                      throws InvocationException

Remotely invoke the given method with the given parameter on the remote object instance (class and ID).

Parameters:

pObjectId - Instance identifier. If null or empty, a new instance of the object will be created.

pClassName - Class of the object to invoke. must not be null or empty

pMethodName - Name of the method to invoke on the object must not be null or empty

pParameter - parameter value for the method invoked.

Returns:

the result of the method invocation

Throws:

InvocationException - if the invocation failed

invokeRestartSession

public ExecutionInfo invokeRestartSession(long pSessionId,
                                          StartupParams pVariables,
                                          boolean pSynchronous,
                                          java.lang.String pWorkRepName,
                                          boolean pKeepSessionParams)
                                   throws InvocationException

Deprecated. Since 11.1.1.6.0. Instead use invokeRestartSession(long pSessionId, StartupParams pVariables, boolean pSynchronous, String pWorkRepName,boolean pKeepSessionParams, Integer pLogLevel) This method uses default log level of null.

Restarts a session with various parameters.

Parameters:

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 synchronous

pWorkRepName - 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.

pKeepSessionParams - 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.
if pKeepSessionParams is false, then the default value of the variable will be used for this restart.

Returns:

information on the session execution.

Throws:

InvocationException - if the invocation failed

invokeRestartSession

public ExecutionInfo invokeRestartSession(long pSessionId,
                                          StartupParams pVariables,
                                          boolean pSynchronous,
                                          java.lang.String pWorkRepName)
                                   throws InvocationException

Deprecated. Since 11.1.1.6.0. Instead use invokeRestartSession(long pSessionId, StartupParams pVariables, boolean pSynchronous, String pWorkRepName, Integer pLogLevel) This method uses default log level of null.

Restarts a session with various parameters.
If a variable value is not redefined in pVariables, then the last execution value will be used.

Parameters:

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 synchronous

pWorkRepName - 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.

Returns:

information on the session execution.

Throws:

InvocationException - if the invocation failed

invokeRestartSession

public ExecutionInfo invokeRestartSession(long pSessionId,
                                          StartupParams pVariables,
                                          boolean pSynchronous,
                                          java.lang.String pWorkRepName,
                                          java.lang.Integer pLogLevel)
                                   throws InvocationException

Restarts a session with various parameters.
If a variable value is not redefined in pVariables, then the last execution value will be used.

Parameters:

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 synchronous

pWorkRepName - 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.

pLogLevel - is the logging level for restarting a session

Returns:

information on the session execution.

Throws:

InvocationException - if the invocation failed

Since:

11.1.1.6.0

invokeRestartSession

public ExecutionInfo invokeRestartSession(long pSessionId,
                                          StartupParams pVariables,
                                          boolean pSynchronous,
                                          java.lang.String pWorkRepName,
                                          boolean pKeepSessionParams,
                                          java.lang.Integer pLogLevel)
                                   throws InvocationException

Restarts a session with various parameters.

Parameters:

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 synchronous

pWorkRepName - 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.

pKeepSessionParams - 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.
if pKeepSessionParams is false, then the default value of the variable will be used for this restart.

pLogLevel - is logging level for session restart. Uses null as default, which will be eventually set from the previous run.

Returns:

information on the session execution.

Throws:

InvocationException - if the invocation failed

Since:

11.1.1.6.0

invokeRestartSession

public ExecutionInfo invokeRestartSession(long pSessionId,
                                          StartupParams pVariables,
                                          boolean pSynchronous,
                                          java.lang.String pWorkRepName,
                                          boolean pKeepSessionParams,
                                          java.lang.Integer pLogLevel,
                                          DebugParams pDebugParams)
                                   throws InvocationException

Restarts a session with various parameters. Supports debug flags.

Parameters:

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 synchronous

pWorkRepName - 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.

pKeepSessionParams - 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.
if pKeepSessionParams is false, then the default value of the variable will be used for this restart.

pLogLevel - is logging level for session restart. Uses null as default, which will be eventually set from the previous run.

pDebugParams - configuration for controlling debugging. null if not to be launched in debug mode.

Returns:

information on the session execution.

Throws:

InvocationException - if the invocation failed

Since:

12.1.2

invokeRestartSession

public ExecutionInfo invokeRestartSession(long pSessionId,
                                          StartupParams pVariables,
                                          boolean pSynchronous,
                                          java.lang.String pWorkRepName,
                                          java.util.Properties pInvocationProperties,
                                          boolean pKeepSessionParams,
                                          java.lang.Integer pLogLevel)
                                   throws InvocationException

Description copied from interface: IRuntimeEngineInvoker

Restarts a session with various parameters. Available for ODI agent and external runtime engines.

Specified by:

invokeRestartSession in interface IRuntimeEngineInvoker

Parameters:

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 synchronous

pWorkRepName - 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 from

pKeepSessionParams - 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.
if pKeepSessionParams is false, then the default value of the variable will be used for this restart.

pLogLevel - is logging level for session restart. Uses null as default, which will be eventually set from the previous run.

Returns:

information on the session execution.

Throws:

InvocationException - if the invocation failed

invokeStartScenario

public ExecutionInfo invokeStartScenario(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,
                                         boolean pSynchronous,
                                         java.lang.String pWorkRepName)
                                  throws InvocationException

Starts the given scenario with various parameters.

Parameters:

pScenName - name of the scenario to run. Must not be null or empty

pScenVersion - version of the scenario to run. If null or -1, the last version of the scenario will be executed. Must not be empty

pVariables - 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 created

pContextCode - 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.

pSynchronous - Is this execution synchronous

pWorkRepName - the name of the work repository containing this scenario. Must not be null.

Returns:

information on the scenario execution

Throws:

InvocationException - if the invocation failed

invokeStartScenario

public ExecutionInfo invokeStartScenario(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,
                                         boolean pSynchronous,
                                         java.lang.String pWorkRepName,
                                         java.util.Properties pInvocationProperties)
                                  throws InvocationException

Starts the given scenario with various parameters.

Parameters:

pScenName - name of the scenario to run. Must not be null or empty

pScenVersion - version of the scenario to run. If null or -1, the last version of the scenario will be executed. Must not be empty

pVariables - 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 created

pContextCode - 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.

pSynchronous - Is this execution synchronous

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 from

Returns:

information on the scenario execution

Throws:

InvocationException - if the invocation failed

Since:

11.1.1.5.0

invokeStartScenario

public ExecutionInfo invokeStartScenario(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,
                                         boolean pSynchronous,
                                         java.lang.String pWorkRepName,
                                         java.util.Properties pInvocationProperties,
                                         DebugParams pDebugParams)
                                  throws InvocationException

Starts the given scenario with various parameters. Supports debug flags.

Parameters:

pScenName - name of the scenario to run. Must not be null or empty

pScenVersion - version of the scenario to run. If null or -1, the last version of the scenario will be executed. Must not be empty

pVariables - 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 created

pContextCode - 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.

pSynchronous - Is this execution synchronous

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 from

pDebugParams - configuration for controlling debugging. null if Session is not to be launched in debug mode.

Returns:

information on the scenario execution

Throws:

InvocationException - if the invocation failed

Since:

12.1.2

invokeStartScenario

public ExecutionInfo invokeStartScenario(java.lang.String pScenName,
                                         java.lang.String pScenVersion,
                                         StartupParams pVariables,
                                         java.lang.String pKeywords,
                                         java.lang.String pContextCode,
                                         IRuntimeEngineInvoker.IndLogMethod pSessLogMethod,
                                         IRuntimeEngineInvoker.IndLogMethod pStepLogMethod,
                                         java.lang.Integer pLogLevel,
                                         java.lang.String pSessionName,
                                         boolean pSynchronous,
                                         java.lang.String pWorkRepName,
                                         java.util.Properties pInvocationProperties,
                                         java.lang.Long pParentSession,
                                         java.lang.String pMasterAgentName)
                                  throws InvocationException

Description copied from interface: IRuntimeEngineInvoker

Starts the given scenario with various parameters. Available for ODI agent and external runtime engines.

Specified by:

invokeStartScenario in interface IRuntimeEngineInvoker

Parameters:

pScenName - name of the scenario to run. Must not be null or empty

pScenVersion - version of the scenario to run. If null or -1, the last version of the scenario will be executed. Must not be empty

pVariables - 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 created

pContextCode - code of the context on which to execute. If null, the default context defined in the ODI Topology will be used.

pSessLogMethod - the session logging method. null to use default behavior.

pStepLogMethod - 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 synchronous

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 from

pParentSession - The parent session Id. null if not applicable.

pMasterAgentName - The master runtime engine name. null if not applicable.

Returns:

information on the scenario execution

Throws:

InvocationException - if the invocation failed

invokeDryrunDeployScenario

public 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)
                                throws InvocationException

Description copied from interface: IRuntimeEngineInvoker

Invoke a dryrun validation and deploy operation with the given scenario with various parameters. Available for external runtime engines only. Not available for ODI Agent runtime engines.

Specified by:

invokeDryrunDeployScenario in interface IRuntimeEngineInvoker

Parameters:

pScenName - name of the scenario to run. Must not be null or empty

pScenVersion - version of the scenario to run. If null or -1, the last version of the scenario will be executed. Must not be empty

pVariables - 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 created

pContextCode - 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 from

pParentSessNo - The parent session Id. null if not applicable.

pMasterRuntimeEngineName - The master runtime engine name. null if not applicable.

Throws:

InvocationException - if the invocation failed

invokeGetSessionStatus

public java.util.List invokeGetSessionStatus(java.util.List pSessionIds,
                                             java.lang.String pWorkRepositoryName)
                                      throws InvocationException

Return the status of given session ids. Use in conjonction with #invokeStartScenario(String, String, StartupParams, String, int, boolean, DataSourceDefinition, String, String, String) to follow the execution of a scenario.

Parameters:

pSessionIds - a list of sessions ids. All the session must have been executed on the same work repository.

pWorkRepositoryName - the name on which the session interrogated have been executed. Must not be null or empty. Must be defined in the ODI Topology.

Returns:

the list of session information for the given session ids.

Throws:

InvocationException

invokeUpdateSchedules

public void invokeUpdateSchedules()
                           throws InvocationException

Asks the agent to compute its planning.

Throws:

InvocationException - if the invocation failed.

invokeTestDataServer

public java.lang.Object invokeTestDataServer(java.lang.Number pDataServerId)
                                      throws InvocationException

Tests a data server defines in the ODI topology. The target data source will be pinged.

Parameters:

pDataServerId - the ID of the data server as defined in the ODI topology. Must not be null.

Throws:

InvocationException - if the invocation failed or if the data server test didn't succeed or if no data server with this identifier exists

invokeTestDataServer

public java.lang.Object invokeTestDataServer(java.lang.Number pDataServerId,
                                             java.lang.String pTransactionId)
                                      throws InvocationException

Tests a data server defines in the ODI topology. The target data source will be pinged.

Parameters:

pDataServerId - the ID of the data server as defined in the ODI topology. Must not be null.

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.

Throws:

InvocationException - if the invocation failed or if the data server test didn't succeed or if no data server with this identifier exists

Since:

11.1.1.5.0

invokeTestDataServer

public java.lang.Object invokeTestDataServer(java.lang.Number pDataServerId,
                                             StartupParams pGlobalVariables)
                                      throws InvocationException

Tests a data server defines in the ODI topology. The target data source will be pinged.

Parameters:

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)

Throws:

InvocationException - if the invocation failed or if the data server test didn't succeed or if no data server with this identifier exists

Since:

11.1.1.5.0

invokeTestDataServer

public java.lang.Object invokeTestDataServer(java.lang.Number pDataServerId,
                                             StartupParams pGlobalVariables,
                                             java.lang.String pTransactionId)
                                      throws InvocationException

Tests a data server defines in the ODI topology. The target data source will be pinged.

Specified by:

invokeTestDataServer in interface IRuntimeEngineInvoker

Parameters:

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.

Returns:

the details about the test data server operation

Throws:

InvocationException - if the invocation failed or if the data server test didn't succeed or if no data server with this identifier exists

Since:

11.1.1.5.0

invokeTestDataServer

public java.lang.Object invokeTestDataServer(java.lang.String pUser,
                                             java.lang.String pEncPassword,
                                             java.lang.String pDriver,
                                             java.lang.String pUrl,
                                             java.lang.String pTechno,
                                             StartupParams pGlobalVariables,
                                             java.lang.String pTransactionId)
                                      throws InvocationException

Tests a data server that is not yet defined in the Topology. The target data source will be pinged.

Specified by:

invokeTestDataServer in interface IRuntimeEngineInvoker

Parameters:

pUser - the data server user.

pEncPassword - the data server password. Encoded with odiInstance.

pDriver - the data server driver.

pUrl - the data server url.

pTechno - the data server technology.

pGlobalVariables - List of global variables (for substitution if used in connection definition)

pTransactionId - Used to identify if OnConnect/OnDisconnect command need to be executed on the conneciton as part of the test.

Throws:

InvocationException - if the invocation failed or if the data server test didn't succeed or if no data server with this identifier exists

Since:

12.2.1

invokeTestEnterpriseScheduler

public java.lang.Object invokeTestEnterpriseScheduler(java.lang.String pEnterpriseSchedulerName)
                                               throws InvocationException

Tests a data server defines in the ODI topology. The target data source will be pinged.

Parameters:

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.

Throws:

InvocationException - if the invocation failed or if the data server test didn't succeed or if no data server with this identifier exists

Since:

11.1.1.9.0

invokeStopSession

public void invokeStopSession(long pSessionId,
                              oracle.odi.runtime.agent.invocation.StopType pStopType,
                              java.lang.String pWorkRepoName)
                       throws InvocationException

Stops a session.

Specified by:

invokeStopSession in interface IRuntimeEngineInvoker

Parameters:

pSessionId - the identifier of the session which needs to be stopped

pStopType - the mechanism to the stop the session

pWorkRepoName - name of the work repository where the session resides. Must not be null or empty. Must be defined in ODI Topology.

Throws:

InvocationException - if the invocation failed

invokeStopSession

public void invokeStopSession(long pSessionId,
                              oracle.odi.runtime.agent.invocation.StopType pStopType,
                              java.lang.String pWorkRepoName,
                              java.util.Properties pInvocationProperties)
                       throws InvocationException

Stops a session.

Parameters:

pSessionId - the identifier of the session which needs to be stopped

pStopType - the mechanism to the stop the session

pWorkRepoName - name of the work repository where the session resides. Must not be null or empty. Must be defined in ODI Topology.

pInvocationProperties - - invocation properties - may contain master repository signature

Throws:

InvocationException - if the invocation failed

invokeKillAgent

public void invokeKillAgent(boolean pImmediate,
                            long pMaxWait)
                     throws InvocationException

Kills the agent. Works only if the agent is a standalone ODI agent.

Parameters:

pImmediate - Indicates whether to kill the agent immediately or not.

pMaxWait - the number of milliseconds given to the agent to end its running task before being killed. Used only when pImmediate = false

Throws:

InvocationException - if the invocation failed

invokeCleanStaleSessionsForAllWorkRepositories

public java.util.List invokeCleanStaleSessionsForAllWorkRepositories()
                                                              throws InvocationException

Cleans the stale sessions for all work repositories defined in connected master repository.

Returns:

a list of WorkRepositoryInfo

Throws:

InvocationException - if the invocation failed.

invokeCleanStaleSessions

public WorkRepositoryInfo invokeCleanStaleSessions(java.lang.String pWorkRepositoryName)
                                            throws InvocationException

Cleans the stale sessions in the specified work repository.

Parameters:

pWorkRepositoryName - the name of the work repository. This cannot be null

Returns:

a WorkRepositoryInfo

Throws:

InvocationException - if the invocation failed.

invokeGetJMXServiceInfo

public oracle.odi.runtime.agent.invocation.response.OdiGetJMXServiceInfoAckType invokeGetJMXServiceInfo()
                                                                                                 throws InvocationException

Returns the JMXServiceInfo details about the current agent.

Returns:

a OdiGetJMXServiceInfoAckType

Throws:

InvocationException - if the invocation failed

invokeStartLoadPlan

public LoadPlanExecutionInfo invokeStartLoadPlan(java.lang.String pLoadPlanName,
                                                 java.lang.String pContextCode,
                                                 LoadPlanStartupParams pStartupParams,
                                                 java.lang.String pKeywords,
                                                 java.lang.String pWorkRepositoryName)
                                          throws InvocationException

Deprecated. Since 11.1.1.6.0. Instead use invokeStartLoadPlan(String pLoadPlanName, String pContextCode, LoadPlanStartupParams pStartupParams, String pKeywords, String pWorkRepositoryName, Integer pLogLevel) This method uses default log level of null.

Starts a load plan instance run with various parameters.

Parameters:

pLoadPlanName - Name of the load plan to start.

pContextCode - code of the context on which to execute. If null, the default context defined in the ODI Topology will be used.

pStartupParams - Load plan start up parameters LoadPlanStartupParams.

pKeywords - Keywords (if more than one, separated by commas) for the load plan instance run.

pWorkRepositoryName - Work repository name.

Returns:

LoadPlanExecutionInfo object. The LoadPlanExecutionInfo#getInstanceId() and LoadPlanExecutionInfo.getRunCount() methods return the instance id and the run count of the load plan that was started.

Throws:

InvocationException - if the invocation failed.

Since:

11.1.1.5.0

invokeStartLoadPlan

public LoadPlanExecutionInfo invokeStartLoadPlan(java.lang.String pLoadPlanName,
                                                 java.lang.String pContextCode,
                                                 LoadPlanStartupParams pStartupParams,
                                                 java.lang.String pKeywords,
                                                 java.lang.String pWorkRepositoryName,
                                                 java.lang.Integer pLogLevel)
                                          throws InvocationException

Starts a load plan instance run with various parameters.

Parameters:

pLoadPlanName - Name of the load plan to start.

pContextCode - code of the context on which to execute. If null, the default context defined in the ODI Topology will be used.

pStartupParams - Load plan start up parameters LoadPlanStartupParams.

pKeywords - Keywords (if more than one, separated by commas) for the load plan instance run.

pWorkRepositoryName - Work repository name.

pLogLevel - Logging level for starting a loadplan execution. default is null. uses pre-defined log level set on the loadplan

Returns:

LoadPlanExecutionInfo object. The LoadPlanExecutionInfo#getInstanceId() and LoadPlanExecutionInfo.getRunCount() methods return the instance id and the run count of the load plan that was started.

Throws:

InvocationException - if the invocation failed.

Since:

11.1.1.6.0

invokeStartLoadPlan

public LoadPlanExecutionInfo invokeStartLoadPlan(java.lang.String pLoadPlanName,
                                                 java.lang.String pContextCode,
                                                 LoadPlanStartupParams pStartupParams,
                                                 java.lang.String pKeywords,
                                                 java.lang.String pWorkRepositoryName,
                                                 java.util.Properties pInvocationProperties)
                                          throws InvocationException

Deprecated. Since 11.1.1.6.0. Instead use invokeStartLoadPlan(String pLoadPlanName, String pContextCode, LoadPlanStartupParams pStartupParams, String pKeywords, String pWorkRepositoryName, Properties pInvocationProperties, Integer pLogLevel) This method uses default log level of null to maintain 11.1.1.5.0 behavior.

Starts a load plan instance run with various parameters.

Parameters:

pLoadPlanName - Name of the load plan to start.

pContextCode - code of the context on which to execute. If null, the default context defined in the ODI Topology will be used.

pStartupParams - Load plan start up parameters LoadPlanStartupParams.

pKeywords - Keywords (if more than one, separated by commas) for the load plan instance run.

pWorkRepositoryName - Work repository name.

pInvocationProperties - Properties for invoking the load plan.

Returns:

LoadPlanExecutionInfo object. The LoadPlanExecutionInfo#getInstanceId() and LoadPlanExecutionInfo.getRunCount() methods return the instance id and the run count of the load plan that was started.

Throws:

InvocationException - if the invocation failed.

Since:

11.1.1.5.0

invokeStartLoadPlan

public LoadPlanExecutionInfo invokeStartLoadPlan(java.lang.String pLoadPlanName,
                                                 java.lang.String pContextCode,
                                                 LoadPlanStartupParams pStartupParams,
                                                 java.lang.String pKeywords,
                                                 java.lang.String pWorkRepositoryName,
                                                 java.util.Properties pInvocationProperties,
                                                 java.lang.Integer pLogLevel)
                                          throws InvocationException

Starts a load plan instance run with various parameters.

Parameters:

pLoadPlanName - Name of the load plan to start.

pContextCode - code of the context on which to execute. If null, the default context defined in the ODI Topology will be used.

pStartupParams - Load plan start up parameters LoadPlanStartupParams.

pKeywords - Keywords (if more than one, separated by commas) for the load plan instance run.

pWorkRepositoryName - Work repository name.

pInvocationProperties - Properties for invoking the load plan.

pLogLevel - Logging level for starting a loadplan execution. default is null. uses pre-defined log level set on the loadplan

Returns:

LoadPlanExecutionInfo object. The LoadPlanExecutionInfo#getInstanceId() and LoadPlanExecutionInfo.getRunCount() methods return the instance id and the run count of the load plan that was started.

Throws:

InvocationException - if the invocation failed.

Since:

11.1.1.6.0

invokeStopLoadPlan

public LoadPlanExecutionInfo invokeStopLoadPlan(java.lang.Number pLoadPlanInstanceId,
                                                java.lang.Number pLoadPlanInstanceRunCount,
                                                oracle.odi.runtime.agent.invocation.StopType pStopType,
                                                java.lang.String pWorkRepositoryName)
                                         throws InvocationException

Stops a load plan instance run.

Parameters:

pLoadPlanInstanceId - Id of the load plan instance to stop.

pLoadPlanInstanceRunCount - Run count of the load plan instance to stop. A value of 0 will stop the most recent run.

pStopType - Specify how the load plan run and its associated sessions are stopped - normally StopType.NORMAL or immediately StopType.IMMEDIATE. This is what gets propagated when stopping all the sessions associated with the load plan instance.

pWorkRepositoryName - Work repository name.

Returns:

LoadPlanExecutionInfo object. The LoadPlanExecutionInfo.getRunCount() method returns the run count of the load plan instance that was actually stopped.

Throws:

InvocationException - if the invocation failed.

Since:

11.1.1.5.0

invokeRestartLoadPlanInstance

public LoadPlanExecutionInfo invokeRestartLoadPlanInstance(java.lang.Number pLoadPlanInstanceId,
                                                           java.lang.String pWorkRepositoryName)
                                                    throws InvocationException

Deprecated. Since 11.1.1.6.0. Instead use invokeRestartLoadPlanInstance(Number pLoadPlanInstanceId, String pWorkRepositoryName, Integer pLogLevel). This method uses default log level null. If log level is not set, restartLoadPlan will use the log level from the previous run.

Restarts a load plan instance that was previously stopped manually or due to an error.

Parameters:

pLoadPlanInstanceId - Id of the load plan instance to restart.

pWorkRepositoryName - Work repository name.

Returns:

LoadPlanExecutionInfo object. The LoadPlanExecutionInfo.getRunCount() method returns the run count of the restarted load plan instance.

Throws:

InvocationException - if the invocation failed

Since:

11.1.1.5.0

invokeRestartLoadPlanInstance

public LoadPlanExecutionInfo invokeRestartLoadPlanInstance(java.lang.Number pLoadPlanInstanceId,
                                                           java.lang.String pWorkRepositoryName,
                                                           java.lang.Integer pLogLevel)
                                                    throws InvocationException

Restarts a load plan instance that was previously stopped manually or due to an error.

Parameters:

pLoadPlanInstanceId - Id of the load plan instance to restart.

pWorkRepositoryName - Work repository name.

pLogLevel - Logging level for restarting a load plan instance. If null, default log level is retrieved from previous run.

Returns:

LoadPlanExecutionInfo object. The LoadPlanExecutionInfo.getRunCount() method returns the run count of the restarted load plan instance.

Throws:

InvocationException - if the invocation failed

Since:

11.1.1.6.0

invokeRestartLoadPlanInstance

public LoadPlanExecutionInfo invokeRestartLoadPlanInstance(java.lang.Number pLoadPlanInstanceId,
                                                           java.lang.String pWorkRepositoryName,
                                                           java.lang.Integer pLogLevel,
                                                           java.util.Properties pInvocationProperties)
                                                    throws InvocationException

Restarts a load plan instance that was previously stopped manually or due to an error.

Parameters:

pLoadPlanInstanceId - Id of the load plan instance to restart.

pWorkRepositoryName - Work repository name.

pLogLevel - Logging level for restarting a load plan instance. If null, default log level is retrieved from previous run.

pInvocationProperties - - invocation properties - such as master repository signature.

Returns:

LoadPlanExecutionInfo object. The LoadPlanExecutionInfo.getRunCount() method returns the run count of the restarted load plan instance.

Throws:

InvocationException - if the invocation failed

Since:

11.1.1.6.0

invokeGetLoadPlanStatus

public java.util.List invokeGetLoadPlanStatus(java.util.List pLoadPlanInstanceIds,
                                              java.util.List pLoadPlanRunNumbers,
                                              java.lang.String pWorkRepositoryName)
                                       throws InvocationException

Returns the status of the specified load plans.

Parameters:

pLoadPlanInstanceIds - A list of load plan instance id.

pLoadPlanRunNumbers - A list of load plan run count.

pWorkRepositoryName - Work repository name.

Returns:

A list of LoadPlanStatusInfo.

Throws:

InvocationException - if the invocation failed.

Since:

11.1.1.5.0

invokeRefreshAgentConfig

public void invokeRefreshAgentConfig()
                              throws InvocationException

Notifies the Agent to synchronize the agent configuration with repository, such as the Session Blueprint cache configuration and the agent Max Threads and Max Threads Per Session settings.

Throws:

InvocationException - if the invocation failed.

Since:

12.1.2

invokeRefreshAgentConfig

public void invokeRefreshAgentConfig(java.util.Set pInitOptions,
                                     java.util.Properties pInitProperties)
                              throws InvocationException

Description copied from interface: IRuntimeEngineInvoker

Initialize and prepare the runtime engine for ODI operations. For example, for ODI agent runtime engine, synchronize the agent configuration with repository; for Oozie external engine, deploy and start the log retrieval coordinator and workflow.

Specified by:

invokeRefreshAgentConfig in interface IRuntimeEngineInvoker

Parameters:

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.

Throws:

InvocationException - if the invocation failed.

setSSLConfiguration

public void setSSLConfiguration(java.util.HashMap lsSSLParameters)

If this instance, needs to communicate with SSL-enabled agents, SSL parameters must be set by calling this method. Here SSL password parameters are encrypted by VM-Instance-encryption.

Parameters:

lsSSLParameters - List of SSL parameters.Shoud contain the below SSL Parameters. javax.net.ssl.keyStore - Location of the KeyStore javax.net.ssl.keyStoreType - KeyStore type javax.net.ssl.trustStore - Location of the TrustStore javax.net.ssl.trustStoreType - TrustStore type javax.net.ssl.keyStorePassword - Clear text KeyStore password javax.net.ssl.trustStorePassword- Clear text TrustStore password

Since:

12.1.1.3.0