JDBC Programmer Reference › DataSource Connection Parameters › IdmsDataSource

IdmsDataSource

The IdmsDataSource class implements the JDBC DataSource interface. It is used with an application server provided Java Naming and Directory Interface (JNDI) naming service to establish a connection to a CA IDMS database.

IdmsDataSource properties conform to the Java Beans naming conventions and are implicitly defined by public "setter" and "getter" methods. For example, the "description" property, which is required for all DataSource implementations, is set using the setDescription(String) method. The application server may use the java.lang.reflection methods to discover DataSource properties and provide an interface to set them, or may simply require that they are defined in some configuration file.

IdmsDataSource properties are used to specify the connection parameters. These properties are the equivalent of the DriverPropertyInfo attributes described in the previous section and can be used to completely define the parameters needed to connect to a database. Like a URL, an IdmsDataSource object can also reference an "ODBC" style data source name, where the connection parameters are defined in the registry on Windows, the configuration file on z/OS or Linux, or in the Java properties file.

accountInfo

Specifies optional accounting information. See the DriverPropertyInfo attribute descriptions.

connectSuspend

Specifies that when set to true, the JDBC driver suspends the SQL session and pseudo converses immediately after connecting to the database. The default for a non-pooled connection is false.

databaseName

Identifies the database on the CA IDMS CV. When nodeName is specified, the driver interprets this property as the DICTNAME of the catalog in which the tables are defined and assumes that the IdmsDataSource contains all information needed to connect to the CV. When nodeName is not specified, the driver interprets this property as the name of an ODBC style data source containing connection information. The networkProtocol property can be used to override this behavior.

dataSourceName

Specifies a logical data source name. Container provided DataSource implementations use this to name the ConnectionPoolDataSource object. The IdmsDataSource implementation does not use this internally.

defaultSchema

Specifies the name of the default SQL Schema. This is an optional 1-to-18 character field. When specified, this field is used as the schema qualifier for all SQL table references that do not contain an explicit schema qualifier. The default is blank (unspecified).

description

Specifies a data source description. This property is required of all DataSource implementations.

externalWait

Overrides the external wait interval for the server task invoked by the Type 4 driver. This effectively becomes the socket timeout.

identityAudited

Enables end-to-end auditing of the external user identity provided by an identity manager such as CA SiteMinder.

networkProtocol

Specifies how the JDBC driver communicates with the CV:

• CCI can be specified on Windows or z/OS when the native client interface is installed. It causes the driver to function as a Type 2 driver, using CAICCI/PC on Windows or CAICCI/ENF on z/OS to communicate with the CV.
• TCP can be specified on any platform. It causes the driver to function as a Type 3 driver when connected to the JDBC Server or as a Type 4 driver when connected directly to CA IDMS.
• IDMS can be specified on any platform. It provides a hint to the driver that it connects directly to CA IDMS as a Type 4 driver. When IDMS is specified, the driver ignores the nodeName and viaName properties and always interprets the databaseName as the DICTNAME.

nodeName

Specifies the NODE name that identifies the CV containing the database. This property should be used to define a Type 2 connection without defining an ODBC style data source. Use of this property implies that the databaseName is a DICTNAME.

password

Specifies the password for the default user ID. The application can override this when the connection is established. For security, the getPassword method does not return the value.

portNumber

Specifies the TCP/IP port number of the CCITCP address space, JDBC Server, or CA IDMS CV, depending on the value of networkProtocol.

programName

Sets an external application name to be used as the CA IDMS program name for all connections created by this data source. The first eight characters of this name are written to the journal.

resourceInterval

Overrides the resource interval for the server task invoked by the Type 4 driver.

roleName

Supported for compatibility with other DataSource implementations. The IdmsDataSource implementation does not use this internally.

serverLength

Overrides the default data buffer size specified in the listener PTERM PARM string for the Type 4 driver server interface, IDMSJSRV.

serverName

Specifies the DNS name or TCP/IP address of the server. The driver uses the value of networkProtocol to interpret this property:

• When networkProtocol is CCI, this property refers to the mainframe where the CCITCP address space is running when the driver is running on Windows and is ignored when the JDBC driver is running on z/OS.
• When network protocol is TCP, this property refers to the machine where the JDBC server is running, which can be on any platform.
• When network protocol is IDMS, this property refers to the machine where the CA IDMS CV is running.

serverTrace

Sets the IDMSJSRV trace flags as defined in CSACFLG1 and CSACFLG2 as directed by CA IDMS Technical Support. Used only with the Type 4 driver.

ssl

Specifies that when set to true, the JDBC driver requests a secure socket for all communication to a CA IDMS CV or a JDBC proxy server.

taskCode

Overrides the TASK code. See the DriverPropertyInfo attribute descriptions.

user

Specifies a default user ID to sign on to CA IDMS. The application can override this when the connection is established.

viaNodeName

Specifies the NODE name of an intermediate CV used to route the connection to the destination CV for a Type 2 driver connection. Valid only if nodeName is specified. See the DriverPropertyInfo attribute descriptions.