oracle.odi.domain.topology
Class OdiDataServer

java.lang.Object
  oracle.odi.domain.support.BusinessObject
      oracle.odi.domain.support.AbstractRepositoryEntity
          oracle.odi.domain.support.AbstractOdiEntity
              oracle.odi.domain.topology.AbstractOdiDataServer
                  oracle.odi.domain.topology.OdiDataServer

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IMasterOdiEntity, IExportable, IOdiEntity, IRepositoryEntity

public class OdiDataServer
extends AbstractOdiDataServer
implements IMasterOdiEntity, IExportable

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, Serialized Form

Nested Class Summary

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

AbstractOdiDataServer.Axis2DeploymentSettings, AbstractOdiDataServer.DirectoryDeploymentSettings, AbstractOdiDataServer.FtpDeploymentSettings, AbstractOdiDataServer.IConnectionSettings, AbstractOdiDataServer.JdbcSettings, AbstractOdiDataServer.JndiSettings, AbstractOdiDataServer.WsContainerSettings

Field Summary

Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity

STARTING_INTERNAL_VERSION

Constructor Summary

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

Method Summary

int	getBatchUpdateSize() Returns the batch update size that should be used when querying this data 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.lang.String	getName() Return the name of this OdiDataServer.
java.util.Collection<OdiPhysicalSchema>	getPhysicalSchemas() Obtains an unmodifable collection of OdiPhysicalSchemas that belongs to this OdiDataServer.
java.lang.String	getServerInstanceName() Return the server instance name that can be used for some technology (i.e.
OdiTechnology	getTechnology() Returns the technology to which this data server is linked.
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	setConnectionSettings(AbstractOdiDataServer.IConnectionSettings pSettings) Defines the connection settings for this AbstractOdiDataServer.
void	setFetchArraySize(int pFetchArraySize) Sets the fetch array size that should be used when querying this data server.
void	setName(java.lang.String pName) Define the name of this OdiDataServer.
void	setServerInstanceName(java.lang.String pServerInstanceName) Defines the server instance name to be used for this OdiDataServer.

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

getDataServerId, getInternalId, getPassword, getSecurityContainer, getUsername, setPassword, setUsername

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

Methods inherited from interface oracle.odi.domain.IRepositoryEntity

getInternalId, getSecurityContainer

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.

Returns:

batch size

See Also:

setBatchUpdateSize(int)

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)

getDefaultPhysicalSchema

public OdiPhysicalSchema getDefaultPhysicalSchema()

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

Returns:

the default physical schema for that data server

See Also:

OdiPhysicalSchema.isDefaultPhysicalSchema()

getFetchArraySize

public int getFetchArraySize()

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

Returns:

fetch size

See Also:

setFetchArraySize(int)

getName

public java.lang.String getName()

Return the name of this OdiDataServer.

Specified by:

getName in interface IOdiEntity

Overrides:

getName in class oracle.odi.domain.support.AbstractOdiEntity

Returns:

data server name

See Also:

setName(String)

getPhysicalSchemas

public java.util.Collection<OdiPhysicalSchema> getPhysicalSchemas()

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

Returns:

a collection of OdiPhysicalSchemas

getServerInstanceName

public java.lang.String getServerInstanceName()

Return the server instance name that can be used for some technology (i.e. oracle DB/LINK), or null if none.

Returns:

server name

See Also:

OdiTechnology.isInstanceServerSupported(), setServerInstanceName(String)

getTechnology

public OdiTechnology getTechnology()

Returns the technology to which this data server is linked.

Returns:

the technology

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:

java.lang.IllegalArgumentException - if pPhysicalSchema is null or does not belong to this OdiDataServer

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()

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()

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()

setName

public void setName(java.lang.String pName)

Define the name of this OdiDataServer.

Parameters:

pName - the name to set

Throws:

java.lang.IllegalArgumentException - if the name is null or empty

See Also:

getName()

setServerInstanceName

public void setServerInstanceName(java.lang.String pServerInstanceName)

Defines the server instance name to be used for this OdiDataServer.

If the technology of that data server doesn't support it, this property won't be used.

Parameters:

pServerInstanceName - the server instance name

See Also:

OdiTechnology.isInstanceServerSupported(), getServerInstanceName()