IRISDataSource (InterSystems IRIS JDBC Driver 3.0.0 API)

java.lang.Object
- com.intersystems.jdbc.IRISWrapper
- - com.intersystems.jdbc.IRISDataSource

All Implemented Interfaces:

Wrapper, CommonDataSource, DataSource

Direct Known Subclasses:

IRISConnectionPoolDataSource
```
public class IRISDataSource
extends com.intersystems.jdbc.IRISWrapper
implements DataSource
```
IRISDataSource object is an implementation of DataSource interface. In addition to the apis defined by the interface, this class also includes a number of InterSystems IRIS specific apis that can be used to set up the DataSource properties (setters) or get the information about the DataSource object properties (getters). In order to be able to connect, at least server name and database name properties must be defined, either by using the corresponding setters, or by supplying a valid url (same as what would be used when connecting via Driver class). Port number is optional, and defaults to 1972. Username and Password can be set via the setters, or alternatively, can be supplied via the getConnection api. Description and DataSource name are completely optional and are not used by IRISDataSource object in order to connect. Logging can be enabled by setting the LogWritter, and Login Timeout set by calling the corresponding setter (both are optional). InterSystems IRIS also provides a way to set the TCP nodelay flag. Toggling this flag can affect the performance of this application. If not set, it defaults to true. Event Class is a mechanism specific to InterSystems IRIS JDBC. It is completely optional, and the vast majority of applications will not need this feature. See setEventClass for more info on Event Class objects.

Constructor Summary

Constructors
Constructor and Description

IRISDataSource()

Constructors
Constructor and Description
`IRISDataSource()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Connection`	`getConnection()`
`Connection`	`getConnection(String usr, String pwd)`
`int`	`getConnectionSecurityLevel()` Returns an `int` representing current Connection Security Level setting.
`String`	`getDatabaseName()` Returns a `String` representing the current database (InterSystems IRIS Namespace) name.
`String`	`getDataSourceName()` Returns a `String` representing the current Data Source name.
`int`	`getDefaultTransactionIsolation()` Returns an `int` representing current Default Transaction Isolation setting.
`String`	`getDescription()` Returns a `String` representing the current description.
`String`	`getEventClass()` Returns a `String` representing an Event Class object.
`String`	`getIPv6ServerAddress()` Returns a `String` representing the current IPv6 server address.
`String`	`getKeyRecoveryPassword()` Returns a `String` representing current Key Recovery Password setting.
`int`	`getLoginTimeout()`
`PrintWriter`	`getLogWriter()`
`boolean`	`getNodelay()` Returns a `boolean` representing a current nodelay flag setting.
`Logger`	`getParentLogger()`
`String`	`getPassword()` Returns a `String` representing the current password.
`int`	`getPortNumber()` Returns an `int` representing the current port number.
`String`	`getServerName()` Returns a `String` representing the current server name.
`String`	`getServicePrincipalName()` Returns a `String` representing current Service Principal Name setting.
`Boolean`	`getSharedMemory()` Gets shared memory connections setting for this `DataSource` object.
`String`	`getSSLConfigurationName()` Returns a `String` representing current SSL Configuration Name setting.
`String`	`getURL()` Returns a `String` representing a current URL for this `DataSource` object.
`String`	`getUser()` Returns a `String` representing the current username.
`void`	`setConnectionSecurityLevel(int level)` Sets the Connection Security Level for this `DataSource` object.
`void`	`setDatabaseName(String databaseName)` Sets Database (InterSystems IRIS Namespace) name for this `DataSource` object.
`void`	`setDataSourceName(String dataSourceName)` Sets Data Source name for this `DataSource` object.
`void`	`setDefaultTransactionIsolation(int level)` Sets the default Transaction Isolation Level for this `DataSource` object.
`void`	`setDescription(String desc)` Sets description for this `DataSource` object.
`void`	`setEventClass(String eventClassName)` Sets the Event Class for this `DataSource` object.
`void`	`setIPv6ServerAddress(String address)` Sets the IPv6 server address for this `DataSource` object.
`void`	`setKeyRecoveryPassword(String password)` Sets the Key Recovery Password for this `DataSource` object.
`void`	`setLogFile(String logFile)` Unconditionally sets log file name for this `DataSource` object.
`void`	`setLoginTimeout(int seconds)`
`void`	`setLogWriter(PrintWriter out)`
`void`	`setNodelay(boolean noDelay)` Sets the noDelay flag for this `DataSource` object.
`void`	`setPassword(String pwd)` Sets the password for this `DataSource` object.
`void`	`setPortNumber(int portNumber)` Sets the port number for this `DataSource` object
`void`	`setServerName(String serverName)` Sets the server name for this `DataSource` object.
`void`	`setServicePrincipalName(String name)` Sets the Service Principal Name for this `DataSource` object.
`void`	`setSharedMemory(Boolean sharedMemory)` Sets shared memory connections on for this `DataSource` object.
`void`	`setSSLConfigurationName(String name)` Sets the SSL Configuration Name for this `DataSource` object.
`void`	`setURL(String u)` Sets the url for this `DataSource` object.
`void`	`setUser(String username)` Sets the username for this `DataSource` object.

Methods inherited from class com.intersystems.jdbc.IRISWrapper
isWrapperFor, unwrap

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.sql.Wrapper
isWrapperFor, unwrap

- Constructor Detail
  - IRISDataSource
```
public IRISDataSource()
```
- Method Detail
  - getConnection
```
public Connection getConnection()
                         throws SQLException
```
    Specified by:
    
    getConnection in interface DataSource
    
    Throws:
    
    SQLException
  - getConnection
```
public Connection getConnection(String usr,
                                String pwd)
                         throws SQLException
```
    Specified by:
    
    getConnection in interface DataSource
    
    Throws:
    
    SQLException
  - getLogWriter
```
public PrintWriter getLogWriter()
```
    Specified by:
    
    getLogWriter in interface CommonDataSource
  - setLogWriter
```
public void setLogWriter(PrintWriter out)
```
    Specified by:
    
    setLogWriter in interface CommonDataSource
  - setLoginTimeout
```
public void setLoginTimeout(int seconds)
```
    Specified by:
    
    setLoginTimeout in interface CommonDataSource
  - getLoginTimeout
```
public int getLoginTimeout()
```
    Specified by:
    
    getLoginTimeout in interface CommonDataSource
  - setDatabaseName
```
public void setDatabaseName(String databaseName)
```
    Sets Database (InterSystems IRIS Namespace) name for this DataSource object.
    
    Parameters:
    
    databaseName - database (InterSystems IRIS namespace) name
  - getDatabaseName
```
public String getDatabaseName()
```
    Returns a String representing the current database (InterSystems IRIS Namespace) name.
    
    Returns:
    
    database (InterSystems IRIS Namespace) name
  - setDataSourceName
```
public void setDataSourceName(String dataSourceName)
```
    Sets Data Source name for this DataSource object.
    
    Parameters:
    
    dataSourceName - DataSource name
  - getDataSourceName
```
public String getDataSourceName()
```
    Returns a String representing the current Data Source name.
    
    Returns:
    
    DataSource name
  - setDescription
```
public void setDescription(String desc)
```
    Sets description for this DataSource object.
    
    Parameters:
    
    desc - DataSource description
  - getDescription
```
public String getDescription()
```
    Returns a String representing the current description.
    
    Returns:
    
    description
  - setPassword
```
public void setPassword(String pwd)
```
    Sets the password for this DataSource object.
    
    Parameters:
    
    pwd - password
  - getPassword
```
public String getPassword()
```
    Returns a String representing the current password.
    
    Returns:
    
    password
  - setPortNumber
```
public void setPortNumber(int portNumber)
```
    Sets the port number for this DataSource object
    
    Parameters:
    
    portNumber - port number
  - getPortNumber
```
public int getPortNumber()
```
    Returns an int representing the current port number.
    
    Returns:
    
    port number
  - setServerName
```
public void setServerName(String serverName)
```
    Sets the server name for this DataSource object. To be used with IPv4 address, or an actual server name. For IPv6 address, use setIPv6ServerAddress api
    
    Parameters:
    
    serverName - server name or an IPv4 server address
  - getServerName
```
public String getServerName()
```
    Returns a String representing the current server name.
    
    Returns:
    
    server name
  - setSharedMemory
```
public void setSharedMemory(Boolean sharedMemory)
```
    Sets shared memory connections on for this DataSource object.
    
    Parameters:
    
    sharedMemory - true to turn on shared memory
  - getSharedMemory
```
public Boolean getSharedMemory()
```
    Gets shared memory connections setting for this DataSource object.
    
    Returns:
    
    useSharedMemory true if shared memory is enabled
  - setIPv6ServerAddress
```
public void setIPv6ServerAddress(String address)
```
    Sets the IPv6 server address for this DataSource object. To be used with IPv6 address only. For specifying and IPv4ddress address or an actual host name, use setServerName api
    
    Parameters:
    
    address - address
  - getIPv6ServerAddress
```
public String getIPv6ServerAddress()
```
    Returns a String representing the current IPv6 server address.
    
    Returns:
    
    IPv6 server address
  - setUser
```
public void setUser(String username)
```
    Sets the username for this DataSource object.
    
    Parameters:
    
    username - username
  - getUser
```
public String getUser()
```
    Returns a String representing the current username.
    
    Returns:
    
    username
  - setEventClass
```
public void setEventClass(String eventClassName)
```
    Sets the Event Class for this DataSource object. InterSystems IRIS JDBC server will dispatch to methods implemented in a class when a transaction is about to be committed and when a transaction is about to be rolled back. The class in which these methods are implemented is referred to as the 'event class'. If an event class is specified during login then the JDBC server will dispatch to %OnTranCommit just prior to committing the current transaction and will dispatch to %OnTranRollback just prior to rolling back (aborting) the current transaction. User event classes should extend %ServerEvent. The methods do not return any values and cannot abort the current transaction.
    
    Parameters:
    
    eventClassName - event class name
  - getEventClass
```
public String getEventClass()
```
    Returns a String representing an Event Class object.
    
    Returns:
    
    event class
  - setURL
```
public void setURL(String u)
            throws SQLException
```
    Sets the url for this DataSource object.
    
    Parameters:
    
    u - url
    
    Throws:
    
    SQLException - throws SQLException
  - getURL
```
public String getURL()
```
    Returns a String representing a current URL for this DataSource object.
    
    Returns:
    
    url
  - setNodelay
```
public void setNodelay(boolean noDelay)
```
    Sets the noDelay flag for this DataSource object.
    
    Parameters:
    
    noDelay - nodelay flag
  - getNodelay
```
public boolean getNodelay()
```
    Returns a boolean representing a current nodelay flag setting.
    
    Returns:
    
    nodelay flag
  - setServicePrincipalName
```
public void setServicePrincipalName(String name)
```
    Sets the Service Principal Name for this DataSource object.
    
    Parameters:
    
    name - principal name
  - getServicePrincipalName
```
public String getServicePrincipalName()
```
    Returns a String representing current Service Principal Name setting.
    
    Returns:
    
    principal name
  - setConnectionSecurityLevel
```
public void setConnectionSecurityLevel(int level)
```
    Sets the Connection Security Level for this DataSource object.
    
    Parameters:
    
    level - security level
  - getConnectionSecurityLevel
```
public int getConnectionSecurityLevel()
```
    Returns an int representing current Connection Security Level setting.
    
    Returns:
    
    security level
  - setSSLConfigurationName
```
public void setSSLConfigurationName(String name)
```
    Sets the SSL Configuration Name for this DataSource object.
    
    Parameters:
    
    name - SSL configuration name
  - getSSLConfigurationName
```
public String getSSLConfigurationName()
```
    Returns a String representing current SSL Configuration Name setting.
    
    Returns:
    
    SSL configuration name
  - setKeyRecoveryPassword
```
public void setKeyRecoveryPassword(String password)
```
    Sets the Key Recovery Password for this DataSource object.
    
    Parameters:
    
    password - key recovery password
  - getKeyRecoveryPassword
```
public String getKeyRecoveryPassword()
```
    Returns a String representing current Key Recovery Password setting.
    
    Returns:
    
    key recovery password
  - setLogFile
```
public void setLogFile(String logFile)
                throws SQLException
```
    Unconditionally sets log file name for this DataSource object.
    
    Parameters:
    
    logFile - log file name
    
    Throws:
    
    SQLException - throws SQLException
  - getDefaultTransactionIsolation
```
public int getDefaultTransactionIsolation()
```
    Returns an int representing current Default Transaction Isolation setting.
    
    Returns:
    
    default transaction isolation level
  - setDefaultTransactionIsolation
```
public void setDefaultTransactionIsolation(int level)
```
    Sets the default Transaction Isolation Level for this DataSource object. Defaults to java.sql.Connection.TRANSACTION_READ_UNCOMMITTED
    
    Parameters:
    
    level - default transaction isolation level
  - getParentLogger
```
public Logger getParentLogger()
                       throws SQLFeatureNotSupportedException
```
    Specified by:
    
    getParentLogger in interface CommonDataSource
    
    Throws:
    
    SQLFeatureNotSupportedException

Class IRISDataSource

Constructor Summary

Method Summary

Methods inherited from class com.intersystems.jdbc.IRISWrapper

Methods inherited from class java.lang.Object

Methods inherited from interface java.sql.Wrapper

Constructor Detail

IRISDataSource

Method Detail

getConnection

getConnection

getLogWriter

setLogWriter

setLoginTimeout

getLoginTimeout

setDatabaseName

getDatabaseName

setDataSourceName

getDataSourceName

setDescription

getDescription

setPassword

getPassword

setPortNumber

getPortNumber

setServerName

getServerName

setSharedMemory

getSharedMemory

setIPv6ServerAddress

getIPv6ServerAddress

setUser

getUser

setEventClass

getEventClass

setURL

getURL

setNodelay

getNodelay

setServicePrincipalName

getServicePrincipalName

setConnectionSecurityLevel

getConnectionSecurityLevel

setSSLConfigurationName

getSSLConfigurationName

setKeyRecoveryPassword

getKeyRecoveryPassword

setLogFile

getDefaultTransactionIsolation

setDefaultTransactionIsolation

getParentLogger