Oracle® Data Integrator Java API Reference
11g Release 1 (11.1.1.3.0)

E17060-01

oracle.odi.domain.runtime.ess.support
Class JobDefinitionWrapper

java.lang.Object
  extended by oracle.odi.domain.runtime.ess.support.JobDefinitionWrapper

public class JobDefinitionWrapper
extends java.lang.Object

Helper class wrapping an ESS JobDefinition. Allows for easier read/write access of common ODI properties, related to ODI job and scenario execution.

Note: that helper class manage password encryption for ODI credentials as well as for ODI master repository in case of plain JDBC credentials.


Constructor Summary
JobDefinitionWrapper(oracle.as.scheduler.JobDefinition pJobDefinition)
          Constructs a JobDefinitionWrapper object.
JobDefinitionWrapper(java.lang.String pJobName, oracle.as.scheduler.MetadataObjectId pOdiJobTypeId)
          Constructs a JobDefinitionWrapper object.
 
Method Summary
 java.lang.String getAgentName()
          Gets agent name.
 java.lang.String getAgentUrl()
          Gets agent URL.
 java.lang.String getContextCode()
          Gets context code.
 StartupParameters getExecutionVariables()
          Gets execution variables.
 oracle.as.scheduler.JobDefinition getJobDefinition()
          Obtains the underlying ESS JobDefinition instance.
 oracle.odi.domain.Password getOdiPassword()
          Obtain the ODI credentials password or null if none.
 java.lang.String getOdiUsername()
          Gets odi user name.
 java.lang.String getRunAsId()
          Gets RunAsId.
 java.lang.String getScenarioName()
          Gets scenario name.
 java.lang.String getScenarioVersion()
          Gets scenario version.
 java.lang.String getSchedulerName()
          Gets scheduler name.
 java.lang.String getWorkRepositoryName()
          Gets work repository name.
 void setAgentName(java.lang.String pAgentName)
          Sets agent name.
 void setAgentUrl(java.lang.String pAgentUrl)
          Sets agent URL.
 void setContextCode(java.lang.String pContextCode)
          Sets context code.
 void setExecutionVariables(StartupParameters pExecutionVariables)
          Sets execution variables.
 void setLogLevel(java.lang.Integer pLogLevel)
          Sets log level.
 void setOdiPassword(oracle.odi.domain.Password pPassword)
          Define the ODI password for ODI credentials.
 void setOdiUsername(java.lang.String pUsername)
          Sets ODI user name.
 void setRunAsId(java.lang.String pRunAsId)
          Sets this object's RunAsId.
 void setScenarioName(java.lang.String pScenarioName)
          Sets this object's scenario name.
 void setScenarioVersion(java.lang.String pScenarioVersion)
          Sets scenario version.
 void setSchedulerName(java.lang.String pSchedulerName)
          Sets this object's scheduler name.
 void setWorkRepositoryName(java.lang.String pWorkRepName)
          Sets work repository name.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JobDefinitionWrapper

public JobDefinitionWrapper(oracle.as.scheduler.JobDefinition pJobDefinition)
Constructs a JobDefinitionWrapper object.

Parameters:
pJobDefinition - a JobDefinition object

JobDefinitionWrapper

public JobDefinitionWrapper(java.lang.String pJobName,
                            oracle.as.scheduler.MetadataObjectId pOdiJobTypeId)
Constructs a JobDefinitionWrapper object.

Parameters:
pJobName - job name
pOdiJobTypeId - a MetadataObjectId object
Method Detail

getAgentName

public java.lang.String getAgentName()
Gets agent name.

Returns:
agent name
See Also:
setAgentName(String)

getAgentUrl

public java.lang.String getAgentUrl()
Gets agent URL.

Returns:
agent URL
See Also:
setAgentUrl(String)

getContextCode

public java.lang.String getContextCode()
Gets context code.

Returns:
context code
See Also:
setContextCode(String)

getExecutionVariables

public StartupParameters getExecutionVariables()
Gets execution variables.

Returns:
execution variables
See Also:
setExecutionVariables(StartupParameters)

getJobDefinition

public oracle.as.scheduler.JobDefinition getJobDefinition()
Obtains the underlying ESS JobDefinition instance.

Returns:
underlying job definition

getOdiPassword

public oracle.odi.domain.Password getOdiPassword()
Obtain the ODI credentials password or null if none.

Returns:
ODI password
See Also:
setOdiPassword(Password)

getOdiUsername

public java.lang.String getOdiUsername()
Gets odi user name.

Returns:
odi user name
See Also:
setOdiUsername(String)

getRunAsId

public java.lang.String getRunAsId()
Gets RunAsId.

Returns:
RunAsId
See Also:
setRunAsId(String)

getScenarioName

public java.lang.String getScenarioName()
Gets scenario name.

Returns:
scenario name
See Also:
setScenarioName(String)

getScenarioVersion

public java.lang.String getScenarioVersion()
Gets scenario version.

Returns:
scenario version
See Also:
setScenarioVersion(String)

getSchedulerName

public java.lang.String getSchedulerName()
Gets scheduler name.

Returns:
scheduler name
See Also:
setSchedulerName(String)

getWorkRepositoryName

public java.lang.String getWorkRepositoryName()
Gets work repository name.

Returns:
work repository name
See Also:
setWorkRepositoryName(String)

setAgentName

public void setAgentName(java.lang.String pAgentName)
Sets agent name.

Parameters:
pAgentName - agent name
See Also:
getAgentName()

setAgentUrl

public void setAgentUrl(java.lang.String pAgentUrl)
Sets agent URL.

Parameters:
pAgentUrl - agent URL
See Also:
getAgentUrl()

setContextCode

public void setContextCode(java.lang.String pContextCode)
Sets context code.

Parameters:
pContextCode - context code
See Also:
getContextCode()

setExecutionVariables

public void setExecutionVariables(StartupParameters pExecutionVariables)
Sets execution variables.

Parameters:
pExecutionVariables - execution variables
See Also:
getExecutionVariables()

setLogLevel

public void setLogLevel(java.lang.Integer pLogLevel)
Sets log level.

Parameters:
pLogLevel - log level
See Also:
setLogLevel(Integer)

setOdiPassword

public void setOdiPassword(oracle.odi.domain.Password pPassword)
Define the ODI password for ODI credentials.

Password string will be encrypted into JobDefinition parameter.

Parameters:
pPassword - the password
See Also:
getOdiPassword()

setOdiUsername

public void setOdiUsername(java.lang.String pUsername)
Sets ODI user name.

Parameters:
pUsername - ODI user name
See Also:
getOdiUsername()

setRunAsId

public void setRunAsId(java.lang.String pRunAsId)
Sets this object's RunAsId.

Parameters:
pRunAsId - RunAsId
See Also:
getRunAsId()

setScenarioName

public void setScenarioName(java.lang.String pScenarioName)
Sets this object's scenario name.

Parameters:
pScenarioName - scenario name
See Also:
getScenarioName()

setScenarioVersion

public void setScenarioVersion(java.lang.String pScenarioVersion)
Sets scenario version.

Parameters:
pScenarioVersion - scenario version
See Also:
getScenarioVersion()

setSchedulerName

public void setSchedulerName(java.lang.String pSchedulerName)
Sets this object's scheduler name.

Parameters:
pSchedulerName - scheduler name
See Also:
getSchedulerName()

setWorkRepositoryName

public void setWorkRepositoryName(java.lang.String pWorkRepName)
Sets work repository name.

Parameters:
pWorkRepName - work repository name
See Also:
getWorkRepositoryName()

Oracle® Data Integrator Java API Reference
11g Release 1 (11.1.1.3.0)

E17060-01

Copyright © 2010, Oracle and/or its affiliates. All rights reserved.