ilog.views.maps.datasource.ibm

Class IlvDBConnectionInfo

java.lang.Object

ilog.views.maps.datasource.ibm.IlvDBConnectionInfo

All Implemented Interfaces:

IlvPersistentObject, Serializable

Direct Known Subclasses:

IlvDB2ConnectionInfo, IlvInformixConnectionInfo

public abstract class IlvDBConnectionInfo
extends Object
implements IlvPersistentObject

Manages the database connection parameters through the JDBC utilities. For example:

 IlvDBConnectionInfo info = new IlvDB2ConnectionInfo();
 info.setUser("db2admin");
 info.setPassword("password");
 info.setDatabaseName("sample");
 connection = info.connect();

Since:

JViews 8.7

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvDBConnectionInfo() Creates a new IlvDBConnectionInfo.
IlvDBConnectionInfo(IlvInputStream stream) Reads an object from an IlvInputStream.

Method Summary

Modifier and Type	Method and Description
Connection	connect() Establish a database connection with all the parameters that have already been set
void	disconnect() Disconnect from the database if currently connected, committing outstanding work.
Connection	getConnection() Get a database connection with the currently set parameters.
String	getDatabaseName() Get the database name
abstract String	getDriverClassName() Get the JDBC driver class name
String	getHostName() Get the name of the database host system
String	getHostPort() Get the string representation of the tcp/ip port number for the database server.
String	getNodeNumber() The node number to which you wish to connect in DB2 Partitioned Database environment.
protected String	getPassword() Get the connection password.
String	getServer() Get the name of the database server (INFORMIX only).
abstract ilog.views.maps.datasource.ibm.internal.DBAbstractSpatialCatalog	getSpatialCatalog() Get a spatial catalog object which can be used to obtain the names of spatial tables.
String[]	getSpatiallyEnabledTableNames() Get the names of spatial tables.
abstract String	getUrlFull() Get the full URL for the database server.
String	getUser() Get the connection user ID.
protected boolean	isLUWDB() Checks if current database connection is for DB2 LUW
boolean	isReady() Indicates whether the connection is ready.
boolean	isSavingPassword() Indicates if the password is saved in an .ivl file.
void	setDatabaseName(String dbName) Set the database name for the connection.
void	setHostName(String hostName) Set the host name for the connection.
void	setHostPort(String hostPort) Set the connection port number as a string.
void	setNodeNumber(String nodeNumber) In DB2 Partitioned Database environment, set this to the node number to which you wish to connect.
void	setPassword(String password) Set the database connection password.
protected abstract Properties	setProperties() Sets up the properties for use in DriverManager.getConnection(String, Properties).
void	setSavingPassword(boolean savePassword) Specifies whether the password should be saved in an .ivl file.
void	setServer(String server) Set the database server name (INFORMIX only).
void	setUser(String userid) Set the database connection user ID.
void	write(IlvOutputStream stream) Writes the attributes of a persistent object.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvDBConnectionInfo

public IlvDBConnectionInfo()

Creates a new IlvDBConnectionInfo.

IlvDBConnectionInfo

public IlvDBConnectionInfo(IlvInputStream stream)
                    throws IlvReadFileException

Reads an object from an IlvInputStream.

Parameters:

stream - The stream to read from.

Throws:

IlvReadFileException - if there is a problem reading from stream.

Method Detail

isReady

public boolean isReady()

Indicates whether the connection is ready.

Returns:

true if all necessary parameters have been set.

connect

public Connection connect()
                   throws SQLException,
                          IllegalArgumentException

Establish a database connection with all the parameters that have already been set

Returns:

The connection object

Throws:

SQLException - when the connection cannot be made.

IllegalArgumentException - when some parameters are missing.

disconnect

public void disconnect()
                throws SQLException

Disconnect from the database if currently connected, committing outstanding work.

Throws:

SQLException

getConnection

public Connection getConnection()
                         throws SQLException

Get a database connection with the currently set parameters. If the connection does not exist, or is closed, this method will try to connect() to it.

Returns:

the connection.

Throws:

SQLException - when the connection cannot be made.

getDatabaseName

public String getDatabaseName()

Get the database name

Returns:

the database name.

getDriverClassName

public abstract String getDriverClassName()

Get the JDBC driver class name

Returns:

the JDBC Driver class name.

getHostName

public String getHostName()

Get the name of the database host system

Returns:

the database host system.

getHostPort

public String getHostPort()

Get the string representation of the tcp/ip port number for the database server.

Returns:

the database host port.

getPassword

protected String getPassword()

Get the connection password.

Returns:

the connection password.

getServer

public String getServer()

Get the name of the database server (INFORMIX only).

Returns:

the name of the database server.

getUrlFull

public abstract String getUrlFull()

Get the full URL for the database server.

Returns:

the constructed URL.

getUser

public String getUser()

Get the connection user ID.

Returns:

the user ID.

isLUWDB

protected boolean isLUWDB()

Checks if current database connection is for DB2 LUW

Returns:

True when the database is DB2 LUW.

setDatabaseName

public void setDatabaseName(String dbName)

Set the database name for the connection.

Parameters:

dbName - The database name.

setHostName

public void setHostName(String hostName)

Set the host name for the connection.

Parameters:

hostName - the host name.

setHostPort

public void setHostPort(String hostPort)

Set the connection port number as a string.

Parameters:

hostPort - the port.

setPassword

public void setPassword(String password)

Set the database connection password.

Parameters:

password - the password.

setServer

public void setServer(String server)

Set the database server name (INFORMIX only). The default is "none".

Parameters:

server - the server name.

setUser

public void setUser(String userid)

Set the database connection user ID.

Parameters:

userid - the user ID.

getNodeNumber

public String getNodeNumber()

The node number to which you wish to connect in DB2 Partitioned Database environment.

Returns:

the node number used.

setNodeNumber

public void setNodeNumber(String nodeNumber)

In DB2 Partitioned Database environment, set this to the node number to which you wish to connect. Leave as "0" (the default) in non-Partitioned Database environment.

Parameters:

nodeNumber - the DB2 node number.

setProperties

protected abstract Properties setProperties()

Sets up the properties for use in DriverManager.getConnection(String, Properties).

Returns:

the connection properties.

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the attributes of a persistent object.

Specified by:

write in interface IlvPersistentObject

Parameters:

stream - the output stream

Throws:

IOException - thrown when an exception occurs during the write operation for this object.

isSavingPassword

public boolean isSavingPassword()

Indicates if the password is saved in an .ivl file.

Returns:

true if the password is saved in an .ivl file.

setSavingPassword

public void setSavingPassword(boolean savePassword)

Specifies whether the password should be saved in an .ivl file. By default, the password is saved.

Parameters:

savePassword - If set to true, the password will be saved with the connection. Otherwise, it is not saved in an .ivl file and the internal value for the password is set to null.

getSpatialCatalog

public abstract ilog.views.maps.datasource.ibm.internal.DBAbstractSpatialCatalog getSpatialCatalog()
                                                                                            throws SQLException

Get a spatial catalog object which can be used to obtain the names of spatial tables.

Returns:

DBSpatialCatalog

Throws:

SQLException

getSpatiallyEnabledTableNames

public String[] getSpatiallyEnabledTableNames()
                                       throws SQLException

Get the names of spatial tables.

Returns:

a table of spatial table names.

Throws:

SQLException