|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.3.0) E17060-01 |
||||||||
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:
- 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
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. |
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. |
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). |
ExecutionInfo |
invokeRestartSession(long pSessionId,
StartupParams pVariables,
boolean pSynchronous,
java.lang.String pWorkRepName)
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,
boolean pKeepSessionParams)
Restarts a session with various parameters. |
ExecutionInfo |
invokeStartScenario(java.lang.String pScenName,
java.lang.String pScenVersion,
StartupParams pVariables,
java.lang.String pKeywords,
java.lang.String pContextCode,
java.lang.Integer pLogLevel,
java.lang.String pSessionName,
boolean pSynchronous,
java.lang.String pWorkRepName)
Starts the given scenario with various parameters. |
void |
invokeStopSession(long pSessionId,
StopType pStopType,
java.lang.String pWorkRepoName)
Stops a session. |
void |
invokeTestDataServer(java.lang.Number pDataServerId)
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 char[] getCharArrayPassword()
public java.lang.String getUser()
setUser(java.lang.String)
public WorkRepositoryInfo invokeCleanStaleSessions(java.lang.String pWorkRepositoryName) throws InvocationException
pWorkRepositoryName
- the name of the work repository. This cannot be null
WorkRepositoryInfo
InvocationException
- if the invocation failed.public java.util.List<WorkRepositoryInfo> invokeCleanStaleSessionsForAllWorkRepositories() throws InvocationException
WorkRepositoryInfo
InvocationException
- if the invocation failed.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 computed
InvocationException
public java.lang.String invokeGetAgentVersion() throws InvocationException
InvocationException
- if the agent was unreachablepublic oracle.odi.runtime.agent.invocation.response.OdiGetJMXServiceInfoAckType invokeGetJMXServiceInfo() throws InvocationException
OdiGetJMXServiceInfoAckType
InvocationException
- if the invocation failedpublic 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 searched
SchedulingInfo
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 searched
SchedulingInfo
object holding the schedules information
InvocationException
- if the schedules retrieval didn't succeed.public 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 java.lang.String invokeIsAlive() throws InvocationException
InvocationException
- if the agent was unreachablepublic 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 = false
InvocationException
- if the invocation failedpublic 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) 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.
InvocationException
- if the invocation failedpublic ExecutionInfo invokeRestartSession(long pSessionId, StartupParams pVariables, boolean pSynchronous, java.lang.String pWorkRepName, boolean pKeepSessionParams) 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.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 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 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 invokeUpdateSchedules() throws InvocationException
InvocationException
- if the invocation failed.public void setPassword(char[] pPassword)
pPassword
- the decrypted user password used to connect to the ODI instancegetPassword()
public void setUser(java.lang.String pUser)
pUser
- the ODI user name used to connect to the ODI instancegetUser()
|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.3.0) E17060-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |