com.ibm.ims.dli

Interface IMSConnectionSpec

public interface IMSConnectionSpec

IMSConnectionSpec is used by an application to pass connection request specific properties to the PSBFactory. For a code example of how to create IMSConnectionSpec, see PSB.

See Also:

IMSConnectionSpecFactory.createIMSConnectionSpec()

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
void	setDatabaseName(java.lang.String databaseName) Sets the name of the target IMS database to be accessed.
void	setDatastoreName(java.lang.String datastore) 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	setDriverType(int driverType) Sets the type of driver to use to connect to the database.
void	setInitStatusGroup(java.lang.String initStatusGroup) When a PSB is allocated, this property will indicate that the driver should automatically issue an INIT STATUS GROUPA or INIT STATUS GROUPB if a value of 'A' or 'B' is provided.
void	setKeyStoreType(java.lang.String keyStoreType) Sets SSL key store type.
void	setLoginTimeout(int loginTimeout) Sets the loginTimeout.
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	setReturnResultOnStatusCodeGE(boolean returnResultOnStatusCodeGE) Sets the option to handle and process data if data was returned when a GE status code is encountered.
void	setSecureSocketProtocol(java.lang.String secureSocketProtocol) Sets secure socket protocol type.
void	setSSLConnection(boolean sslConnection) Sets SSL encryption on or off.
void	setSSLKeyMgrAlgorithm(java.lang.String keyMgrAlgorithm) Sets SSL key manager algorithm.
void	setSSLKeyStoreLocation(java.lang.String keyStoreLocation) Sets SSL key store path.
void	setSSLKeyStorePassword(java.lang.String keyStorePassword) Sets SSL key store password.
void	setSSLTrustMgrAlgorithm(java.lang.String trustMgrAlgorithm) Sets SSL trust manager algorithm.
void	setSSLTrustStoreLocation(java.lang.String trustStoreLocation) Sets SSL trust store path.
void	setSSLTrustStorePassword(java.lang.String trustStorePassword) Sets SSL trust store password.
void	setTransientPSBName(java.lang.String transientPSBName) Sets a transient PSB name that will replace the PSB name in the database view class.
void	setTreatIncompleteFieldAsNull(boolean treatIncompleteFieldAsNull) Sets the option to treat incomplete field data as null.
void	setUser(java.lang.String user) Sets the user name

Field Detail

DRIVER_TYPE_4

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

DRIVER_TYPE_2

static final int DRIVER_TYPE_2

Constant indicating the driver is local.

See Also:

Constant Field Values

Method Detail

setDatastoreName

void setDatastoreName(java.lang.String datastore)

Sets the name of the IMS datastore to access.

For Type-4 connectivity: 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.

For Type-2 connectivity: The datastore parameter refers to the 1 to 4 character identifier of the DRA startup table member. The member name structure is DFSxxxx0 where xxxx is the member identifier. Example: datastore parameter = SYS1 refers to DRA startup table member DFSSYS10 The ODBA startup table is a user created member that contains the IMS subsystem connection properties which includes the IMS subsystem id. This is not required to be set for the Java Dependent Region runtime.

Parameters:

datastore - IMS datastore name

setDatastoreServer

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

NOTE: Only used for Type-4 connectivity. Do not apply for Type-2.

Parameters:

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

setPortNumber

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.

NOTE: Only used for Type-4 connectivity. Do not apply for Type-2.

Parameters:

portNumber - port number

setLoginTimeout

void setLoginTimeout(int loginTimeout)

Sets the loginTimeout. This value represents the number of seconds to wait for TCP/IP socket creation or server response before timing out.

By default, the value is 0, which means the driver will wait indefinitely for a socket connection creation or server response.

NOTE: Only used for Type-4 connectivity

Parameters:

loginTimeout -

setMetadataURL

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

setUser

void setUser(java.lang.String user)

Sets the user name

Parameters:

user - User name.

setPassword

void setPassword(java.lang.String password)

Sets the user password.

Parameters:

password - User password value

setSSLConnection

void setSSLConnection(boolean sslConnection)

Sets SSL encryption on or off.

Parameters:

sslConnection - Set to true to turn SSL encryption on.

setSSLTrustStoreLocation

void setSSLTrustStoreLocation(java.lang.String trustStoreLocation)

Sets SSL trust store path.

Parameters:

trustStoreLocation - Fully qualified path to the key store file containing the trusted certificate from IMS Connect.

setSSLTrustStorePassword

void setSSLTrustStorePassword(java.lang.String trustStorePassword)

Sets SSL trust store password.

Parameters:

trustStorePassword - Password set for the key store file using keytool.

setSSLTrustMgrAlgorithm

void setSSLTrustMgrAlgorithm(java.lang.String trustMgrAlgorithm)

Sets SSL trust manager algorithm.

Parameters:

trustMgrAlgorithm -

setSSLKeyStoreLocation

void setSSLKeyStoreLocation(java.lang.String keyStoreLocation)

Sets SSL key store path.

Parameters:

keyStoreLocation - Fully qualified path to the key store file containing the client's certificate and private key.

setSSLKeyStorePassword

void setSSLKeyStorePassword(java.lang.String keyStorePassword)

Sets SSL key store password.

Parameters:

keyStorePassword - Password set for the key store file using keytool.

setSSLKeyMgrAlgorithm

void setSSLKeyMgrAlgorithm(java.lang.String keyMgrAlgorithm)

Sets SSL key manager algorithm.

Parameters:

keyMgrAlgorithm -

setKeyStoreType

void setKeyStoreType(java.lang.String keyStoreType)

Sets SSL key store type.

Parameters:

keyStoreType - Valid values include "JKS" or "PKCS12".

setSecureSocketProtocol

void setSecureSocketProtocol(java.lang.String secureSocketProtocol)

Sets secure socket protocol type.

Parameters:

secureSocketProtocol - Valid values include "SSL", "SSLv3", "TLSv1.1", "TLSv1.2", etc.

setDriverType

void setDriverType(int driverType)

Sets the type of driver to use to connect to the database. Type-4: Distributed access over TCP/IP. Type-2: Local access (no TCP/IP).

Parameters:

driverType - Supported values are IMSConnectionSpec.DRIVER_TYPE_4 and IMSConnectionSpec.DRIVER_TYPE_2

setDatabaseName

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

setTransientPSBName

void setTransientPSBName(java.lang.String transientPSBName)

Sets a transient PSB name that will replace the PSB name in the database view class.

Parameters:

transientPSBName - PSB name to override the database view's PSB

setInitStatusGroup

void setInitStatusGroup(java.lang.String initStatusGroup)

When a PSB is allocated, this property will indicate that the driver should automatically issue an INIT STATUS GROUPA or INIT STATUS GROUPB if a value of 'A' or 'B' is provided. The default will not issue an INIT STATUS GROUP call.

Parameters:

initStatusGroup -

setReturnResultOnStatusCodeGE

void setReturnResultOnStatusCodeGE(boolean returnResultOnStatusCodeGE)

Sets the option to handle and process data if data was returned when a GE status code is encountered. This property only applies to batchRetrieve or JDBC SELECT operations. When set to true, a retrieve call's Path or ResultSet will receive the data returned from a GE status code. When set to false (default), no data will be returned when a call receives a GE status code.

Parameters:

returnResultOnStatusCodeGE -

setTreatIncompleteFieldAsNull

void setTreatIncompleteFieldAsNull(boolean treatIncompleteFieldAsNull)

Sets the option to treat incomplete field data as null. Incomplete field data is defined as a field's full length extending past the length of the segment. When set to true, incomplete field data is treated as a null. When set to false, the fields incomplete data will be returned. True is the default option. This property only applies to Binary and String datatypes.

Parameters:

treatIncompleteFieldAsNull -