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

E17060-01

oracle.odi.domain.topology
Class OdiEnterpriseScheduler

java.lang.Object
  extended by oracle.odi.domain.support.BusinessObject
      extended by oracle.odi.domain.support.AbstractRepositoryEntity
          extended by oracle.odi.domain.support.AbstractOdiEntity
              extended by oracle.odi.domain.topology.OdiEnterpriseScheduler
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, oracle.odi.core.ess.IMetadataSessionFactory, oracle.odi.core.ess.IRuntimeSessionFactory, IMasterOdiEntity, IOdiEntity, IRepositoryEntity

public class OdiEnterpriseScheduler
extends oracle.odi.domain.support.AbstractOdiEntity
implements IMasterOdiEntity, oracle.odi.core.ess.IMetadataSessionFactory, oracle.odi.core.ess.IRuntimeSessionFactory

ODI domain object representing an ODI enterprise scheduler.

This domain class implements IMetadataSessionFactory and IRuntimeSessionFactory interfaces to provide access to the (remote) deployed schedulers through ESS scheduler APIs using the session pattern. However, it is not recommended to directly use those sessions and we recommend to use specific domain interfaces for ESS.

Since:
11.1.1.3.0
See Also:
MetadataService, RuntimeService, Serialized Form

Field Summary
 
Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity
STARTING_INTERNAL_VERSION
 
Constructor Summary
OdiEnterpriseScheduler()
           
 
Method Summary
 oracle.odi.core.ess.IMetadataSession createMetadataSession()
          Internal: Internal method that is not part of the public API.
 oracle.odi.core.ess.IRuntimeSession createRuntimeSession()
          Internal: Internal method that is not part of the public API.
 java.lang.String getAsyncJndiName()
          Obtains async JNDI name.
 java.lang.Number getEnterpriseSchedulerId()
          This OdiEnterpriseScheduler ID.
 java.lang.String getInitialContextFactory()
          Obtains JNDI initial context factory to be used to lookup ESS services related to this OdiEnterpriseScheduler object.
 java.io.Serializable getInternalId()
          Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.
 java.lang.String getMetadataServiceJndiName()
          Obtains JNDI name of the ESS MetadataService EJB, related to this OdiEnterpriseScheduler object.
 java.lang.String getName()
          Obtains the name of this OdiEnterpriseScheduler, that is the name used in ODI topology.
 java.lang.String getProviderUrl()
          Obtains the JNDI provider URL defined for this OdiEnterpriseScheduler.
 java.lang.String getRuntimeServiceJndiName()
          Obtains JNDI name of the ESS RuntimeService EJB, related to this OdiEnterpriseScheduler object.
 IRepositoryEntity getSecurityContainer()
          Define a generic way to retrieve container for entities.
 ObfuscatedString getSecurityCredentials()
          Obtains the JNDI security credentials.
 java.lang.String getSecurityPrincipal()
          Obtains the JNDI security principal.
 ObfuscatedString getSecurityRuntimeCredentials()
          Obtains the security runtime credentials.
 java.lang.String getSecurityRuntimePrincipal()
          Obtains the security runtime principal.
 java.lang.String getWsCallbackUrl()
          Obtains the WebService callback URL.
 void setAsyncJndiName(java.lang.String pAsyncJndiName)
          Defines async JNDI name.
 void setInitialContextFactory(java.lang.String pInitialContextFactory)
          Defines the JNDI initial context factory for this OdiEnterpriseScheduler.
 void setMetadataServiceJndiName(java.lang.String pMetadataServiceJndiName)
          Defines the JNDI name for the ESS MetadataService.
 void setName(java.lang.String pName)
          Defines the name of this OdiEnterpriseScheduler.
 void setProviderUrl(java.lang.String pProviderUrl)
          Defines the JNDI provider URL.
 void setRuntimeServiceJndiName(java.lang.String pRuntimeServiceJndiName)
          Defines the JNDI name for the ESS RuntimeService.
 void setSecurityCredentials(ObfuscatedString pCredentials)
          Defines the JNDI security credentials.
 void setSecurityPrincipal(java.lang.String pSecurityPrincipal)
          Defines the JNDI security principal.
 void setSecurityRuntimeCredentials(ObfuscatedString pCredentials)
          Defines the security runtime credentials.
 void setSecurityRuntimePrincipal(java.lang.String pSecurityRuntimePrincipal)
          Defines the security runtime principal.
 void setWsCallbackUrl(java.lang.String pWsCallbackUrl)
          Defines the WebService callback URL.
 
Methods inherited from class oracle.odi.domain.support.AbstractOdiEntity
equals, getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, hashCode, isInstanceLevelSecurityNeeded, isNew, toString
 
Methods inherited from class oracle.odi.domain.support.BusinessObject
clone
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface oracle.odi.domain.IOdiEntity
getFirstDate, getFirstUser, getLastDate, getLastUser, isInstanceLevelSecurityNeeded
 

Constructor Detail

OdiEnterpriseScheduler

public OdiEnterpriseScheduler()
Method Detail

createMetadataSession

public oracle.odi.core.ess.IMetadataSession createMetadataSession()
Internal: Internal method that is not part of the public API.

Specified by:
createMetadataSession in interface oracle.odi.core.ess.IMetadataSessionFactory
Returns:
an IMetadataSession instance

createRuntimeSession

public oracle.odi.core.ess.IRuntimeSession createRuntimeSession()
Internal: Internal method that is not part of the public API.

Specified by:
createRuntimeSession in interface oracle.odi.core.ess.IRuntimeSessionFactory
Returns:
an IRuntimeSession instance

getAsyncJndiName

public java.lang.String getAsyncJndiName()
Obtains async JNDI name.

Returns:
async JNDI name
See Also:
setAsyncJndiName(String)

getEnterpriseSchedulerId

public java.lang.Number getEnterpriseSchedulerId()
This OdiEnterpriseScheduler ID.

Returns:
ID

getInitialContextFactory

public java.lang.String getInitialContextFactory()
Obtains JNDI initial context factory to be used to lookup ESS services related to this OdiEnterpriseScheduler object.

Returns:
JNDI initial context factory
See Also:
setInitialContextFactory(String)

getInternalId

public java.io.Serializable getInternalId()
Description copied from interface: IRepositoryEntity
Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.

Typically a subclass will delegate to a public SomePrimitiveWrapper getId() method. The necessity for the getInternalId() abstract method is solely because the persistence layer needs a way of obtaining the identity irrespective of the actual identity implementation choice.

Returning null from this method will indicate the object has never been saved. This will likely be relied on by some DAO implementations.

Specified by:
getInternalId in interface IRepositoryEntity
Returns:
the persistence identity of this instance

getMetadataServiceJndiName

public java.lang.String getMetadataServiceJndiName()
Obtains JNDI name of the ESS MetadataService EJB, related to this OdiEnterpriseScheduler object.

Returns:
ESS metadata service JNDI name
See Also:
setMetadataServiceJndiName(String)

getName

public java.lang.String getName()
Obtains the name of this OdiEnterpriseScheduler, that is the name used in ODI topology.

Specified by:
getName in interface IOdiEntity
Overrides:
getName in class oracle.odi.domain.support.AbstractOdiEntity
Returns:
the name
See Also:
setName(String)

getProviderUrl

public java.lang.String getProviderUrl()
Obtains the JNDI provider URL defined for this OdiEnterpriseScheduler.

Returns:
JNDI provider URL
See Also:
setProviderUrl(String)

getRuntimeServiceJndiName

public java.lang.String getRuntimeServiceJndiName()
Obtains JNDI name of the ESS RuntimeService EJB, related to this OdiEnterpriseScheduler object.

Returns:
ESS runtime service JNDI name
See Also:
setRuntimeServiceJndiName(String)

getSecurityContainer

public IRepositoryEntity getSecurityContainer()
Description copied from interface: IRepositoryEntity
Define a generic way to retrieve container for entities.

Specified by:
getSecurityContainer in interface IRepositoryEntity
Returns:
container entity

getSecurityCredentials

public ObfuscatedString getSecurityCredentials()
Obtains the JNDI security credentials.

Returns:
security credentials as an ObfuscatedString instance
See Also:
setSecurityCredentials(ObfuscatedString)

getSecurityPrincipal

public java.lang.String getSecurityPrincipal()
Obtains the JNDI security principal.

Returns:
JNDI security principal
See Also:
setSecurityPrincipal(String)

getSecurityRuntimeCredentials

public ObfuscatedString getSecurityRuntimeCredentials()
Obtains the security runtime credentials.

Returns:
security runtime credentials
See Also:
setSecurityRuntimeCredentials(ObfuscatedString)

getSecurityRuntimePrincipal

public java.lang.String getSecurityRuntimePrincipal()
Obtains the security runtime principal.

Returns:
security runtime principal
See Also:
setSecurityRuntimePrincipal(String)

getWsCallbackUrl

public java.lang.String getWsCallbackUrl()
Obtains the WebService callback URL.

Returns:
callback url
See Also:
setWsCallbackUrl(String)

setAsyncJndiName

public void setAsyncJndiName(java.lang.String pAsyncJndiName)
Defines async JNDI name.

Parameters:
pAsyncJndiName - async name
See Also:
getAsyncJndiName()

setInitialContextFactory

public void setInitialContextFactory(java.lang.String pInitialContextFactory)
Defines the JNDI initial context factory for this OdiEnterpriseScheduler.

Parameters:
pInitialContextFactory - the initial context factory to be used
See Also:
getInitialContextFactory()

setMetadataServiceJndiName

public void setMetadataServiceJndiName(java.lang.String pMetadataServiceJndiName)
Defines the JNDI name for the ESS MetadataService.

Parameters:
pMetadataServiceJndiName - JNDI name of ESS MetadataService
See Also:
getMetadataServiceJndiName()

setName

public void setName(java.lang.String pName)
Defines the name of this OdiEnterpriseScheduler.

Parameters:
pName - the name
See Also:
getName()

setProviderUrl

public void setProviderUrl(java.lang.String pProviderUrl)
Defines the JNDI provider URL.

Parameters:
pProviderUrl - the url
See Also:
getProviderUrl()

setRuntimeServiceJndiName

public void setRuntimeServiceJndiName(java.lang.String pRuntimeServiceJndiName)
Defines the JNDI name for the ESS RuntimeService.

Parameters:
pRuntimeServiceJndiName - JNDI name of ESS RuntimeService
See Also:
getRuntimeServiceJndiName()

setSecurityCredentials

public void setSecurityCredentials(ObfuscatedString pCredentials)
Defines the JNDI security credentials.

Parameters:
pCredentials - the credentials
See Also:
getSecurityCredentials()

setSecurityPrincipal

public void setSecurityPrincipal(java.lang.String pSecurityPrincipal)
Defines the JNDI security principal.

Parameters:
pSecurityPrincipal - security principal
See Also:
getSecurityPrincipal()

setSecurityRuntimeCredentials

public void setSecurityRuntimeCredentials(ObfuscatedString pCredentials)
Defines the security runtime credentials.

Parameters:
pCredentials - security runtime credentials
See Also:
getSecurityRuntimeCredentials()

setSecurityRuntimePrincipal

public void setSecurityRuntimePrincipal(java.lang.String pSecurityRuntimePrincipal)
Defines the security runtime principal.

Parameters:
pSecurityRuntimePrincipal - the security runtime principal
See Also:
getSecurityRuntimePrincipal()

setWsCallbackUrl

public void setWsCallbackUrl(java.lang.String pWsCallbackUrl)
Defines the WebService callback URL.

Parameters:
pWsCallbackUrl - callback url
See Also:
getWsCallbackUrl()

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.