org.trafodion.jdbc.t4

Class TrafT4DataSource

java.lang.Object

org.trafodion.jdbc.t4.T4Properties

org.trafodion.jdbc.t4.T4DSProperties

org.trafodion.jdbc.t4.TrafT4DataSource

All Implemented Interfaces:

Serializable, Wrapper, Referenceable, CommonDataSource, DataSource

public class TrafT4DataSource
extends T4DSProperties
implements DataSource, Serializable, Referenceable

JDBC Type 4 Driver DataSource class.

Description: A DataSource object is a factory for Connection objects. An object that implements the DataSource interface is typically registered with a JNDI service provider. A JDBC driver that is accessed through the DataSource API does not automatically register itself with the DriverManager object.

The TrafT4DataSource class can provide connection pooling and statement pooling features.

 <b>Setting properties for the TrafT4DataSource in the Type 4 driver</b>
    TrafT4DataSource ds = new TrafT4DataSource();
   ds.setUrl("jdbc:t4jdbc://<NDCS host>:<NDCS port>/:");
   ds.setCatalog("your catalog");
   ds.setSchema("your schema");
   ds.setUser("safeguard user name");
   ds.setPassword("safeguard password");
 
   // Following are optional properties
   ds.setConnectionTimeout("timeout in seconds");
   ds.setT4LogFile("your log file location");
   ds.setT4LogLevel("SEVERE");
   ds.setServerDataSource("NDCS datasource name");
 
   // Properties relevant for Type 4 connection pooling.
   // Set ds.setMaxPoolSize(-1) to turn OFF connection pooling
   ds.setMaxPoolSize("number of connections required");
   ds.setMinPoolSize("number of connections required");
 
   // Properties relevant for Type 4 statement pooling.
   // Set ds.setMaxStatement(0) to turn statement pooling OFF
   // Statement pooling is enabled only when connection pooling is enabled.
   ds.setMaxStatements("number of statements to be pooled");
 

 <b>Programmatically registering TrafT4DataSource with JDNI</b>
        java.util.Hashtable env = new java.util.Hashtable();
      env.put(Context.INITIAL_CONTEXT_FACTORY, "Factory class name here");
      javax.naming.Context ctx = new javax.naming.InitialContext(env);
      ctx.rebind("DataSource name here", ds);
 

 <b>Application making Type4 connection using the DataSource from JDNI</b>
        java.util.Hashtable env = new java.util.Hashtable();
      env.put(Context.INITIAL_CONTEXT_FACTORY, "Factory class name here");
      javax.naming.Context ctx = new javax.naming.InitialContext(env);
      DataSource ds = (DataSource)ctx.lookup("DataSource name here");
      java.sql.Connection con = ds.getConnection();
 

Copyright: (C) Apache Software Foundation (ASF)

See Also:

T4Properties, Serialized Form

Constructor Summary

Constructors

Constructor and Description
TrafT4DataSource() Contructor for the TrafT4DataSource object.
TrafT4DataSource(Properties info) Contructor for the TrafT4DataSource object.

Method Summary

Methods

Modifier and Type	Method and Description
Connection	getConnection() Attempts to establish an NDCS connection.
Connection	getConnection(String username, String password) Attempts to establish an NDCS connection.
String	getNameType() Deprecated.
Logger	getParentLogger()
Reference	getReference()
boolean	isWrapperFor(Class iface)
void	setLogWriter(PrintWriter out) Sets the print writer for the current Type 4 data source.
void	setNameType(String nameType) Deprecated.
Object	unwrap(Class iface)

Methods inherited from class org.trafodion.jdbc.t4.T4DSProperties

getBlobTableName, getCatalog, getClobTableName, getConnectionTimeout, getDataSourceName, getDescription, getInitialPoolSize, getLocale, getLoginTimeout, getMaxIdleTime, getMaxPoolSize, getMaxStatements, getMinPoolSize, getNetworkTimeout, getReserveDataLocator, getRoundingMode, getSchema, getServerDataSource, getT4LogFile, getT4LogLevel, getUrl, getURL, getUser, setBlobTableName, setCatalog, setClobTableName, setConnectionTimeout, setConnectionTimeout, setDataSourceName, setDescription, setInitialPoolSize, setInitialPoolSize, setLoginTimeout, setLoginTimeout, setMaxIdleTime, setMaxIdleTime, setMaxPoolSize, setMaxPoolSize, setMaxStatements, setMaxStatements, setMinPoolSize, setMinPoolSize, setNetworkTimeout, setNetworkTimeout, setPassword, setReserveDataLocator, setReserveDataLocator, setRoundingMode, setRoundingMode, setSchema, setServerDataSource, setT4LogFile, setT4LogLevel, setUrl, setURL, setUser

Methods inherited from class org.trafodion.jdbc.t4.T4Properties

getApplicationName, getCertificateDir, getCertificateFile, getCertificateFileActive, getCompression, getCpuToUse, getDelayedErrorMode, getKeepAlive, getKeepRawFetchBuffer, getLogWriter, getProperties, getReplacementString, getRoleName, getSessionName, getSPJEnv, getTcpNoDelay, getTokenAuth, setApplicationName, setCertificateDir, setCertificateFile, setCertificateFileActive, setCompression, setCompression, setCpuToUse, setCpuToUse, setDelayedErrorMode, setDelayedErrorMode, setKeepAlive, setKeepAlive, setKeepRawFetchBuffer, setKeepRawFetchBuffer, setReplacementString, setRoleName, setSessionName, setSPJEnv, setSPJEnv, setTcp_NoDelay, setTcpNoDelay, setTokenAuth, setTokenAuth

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.sql.CommonDataSource

getLoginTimeout, getLogWriter, setLoginTimeout

Constructor Detail

TrafT4DataSource

public TrafT4DataSource()

Contructor for the TrafT4DataSource object.

See Also:

TrafT4DataSource(java.util.Properties)

TrafT4DataSource

public TrafT4DataSource(Properties info)

Contructor for the TrafT4DataSource object.

Parameters:

info - Contains all the Type 4 properties in a name, value pair.

See Also:

TrafT4DataSource(), Properties

Method Detail

getConnection

public Connection getConnection()
                         throws SQLException

Attempts to establish an NDCS connection.

Specified by:

getConnection in interface DataSource

Returns:

a connection to the NDCS server.

Throws:

SQLException - if a database access error or NDCS error occurs.

See Also:

getConnection(String, String)

getConnection

public Connection getConnection(String username,
                       String password)
                         throws SQLException

Attempts to establish an NDCS connection.

Specified by:

getConnection in interface DataSource

Parameters:

username - Safeguard user name

password - Safeguard user password

Returns:

a connection to the NDCS server.

Throws:

SQLException - if a database access error or NDCS error occurs.

See Also:

getConnection()

getReference

public Reference getReference()
                       throws NamingException

Specified by:

getReference in interface Referenceable

Returns:

Reference Object containing all the Type 4 property references.

Throws:

NamingException

setLogWriter

public void setLogWriter(PrintWriter out)
                  throws SQLException

Sets the print writer for the current Type 4 data source.

Specified by:

setLogWriter in interface CommonDataSource

Overrides:

setLogWriter in class T4Properties

Parameters:

out - java.io.PrintWriter for the current T4 connection.

Throws:

SQLException - when error occurs.

See Also:

T4Properties.getLogWriter(), ConnectionPoolDataSource

setNameType

public void setNameType(String nameType)

Deprecated.

getNameType

public String getNameType()

Deprecated.

getParentLogger

public Logger getParentLogger()
                       throws SQLFeatureNotSupportedException

Specified by:

getParentLogger in interface CommonDataSource

Throws:

SQLFeatureNotSupportedException

unwrap

public Object unwrap(Class iface)
              throws SQLException

Specified by:

unwrap in interface Wrapper

Throws:

SQLException

isWrapperFor

public boolean isWrapperFor(Class iface)
                     throws SQLException

Specified by:

isWrapperFor in interface Wrapper

Throws:

SQLException