RuntimeAgent (Oracle Fusion Middleware Java API Reference for Oracle Data Integrator)

Constructor Summary

Constructors
Constructor and Description

RuntimeAgent(OdiInstance pOdiInstance, java.lang.String pOdiUser, char[] pPassword)
Constructs a RuntimeAgent object.

Constructors
Constructor and Description
`RuntimeAgent(OdiInstance pOdiInstance, java.lang.String pOdiUser, char[] pPassword)` Constructs a RuntimeAgent object.

Method Summary

doclet.All_Methods doclet.Instance_Methods doclet.Concrete_Methods doclet.Deprecated_Methods
Modifier and Type	Method and Description
`WorkRepositoryInfo`	`cleanStaleSessions()` Clean the stale sessions present in the work repository.
`IAgentCredentialProvider`	`getCredentialProvider()`
`java.lang.String`	`getExecutionName()` Returns the Agent name that will appear in the execution log for a startScenario operation.
`ISessionInformation`	`getSessionInformation()`
`java.util.List`	`getSessionStatus(java.util.List pSessionIds)` Returns the sessions status.
`void`	`initializeDataServer(java.lang.Number pDataServerId, java.util.Properties pInitProps)` Initialize a data server as defined in the topology.
`java.lang.Object`	`previewFile(java.lang.Number pDataServerId, java.lang.Number pAmount)`
`void`	`previewFile(java.lang.Number pDataServerId, java.lang.Number pAmount, StartupParams pGlobalVariables)`
`java.lang.Object`	`previewFile(java.lang.Number pDataServerId, java.lang.Number pAmount, StartupParams pGlobalVariables, java.lang.String pTransactionId)` Tests a data server as defined in the topology.
`void`	`previewFile(java.lang.Number pDataServerId, java.lang.Number pAmount, java.lang.String pTransactionId)`
`ExecutionInfo`	`restartSession(long pSessionId, StartupParams pVariables, boolean pSynchronous)` Deprecated. Since 11.1.1.6.0. Instead use `restartSession(long, StartupParams, boolean, Integer)`
`ExecutionInfo`	`restartSession(long pSessionId, StartupParams pVariables, boolean pSynchronous, boolean pKeepSessionParams)` Deprecated. Since 11.1.1.6.0. Instead use `restartSession(long, StartupParams, boolean, boolean, Integer)`
`ExecutionInfo`	`restartSession(long pSessionId, StartupParams pVariables, boolean pSynchronous, boolean pKeepSessionParams, java.lang.Integer pLogLevel)` Restart the given session with various parameters.
`ExecutionInfo`	`restartSession(long pSessionId, StartupParams pVariables, boolean pSynchronous, java.lang.Integer pLogLevel)` Restart the given session with various parameters.
`ExecutionInfo`	`startScenario(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)` Start the scenario with various parameters.
`void`	`stopSession(long pSessionId, StopType pStopType)` Kill the session described by the parameters.
`java.lang.Object`	`testDataServer(java.lang.Number pDataServerId)`
`void`	`testDataServer(java.lang.Number pDataServerId, StartupParams pGlobalVariables)`
`java.lang.Object`	`testDataServer(java.lang.Number pDataServerId, StartupParams pGlobalVariables, java.lang.String pTransactionId)` Tests a data server as defined in the topology.
`void`	`testDataServer(java.lang.Number pDataServerId, java.lang.String pTransactionId)`
`java.lang.Object`	`testDataServer(SnpConnect pSnpConnect, StartupParams pGlobalVariables, java.lang.String pTransactionId)` Tests a data server without defining it in the topology
`java.lang.Object`	`testDataServer(java.lang.String pUser, java.lang.String pPassword, java.lang.String pDriver, java.lang.String pUrl, java.lang.String pTechno, StartupParams pGlobalVariables, java.lang.String pTransactionId)` Tests a data server without defining it in the topology
`java.lang.Object`	`testEnterpriseScheduler(java.lang.String pSchedulerName)` Tests a data server as defined in the topology.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RuntimeAgent
```
public RuntimeAgent(OdiInstance pOdiInstance,
                    java.lang.String pOdiUser,
                    char[] pPassword)
```
    Constructs a RuntimeAgent object.
    
    Parameters:
    
    pOdiInstance - the odiInstance to which the RuntimeAgent is linked. Cannot be null.
    If the instance is not linked to a work repository, only testDataServer method will work.
    
    pOdiUser - the name of ODI user you want to use to connect to ODI to execute your operations.
    
    pPassword - the password NOT encoded
- Method Detail
  - stopSession
```
public void stopSession(long pSessionId,
                        StopType pStopType)
```
    Kill the session described by the parameters. The instance you used to instantiate this RuntimeAgent must be connected to a work repository to execute this method.
    Only the sessions that have been started by this RuntimeAgent instance can be stopped.
    
    Parameters:
    
    pSessionId - the id of the session to stop
    
    pStopType - the type of stop operation to perform
  - restartSession
```
public ExecutionInfo restartSession(long pSessionId,
                                    StartupParams pVariables,
                                    boolean pSynchronous)
```
    Deprecated. Since 11.1.1.6.0. Instead use restartSession(long, StartupParams, boolean, Integer)
    
    Restart the given session with various parameters. The instance you used to instantiate this RuntimeAgent must be connected to a work repository to execute this method.
    Only sessions in status ERROR and WAITING can be restarted.
    If a variable value is not redefined in pVariables, then the last execution value will be used.
    
    Parameters:
    
    pSessionId - identifier of the session to restart
    
    pVariables - start up parameters for this session execution. Redefine the values for the session variables.
    
    pSynchronous - indicates whether the execution should be synchronous.
    
    Returns:
    
    informations on the execution
  - restartSession
```
public ExecutionInfo restartSession(long pSessionId,
                                    StartupParams pVariables,
                                    boolean pSynchronous,
                                    java.lang.Integer pLogLevel)
```
    Restart the given session with various parameters. The instance you used to instantiate this RuntimeAgent must be connected to a work repository to execute this method.
    Only sessions in status ERROR and WAITING can be restarted.
    If a variable value is not redefined in pVariables, then the last execution value will be used.
    
    Parameters:
    
    pSessionId - identifier of the session to restart
    
    pVariables - start up parameters for this session execution. Redefine the values for the session variables.
    
    pSynchronous - indicates whether the execution should be synchronous.
    
    pLogLevel - is logging level for restarting session. If null, log level is retrieved from the previous run of this session.
    
    Returns:
    
    informations on the execution
    
    Since:
    
    11.1.1.6.0.
  - restartSession
```
public ExecutionInfo restartSession(long pSessionId,
                                    StartupParams pVariables,
                                    boolean pSynchronous,
                                    boolean pKeepSessionParams)
```
    Deprecated. Since 11.1.1.6.0. Instead use restartSession(long, StartupParams, boolean, boolean, Integer)
    
    Restart the given session with various parameters. The instance you used to instantiate this RuntimeAgent must be connected to a work repository to execute this method. Only sessions in status ERROR and WAITING can be restarted.
    
    Parameters:
    
    pSessionId - identifier of the session to restart
    
    pVariables - start up parameters for this session execution. Redefine the values for the session variables.
    
    pSynchronous - indicates whether the execution should be synchronous.
    
    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:
    
    informations on the execution
  - restartSession
```
public ExecutionInfo restartSession(long pSessionId,
                                    StartupParams pVariables,
                                    boolean pSynchronous,
                                    boolean pKeepSessionParams,
                                    java.lang.Integer pLogLevel)
```
    Restart the given session with various parameters. The instance you used to instantiate this RuntimeAgent must be connected to a work repository to execute this method. Only sessions in status ERROR and WAITING can be restarted.
    
    Parameters:
    
    pSessionId - identifier of the session to restart
    
    pVariables - start up parameters for this session execution. Redefine the values for the session variables.
    
    pSynchronous - indicates whether the execution should be synchronous.
    
    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 restarting session. If null, log level is retrieved from the previous run of this session.
    
    Returns:
    
    informations on the execution
    
    Since:
    
    11.1.1.6.0
  - startScenario
```
public ExecutionInfo startScenario(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)
```
    Start the scenario with various parameters. The instance you used to instantiate this RuntimeAgent must be connected to a work repository to execute this method.
    
    Parameters:
    
    pScenName - the name of the scenario to run. Must not be null or empty.
    
    pScenVersion - the version of the scenario to run. Must not be empty. If null or -1, the last version of the scenario will be run.
    
    pVariables - start up parameters used for the execution of this scenario
    
    pKeywords - keywords used for the execution of this scenario
    
    pContextCode - the context in which this scenario will be executed
    
    pLogLevel - logging level for this scenario execution. If null, default is 5
    
    pSessionName - the name to give to the sessions that will be created. If null, the scenario name will be used.
    
    pSynchronous - indicates whether the scenario execution should be synchronous
    
    Returns:
    
    information on the execution
  - testDataServer
```
public java.lang.Object testDataServer(java.lang.Number pDataServerId,
                                       StartupParams pGlobalVariables,
                                       java.lang.String pTransactionId)
                                throws InvocationException
```
    Tests a data server as defined in the topology.
    
    Parameters:
    
    pDataServerId - the data server identifier. Must not be null.
    
    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
    
    Since:
    
    11.1.1.5.0
  - testDataServer
```
public java.lang.Object testDataServer(java.lang.String pUser,
                                       java.lang.String pPassword,
                                       java.lang.String pDriver,
                                       java.lang.String pUrl,
                                       java.lang.String pTechno,
                                       StartupParams pGlobalVariables,
                                       java.lang.String pTransactionId)
                                throws InvocationException
```
    Tests a data server without defining it in the topology
    
    Parameters:
    
    pUser - the data server user.
    
    pPassword - the data server password.
    
    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
    
    Since:
    
    12.2.1
  - testDataServer
```
public java.lang.Object testDataServer(SnpConnect pSnpConnect,
                                       StartupParams pGlobalVariables,
                                       java.lang.String pTransactionId)
                                throws InvocationException,
                                       java.lang.IllegalAccessException,
                                       java.lang.IllegalArgumentException,
                                       java.lang.reflect.InvocationTargetException,
                                       java.io.IOException,
                                       java.beans.IntrospectionException
```
    Tests a data server without defining it in the topology
    
    Parameters:
    
    pSnpConnect - the SnpConnect object of the data server.
    
    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:
    
    java.beans.IntrospectionException
    
    java.io.IOException
    
    java.lang.reflect.InvocationTargetException
    
    java.lang.IllegalArgumentException
    
    java.lang.IllegalAccessException
    
    InvocationException
    
    Since:
    
    12.2.1
  - testEnterpriseScheduler
```
public java.lang.Object testEnterpriseScheduler(java.lang.String pSchedulerName)
```
    Tests a data server as defined in the topology.
    
    Parameters:
    
    pDataServerId - the data server identifier. Must not be null.
    
    pTransactionId - Used to identify if OnConnect/OnDisconnect command need to be executed on the conneciton as part of the test.
    
    Since:
    
    11.1.1.9.0
  - testDataServer
```
public void testDataServer(java.lang.Number pDataServerId,
                           java.lang.String pTransactionId)
                    throws InvocationException
```
    Throws:
    
    InvocationException
    
    Since:
    
    11.1.1.5.0
  - testDataServer
```
public void testDataServer(java.lang.Number pDataServerId,
                           StartupParams pGlobalVariables)
                    throws InvocationException
```
    Throws:
    
    InvocationException
    
    Since:
    
    11.1.1.5.0
  - testDataServer
```
public java.lang.Object testDataServer(java.lang.Number pDataServerId)
                                throws InvocationException
```
    Throws:
    
    InvocationException
  - initializeDataServer
```
public void initializeDataServer(java.lang.Number pDataServerId,
                                 java.util.Properties pInitProps)
                          throws InvocationException
```
    Initialize a data server as defined in the topology. Currently, this can be used to initialize a Hadoop Data Server only.
    
    Parameters:
    
    pDataServerId - the data server identifier. Must not be null.
    
    pInitProps - additional properties, if any, for the initialization operations. May pass in null if none.
    
    Throws:
    
    InvocationException
    
    Since:
    
    12.1.3.0.1 / 12.2.1
  - previewFile
```
public java.lang.Object previewFile(java.lang.Number pDataServerId,
                                    java.lang.Number pAmount,
                                    StartupParams pGlobalVariables,
                                    java.lang.String pTransactionId)
                             throws InvocationException
```
    Tests a data server as defined in the topology.
    
    Parameters:
    
    pDataServerId - the data server identifier. Must not be null.
    
    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
    
    Since:
    
    12.1.4.0.0
  - previewFile
```
public void previewFile(java.lang.Number pDataServerId,
                        java.lang.Number pAmount,
                        java.lang.String pTransactionId)
                 throws InvocationException
```
    Throws:
    
    InvocationException
    
    Since:
    
    12.1.4.0.0
  - previewFile
```
public void previewFile(java.lang.Number pDataServerId,
                        java.lang.Number pAmount,
                        StartupParams pGlobalVariables)
                 throws InvocationException
```
    Throws:
    
    InvocationException
    
    Since:
    
    12.1.4.0.0
  - previewFile
```
public java.lang.Object previewFile(java.lang.Number pDataServerId,
                                    java.lang.Number pAmount)
                             throws InvocationException
```
    Throws:
    
    InvocationException
    
    Since:
    
    12.1.4.0.0
  - cleanStaleSessions
```
public WorkRepositoryInfo cleanStaleSessions()
```
    Clean the stale sessions present in the work repository.
    
    Returns:
    
    WorkRepositoryInfo
  - getSessionStatus
```
public java.util.List getSessionStatus(java.util.List pSessionIds)
                                throws InvocationException
```
    Returns the sessions status.
    
    Parameters:
    
    pSessionIds - a list of sessions to check.
    
    Returns:
    
    a list of SessionStatusInfo for the session ids passed as parameter
    
    Throws:
    
    InvocationException
  - getExecutionName
```
public java.lang.String getExecutionName()
```
    Returns the Agent name that will appear in the execution log for a startScenario operation.
    
    Returns:
    
    the Agent name that will appear in the execution log for a startScenario operation. Caution: This agent name does not correspond to a logical or physical agent in the topology. This parameter does not enable to run a session on a remote agent. This field is only set through the startScen.sh tool.
  - getSessionInformation
```
public ISessionInformation getSessionInformation()
```
  - getCredentialProvider
```
public IAgentCredentialProvider getCredentialProvider()
```

Class RuntimeAgent

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RuntimeAgent

Method Detail

stopSession

restartSession

restartSession

restartSession

restartSession

startScenario

testDataServer

testDataServer

testDataServer

testEnterpriseScheduler

testDataServer

testDataServer

testDataServer

initializeDataServer

previewFile

previewFile

previewFile

previewFile

cleanStaleSessions

getSessionStatus

getExecutionName

getSessionInformation

getCredentialProvider