EvpDataSource (evp-jdbc-driver 10.3.0-v0036 API)

java.lang.Object
- com.softwareag.evp.jdbc.EvpDataSource

All Implemented Interfaces:

java.sql.Wrapper, javax.sql.CommonDataSource, javax.sql.DataSource
```
public class EvpDataSource
extends java.lang.Object
implements javax.sql.DataSource
```
Primary implementation of a JDBC DataSource for Event Persistence. Like the EvpDriver class the true implementation is loaded dynamically based on the URL of the database (Hive/Elasticsearch). For each driver or data source implementation there is an associated "loader" implementation and resource file that contains all of the required run-time libraries. It's up to this module to pull down the libraries and provide them in the zip distribution.

Constructor Summary

Constructors
Constructor and Description

EvpDataSource()

Constructors
Constructor and Description
`EvpDataSource()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.sql.Connection`	`getConnection()` Attempts to establish a connection with the data source that this `DataSource` object represents.
`java.sql.Connection`	`getConnection(java.lang.String username, java.lang.String password)` Attempts to establish a connection with the data source that this `DataSource` object represents.
`int`	`getLoginTimeout()` Gets the maximum time in seconds that this data source can wait while attempting to connect to a database.
`java.io.PrintWriter`	`getLogWriter()` Retrieves the log writer for this `DataSource` object.
`java.util.logging.Logger`	`getParentLogger()` Return the parent Logger of all the Loggers used by this data source.
`boolean`	`isWrapperFor(java.lang.Class<?> iface)` Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does.
`void`	`setDatabaseURL(java.lang.String databaseURL)`
`void`	`setInstallDir(java.lang.String installDir)`
`void`	`setKeystore(java.lang.String keystore)`
`void`	`setKeystorePassword(java.lang.String keystorePassword)`
`void`	`setLoginTimeout(int seconds)` Sets the maximum time in seconds that this data source will wait while attempting to connect to a database.
`void`	`setLogWriter(java.io.PrintWriter out)` Sets the log writer for this `DataSource` object to the given `java.io.PrintWriter` object.
`void`	`setTruststore(java.lang.String truststore)`
`void`	`setTruststorePassword(java.lang.String truststorePassword)`
`void`	`setUseSSL(boolean useSSL)`
`<T> T`	`unwrap(java.lang.Class<T> iface)` Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy.

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

- Constructor Detail
  - EvpDataSource
```
public EvpDataSource()
```
- Method Detail
  - setDatabaseURL
```
public void setDatabaseURL(java.lang.String databaseURL)
```
  - setInstallDir
```
public void setInstallDir(java.lang.String installDir)
```
  - setUseSSL
```
public void setUseSSL(boolean useSSL)
```
  - setKeystore
```
public void setKeystore(java.lang.String keystore)
```
  - setKeystorePassword
```
public void setKeystorePassword(java.lang.String keystorePassword)
```
  - setTruststore
```
public void setTruststore(java.lang.String truststore)
```
  - setTruststorePassword
```
public void setTruststorePassword(java.lang.String truststorePassword)
```
  - getConnection
```
public java.sql.Connection getConnection()
                                  throws java.sql.SQLException
```
    Attempts to establish a connection with the data source that this DataSource object represents.
    
    Specified by:
    
    getConnection in interface javax.sql.DataSource
    
    Returns:
    
    a connection to the data source
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs
    
    java.sql.SQLTimeoutException - when the driver has determined that the timeout value specified by the setLoginTimeout method has been exceeded and has at least tried to cancel the current database connection attempt
  - getConnection
```
public java.sql.Connection getConnection(java.lang.String username,
                                         java.lang.String password)
                                  throws java.sql.SQLException
```
    Attempts to establish a connection with the data source that this DataSource object represents.
    
    Specified by:
    
    getConnection in interface javax.sql.DataSource
    
    Parameters:
    
    username - the database user on whose behalf the connection is being made
    
    password - the user's password
    
    Returns:
    
    a connection to the data source
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs
    
    java.sql.SQLTimeoutException - when the driver has determined that the timeout value specified by the setLoginTimeout method has been exceeded and has at least tried to cancel the current database connection attempt
    
    Since:
    
    1.4
  - unwrap
```
public <T> T unwrap(java.lang.Class<T> iface)
             throws java.sql.SQLException
```
    Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy.
    If the receiver implements the interface then the result is the receiver or a proxy for the receiver. If the receiver is a wrapper and the wrapped object implements the interface then the result is the wrapped object or a proxy for the wrapped object. Otherwise return the the result of calling unwrap recursively on the wrapped object or a proxy for that result. If the receiver is not a wrapper and does not implement the interface, then an SQLException is thrown.
    
    Specified by:
    
    unwrap in interface java.sql.Wrapper
    
    Parameters:
    
    iface - A Class defining an interface that the result must implement.
    
    Returns:
    
    an object that implements the interface. May be a proxy for the actual implementing object.
    
    Throws:
    
    java.sql.SQLException - If no object found that implements the interface
    
    Since:
    
    1.6
  - isWrapperFor
```
public boolean isWrapperFor(java.lang.Class<?> iface)
                     throws java.sql.SQLException
```
    Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does. Returns false otherwise. If this implements the interface then return true, else if this is a wrapper then return the result of recursively calling isWrapperFor on the wrapped object. If this does not implement the interface and is not a wrapper, return false. This method should be implemented as a low-cost operation compared to unwrap so that callers can use this method to avoid expensive unwrap calls that may fail. If this method returns true then calling unwrap with the same argument should succeed.
    
    Specified by:
    
    isWrapperFor in interface java.sql.Wrapper
    
    Parameters:
    
    iface - a Class defining an interface.
    
    Returns:
    
    true if this implements the interface or directly or indirectly wraps an object that does.
    
    Throws:
    
    java.sql.SQLException - if an error occurs while determining whether this is a wrapper for an object with the given interface.
    
    Since:
    
    1.6
  - getLogWriter
```
public java.io.PrintWriter getLogWriter()
                                 throws java.sql.SQLException
```
    Retrieves the log writer for this DataSource object.
    
    The log writer is a character output stream to which all logging and tracing messages for this data source will be printed. This includes messages printed by the methods of this object, messages printed by methods of other objects manufactured by this object, and so on. Messages printed to a data source specific log writer are not printed to the log writer associated with the java.sql.DriverManager class. When a DataSource object is created, the log writer is initially null; in other words, the default is for logging to be disabled.
    
    Specified by:
    
    getLogWriter in interface javax.sql.CommonDataSource
    
    Returns:
    
    the log writer for this data source or null if logging is disabled
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs
    
    Since:
    
    1.4
    
    See Also:
    
    setLogWriter(java.io.PrintWriter)
  - setLogWriter
```
public void setLogWriter(java.io.PrintWriter out)
                  throws java.sql.SQLException
```
    Sets the log writer for this DataSource object to the given java.io.PrintWriter object.
    
    The log writer is a character output stream to which all logging and tracing messages for this data source will be printed. This includes messages printed by the methods of this object, messages printed by methods of other objects manufactured by this object, and so on. Messages printed to a data source-specific log writer are not printed to the log writer associated with the java.sql.DriverManager class. When a DataSource object is created the log writer is initially null; in other words, the default is for logging to be disabled.
    
    Specified by:
    
    setLogWriter in interface javax.sql.CommonDataSource
    
    Parameters:
    
    out - the new log writer; to disable logging, set to null
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs
    
    Since:
    
    1.4
    
    See Also:
    
    getLogWriter()
  - setLoginTimeout
```
public void setLoginTimeout(int seconds)
                     throws java.sql.SQLException
```
    Sets the maximum time in seconds that this data source will wait while attempting to connect to a database. A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout. When a DataSource object is created, the login timeout is initially zero.
    
    Specified by:
    
    setLoginTimeout in interface javax.sql.CommonDataSource
    
    Parameters:
    
    seconds - the data source login time limit
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs.
    
    Since:
    
    1.4
    
    See Also:
    
    getLoginTimeout()
  - getLoginTimeout
```
public int getLoginTimeout()
                    throws java.sql.SQLException
```
    Gets the maximum time in seconds that this data source can wait while attempting to connect to a database. A value of zero means that the timeout is the default system timeout if there is one; otherwise, it means that there is no timeout. When a DataSource object is created, the login timeout is initially zero.
    
    Specified by:
    
    getLoginTimeout in interface javax.sql.CommonDataSource
    
    Returns:
    
    the data source login time limit
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs.
    
    Since:
    
    1.4
    
    See Also:
    
    setLoginTimeout(int)
  - getParentLogger
```
public java.util.logging.Logger getParentLogger()
                                         throws java.sql.SQLFeatureNotSupportedException
```
    Return the parent Logger of all the Loggers used by this data source. This should be the Logger farthest from the root Logger that is still an ancestor of all of the Loggers used by this data source. Configuring this Logger will affect all of the log messages generated by the data source. In the worst case, this may be the root Logger.
    
    Specified by:
    
    getParentLogger in interface javax.sql.CommonDataSource
    
    Returns:
    
    the parent Logger for this data source
    
    Throws:
    
    java.sql.SQLFeatureNotSupportedException - if the data source does not use java.util.logging
    
    Since:
    
    1.7

Class EvpDataSource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EvpDataSource

Method Detail

setDatabaseURL

setInstallDir

setUseSSL

setKeystore

setKeystorePassword

setTruststore

setTruststorePassword

getConnection

getConnection

unwrap

isWrapperFor

getLogWriter

setLogWriter

setLoginTimeout

getLoginTimeout

getParentLogger