ca.idms.jdbc
Class IdmsCommonDataSource

java.lang.Object
  ca.idms.jdbc.IdmsCommonDataSource

All Implemented Interfaces:

IdmsDriverInterface, javax.sql.CommonDataSource

Direct Known Subclasses:

IdmsCommonPoolDataSource, IdmsDataSource

public class IdmsCommonDataSource
extends java.lang.Object
implements javax.sql.CommonDataSource, IdmsDriverInterface

This class is the base class for all CA IDMS DataSource implementations classes, and contains the properties for need to establish a connection.

Author:

rosda01

Field Summary

static java.lang.String	CCI networkProtocol value for type 2 driver
static java.lang.String	IDMS networkProtocol value for type 4 driver
static java.lang.String	TCP networkProtocol value for type 3 and 4 driver

Fields inherited from interface ca.idms.jdbc.IdmsDriverInterface

ACCOUNT, BATCH, CCIHOST, CCIPORT, CSUSPEND, CUSTOM, DEF_CCIPORT, DEF_TASK, DEFSCHEM, EWAIT, INFO, INTERACTIVE, NODE, PASSWORD, PROGRAM, RSINT, SBUFLEN, SERVICE, SSL, STRACE, SUSPEND, TASK, USER, VIA

Constructor Summary

IdmsCommonDataSource()

Method Summary

java.lang.String	getAccountInfo() Gets the accountCode property for this data source.
boolean	getConnectSuspend() Deprecated. Use #getSuspendStrategy instead.
java.lang.String	getDatabaseName() Gets the databaseName property for this data source.
java.lang.String	getDataSourceName() Gets the dataSourceName property for this data source.
java.lang.String	getDefaultSchema() Gets the defaultSchema property for this data source.
java.lang.String	getDescription() Gets the description property for this data source.
short	getExternalWait() Gets the externalWait property for this data source.
IdmsConnection	getIdmsConnection() Connect using the default user id and password.
IdmsConnection	getIdmsConnection(java.lang.String uid, java.lang.String pwd) Connect using the specified user id and password.
int	getLoginTimeout() Gets the replay timeout.
java.io.PrintWriter	getLogWriter() Gets the log writer for this data source.
java.lang.String	getNetworkProtocol() Gets the networkProtocol property for this data source.
java.lang.String	getNodeName() Gets the nodeName property for this data source.
java.lang.String	getPassword() Does not get the password For security.
int	getPortNumber() Gets the portNumber property for this data source.
java.lang.String	getProgramName() Gets the programName property for this data source.
short	getResourceInterval() Gets the resourceInterval property for this data source.
java.lang.String	getRoleName() Gets the roleName property for this data source.
int	getServerLength() Gets the serverLength property for this data source.
java.lang.String	getServerName() Gets the serverName property for this data source.
int	getServerTrace() Gets the serverTrace property for this data source.
java.lang.String	getSuspendStrategy() Gets the suspendStrategy for this data source.
java.lang.String	getTaskCode() Gets the taskCode property for this data source.
java.lang.String	getUser() Gets the user property for this data source.
java.lang.String	getViaNodeName() Gets the viaNodeName property for this data source.
boolean	isIdentityAudited() Is identity auditing enabled?
boolean	isSsl()
void	list(java.io.PrintWriter out) Lists the data source properties.
void	list(TraceOutput out) Lists the data source properties.
void	setAccountInfo(java.lang.String s) Sets the accountInfo property for this data source.
void	setConnectSuspend(boolean b) Deprecated. Use #setSuspendStrategy With SERVICE instead.
void	setDatabaseName(java.lang.String s) Sets the databaseName property for this data source.
void	setDataSourceName(java.lang.String dsn) Sets the dataSourceName property for this data source.
void	setDefaultSchema(java.lang.String s) Sets the defaultSchema property for this data source.
void	setDescription(java.lang.String s) Sets the description property for this data source.
void	setExternalWait(short w) Sets the externalWait property for this data source.
void	setIdentityAudited(boolean enable) Enables or disables identity auditing.
void	setLoginTimeout(int t) Sets the reply timeout.
void	setLogWriter(java.io.PrintWriter out) Sets the log writer for this data source.
void	setNetworkProtocol(java.lang.String s) Sets the networkProtocol property for this data source.
void	setNodeName(java.lang.String s) Sets the nodeName property for this data source.
void	setPassword(java.lang.String pwd) Sets the password property for this data source.
void	setPortNumber(int p) Sets the portNumber property for this data source.
void	setProgramName(java.lang.String s) Sets the programName property for this data source.
void	setResourceInterval(short w) Sets the resourceInterval property for this data source.
void	setRoleName(java.lang.String s) Sets the roleName property for this data source.
void	setServerLength(int l) Sets the serverLength property for this data source.
void	setServerName(java.lang.String s) Sets the serverName property for this data source.
void	setServerTrace(int t) Sets the serverTrace property for this data source.
void	setSsl(boolean ssl) Request an SSL connection.
void	setSuspendStrategy(java.lang.String s) Sets the suspendStrategy property for this data source.
void	setTaskCode(java.lang.String s) Sets the taskCode property for this data source.
void	setUser(java.lang.String uid) Sets the user property for this data source.
void	setViaNodeName(java.lang.String s) Sets the viaNodeName property for this data source.

Methods inherited from class java.lang.Object

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

Field Detail

CCI

public static final java.lang.String CCI

networkProtocol value for type 2 driver

See Also:

Constant Field Values

TCP

public static final java.lang.String TCP

networkProtocol value for type 3 and 4 driver

See Also:

Constant Field Values

IDMS

public static final java.lang.String IDMS

networkProtocol value for type 4 driver

See Also:

Constant Field Values

Constructor Detail

IdmsCommonDataSource

public IdmsCommonDataSource()

Method Detail

setLoginTimeout

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

Sets the reply timeout. The CA IDMS JDBC driver uses the value of loginTimeout as the reply timeout for all connections created from this DataSource. The reply timeout specifies how long the driver waits for a reply from CA IDMS before returning a timeout error. A value greater than 0 overrides the CCI Reply Wait interval for the Type 2 driver, and is used as the socket reply timeout for the Type 3 and Type 4 drivers. The system default can be set using the IdmsConnectOptions.LOGIN_TIMEOUT property.

Specified by:

setLoginTimeout in interface javax.sql.CommonDataSource

Parameters:

t - timeout in seconds, ignored if < 0

Throws:

java.sql.SQLException - not really

See Also:

setLoginTimeout(int), IdmsStatement.setQueryTimeout(int)

getLoginTimeout

public int getLoginTimeout()
                    throws java.sql.SQLException

Gets the replay timeout.

Specified by:

getLoginTimeout in interface javax.sql.CommonDataSource

Returns:

the timeout in seconds

Throws:

java.sql.SQLException - not really

See Also:

getLoginTimeout()

setLogWriter

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

Sets the log writer for this data source. Although each DataSource can be associated with a separate log writer, all Connections created by the same DataSource share the same one. Once a Connection is created with a non-null log writer it will continue to use it until the Connection is closed. Disabling the log writer in the DataSource (or DriverManager, for that matter) has no effect on existing connections.

Specified by:

setLogWriter in interface javax.sql.CommonDataSource

Parameters:

out - the output print writer object

Throws:

java.sql.SQLException - not really

getLogWriter

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

Gets the log writer for this data source.

Specified by:

getLogWriter in interface javax.sql.CommonDataSource

Returns:

the output print writer object

Throws:

java.sql.SQLException - not really

setDataSourceName

public void setDataSourceName(java.lang.String dsn)

Sets the dataSourceName property for this data source. The dataSourceName is used by an application container for connection pooling and distributed transaction management. The CA IDMS JDBC driver does not use it internally.

Parameters:

dsn - the data source name

getDataSourceName

public java.lang.String getDataSourceName()

Gets the dataSourceName property for this data source.

Returns:

the data source name

See Also:

setDataSourceName(java.lang.String)

setDescription

public void setDescription(java.lang.String s)

Sets the description property for this data source. This property is required of all DataSource implementations.

Parameters:

s - the description

getDescription

public java.lang.String getDescription()

Gets the description property for this data source.

Returns:

the description

See Also:

setDescription(java.lang.String)

setUser

public void setUser(java.lang.String uid)

Sets the user property for this data source. This property specifies the default user id, and is used when the 0 argument form of getConnection is invoked.

Parameters:

uid - the default CA IDMS user id, ignored it null

See Also:

IdmsJdbcDriver.getPropertyInfo(java.lang.String, java.util.Properties)

getUser

public java.lang.String getUser()

Gets the user property for this data source.

Returns:

the default CA IDMS user id

See Also:

setUser(java.lang.String)

setPassword

public void setPassword(java.lang.String pwd)

Sets the password property for this data source. The password is encrypted and used as the default password when when the IdmsDataSource.getConnection() method is invoked.

Parameters:

pwd - the property value

See Also:

IdmsJdbcDriver.getPropertyInfo(java.lang.String, java.util.Properties)

getPassword

public java.lang.String getPassword()

Does not get the password For security.

Returns:

"******" if set, null otherwise

See Also:

setPassword(java.lang.String)

setAccountInfo

public void setAccountInfo(java.lang.String s)

Sets the accountInfo property for this data source. This optional property can be used to specify accounting information passed to CA IDMS when the physical connection is established. The meaning of this information defined by the client site.

Detailed information is available in the CA IDMS Server User Guide.

Parameters:

s - accounting information

See Also:

getAccountInfo(), IdmsJdbcDriver.getPropertyInfo(java.lang.String, java.util.Properties)

getAccountInfo

public java.lang.String getAccountInfo()

Gets the accountCode property for this data source.

Returns:

the accounting information

See Also:

setAccountInfo(java.lang.String)

setProgramName

public void setProgramName(java.lang.String s)

Sets the programName property for this data source. This optional property can be used to override the default program name for the JDBC driver ("IDMSJDBC"). The program name is shown by IDMS monitoring tools and recorded in the journal. Only the first 8 characters of the string are used.

Parameters:

s - program name

See Also:

getProgramName(), IdmsJdbcDriver.getPropertyInfo(java.lang.String, java.util.Properties)

getProgramName

public java.lang.String getProgramName()

Gets the programName property for this data source.

Returns:

the accounting information

See Also:

setProgramName(java.lang.String)

setRoleName

public void setRoleName(java.lang.String s)

Sets the roleName property for this data source. CA IDMS does not use this property.

Parameters:

s - the property value

getRoleName

public java.lang.String getRoleName()

Gets the roleName property for this data source.

Returns:

the property value

See Also:

setRoleName(java.lang.String)

setNetworkProtocol

public void setNetworkProtocol(java.lang.String s)

Sets the networkProtocol property for this data source. This propery defines the driver "type", that is, where the native CA IDMS client interface is located, and determines how to interpret the nodeName, taskCode, serverName, and portNumber properties. Values are:

CCI

The driver functions as a "Type 2" driver, and invokes the native CA IDMS interface directly using JNI. The native interface uses CAICCI to communicate with CA IDMS CV. This can be used on Windows or in the Unix Systems Services (USS) environment on z/OS. Note that CAICCI uses TCP/IP on Windows but not in USS. The equivalent JDBC URL for the connection is:

jdbc:idms:

TCP

The driver functions as a "Type 3" driver, and communicates with the Java implementation of the JDBC server, referred to as the "Proxy" server. No native code is needed on the client so the driver can be used on any Java platform. On Windows and USS the Proxy server uses JNI to invoke the native interface, which uses CAICCI to communicate with the CA IDMS CV, or it can forward the request to another instance of the JDBC Server, allowing it to run on any Java platform. The equivalent JDBC URL for the connection is:

jdbc:idms://:/

IDMS

The driver functions as a Type 4 driver, and communicates directly with the CA IDMS/DC implementation of the JDBC server, IDMSJSRV. No native code is needed on the client so the driver can be used on any Java platform. IDMSJSRV runs a a server task started by the TCP/IP line driver generic listener, and requires CA IDMS 16.0 SP2 or later. The equivalent JDBC URL for the connection is:

jdbc:idms://:/

Note that the Type 3 and Type 4 drivers are essentially equivalent from the point of view of the client. The actual type depends only on the JDBC server that the driver connects to at run time, specified by the serverName and portNumber. Setting the networkProtocol to "IDMS" gives a hint to the driver that it uses to optimize the way it passes connection properties to the IDMS.

Parameters:

s - either "CCI", "TCP", or "IDMS", anything else is ignored

See Also:

CCI, TCP, IDMS, setNodeName(java.lang.String), setTaskCode(java.lang.String), setServerName(java.lang.String), setPortNumber(int)

getNetworkProtocol

public java.lang.String getNetworkProtocol()

Gets the networkProtocol property for this data source.

Returns:

the protocol string

See Also:

setNetworkProtocol(java.lang.String)

setServerName

public void setServerName(java.lang.String s)

Sets the serverName property for this data source. The interpretation of this property depends on the value of the networkProtocol and nodeName properties:

CCI

When the JDBC driver is running on Windows the value is interpreted as the TCP/IP host name of the mainframe where the CCITCP server runs. If not specified the host name is accessed from the Windows registry. When running on USS in z/OS this property should not be specified since since the JDBC driver bypasses CCITCP and communicates directly with CCIENF. CCI is only supported on Windows and z/OS. This property is ignored for CCI when nodeName is null.

TCP

The value is interpreted as the TCP/IP host name of the machine where the CA IDMS JDBC Server runs. This property is required.

IDMS

The value is interpreted as the TCP/IP host name of the machine where the CA IDMS/DC CV runs. This property is required.

Parameters:

s - the server name

See Also:

setNetworkProtocol(java.lang.String), setNodeName(java.lang.String), IdmsJdbcDriver.getPropertyInfo(java.lang.String, java.util.Properties)

getServerName

public java.lang.String getServerName()

Gets the serverName property for this data source.

Returns:

the server name

See Also:

setServerName(java.lang.String)

setPortNumber

public void setPortNumber(int p)

Sets the portNumber property for this data source. This property identifies the TCP/IP port associated with serverName, and is interpeted the same way.

It is usually not needed with the Type 2 driver (CCI), since there is usually only one CCITCP region per operating system image.

It is needed with the Type 3 driver (TCP), unless there is only a single version of the JDBC server using the default port on the host.

It is usually needed with the Type 4 driver (IDMS), since each CV rquires a different port. A recommended convention is to derive the port number from the system number, for example SYST0099 would listen on port 3799. Common port numbers:

CCI

1202 (default)

TCP

3709 (default)

IDMS

37nn (nn = CV number for IDMSJSRV)

Parameters:

p - the TCP/IP port

See Also:

setNetworkProtocol(java.lang.String), setServerName(java.lang.String), IdmsJdbcDriver.getPropertyInfo(java.lang.String, java.util.Properties)

getPortNumber

public int getPortNumber()

Gets the portNumber property for this data source.

Returns:

the port number

See Also:

setPortNumber(int)

setDatabaseName

public void setDatabaseName(java.lang.String s)

Sets the databaseName property for this data source. When the nodeName property is set, this is interpreted as the DICTNAME, that is, the DBNAME of the dictionary where the SQL database is defined, on the CA IDMS system identified by nodeName.

When nodeName is not set, this is interpreted as the name of a logical "data source" (in the ODBC sense, not to be confused with the JDBC class) in the CA IDMS configuration file (or registry in Windows). The DBNODE and all other connection properties are accessed from this definition. Note that this definition is accessed from the local machine when networkProtocol is "CCI" and from the JDBC Server's machine for "TCP".

Parameters:

s - the DICTNAME or DSN

See Also:

setNetworkProtocol(java.lang.String), setNodeName(java.lang.String)

getDatabaseName

public java.lang.String getDatabaseName()

Gets the databaseName property for this data source.

Returns:

the DICTNAME or DSN

See Also:

setDatabaseName(java.lang.String)

setDefaultSchema

public void setDefaultSchema(java.lang.String s)

Sets the defaultSchema property for this data source. Setting this property causes a SET SESSION CURRENT SCHEMA command to be sent to the back-end IDMS system after a connection is made. This will be in effect for all SQL operations on the connection.

Parameters:

s - the default schema name

getDefaultSchema

public java.lang.String getDefaultSchema()

Gets the defaultSchema property for this data source.

Returns:

the default schema name, if set

See Also:

setDefaultSchema(java.lang.String)

setNodeName

public void setNodeName(java.lang.String s)

Sets the nodeName property for this data source. This property specifies the CA IDMS system that contains the database specified by the databaseName property. The interpretation of this property depends on the value of networkProtocol:

CCI

The value is the DBNODE of the CA IDMS CV. If null, the DBNODE is taken from the Windows registry of USS configuration file, and the viaNode, taskCode, serverName, and portNumber properties are ignored.

TCP

The value is the DBNODE of the CA IDMS CV. If null, the DBNODE is taken from the Windows registry or USS configuration file, and the viaNodeName, taskCode, serverName, and portNumber properties are ignored. If specified and the server is IDMSJSRV, the nodeName and viaNodeName values are ignored, but the taskCode, serverName, and portNumber properties are used.

IDMS

The value is ignored. The serverName and portNumber identify the host.

Parameters:

s - the DBNODE

See Also:

setNetworkProtocol(java.lang.String), setDatabaseName(java.lang.String), setViaNodeName(java.lang.String), setTaskCode(java.lang.String), setServerName(java.lang.String), setPortNumber(int), IdmsJdbcDriver.getPropertyInfo(java.lang.String, java.util.Properties)

getNodeName

public java.lang.String getNodeName()

Gets the nodeName property for this data source.

Returns:

the DBNODE

See Also:

setNodeName(java.lang.String)

setViaNodeName

public void setViaNodeName(java.lang.String s)

Sets the viaNodeName property for this data source. This optional property can be used to specify an intermediate CA IDMS system used to access the database on the CA IDMS system specified by the nodeName property. If specified the value should be the DBNODE of the "front end" CA IDMS system.

This property is ignored when nodeName is null. It is not supported by the Type 4 driver, which uses the DBTABLE defined in the CV for equivalent routing.

Parameters:

s - the via DBNODE

See Also:

setDatabaseName(java.lang.String), setNetworkProtocol(java.lang.String), setNodeName(java.lang.String), IdmsJdbcDriver.getPropertyInfo(java.lang.String, java.util.Properties)

getViaNodeName

public java.lang.String getViaNodeName()

Gets the viaNodeName property for this data source.

Returns:

the via DBNODE

See Also:

setViaNodeName(java.lang.String)

setTaskCode

public void setTaskCode(java.lang.String s)

Sets the taskCode property for this data source. This property can be used to override the default task started in the CA IDMS system when the physical connection established. The interpretation of this property depends on the values of the networkProtocol and nodeName properties:

CCI

Specifies the task started by the CCI line driver. The value is ignored if nodeName is null. The default is CASERVER.

TCP

Specifies the task started by the CCI line driver or used by IDMSJSRV. The value is ignored if nodeName is null. The default is CASERVER. Note that the default will cause an error if the server is IDMSJSRV and the CASERVER task is used for CCI connections (as it usually is).

IDMS

IDMSJSRV uses the specified task code to check task authorization and get default timeouts. The task is not actually invoked until the first pseudo converse. The default value is null, and the value of nodeName is ignored.

Parameters:

s - the TASK code

See Also:

setDatabaseName(java.lang.String), setNetworkProtocol(java.lang.String), setNodeName(java.lang.String), IdmsJdbcDriver.getPropertyInfo(java.lang.String, java.util.Properties)

getTaskCode

public java.lang.String getTaskCode()

Gets the taskCode property for this data source.

Returns:

the TASK code

See Also:

setTaskCode(java.lang.String)

setConnectSuspend

public void setConnectSuspend(boolean b)

Deprecated. Use #setSuspendStrategy With SERVICE instead.

Sets the connectSuspend property for this data source. When this optional property is set to true the will execute an SQL SUSPEND immediately after establishing a the connection to CA IDMS. This can be especially useful when the connection pool contains a minimum number of connections to prevent these connections from allocating unused tasks. The default for an IdmsDataSource object is false, while the default for an IdmsConnectionPoolDataSource object is true.

Parameters:

b - true to enable connectSuspend

See Also:

IdmsJdbcDriver.getPropertyInfo(java.lang.String, java.util.Properties)

getConnectSuspend

public boolean getConnectSuspend()

Deprecated. Use #getSuspendStrategy instead.

Gets the connectSuspend option for this data source.

Returns:

true if suspendStrategy is SERVICE

See Also:

setConnectSuspend(boolean)

setSuspendStrategy

public void setSuspendStrategy(java.lang.String s)

Sets the suspendStrategy property for this data source. The suspend strategy can be:

• IdmsDriverInterface.INTERACTIVE
• IdmsDriverInterface.SERVICE
• IdmsDriverInterface.BATCH
• IdmsDriverInterface.CUSTOM

Parameters:

s - suspend strategy, ignored if not one of the above

See Also:

IdmsJdbcDriver.getPropertyInfo(java.lang.String, java.util.Properties)

getSuspendStrategy

public java.lang.String getSuspendStrategy()

Gets the suspendStrategy for this data source.

Returns:

true if enabled

See Also:

setSuspendStrategy(java.lang.String)

setExternalWait

public void setExternalWait(short w)

Sets the externalWait property for this data source. This optional property can be used to specify the external wait interval for the IDMSJSRV server task. This is set as the socket timeout while the task is active. Valid values are:

-1

Disable timeouts (wait forever)

0

Use default for the task

1-32767

Timeout value

The value set is constrained by the TIMEOUT option set on the listener PTERM definition for IDMSJSRV. This property is used only by the Type 4 driver.

Parameters:

w - the wait interval

See Also:

setDatabaseName(java.lang.String), setNetworkProtocol(java.lang.String), setNodeName(java.lang.String), IdmsJdbcDriver.getPropertyInfo(java.lang.String, java.util.Properties)

getExternalWait

public short getExternalWait()

Gets the externalWait property for this data source.

Returns:

the wait interval

See Also:

setExternalWait(short)

setResourceInterval

public void setResourceInterval(short w)

Sets the resourceInterval property for this data source. This optional property can be used to specify the resource timeout interval for the IDMSJSRV server task. This is set when the task ends for a pseudo converse, and controls how long the connection can remain inactive before it is terminated. Valid values are:

-1

Disable timeouts (wait forever)

0

Use default for the task

1-32767

Timeout value

The value set is constrained by the TIMEOUT option set on the listener PTERM definition for IDMSJSRV. This property is used only by the Type 4 driver.

Parameters:

w - the resource interval

See Also:

setDatabaseName(java.lang.String), setNetworkProtocol(java.lang.String), setNodeName(java.lang.String), IdmsJdbcDriver.getPropertyInfo(java.lang.String, java.util.Properties)

getResourceInterval

public short getResourceInterval()

Gets the resourceInterval property for this data source.

Returns:

the resource interval

See Also:

setResourceInterval(short)

setServerLength

public void setServerLength(int l)

Sets the serverLength property for this data source. This optional property can be used to specify the size of the default buffer for the IDMSJSRV server task. The value set overrides the BULLEN option and is constrained by the BUFMAX option set on the listener PTERM definition for IDMSJSRV. This property is used only by the Type 4 driver.

Parameters:

l - the requested buffer length

See Also:

setDatabaseName(java.lang.String), setNetworkProtocol(java.lang.String), setNodeName(java.lang.String), IdmsJdbcDriver.getPropertyInfo(java.lang.String, java.util.Properties)

getServerLength

public int getServerLength()

Gets the serverLength property for this data source.

Returns:

the requested buffer length

See Also:

setExternalWait(short)

setServerTrace

public void setServerTrace(int t)

Sets the serverTrace property for this data source. This optional property can be used to specify the trace options for the IDMSJSRV server task. This allows tracing on a per connection basis, controlled by the client. The CSATST63 bit must be set in the CV to enable the trace options specified:

CSATST06

#DBTRACE

CSATST08

#WTL calls

CSATST16

#SNAP data

This property is used only by the Type 4 driver.

Parameters:

t - trace flags

See Also:

setDatabaseName(java.lang.String), setNetworkProtocol(java.lang.String), setNodeName(java.lang.String)

getServerTrace

public int getServerTrace()

Gets the serverTrace property for this data source.

Returns:

the trace flags

See Also:

setExternalWait(short)

isSsl

public boolean isSsl()

Returns:

true if SSL requested

setSsl

public void setSsl(boolean ssl)

Request an SSL connection. Specifying an SSL connection is currently supported with Type 3 and Type 4 connections.

Parameters:

ssl - true to specify an SSL connection

setIdentityAudited

public void setIdentityAudited(boolean enable)

Enables or disables identity auditing.

Parameters:

enable - true to enable, false to disable

isIdentityAudited

public boolean isIdentityAudited()

Is identity auditing enabled?

Returns:

true if enabled, false otherwise

list

public void list(java.io.PrintWriter out)

Lists the data source properties. This method is useful for debugging.

Parameters:

out - the output writer

See Also:

list(TraceOutput)

list

public void list(TraceOutput out)

Lists the data source properties. This method is useful for debugging. Note that the password is not displayed.

Parameters:

out - the trace output log

getIdmsConnection

public IdmsConnection getIdmsConnection()
                                 throws java.sql.SQLException

Connect using the default user id and password.

Returns:

an IdmsConnection to the database

Throws:

java.sql.SQLException - if an error occurs.

getIdmsConnection

public IdmsConnection getIdmsConnection(java.lang.String uid,
                                        java.lang.String pwd)
                                 throws java.sql.SQLException

Connect using the specified user id and password.

Parameters:

uid - the IDMS user id, can't be null, IDMS will complain

pwd - the IDMS password, can be null if IDMS not secured

Returns:

an IdmsConnection to the database

Throws:

java.sql.SQLException - if an error occurs.