ClientJDBCObjectFactoryImpl (Apache Derby V10.10 Internals)

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

All Implemented Interfaces:

ClientJDBCObjectFactory

Direct Known Subclasses:

ClientJDBCObjectFactoryImpl40
```
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 Eg. newCallableStatement would return org.apache.derby.client.am.CallableStatement

Field Summary

Fields
Modifier and Type	Field and 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 and Description

ClientJDBCObjectFactoryImpl()

Constructors
Constructor and Description
`ClientJDBCObjectFactoryImpl()`

Method Summary

Methods
Modifier and Type	Method and Description
`java.sql.BatchUpdateException`	`newBatchUpdateException(LogWriter logWriter, ClientMessageId msgid, java.lang.Object[] args, long[] updateCounts, SqlException cause)` Creates a BatchUpdateException depending on the JVM level.
`protected java.sql.BatchUpdateException`	`newBatchUpdateException(java.lang.String message, java.lang.String sqlState, int errorCode, long[] updateCounts, SqlException cause)` This method is overriden on JVM 8
`LogicalConnection`	`newCachingLogicalConnection(Connection physicalConnection, ClientPooledConnection pooledConnection, JDBCStatementCache stmtCache)` Returns an instance of a `CachingLogicalConnection`, which provides caching of prepared statements.
`CallableStatement`	`newCallableStatement(Agent agent, Connection connection, java.lang.String sql, int type, int concurrency, int holdability, ClientPooledConnection cpc)` Returns an instance of org.apache.derby.client.am.CallableStatement.
`ClientPooledConnection`	`newClientPooledConnection(ClientBaseDataSourceRoot ds, LogWriter logWriter, java.lang.String user, java.lang.String password)` Returns an instance of org.apache.derby.client.ClientPooledConnection
`ClientPooledConnection`	`newClientPooledConnection(ClientBaseDataSourceRoot ds, LogWriter logWriter, java.lang.String user, java.lang.String password, int rmId)` Returns an instance of org.apache.derby.client.ClientPooledConnection
`ClientXAConnection`	`newClientXAConnection(ClientBaseDataSourceRoot ds, LogWriter logWriter, java.lang.String user, java.lang.String password)` Returns an instance of org.apache.derby.client.ClientXAConnection
`ColumnMetaData`	`newColumnMetaData(LogWriter logWriter)` Returns an instanceof ColumnMetaData
`ColumnMetaData`	`newColumnMetaData(LogWriter logWriter, int upperBound)` Returns an instanceof 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(Connection physicalConnection, ClientPooledConnection pooledConnection)` Returns an instance of org.apache.derby.client.am.LogicalConnection
`LogicalPreparedStatement`	`newLogicalPreparedStatement(java.sql.PreparedStatement ps, StatementKey stmtKey, StatementCacheInteractor cacheInteractor)` Returns a new logcial prepared statement object.
`Connection`	`newNetConnection(LogWriter netLogWriter, ClientBaseDataSourceRoot clientDataSource, java.lang.String user, java.lang.String password)` returns an instance of org.apache.derby.client.net.NetConnection
`Connection`	`newNetConnection(LogWriter netLogWriter, int driverManagerLoginTimeout, java.lang.String serverName, int portNumber, java.lang.String databaseName, java.util.Properties properties)` returns an instance of org.apache.derby.client.net.NetConnection
`Connection`	`newNetConnection(LogWriter netLogWriter, java.lang.String ipaddr, int portNumber, ClientBaseDataSourceRoot dataSource, boolean isXAConn)` returns an instance of org.apache.derby.client.net.NetConnection
`Connection`	`newNetConnection(LogWriter netLogWriter, java.lang.String databaseName, java.util.Properties properties)` returns an instance of org.apache.derby.client.net.NetConnection
`Connection`	`newNetConnection(LogWriter netLogWriter, java.lang.String user, java.lang.String password, ClientBaseDataSourceRoot dataSource, int rmId, boolean isXAConn)` returns an instance of org.apache.derby.client.net.NetConnection
`Connection`	`newNetConnection(LogWriter netLogWriter, java.lang.String user, java.lang.String password, ClientBaseDataSourceRoot dataSource, int rmId, boolean isXAConn, ClientPooledConnection cpc)` Returns an instance of org.apache.derby.client.net.NetConnection.
`DatabaseMetaData`	`newNetDatabaseMetaData(Agent netAgent, Connection netConnection)` returns an instance of org.apache.derby.client.net.NetDatabaseMetaData
`ResultSet`	`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)` returns an instance of org.apache.derby.client.net.NetResultSet
`ParameterMetaData`	`newParameterMetaData(ColumnMetaData columnMetaData)` returns an instance of ParameterMetaData
`PreparedStatement`	`newPreparedStatement(Agent agent, Connection 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 PreparedStatement which implements java.sql.PreparedStatement.
`PreparedStatement`	`newPreparedStatement(Agent agent, Connection connection, java.lang.String sql, Section section, ClientPooledConnection cpc)` This method returns an instance of PreparedStatement which implements java.sql.PreparedStatement.
`Statement`	`newStatement(Agent agent, Connection connection)` This method provides an instance of Statement
`Statement`	`newStatement(Agent agent, Connection 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(ClientBaseDataSourceRoot ds,
                                               LogWriter logWriter,
                                               java.lang.String user,
                                               java.lang.String password)
                                                 throws java.sql.SQLException

Returns an instance of org.apache.derby.client.ClientPooledConnection

Specified by:: newClientPooledConnection in interface ClientJDBCObjectFactory
Throws:: java.sql.SQLException

newClientPooledConnection

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

Returns an instance of org.apache.derby.client.ClientPooledConnection

Specified by:: newClientPooledConnection in interface ClientJDBCObjectFactory
Throws:: java.sql.SQLException

newClientXAConnection

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

Returns an instance of org.apache.derby.client.ClientXAConnection

Specified by:: newClientXAConnection in interface ClientJDBCObjectFactory
Throws:: java.sql.SQLException

newCallableStatement
```
public CallableStatement newCallableStatement(Agent agent,
                                     Connection connection,
                                     java.lang.String sql,
                                     int type,
                                     int concurrency,
                                     int holdability,
                                     ClientPooledConnection cpc)
                                       throws SqlException
```
Returns an instance of org.apache.derby.client.am.CallableStatement.

Specified by:

newCallableStatement in interface ClientJDBCObjectFactory

Parameters:
agent - The instance of NetAgent associated with this CallableStatement 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 CallableStatement object

Throws:

SqlException

newLogicalConnection

public LogicalConnection newLogicalConnection(Connection physicalConnection,
                                     ClientPooledConnection pooledConnection)
                                       throws SqlException

Returns an instance of org.apache.derby.client.am.LogicalConnection

Specified by:: newLogicalConnection in interface ClientJDBCObjectFactory
Throws:: SqlException

newCachingLogicalConnection
```
public LogicalConnection newCachingLogicalConnection(Connection 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 PreparedStatement newPreparedStatement(Agent agent,
                                     Connection connection,
                                     java.lang.String sql,
                                     Section section,
                                     ClientPooledConnection cpc)
                                       throws SqlException
```
This method returns an instance of PreparedStatement 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 CallableStatement 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 PreparedStatement newPreparedStatement(Agent agent,
                                     Connection 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 PreparedStatement 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 CallableStatement 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 logcial 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.