com.ibm.ims.jdbc.xa

Class IMSXADataSource

java.lang.Object

com.ibm.ims.jdbc.xa.IMSXADataSource

All Implemented Interfaces:

javax.sql.CommonDataSource, javax.sql.XADataSource

public class IMSXADataSource
extends java.lang.Object
implements javax.sql.XADataSource

The IMSXADataSource is used as a factory for XAConnection objects and enables your JDBC application to participate in two-phase commit transactions against IMS databases.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DRIVER_TYPE_4 Constant indicating the driver is pure Java and implements the network protocol for the data source.

Constructor Summary

Constructors

Constructor and Description
IMSXADataSource() The default constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDatabaseName() Retrieves the database name this DataSource is configured to access.
java.lang.String	getDatastoreName() Retrieves name of the IMS datastore this XADataSource is configured to access.
java.lang.String	getDatastoreServer() Retrieves the name or IP address of your datastore server (IMS Connect).
java.lang.String	getDescription() Retrieves the description of this XADataSource.
int	getDriverType() Retrieves the database connectivity method.
boolean	getExpandArrayResultSet() Returns the option to expand or not expand the ResultSet of a column with data type ARRAY.
int	getLoginTimeout() Retrieves the login timeout for this XADataSource object
java.io.PrintWriter	getLogWriter() Retrieves the log writer for this XADataSource object.
java.lang.String	getMetadataURL() Deprecated. getDatabaseName()
java.util.logging.Logger	getParentLogger()
java.lang.String	getPassword() Retrieves the user password.
int	getPortNumber() Retrieves the port number.
void	getRemoveInvalidCaseFields() Returns the option to whether to remove the map case fields that don't satisfy the DEPENDINGON field condition in the WHERE clause from the column's list in the result set.
boolean	getSsaOptimization() Returns the option to whether to optimize the SSA or not When set to true the SSA will be optimized to a fully qualified key if subfields of that key are provided.
java.lang.String	getUser() Retrieves the user name.
javax.sql.XAConnection	getXAConnection() Retrieves the XAConnection object.
javax.sql.XAConnection	getXAConnection(java.lang.String user, java.lang.String password) Retrieves the XAConnection object, using the given user name and password.
void	setDatabaseName(java.lang.String databaseName) Sets the name of the target IMS database to be accessed.
void	setDatastoreName(java.lang.String datastoreName) Sets the name of the IMS datastore to access.
void	setDatastoreServer(java.lang.String datastoreServer) Sets the name or IP address of the datastore server (IMS Connect).
void	setDescription(java.lang.String description) Sets the description of this XADataSource.
void	setDriverType(int driverType) Sets the type of driver to use to connect to the database.
void	setExpandArrayResultSet(boolean expandArrayResultSet) Sets the option to expand or not expand the ResultSet of a column with data type ARRAY.
void	setLoginTimeout(int seconds) Sets the maximum time in seconds that this data source will wait while attempting to connect to a database.
void	setLogWriter(java.io.PrintWriter out) Sets the log writer for this XADataSource object to the given java.io.PrintWriter object.
void	setMetadataURL(java.lang.String metadataURL) Deprecated. setDatabaseName(String)
void	setPassword(java.lang.String password) Sets the user password.
void	setPortNumber(int portNumber) Sets the port number to be used to communicate with IMS Connect.
void	setRemoveInvalidCaseFields(boolean removeInvalidCaseFields) Sets the option to whether to remove the map case fields that don't satisfy the DEPENDINGON field condition in the WHERE clause from the column's list in the result set.
void	setSsaOptimization(boolean ssaOptimization) Sets the option to whether to optimize the SSA or not When set to true the SSA will be optimized to a fully qualified key if subfields of that key are provided.
void	setUser(java.lang.String user) Sets the user name

Methods inherited from class java.lang.Object

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

Field Detail

DRIVER_TYPE_4

public static final int DRIVER_TYPE_4

Constant indicating the driver is pure Java and implements the network protocol for the data source.

See Also:

Constant Field Values

Constructor Detail

IMSXADataSource

public IMSXADataSource()

The default constructor.

Method Detail

getXAConnection

public javax.sql.XAConnection getXAConnection()
                                       throws java.sql.SQLException

Retrieves the XAConnection object.

Specified by:

getXAConnection in interface javax.sql.XADataSource

Returns:

the XAConnection object, which represents a physical database connection that can be used in a distributed transaction.

Throws:

java.sql.SQLException

getXAConnection

public javax.sql.XAConnection getXAConnection(java.lang.String user,
                                              java.lang.String password)
                                       throws java.sql.SQLException

Retrieves the XAConnection object, using the given user name and password.

Specified by:

getXAConnection in interface javax.sql.XADataSource

Parameters:

user - the user name

password - the user password

Returns:

the XAConnection object, which represents a physical database connection that can be used in a distributed transaction.

Throws:

java.sql.SQLException

getLogWriter

public java.io.PrintWriter getLogWriter()
                                 throws java.sql.SQLException

Retrieves the log writer for this XADataSource object.

The log writer is a character output stream to which all logging and tracing messages for this XADataSource will be printed. This includes messages printed by the methods of this object,messages printed by methods of other objects manufactured by this object, and so on. Messages printed to a data source specific log writer are not printed to the log writer associated with the java.sql.Drivermanager class. When a XADataSource object is created, the log writer is initially null; in other words, the default is for logging to be disabled.

Specified by:

getLogWriter in interface javax.sql.CommonDataSource

Returns:

the log writer for this data source or null if logging is disabled

Throws:

java.sql.SQLException

getLoginTimeout

public int getLoginTimeout()
                    throws java.sql.SQLException

Retrieves the login timeout for this XADataSource object

Specified by:

getLoginTimeout in interface javax.sql.CommonDataSource

Returns:

the login timeout

Throws:

java.sql.SQLException

setLogWriter

public void setLogWriter(java.io.PrintWriter out)
                  throws java.sql.SQLException

Sets the log writer for this XADataSource object to the given java.io.PrintWriter object.

The log writer is a character output stream to which all logging and tracing messages for this XADataSource will be printed. This includes messages printed by the methods of this object, messages printed by methods of other objects manufactured by this object, and so on. Messages printed to a data source specific log writer are not printed to the log writer associated with the java.sql.Drivermanager class. When a XADataSource object is created the log writer is initially null; in other words, the default is for logging to be disabled.

Specified by:

setLogWriter in interface javax.sql.CommonDataSource

Parameters:

out - the new log writer; to disable logging, set to null

Throws:

java.sql.SQLException

setLoginTimeout

public void setLoginTimeout(int seconds)
                     throws java.sql.SQLException

Sets the maximum time in seconds that this data source will wait while attempting to connect to a database. A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout. When a XADataSource object is created, the login timeout is initially zero.

Specified by:

setLoginTimeout in interface javax.sql.CommonDataSource

Parameters:

seconds - the data source login time limit

Throws:

java.sql.SQLException

getMetadataURL

public java.lang.String getMetadataURL()

Deprecated. getDatabaseName()

Retrieves the URL of the database metadata representing the target IMS database.

Returns:

the metadata URL

setMetadataURL

public void setMetadataURL(java.lang.String metadataURL)

Deprecated. setDatabaseName(String)

Sets the location of the database metadata representing the target IMS database. The metadata URL is the fully qualified name of the Java metadata class generated by the IMS Explorer for Development. The URL must begin with class://

Parameters:

metadataURL - metadata url

getDatabaseName

public java.lang.String getDatabaseName()

Retrieves the database name this DataSource is configured to access.

Returns:

the database name

setDatabaseName

public void setDatabaseName(java.lang.String databaseName)

Sets the name of the target IMS database to be accessed. If the metadata repository is the IMS catalog then the database name is the name of the PSB (program specification block) containing the database(s) to be accessed. If the metadata repository is the file system then the database name is the fully qualified name of the Java metadata class generated by the IMS Explorer for Development. In this case the name must begin with class://

Parameters:

databaseName - database name

getDatastoreServer

public java.lang.String getDatastoreServer()

Retrieves the name or IP address of your datastore server (IMS Connect).

Returns:

the name or IP address of the datastore server (IMS Connect)

setDatastoreServer

public void setDatastoreServer(java.lang.String datastoreServer)

Sets the name or IP address of the datastore server (IMS Connect). You can provide either the host name (for example, dev123.svl.ibm.com) or the IP address (for example, 192.166.0.2).

Parameters:

datastoreServer - name or IP address of the datastore server (IMS Connect)

getDescription

public java.lang.String getDescription()

Retrieves the description of this XADataSource.

Returns:

the description

setDescription

public void setDescription(java.lang.String description)

Sets the description of this XADataSource.

Parameters:

description - the description

getDriverType

public int getDriverType()

Retrieves the database connectivity method.

Returns:

the database connectivity method

setDriverType

public void setDriverType(int driverType)

Sets the type of driver to use to connect to the database.

Parameters:

driverType - Only IMSXADataSource.DRIVER_TYPE_4 is currently supported.

getPassword

public java.lang.String getPassword()

Retrieves the user password.

Returns:

user password value for this connection

setPassword

public void setPassword(java.lang.String password)

Sets the user password.

Parameters:

password - User password value

getPortNumber

public int getPortNumber()

Retrieves the port number.

Returns:

the port number for this connection.

setPortNumber

public void setPortNumber(int portNumber)

Sets the port number to be used to communicate with IMS Connect. The port number is defined using the DRDAPORT parameter on the ODACCESS statement in the integrated IMS Connect configuration PROCLIB member.

By default, the port number is 8888.

Parameters:

portNumber - port number

getDatastoreName

public java.lang.String getDatastoreName()

Retrieves name of the IMS datastore this XADataSource is configured to access.

Returns:

the datastore name

setDatastoreName

public void setDatastoreName(java.lang.String datastoreName)

Sets the name of the IMS datastore to access. The datastore parameter must match either the name of the datastore defined to ODBM or be blank. The datastore name is defined in the ODBM CSLDCxxx PROCLIB member using either the DATASTORE (NAME=name) or ALIAS (NAME=aliasname) parameter. If the datastore value is left blank (or not supplied), IMS Connect will connect to any available instance of ODBM as it is assumed all datastores defined to ODBM are data shared.

Parameters:

datastoreName - IMS datastore name

getUser

public java.lang.String getUser()

Retrieves the user name.

Returns:

the user name for this connection.

setUser

public void setUser(java.lang.String user)

Sets the user name

Parameters:

user - User name.

getParentLogger

public java.util.logging.Logger getParentLogger()
                                         throws java.sql.SQLFeatureNotSupportedException

Specified by:

getParentLogger in interface javax.sql.CommonDataSource

Throws:

java.sql.SQLFeatureNotSupportedException

setRemoveInvalidCaseFields

public void setRemoveInvalidCaseFields(boolean removeInvalidCaseFields)

Sets the option to whether to remove the map case fields that don't satisfy the DEPENDINGON field condition in the WHERE clause from the column's list in the result set.

When set to true, only the valid map case fields will be returned in the result set.

When set to false (default) the result set will contain all map case fields.

Parameters:

removeInvalidCaseFields -

getRemoveInvalidCaseFields

public void getRemoveInvalidCaseFields()

Returns the option to whether to remove the map case fields that don't satisfy the DEPENDINGON field condition in the WHERE clause from the column's list in the result set.

When set to true, only the valid map case fields will be returned in the result set.

When set to false (default) the result set will contain all map case fields.

setExpandArrayResultSet

public void setExpandArrayResultSet(boolean expandArrayResultSet)

Sets the option to expand or not expand the ResultSet of a column with data type ARRAY.

When set to true the array result set expands the sub-elements of the array into 1 or more columns depending on the number of fields defined within the array.

When set to false (default) the array result set returns a result set of exactly 2 columns. Column 1 is the index and column 2 is a Struct object that contains accessors for fields within that array element.

Parameters:

expandArrayResultSet -

setSsaOptimization

public void setSsaOptimization(boolean ssaOptimization)

Sets the option to whether to optimize the SSA or not

When set to true the SSA will be optimized to a fully qualified key if subfields of that key are provided.

When set to false (default) the SSA will not be optimized.

Parameters:

ssaOptimization -

getExpandArrayResultSet

public boolean getExpandArrayResultSet()

Returns the option to expand or not expand the ResultSet of a column with data type ARRAY.

When set to true the array result set expands the sub-elements of the array into 1 or more columns depending on the number of fields defined within the array.

When set to false (default) the array result set returns a result set of exactly 2 columns. Column 1 is the index and column 2 is a Struct object that contains accessors for fields within that array element.

Parameters:

expandArrayResultSet -

getSsaOptimization

public boolean getSsaOptimization()

Returns the option to whether to optimize the SSA or not

When set to true the SSA will be optimized to a fully qualified key if subfields of that key are provided.

When set to false (default) the SSA will not be optimized.

Parameters:

ssaOptimization -