ClientJDBCObjectFactoryImpl (Apache Derby V10.14 Internals)

java.lang.Object
- org.apache.derby.client.net.ClientJDBCObjectFactoryImpl

All Implemented Interfaces:

ClientJDBCObjectFactory

Direct Known Subclasses:

ClientJDBCObjectFactoryImpl42
```
public class ClientJDBCObjectFactoryImpl
extends java.lang.Object
implements ClientJDBCObjectFactory
```
Implements the the ClientJDBCObjectFactory interface and returns the classes that implement the JDBC3.0/2.0 interfaces For example, newCallableStatement would return ClientCallableStatement

Field Summary

Fields
Modifier and Type	Field	Description
`private static MessageUtil`	`msgutil_`	The message utility instance we use to find messages It's primed with the name of the client message bundle so that it knows to look there if the message isn't found in the shared message bundle.

Constructor Summary

Constructors
Constructor Description

ClientJDBCObjectFactoryImpl()

Constructors
Constructor	Description
`ClientJDBCObjectFactoryImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected java.sql.BatchUpdateException`	`newBatchUpdateException(java.lang.String message, java.lang.String sqlState, int errorCode, long[] updateCounts, SqlException cause)`	This method is overridden on JVM 8
`java.sql.BatchUpdateException`	`newBatchUpdateException(LogWriter logWriter, ClientMessageId msgid, java.lang.Object[] args, long[] updateCounts, SqlException cause)`	Creates a BatchUpdateException depending on the JVM level.
`LogicalConnection`	`newCachingLogicalConnection(ClientConnection physicalConnection, ClientPooledConnection pooledConnection, JDBCStatementCache stmtCache)`	Returns an instance of a `CachingLogicalConnection`, which provides caching of prepared statements.
`ClientCallableStatement`	`newCallableStatement(Agent agent, ClientConnection connection, java.lang.String sql, int type, int concurrency, int holdability, ClientPooledConnection cpc)`	Returns an instance of ClientCallableStatement.
`ClientPooledConnection`	`newClientPooledConnection(BasicClientDataSource40 ds, LogWriter logWriter, java.lang.String user, java.lang.String password)`	This method is used to return an instance of the `ClientPooledConnection` class which implements `javax.sql.PooledConnection`.
`ClientXAConnection`	`newClientXAConnection(BasicClientDataSource40 ds, LogWriter logWriter, java.lang.String user, java.lang.String password)`	This method is used to return an instance of ClientXAConnection (or ClientXAConnection40) class which implements `javax.sql.XAConnection`.
`ColumnMetaData`	`newColumnMetaData(LogWriter logWriter)`	Returns an instance of ColumnMetaData
`ColumnMetaData`	`newColumnMetaData(LogWriter logWriter, int upperBound)`	Returns an instance of ColumnMetaData or ColumnMetaData40 depending on the JDK version under use
`LogicalCallableStatement`	`newLogicalCallableStatement(java.sql.CallableStatement cs, StatementKey stmtKey, StatementCacheInteractor cacheInteractor)`	Returns a new logical callable statement object.
`LogicalConnection`	`newLogicalConnection(ClientConnection physicalConnection, ClientPooledConnection pooledConnection)`	Returns an instance of LogicalConnection.
`LogicalPreparedStatement`	`newLogicalPreparedStatement(java.sql.PreparedStatement ps, StatementKey stmtKey, StatementCacheInteractor cacheInteractor)`	Returns a new logical prepared statement object.
`ClientConnection`	`newNetConnection(LogWriter logWriter, int driverManagerLoginTimeout, java.lang.String serverName, int portNumber, java.lang.String databaseName, java.util.Properties properties)`	This method returns an instance of NetConnection (or NetConnection40) class which extends from ClientConnection this implements the java.sql.Connection interface
`ClientConnection`	`newNetConnection(LogWriter logWriter, java.lang.String user, java.lang.String password, BasicClientDataSource40 dataSource, int rmId, boolean isXAConn)`	This method returns an instance of NetConnection (or NetConnection40) class which extends from ClientConnection.
`ClientConnection`	`newNetConnection(LogWriter logWriter, java.lang.String user, java.lang.String password, BasicClientDataSource40 dataSource, int rmId, boolean isXAConn, ClientPooledConnection cpc)`	Returns an instance of NetConnection.
`ClientDatabaseMetaData`	`newNetDatabaseMetaData(Agent netAgent, ClientConnection netConnection)`	This method provides an instance of NetDatabaseMetaData (or NetDatabaseMetaData40) which extends from ClientDatabaseMetaData which implements `java.sql.DatabaseMetaData`.
`ClientResultSet`	`newNetResultSet(Agent netAgent, MaterialStatement netStatement, Cursor cursor, int qryprctyp, int sqlcsrhld, int qryattscr, int qryattsns, int qryattset, long qryinsid, int actualResultSetType, int actualResultSetConcurrency, int actualResultSetHoldability)`	This method returns an instance of NetResultSet(or NetResultSet40) which extends from ClientResultSet which implements `java.sql.ResultSet`.
`ClientParameterMetaData`	`newParameterMetaData(ColumnMetaData columnMetaData)`	returns an instance of ParameterMetaData
`ClientPreparedStatement`	`newPreparedStatement(Agent agent, ClientConnection connection, java.lang.String sql, int type, int concurrency, int holdability, int autoGeneratedKeys, java.lang.String[] columnNames, int[] columnIndexes, ClientPooledConnection cpc)`	This method returns an instance of ClientPreparedStatement which implements `java.sql.PreparedStatement`.
`ClientPreparedStatement`	`newPreparedStatement(Agent agent, ClientConnection connection, java.lang.String sql, Section section, ClientPooledConnection cpc)`	This method returns an instance of ClientPreparedStatement which implements java.sql.PreparedStatement.
`ClientStatement`	`newStatement(Agent agent, ClientConnection connection, int type, int concurrency, int holdability, int autoGeneratedKeys, java.lang.String[] columnNames, int[] columnIndexes)`	This method provides an instance of Statement

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

Field Detail
- msgutil_
```
private static final MessageUtil msgutil_
```
  The message utility instance we use to find messages It's primed with the name of the client message bundle so that it knows to look there if the message isn't found in the shared message bundle.

Constructor Detail
- ClientJDBCObjectFactoryImpl
```
public ClientJDBCObjectFactoryImpl()
```

Method Detail

newClientPooledConnection

public ClientPooledConnection newClientPooledConnection(BasicClientDataSource40 ds,
                                                        LogWriter logWriter,
                                                        java.lang.String user,
                                                        java.lang.String password)
                                                 throws java.sql.SQLException

Description copied from interface: ClientJDBCObjectFactory

This method is used to return an instance of the ClientPooledConnection class which implements javax.sql.PooledConnection.

Specified by:: newClientPooledConnection in interface ClientJDBCObjectFactory
Returns:: an instance of ClientPooledConnection
Throws:: java.sql.SQLException

newClientXAConnection

public ClientXAConnection newClientXAConnection(BasicClientDataSource40 ds,
                                                LogWriter logWriter,
                                                java.lang.String user,
                                                java.lang.String password)
                                         throws java.sql.SQLException

Description copied from interface: ClientJDBCObjectFactory

This method is used to return an instance of ClientXAConnection (or ClientXAConnection40) class which implements javax.sql.XAConnection.

Specified by:: newClientXAConnection in interface ClientJDBCObjectFactory
Returns:: an instance of ClientXAConnection
Throws:: java.sql.SQLException

newCallableStatement
```
public ClientCallableStatement newCallableStatement(Agent agent,
                                                    ClientConnection connection,
                                                    java.lang.String sql,
                                                    int type,
                                                    int concurrency,
                                                    int holdability,
                                                    ClientPooledConnection cpc)
                                             throws SqlException
```
Returns an instance of ClientCallableStatement.

Specified by:

newCallableStatement in interface ClientJDBCObjectFactory

Parameters:

agent - The instance of NetAgent associated with this ClientCallableStatement object.

connection - The connection object associated with this PreparedStatement Object.

sql - A String object that is the SQL statement to be sent to the database.

type - One of the ResultSet type constants

concurrency - One of the ResultSet concurrency constants

holdability - One of the ResultSet holdability constants

cpc - The PooledConnection object that will be used to notify the PooledConnection reference of the Error Occurred and the Close events.

Returns:

a ClientCallableStatement object

Throws:

SqlException

newLogicalConnection
```
public LogicalConnection newLogicalConnection(ClientConnection physicalConnection,
                                              ClientPooledConnection pooledConnection)
                                       throws SqlException
```
Description copied from interface: ClientJDBCObjectFactory

Returns an instance of LogicalConnection. This method returns an instance of LogicalConnection (or LogicalConnection40) which implements java.sql.Connection.

Specified by:

newLogicalConnection in interface ClientJDBCObjectFactory

Returns:

an instance of LogicalConnection

Throws:

SqlException

newCachingLogicalConnection

public LogicalConnection newCachingLogicalConnection(ClientConnection physicalConnection,
                                                     ClientPooledConnection pooledConnection,
                                                     JDBCStatementCache stmtCache)
                                              throws SqlException

Returns an instance of a CachingLogicalConnection, which provides caching of prepared statements.

Specified by:: newCachingLogicalConnection in interface ClientJDBCObjectFactory
Parameters:: physicalConnection - the underlying physical connection; pooledConnection - the pooled connection; stmtCache - statement cache
Returns:: A logical connection with statement caching capabilities.
Throws:: SqlException - if creation of the logical connection fails

newPreparedStatement
```
public ClientPreparedStatement newPreparedStatement(Agent agent,
                                                    ClientConnection connection,
                                                    java.lang.String sql,
                                                    Section section,
                                                    ClientPooledConnection cpc)
                                             throws SqlException
```
This method returns an instance of ClientPreparedStatement which implements java.sql.PreparedStatement. It has the ClientPooledConnection as one of its parameters this is used to raise the Statement Events when the prepared statement is closed.

Specified by:

newPreparedStatement in interface ClientJDBCObjectFactory

Parameters:

agent - The instance of NetAgent associated with this ClientCallableStatement object.

connection - The connection object associated with this PreparedStatement Object.

sql - A String object that is the SQL statement to be sent to the database.

section - Section

cpc - The ClientPooledConnection wraps the underlying physical connection associated with this prepared statement. It is used to pass the Statement closed and the Statement error occurred events that occur back to the ClientPooledConnection.

Returns:

a PreparedStatement object

Throws:

SqlException

newPreparedStatement
```
public ClientPreparedStatement newPreparedStatement(Agent agent,
                                                    ClientConnection connection,
                                                    java.lang.String sql,
                                                    int type,
                                                    int concurrency,
                                                    int holdability,
                                                    int autoGeneratedKeys,
                                                    java.lang.String[] columnNames,
                                                    int[] columnIndexes,
                                                    ClientPooledConnection cpc)
                                             throws SqlException
```
This method returns an instance of ClientPreparedStatement which implements java.sql.PreparedStatement. It has the ClientPooledConnection as one of its parameters this is used to raise the Statement Events when the prepared statement is closed.

Specified by:

newPreparedStatement in interface ClientJDBCObjectFactory

Parameters:

agent - The instance of NetAgent associated with this ClientCallableStatement object.

connection - The connection object associated with this PreparedStatement Object.

sql - A String object that is the SQL statement to be sent to the database.

type - One of the ResultSet type constants.

concurrency - One of the ResultSet concurrency constants.

holdability - One of the ResultSet holdability constants.

autoGeneratedKeys - a flag indicating whether auto-generated keys should be returned.

columnNames - an array of column names indicating the columns that should be returned from the inserted row or rows.

cpc - The ClientPooledConnection wraps the underlying physical connection associated with this prepared statement it is used to pass the Statement closed and the Statement error occurred events that occur back to the ClientPooledConnection.

columnIndexes - an array of column indexes indicating the columns that should be returned form the inserted row.

Returns:

a PreparedStatement object

Throws:

SqlException

newLogicalPreparedStatement

public LogicalPreparedStatement newLogicalPreparedStatement(java.sql.PreparedStatement ps,
                                                            StatementKey stmtKey,
                                                            StatementCacheInteractor cacheInteractor)

Returns a new logical prepared statement object.

Specified by:: newLogicalPreparedStatement in interface ClientJDBCObjectFactory
Parameters:: ps - underlying physical prepared statement; stmtKey - key for the underlying physical prepared statement; cacheInteractor - the statement cache interactor
Returns:: A logical prepared statement.

newLogicalCallableStatement

public LogicalCallableStatement newLogicalCallableStatement(java.sql.CallableStatement cs,
                                                            StatementKey stmtKey,
                                                            StatementCacheInteractor cacheInteractor)

Returns a new logical callable statement object.

Specified by:: newLogicalCallableStatement in interface ClientJDBCObjectFactory
Parameters:: cs - underlying physical callable statement; stmtKey - key for the underlying physical callable statement; cacheInteractor - the statement cache interactor
Returns:: A logical callable statement.

newNetConnection

public ClientConnection newNetConnection(LogWriter logWriter,
                                         int driverManagerLoginTimeout,
                                         java.lang.String serverName,
                                         int portNumber,
                                         java.lang.String databaseName,
                                         java.util.Properties properties)
                                  throws SqlException

Description copied from interface: ClientJDBCObjectFactory

This method returns an instance of NetConnection (or NetConnection40) class which extends from ClientConnection this implements the java.sql.Connection interface

Specified by:: newNetConnection in interface ClientJDBCObjectFactory
Returns:: an instance of NetConnection
Throws:: SqlException

newNetConnection

public ClientConnection newNetConnection(LogWriter logWriter,
                                         java.lang.String user,
                                         java.lang.String password,
                                         BasicClientDataSource40 dataSource,
                                         int rmId,
                                         boolean isXAConn)
                                  throws SqlException

Description copied from interface: ClientJDBCObjectFactory

This method returns an instance of NetConnection (or NetConnection40) class which extends from ClientConnection. This implements the java.sql.Connection interface.

Specified by:: newNetConnection in interface ClientJDBCObjectFactory
Returns:: an instance of NetConnection
Throws:: SqlException

newNetConnection
```
public ClientConnection newNetConnection(LogWriter logWriter,
                                         java.lang.String user,
                                         java.lang.String password,
                                         BasicClientDataSource40 dataSource,
                                         int rmId,
                                         boolean isXAConn,
                                         ClientPooledConnection cpc)
                                  throws SqlException
```
Returns an instance of NetConnection.

Specified by:

newNetConnection in interface ClientJDBCObjectFactory

Parameters:

logWriter - LogWriter object associated with this connection.

user - user id for this connection.

password - password for this connection.

dataSource - The DataSource object passed from the PooledConnection object from which this constructor was called.

rmId - The Resource Manager ID for XA Connections

isXAConn - true if this is a XA connection

cpc - The ClientPooledConnection object from which this NetConnection constructor was called. This is used to pass StatementEvents back to the pooledConnection object.

Returns:

a ClientConnection object

Throws:

SqlException

newNetResultSet

public ClientResultSet newNetResultSet(Agent netAgent,
                                       MaterialStatement netStatement,
                                       Cursor cursor,
                                       int qryprctyp,
                                       int sqlcsrhld,
                                       int qryattscr,
                                       int qryattsns,
                                       int qryattset,
                                       long qryinsid,
                                       int actualResultSetType,
                                       int actualResultSetConcurrency,
                                       int actualResultSetHoldability)
                                throws SqlException

Description copied from interface: ClientJDBCObjectFactory

This method returns an instance of NetResultSet(or NetResultSet40) which extends from ClientResultSet which implements java.sql.ResultSet.

Specified by:: newNetResultSet in interface ClientJDBCObjectFactory
Returns:: an instance of NetResultSet
Throws:: SqlException

newNetDatabaseMetaData
```
public ClientDatabaseMetaData newNetDatabaseMetaData(Agent netAgent,
                                                     ClientConnection netConnection)
```
Description copied from interface: ClientJDBCObjectFactory

This method provides an instance of NetDatabaseMetaData (or NetDatabaseMetaData40) which extends from ClientDatabaseMetaData which implements java.sql.DatabaseMetaData.

Specified by:

newNetDatabaseMetaData in interface ClientJDBCObjectFactory

Returns:

an instance of NetDatabaseMetaData

newStatement

public ClientStatement newStatement(Agent agent,
                                    ClientConnection connection,
                                    int type,
                                    int concurrency,
                                    int holdability,
                                    int autoGeneratedKeys,
                                    java.lang.String[] columnNames,
                                    int[] columnIndexes)
                             throws SqlException

This method provides an instance of Statement

Specified by:: newStatement in interface ClientJDBCObjectFactory
Parameters:: agent - Agent; connection - Connection; type - int; concurrency - int; holdability - int; autoGeneratedKeys - int; columnNames - String[]; columnIndexes - int[]
Returns:: a ClientStatement implementation
Throws:: SqlException

newColumnMetaData
```
public ColumnMetaData newColumnMetaData(LogWriter logWriter)
```
Returns an instance of ColumnMetaData

Specified by:

newColumnMetaData in interface ClientJDBCObjectFactory

Parameters:

logWriter - LogWriter

Returns:

a ColumnMetaData implementation

newColumnMetaData
```
public ColumnMetaData newColumnMetaData(LogWriter logWriter,
                                        int upperBound)
```
Returns an instance of ColumnMetaData or ColumnMetaData40 depending on the JDK version under use

Specified by:

newColumnMetaData in interface ClientJDBCObjectFactory

Parameters:

logWriter - LogWriter

upperBound - int

Returns:

a ColumnMetaData implementation

newParameterMetaData
```
public ClientParameterMetaData newParameterMetaData(ColumnMetaData columnMetaData)
```
returns an instance of ParameterMetaData

Specified by:

newParameterMetaData in interface ClientJDBCObjectFactory

Parameters:

columnMetaData - ColumnMetaData

Returns:

a ParameterMetaData implementation

newBatchUpdateException

public java.sql.BatchUpdateException newBatchUpdateException(LogWriter logWriter,
                                                             ClientMessageId msgid,
                                                             java.lang.Object[] args,
                                                             long[] updateCounts,
                                                             SqlException cause)

Creates a BatchUpdateException depending on the JVM level.

Specified by:: newBatchUpdateException in interface ClientJDBCObjectFactory

newBatchUpdateException

protected java.sql.BatchUpdateException newBatchUpdateException(java.lang.String message,
                                                                java.lang.String sqlState,
                                                                int errorCode,
                                                                long[] updateCounts,
                                                                SqlException cause)

This method is overridden on JVM 8

Class ClientJDBCObjectFactoryImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

msgutil_

Constructor Detail

ClientJDBCObjectFactoryImpl

Method Detail

newClientPooledConnection

newClientXAConnection

newCallableStatement

newLogicalConnection

newCachingLogicalConnection

newPreparedStatement

newPreparedStatement

newLogicalPreparedStatement

newLogicalCallableStatement

newNetConnection

newNetConnection

newNetConnection

newNetResultSet

newNetDatabaseMetaData

newStatement

newColumnMetaData

newColumnMetaData

newParameterMetaData

newBatchUpdateException

newBatchUpdateException