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
.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.
|
Modifier and Type | Method and Description |
---|---|
void |
setDatabaseName(String databaseName)
Sets the name of the target IMS database to be accessed.
|
void |
setDatastoreName(String datastore)
Sets the name of the IMS datastore to access.
|
void |
setDatastoreServer(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(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(String keyStoreType)
Sets SSL key store type.
|
void |
setLoginTimeout(int loginTimeout)
Sets the loginTimeout.
|
void |
setMetadataURL(String metadataURL)
Deprecated.
|
void |
setPassword(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(String secureSocketProtocol)
Sets secure socket protocol type.
|
void |
setSSLConnection(boolean sslConnection)
Sets SSL encryption on or off.
|
void |
setSSLKeyMgrAlgorithm(String keyMgrAlgorithm)
Sets SSL key manager algorithm.
|
void |
setSSLKeyStoreLocation(String keyStoreLocation)
Sets SSL key store path.
|
void |
setSSLKeyStorePassword(String keyStorePassword)
Sets SSL key store password.
|
void |
setSSLTrustMgrAlgorithm(String trustMgrAlgorithm)
Sets SSL trust manager algorithm.
|
void |
setSSLTrustStoreLocation(String trustStoreLocation)
Sets SSL trust store path.
|
void |
setSSLTrustStorePassword(String trustStorePassword)
Sets SSL trust store password.
|
void |
setTransientPSBName(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(String user)
Sets the user name
|
static final int DRIVER_TYPE_4
static final int DRIVER_TYPE_2
void setDatastoreName(String datastore)
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.
datastore
- IMS datastore namevoid setDatastoreServer(String datastoreServer)
NOTE: Only used for Type-4 connectivity. Do not apply for Type-2.
datastoreServer
- name or IP address of the datastore server (IMS Connect)void setPortNumber(int portNumber)
By default, the port number is 8888.
NOTE: Only used for Type-4 connectivity. Do not apply for Type-2.
portNumber
- port numbervoid setLoginTimeout(int loginTimeout)
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
loginTimeout
- void setMetadataURL(String metadataURL)
setDatabaseName(String)
metadataURL
- metadata urlvoid setUser(String user)
user
- User name.void setPassword(String password)
password
- User password valuevoid setSSLConnection(boolean sslConnection)
sslConnection
- Set to true
to turn SSL encryption on.void setSSLTrustStoreLocation(String trustStoreLocation)
trustStoreLocation
- Fully qualified path to the key store file containing the
trusted certificate from IMS Connect.void setSSLTrustStorePassword(String trustStorePassword)
trustStorePassword
- Password set for the key store file using keytool.void setSSLTrustMgrAlgorithm(String trustMgrAlgorithm)
trustMgrAlgorithm
- void setSSLKeyStoreLocation(String keyStoreLocation)
keyStoreLocation
- Fully qualified path to the key store file containing the
client's certificate and private key.void setSSLKeyStorePassword(String keyStorePassword)
keyStorePassword
- Password set for the key store file using keytool.void setSSLKeyMgrAlgorithm(String keyMgrAlgorithm)
keyMgrAlgorithm
- void setKeyStoreType(String keyStoreType)
keyStoreType
- Valid values include "JKS" or "PKCS12".void setSecureSocketProtocol(String secureSocketProtocol)
secureSocketProtocol
- Valid values include "SSL", "SSLv3", "TLSv1.1", "TLSv1.2",
etc.void setDriverType(int driverType)
driverType
- Supported values are
IMSConnectionSpec.DRIVER_TYPE_4
and
IMSConnectionSpec.DRIVER_TYPE_2
void setDatabaseName(String databaseName)
databaseName
- database namevoid setTransientPSBName(String transientPSBName)
transientPSBName
- PSB name to override the database view's PSBvoid setInitStatusGroup(String initStatusGroup)
initStatusGroup
- void setReturnResultOnStatusCodeGE(boolean returnResultOnStatusCodeGE)
returnResultOnStatusCodeGE
- void setTreatIncompleteFieldAsNull(boolean treatIncompleteFieldAsNull)
treatIncompleteFieldAsNull
- (c) Copyright IBM Corporation 2008, 2017.