|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.6.0) E17060-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.odi.runtime.agent.invocation.RemoteRuntimeAgentInvoker
public class RemoteRuntimeAgentInvoker
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:
Constructor Summary | |
---|---|
RemoteRuntimeAgentInvoker(java.lang.String pAgentUrl, java.lang.String pUser, char[] pPassword) Constructs a RemoteRuntimeAgentInvoker object. |
Method Summary | |
---|---|
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<WorkRepositoryInfo> |
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. |
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<LoadPlanStatusInfo> |
invokeGetLoadPlanStatus(java.util.List<? extends java.lang.Number> pLoadPlanInstanceIds, java.util.List<? extends java.lang.Number> 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<SessionStatusInfo> |
invokeGetSessionStatus(java.util.List<java.lang.Long> 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) Ping the agent. |
void |
invokeKillAgent(boolean pImmediate, long pMaxWait) Kills the agent. |
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) Deprecated. |
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, 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. |
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. |
LoadPlanExecutionInfo |
invokeStopLoadPlan(java.lang.Number pLoadPlanInstanceId, java.lang.Number pLoadPlanInstanceRunCount, StopType pStopType, java.lang.String pWorkRepositoryName) Stops a load plan instance run. |
void |
invokeStopSession(long pSessionId, StopType pStopType, java.lang.String pWorkRepoName) Stops a session. |
void |
invokeStopSession(long pSessionId, StopType pStopType, java.lang.String pWorkRepoName, java.util.Properties pInvocationProperties) Stops a session. |
void |
invokeTestDataServer(java.lang.Number pDataServerId) Tests a data server defines in the ODI topology. |
void |
invokeTestDataServer(java.lang.Number pDataServerId, StartupParams pGlobalVariables) Tests a data server defines in the ODI topology. |
void |
invokeTestDataServer(java.lang.Number pDataServerId, StartupParams pGlobalVariables, java.lang.String pTransactionId) Tests a data server defines in the ODI topology. |
void |
invokeTestDataServer(java.lang.Number pDataServerId, java.lang.String pTransactionId) 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 |
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 |
---|
public RemoteRuntimeAgentInvoker(java.lang.String pAgentUrl, java.lang.String pUser, char[] pPassword)
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 |
---|
public java.lang.String getAgentURL()
public java.lang.String getUser()
setUser(java.lang.String)
public void setUser(java.lang.String pUser)
pUser
- the ODI user name used to connect to the ODI instancegetUser()
public char[] getCharArrayPassword()
public void setPassword(char[] pPassword)
pPassword
- the decrypted user password used to connect to the ODI instance#getPassword
public SchedulingInfo invokeGetSchedules(long pStart, long pEnd) throws InvocationException
pStart
- lower limit of the time interval for schedules searchedpEnd
- upper limit of the time interval for schedules searchedSchedulingInfo
the detail on the schedules defined on this agent for all work repositories.InvocationException
- if the schedules retrieval didn't succeed.public SchedulingInfo invokeGetSchedules(java.lang.String pWorkrep, long pStart, long pEnd) throws InvocationException
pWorkrep
- the name of the work repository to usepStart
- lower limit of the time interval for schedules searchedpEnd
- upper limit of the time interval for schedules searchedSchedulingInfo
object holding the schedules informationInvocationException
- if the schedules retrieval didn't succeed.public void invokeComputePlanning() throws InvocationException
InvocationException
public void invokeComputePlanning(java.lang.String pWorkrep) throws InvocationException
pWorkrep
- the name of the work repository on which the plannings will computedInvocationException
public java.lang.String invokeIsAlive() throws InvocationException
InvocationException
- if the agent was unreachablepublic java.lang.String invokeIsAlive(java.lang.String pSignature) throws InvocationException
pSignature
- the signature of the master repositoryInvocationException
- if the agent was unreachablepublic java.lang.String invokeGetAgentVersion() throws InvocationException
InvocationException
- if the agent was unreachablepublic RemoteObjectResult invokeRemoteObject(java.lang.String pObjectId, java.lang.String pClassName, java.lang.String pMethodName, java.lang.String pParameter) throws InvocationException
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 emptypMethodName
- Name of the method to invoke on the object must not be null or emptypParameter
- parameter value for the method invoked.InvocationException
- if the invocation failedpublic ExecutionInfo invokeRestartSession(long pSessionId, StartupParams pVariables, boolean pSynchronous, java.lang.String pWorkRepName, boolean pKeepSessionParams) throws InvocationException
invokeRestartSession(long pSessionId, StartupParams pVariables, boolean pSynchronous, String pWorkRepName,boolean pKeepSessionParams, Integer pLogLevel)
This method uses default log level of null.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.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.InvocationException
- if the invocation failedpublic ExecutionInfo invokeRestartSession(long pSessionId, StartupParams pVariables, boolean pSynchronous, java.lang.String pWorkRepName) throws InvocationException
invokeRestartSession(long pSessionId, StartupParams pVariables, boolean pSynchronous, String pWorkRepName, Integer pLogLevel)
This method uses default log level of null.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.InvocationException
- if the invocation failedpublic ExecutionInfo invokeRestartSession(long pSessionId, StartupParams pVariables, boolean pSynchronous, java.lang.String pWorkRepName, 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.pLogLevel
- is the logging level for restarting a sessionInvocationException
- if the invocation failedpublic ExecutionInfo invokeRestartSession(long pSessionId, StartupParams pVariables, boolean pSynchronous, java.lang.String pWorkRepName, 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.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.pLogLevel
- is logging level for session restart. Uses null as default, which will be eventually set from the previous run.InvocationException
- if the invocation failedpublic 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
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.pSynchronous
- Is this execution synchronouspWorkRepName
- the name of the work repository containing this scenario. Must not be null.InvocationException
- if the invocation failedpublic 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
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.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 fromInvocationException
- if the invocation failedpublic java.util.List<SessionStatusInfo> invokeGetSessionStatus(java.util.List<java.lang.Long> pSessionIds, java.lang.String pWorkRepositoryName) throws InvocationException
#invokeStartScenario(String, String, StartupParams, String, int, boolean, DataSourceDefinition, String, String, String)
to follow the execution of a scenario.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.InvocationException
public void invokeUpdateSchedules() throws InvocationException
InvocationException
- if the invocation failed.public void invokeTestDataServer(java.lang.Number pDataServerId) throws InvocationException
pDataServerId
- the ID of the data server as defined in the ODI topology. Must not be null.InvocationException
- if the invocation failed or if the data server test didn't succeed or if no data server with this identifier existspublic void invokeTestDataServer(java.lang.Number pDataServerId, java.lang.String pTransactionId) throws InvocationException
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.InvocationException
- if the invocation failed or if the data server test didn't succeed or if no data server with this identifier existspublic void invokeTestDataServer(java.lang.Number pDataServerId, StartupParams pGlobalVariables) 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)InvocationException
- if the invocation failed or if the data server test didn't succeed or if no data server with this identifier existspublic void 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 existspublic void invokeStopSession(long pSessionId, 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 failedpublic void invokeStopSession(long pSessionId, StopType pStopType, java.lang.String pWorkRepoName, java.util.Properties pInvocationProperties) 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.pInvocationProperties
- - invocation properties - may contain master repository signatureInvocationException
- if the invocation failedpublic void invokeKillAgent(boolean pImmediate, long pMaxWait) throws InvocationException
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 = falseInvocationException
- if the invocation failedpublic java.util.List<WorkRepositoryInfo> invokeCleanStaleSessionsForAllWorkRepositories() throws InvocationException
WorkRepositoryInfo
InvocationException
- if the invocation failed.public WorkRepositoryInfo invokeCleanStaleSessions(java.lang.String pWorkRepositoryName) throws InvocationException
pWorkRepositoryName
- the name of the work repository. This cannot be nullWorkRepositoryInfo
InvocationException
- if the invocation failed.public oracle.odi.runtime.agent.invocation.response.OdiGetJMXServiceInfoAckType invokeGetJMXServiceInfo() throws InvocationException
OdiGetJMXServiceInfoAckType
InvocationException
- if the invocation failedpublic LoadPlanExecutionInfo invokeStartLoadPlan(java.lang.String pLoadPlanName, java.lang.String pContextCode, LoadPlanStartupParams pStartupParams, java.lang.String pKeywords, java.lang.String pWorkRepositoryName) throws InvocationException
invokeStartLoadPlan(String pLoadPlanName, String pContextCode, LoadPlanStartupParams pStartupParams, String pKeywords, String pWorkRepositoryName, Integer pLogLevel)
This method uses default log level of null.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.LoadPlanExecutionInfo
object. The LoadPlanExecutionInfo#getInstanceId()
and LoadPlanExecutionInfo.getRunCount()
methods return the instance id and the run count of the load plan that was started.InvocationException
- if the invocation failed.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
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 loadplanLoadPlanExecutionInfo
object. The LoadPlanExecutionInfo#getInstanceId()
and LoadPlanExecutionInfo.getRunCount()
methods return the instance id and the run count of the load plan that was started.InvocationException
- if the invocation failed.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
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.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.LoadPlanExecutionInfo
object. The LoadPlanExecutionInfo#getInstanceId()
and LoadPlanExecutionInfo.getRunCount()
methods return the instance id and the run count of the load plan that was started.InvocationException
- if the invocation failed.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
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 loadplanLoadPlanExecutionInfo
object. The LoadPlanExecutionInfo#getInstanceId()
and LoadPlanExecutionInfo.getRunCount()
methods return the instance id and the run count of the load plan that was started.InvocationException
- if the invocation failed.public LoadPlanExecutionInfo invokeStopLoadPlan(java.lang.Number pLoadPlanInstanceId, java.lang.Number pLoadPlanInstanceRunCount, StopType pStopType, java.lang.String pWorkRepositoryName) throws InvocationException
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.LoadPlanExecutionInfo
object. The LoadPlanExecutionInfo.getRunCount()
method returns the run count of the load plan instance that was actually stopped.InvocationException
- if the invocation failed.
@Deprecated
public LoadPlanExecutionInfo invokeRestartLoadPlanInstance(java.lang.Number pLoadPlanInstanceId,
java.lang.String pWorkRepositoryName)
throws InvocationException
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.pLoadPlanInstanceId
- Id of the load plan instance to restart.pWorkRepositoryName
- Work repository name.LoadPlanExecutionInfo
object. The LoadPlanExecutionInfo.getRunCount()
method returns the run count of the restarted load plan instance.InvocationException
- if the invocation failed
@Deprecated
public LoadPlanExecutionInfo invokeRestartLoadPlanInstance(java.lang.Number pLoadPlanInstanceId,
java.lang.String pWorkRepositoryName,
java.lang.Integer pLogLevel)
throws InvocationException
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.LoadPlanExecutionInfo
object. The LoadPlanExecutionInfo.getRunCount()
method returns the run count of the restarted load plan instance.InvocationException
- if the invocation failedpublic LoadPlanExecutionInfo invokeRestartLoadPlanInstance(java.lang.Number pLoadPlanInstanceId, java.lang.String pWorkRepositoryName, java.lang.Integer pLogLevel, java.util.Properties pInvocationProperties) throws InvocationException
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.LoadPlanExecutionInfo
object. The LoadPlanExecutionInfo.getRunCount()
method returns the run count of the restarted load plan instance.InvocationException
- if the invocation failedpublic java.util.List<LoadPlanStatusInfo> invokeGetLoadPlanStatus(java.util.List<? extends java.lang.Number> pLoadPlanInstanceIds, java.util.List<? extends java.lang.Number> pLoadPlanRunNumbers, java.lang.String pWorkRepositoryName) throws InvocationException
pLoadPlanInstanceIds
- A list of load plan instance id.pLoadPlanRunNumbers
- A list of load plan run count.pWorkRepositoryName
- Work repository name.LoadPlanStatusInfo
.InvocationException
- if the invocation failed.
|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.6.0) E17060-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |