oracle.odi.domain.topology

Class OdiDataServer

java.lang.Object

AbstractOdiEntity

oracle.odi.domain.topology.AbstractOdiDataServer

oracle.odi.domain.topology.OdiDataServer

All Implemented Interfaces:

IFlexFieldUser, IModelObject, IModelObjectBase, IDataServer, IMasterOdiEntity, IOdiEntity, IRepositoryEntity

Direct Known Subclasses:

OdiHadoopDataServer, OdiHBaseDataServer, OdiHiveDataServer, OdiPigDataServer, OdiSparkPythonDataServer

public class OdiDataServer
extends AbstractOdiDataServer
implements IDataServer, IMasterOdiEntity, IFlexFieldUser

An OdiDataServer is a data server that is defined for a technology into the physical topology of ODI. An instance of OdiDataServer belong to a single instance of OdiTechnology and should be used to manage the collection of OdiPhysicalSchema that belong to an instance of OdiDataServer.

The OdiDataServer class contains informations to connect to the described data server and how to manage that connection with properties like "fetchArraySize" and "batchUpdateSize".

Since:

11.1.1.3.0

See Also:

OdiTechnology

Nested Class Summary

Nested classes/interfaces inherited from class oracle.odi.domain.topology.AbstractOdiDataServer

AbstractOdiDataServer.Axis2DeploymentSettings, AbstractOdiDataServer.BICSConnectionSettings, AbstractOdiDataServer.BigDataCloudConnectionSettings, AbstractOdiDataServer.DirectoryDeploymentSettings, AbstractOdiDataServer.DummyConnectionSettings, AbstractOdiDataServer.FtpDeploymentSettings, AbstractOdiDataServer.IConnectionSettings, AbstractOdiDataServer.JdbcSettings, AbstractOdiDataServer.JndiSettings, AbstractOdiDataServer.ObjectStorageConnectionSettings, AbstractOdiDataServer.OracleWalletConnectionSettings, AbstractOdiDataServer.StorageCSConnectionSettings, AbstractOdiDataServer.WsContainerSettings

Constructor Summary

Constructors

Constructor and Description
OdiDataServer(OdiTechnology pTechnology, java.lang.String pName) Construct a new OdiDataServer.

Method Summary

Modifier and Type	Method and Description
void	addChildDataServer(OdiDataServer childDataSever) Adds the given OdiDataServer to the collection of child OdiDataServers.
int	getBatchUpdateSize() Returns the batch update size that should be used when querying this data server.
java.util.Collection	getChildDataServers() Returns the unmodifable collection of child OdiDataServers.
java.lang.String	getClasspath() Obtains the classpath for this OdiDataServer.
IConnectionInfo	getConnectionInfo() Gets information about the connection to the server.
AbstractOdiDataServer.IConnectionSettings	getConnectionSettings() Returns the AbstractOdiDataServer.IConnectionSettings defined for this data server.
OdiPhysicalSchema	getDefaultPhysicalSchema() Looks up the default physical schema for this OdiDataServer from its associated physical schemas.
int	getFetchArraySize() Returns the fetch array size that should be used when querying this data server.
java.util.Collection	getFlexFieldsValues() * Obtains flex fields values related to this IFlexFieldUser.
java.lang.String	getJagentHost() Method returns hostname where Oracle Golden Gate's JAgent is located.
java.lang.Integer	getJagentManagerPort() Method returns host's port number where Oracle Golden Gate's JAgent manager is located.
java.lang.Integer	getJagentPort() Method returns host's port number where Oracle Golden Gate's JAgent is located.
java.lang.String	getName() Return the name of this OdiDataServer.
java.lang.String	getOggInstallPath() Method returns path where Oracle Golden Gate's installation is located.
OdiDataServer	getParentDataServer() Return the parent OdiDataServer of this OdiDataServer.
java.util.Collection	getPhysicalSchemas() Obtains an unmodifable collection of OdiPhysicalSchemas that belongs to this OdiDataServer.
java.lang.Integer	getTargetDOP() Returns the target degree of Parallelism.
void	initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder) Initialize flex fields related to this IFlexFieldUser.
void	removeChildDataServer(OdiDataServer childDataSever) Remove the given OdiDataServer from the collection of OdiDataServers.
void	removePhysicalSchema(OdiPhysicalSchema pPhysicalSchema) Remove the given OdiPhysicalSchema from the collection of OdiPhysicalSchemas.
void	setBatchUpdateSize(int pBatchUpdateSize) Sets the batch update size that should be used when querying this data server.
void	setClasspath(java.lang.String classpath) Specifies the classpath for this OdiDataServer.
void	setConnectionSettings(AbstractOdiDataServer.IConnectionSettings pSettings) Defines the connection settings for this AbstractOdiDataServer.
void	setDefaultPhysicalSchema(OdiPhysicalSchema pPSchema) Defines the specified OdiPhysicalSchema as the new default physical schema.
void	setFetchArraySize(int pFetchArraySize) Sets the fetch array size that should be used when querying this data server.
void	setJagentHost(java.lang.String pJagentHost) Method sets hostname where Oracle Golden Gate's JAgent is located.
void	setJagentManagerPort(java.lang.Integer pJagentManagerPort) Method sets host's port number where Oracle Golden Gate's JAgent manager is located.
void	setJagentPort(java.lang.Integer pJagentPort) Method sets host's port number where Oracle Golden Gate's JAgent is located.
void	setName(java.lang.String pName) Define the name of this OdiDataServer.
void	setOggInstallPath(java.lang.String pOggInstallPath) Method sets path where Oracle Golden Gate's installation is located.
void	setParentDataServer(OdiDataServer parentDataServer) Sets the parameter OdiDataServer as the parent Data Server of this OdiDataServer.
void	setTargetDOP(java.lang.Integer pTargetDOP) Sets the target degree of Parallelism.

Methods inherited from class oracle.odi.domain.topology.AbstractOdiDataServer

getDataServerId, getDataServerProperties, getInternalId, getPassword, getSecurityContainer, getServerInstanceName, getTechnology, getUsername, isJndiConnection, removeDataServerProperty, setPassword, setServerInstanceName, setUsername

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.odi.domain.adapter.topology.IDataServer

getServerInstanceName, getTechnology, getUsername

Methods inherited from interface oracle.odi.domain.adapter.IModelObjectBase

getBigNumericId, getGlobalId, getNumericId

Methods inherited from interface oracle.odi.domain.IOdiEntity

getFirstDate, getFirstUser, getLastDate, getLastUser, isInstanceLevelSecurityNeeded

Methods inherited from interface oracle.odi.domain.IRepositoryEntity

getGlobalId, getInternalId, getParent

Constructor Detail

OdiDataServer

public OdiDataServer(OdiTechnology pTechnology,
                     java.lang.String pName)

Construct a new OdiDataServer.

This will adds this new data server to the given OdiTechnology's data servers.

Parameters:

pTechnology - the technology the OdiDataServer belongs to

pName - the data server's name

Method Detail

getBatchUpdateSize

public int getBatchUpdateSize()

Returns the batch update size that should be used when querying this data server.

Specified by:

getBatchUpdateSize in interface IDataServer

Returns:

batch size

See Also:

setBatchUpdateSize(int)

setBatchUpdateSize

public void setBatchUpdateSize(int pBatchUpdateSize)

Sets the batch update size that should be used when querying this data server.

Default is 30.

Parameters:

pBatchUpdateSize - batch size to set

See Also:

getBatchUpdateSize()

getFetchArraySize

public int getFetchArraySize()

Returns the fetch array size that should be used when querying this data server.

Specified by:

getFetchArraySize in interface IDataServer

Returns:

fetch size

See Also:

setFetchArraySize(int)

setFetchArraySize

public void setFetchArraySize(int pFetchArraySize)

Sets the fetch array size that should be used when querying this data server.

Default is 30.

Parameters:

pFetchArraySize - fetch size to set

See Also:

getFetchArraySize()

getTargetDOP

public java.lang.Integer getTargetDOP()

Returns the target degree of Parallelism.

Returns:

target degree of Parallelism

See Also:

#setTargetDOP(int)

setTargetDOP

public void setTargetDOP(java.lang.Integer pTargetDOP)

Sets the target degree of Parallelism.

Default is 1.

Parameters:

pTargetDOP - target degree of Parallelism to set

targetDOP -

See Also:

#geFTargetDOP()

getDefaultPhysicalSchema

public OdiPhysicalSchema getDefaultPhysicalSchema()

Looks up the default physical schema for this OdiDataServer from its associated physical schemas.

Specified by:

getDefaultPhysicalSchema in interface IDataServer

Returns:

the default physical schema for that data server

See Also:

OdiPhysicalSchema.isDefaultPhysicalSchema()

getPhysicalSchemas

public java.util.Collection getPhysicalSchemas()

Obtains an unmodifable collection of OdiPhysicalSchemas that belongs to this OdiDataServer.

Specified by:

getPhysicalSchemas in interface IDataServer

Returns:

a collection of OdiPhysicalSchemas

removePhysicalSchema

public void removePhysicalSchema(OdiPhysicalSchema pPhysicalSchema)

Remove the given OdiPhysicalSchema from the collection of OdiPhysicalSchemas. This will also reset the OdiDataServer of the given OdiPhysicalSchema to null.

If the removed OdiPhysicalSchema is the default one then this method will assign the default OdiPhysicalSchema status to the first one found from the physical schemas of this data server.

Parameters:

pPhysicalSchema - physical schema to remove

Throws:

DomainRuntimeException - if pPhysicalSchema is null or does not belong to this OdiDataServer

setDefaultPhysicalSchema

public void setDefaultPhysicalSchema(OdiPhysicalSchema pPSchema)

Defines the specified OdiPhysicalSchema as the new default physical schema.

Since only one default schema is allowed per OdiDataServer, any previous default schema will no longer be defined as default schema.

Parameters:

pPSchema - the new default schema

getName

public java.lang.String getName()

Return the name of this OdiDataServer.

Specified by:

getName in interface IFlexFieldUser

Specified by:

getName in interface IModelObject

Specified by:

getName in interface IDataServer

Specified by:

getName in interface IOdiEntity

Returns:

data server name

See Also:

setName(String)

setName

public void setName(java.lang.String pName)

Define the name of this OdiDataServer.

Parameters:

pName - the name to set

Throws:

DomainRuntimeException - if the name is null or empty

See Also:

getName()

setConnectionSettings

public void setConnectionSettings(AbstractOdiDataServer.IConnectionSettings pSettings)

Description copied from class: AbstractOdiDataServer

Defines the connection settings for this AbstractOdiDataServer.

Specified by:

setConnectionSettings in class AbstractOdiDataServer

Parameters:

pSettings - the connection settings of this data server

See Also:

getConnectionSettings()

getConnectionSettings

public AbstractOdiDataServer.IConnectionSettings getConnectionSettings()

Description copied from class: AbstractOdiDataServer

Returns the AbstractOdiDataServer.IConnectionSettings defined for this data server.

Specified by:

getConnectionSettings in class AbstractOdiDataServer

Returns:

connection settings

See Also:

AbstractOdiDataServer.setConnectionSettings(IConnectionSettings)

getFlexFieldsValues

public java.util.Collection getFlexFieldsValues()

* Obtains flex fields values related to this IFlexFieldUser. In most implementations method initFlexFields(IOdiFlexFieldFinder) should be called before calling this method.

Specified by:

getFlexFieldsValues in interface IFlexFieldUser

Returns:

an unmodifiable Collection of flex field values

Since:

11.1.1.5.0

initFlexFields

public void initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder)

Description copied from interface: IFlexFieldUser

Initialize flex fields related to this IFlexFieldUser.

Specified by:

initFlexFields in interface IFlexFieldUser

Parameters:

pOdiFlexFieldFinder - OdiFlexField finder to be used to query flex fields

Since:

11.1.1.5.0

getConnectionInfo

public IConnectionInfo getConnectionInfo()

Description copied from interface: IDataServer

Gets information about the connection to the server.

Specified by:

getConnectionInfo in interface IDataServer

Returns:

the connection information.

getJagentHost

public java.lang.String getJagentHost()

Method returns hostname where Oracle Golden Gate's JAgent is located. Applicable for Oracle Golden Gate data servers only.

Returns:

the host of JAgent

setJagentHost

public void setJagentHost(java.lang.String pJagentHost)

Method sets hostname where Oracle Golden Gate's JAgent is located. No validation is performed. Applicable for Oracle Golden Gate data servers only.

Parameters:

pJagentHost - hostname to be set, no validation is performed

getJagentPort

public java.lang.Integer getJagentPort()

Method returns host's port number where Oracle Golden Gate's JAgent is located. Applicable for Oracle Golden Gate data servers only.

Returns:

the port of JAgent

setJagentPort

public void setJagentPort(java.lang.Integer pJagentPort)

Method sets host's port number where Oracle Golden Gate's JAgent is located. No validation is performed. Applicable for Oracle Golden Gate data servers only.

Parameters:

pJagentPort - port number to be set

getJagentManagerPort

public java.lang.Integer getJagentManagerPort()

Method returns host's port number where Oracle Golden Gate's JAgent manager is located. Applicable for Oracle Golden Gate data servers only.

Returns:

the port number of JAgent

setJagentManagerPort

public void setJagentManagerPort(java.lang.Integer pJagentManagerPort)

Method sets host's port number where Oracle Golden Gate's JAgent manager is located. No validation is performed. Applicable for Oracle Golden Gate data servers only.

Parameters:

pJagentManagerPort - port number to be set

getOggInstallPath

public java.lang.String getOggInstallPath()

Method returns path where Oracle Golden Gate's installation is located. Applicable for Oracle Golden Gate data servers only.

Returns:

OGG installation's path

setOggInstallPath

public void setOggInstallPath(java.lang.String pOggInstallPath)

Method sets path where Oracle Golden Gate's installation is located. No validation is performed. Applicable for Oracle Golden Gate data servers only.

getClasspath

public java.lang.String getClasspath()

Obtains the classpath for this OdiDataServer.

Returns:

the classpath

setClasspath

public void setClasspath(java.lang.String classpath)

Specifies the classpath for this OdiDataServer.

Parameters:

classpath - the classpath to set

getParentDataServer

public OdiDataServer getParentDataServer()

Return the parent OdiDataServer of this OdiDataServer. if there is no parent OdiDataServer returns null

Returns:

an OdiDataServer object representing the parent Data Server or null if parent data server is not set or deleted

See Also:

setParentDataServer(OdiDataServer)

setParentDataServer

public void setParentDataServer(OdiDataServer parentDataServer)

Sets the parameter OdiDataServer as the parent Data Server of this OdiDataServer. Parent and the child data servers have to be persisted individually. Deletion of parent data server sets the parentDataServer in child data server to null

Parameters:

parentDataServer - the parent Data Server

See Also:

getParentDataServer()

getChildDataServers

public java.util.Collection getChildDataServers()

Returns the unmodifable collection of child OdiDataServers.

Use addChildDataServer(OdiDataServer) and removeChildDataserver(OdiDataServer) respectively to add and remove OdiDataServer.

Returns:

a Collection object representing the child data server value

See Also:

addChildDataServer(OdiDataServer), removeChildDataServer(OdiDataServer)

addChildDataServer

public void addChildDataServer(OdiDataServer childDataSever)

Adds the given OdiDataServer to the collection of child OdiDataServers.

This will also set the Parent Data Server of the given OdiDataServer to this OdiDataServer instance.

If the given OdiDataServer was already associated to an other OdiDataServer it will be removed

Parameters:

childDataSever - an OdiDataServer object

removeChildDataServer

public void removeChildDataServer(OdiDataServer childDataSever)

Remove the given OdiDataServer from the collection of OdiDataServers.

This will also reset the parent OdiDataServer of the given OdiDataServer to null

Parameters:

childDataSever - an OdiDataServer object