Apache Derby Network Server 10.17.1.0 · org.apache.derby.impl.drda.Database

Field Summary

Modifier and Type	Field and Description
protected int	accessCount
pack-priv String	attrString
protected int	byteOrder
protected int	ccsidDBC
protected String	ccsidDBCEncoding
protected int	ccsidMBC
protected String	ccsidMBCEncoding
protected int	ccsidSBC
protected String	ccsidSBCEncoding
private EngineConnection	conn Connection to the database in the embedded engine.
protected byte[]	crrtkn
private DRDAStatement	currentStatement
private String	dbName
protected String	decryptedPassword
protected String	decryptedUserId
pack-priv DRDAStatement	defaultStatement
private boolean	locatorSupport
private boolean	locatorSupportChecked
protected String	password
protected byte[]	passwordSubstitute
private PiggyBackedSessionData	pbsd_ Piggy-backed session data.
protected boolean	rdbAllowUpdates
protected boolean	RDBUPDRM_sent
protected byte[]	secTokenIn
protected byte[]	secTokenOut
protected int	securityMechanism
protected boolean	sendTRGDFTRT
private String	shortDbName
private Hashtable<Object, DRDAStatement>	stmtTable Hash table for storing statements.
protected String	typDefNam
protected String	userId

Constructor Summary

Access	Constructor and Description
pack-priv	Database(String database name dbName) Database constructor

Method Summary

Modifier and Type	Method and Description
pack-priv String	appendAttrString(Properties p)
protected String	buildRuntimeInfo(String indent, LocalizedResource localLangUtil)
protected void	close() Database close does following cleanup tasks 1)Rollback any pending transaction on the Connection object (except for a global-XA Connection obejct) before closing the Connection.
protected void	commit()
pack-priv final EngineConnection	Returns: connection getConnection() Get the connection
protected DRDAStatement	Returns: DRDAStatement getCurrentStatement() Get current DRDA statement
public String	getDatabaseName()
protected DRDAStatement	Returns: DRDAStatement getDefaultStatement() Get default statement for use in EXCIMM
protected DRDAStatement	Returns: DRDAStatement getDefaultStatement(Pkgnamcsn package/ section # for statement pkgnamcsn) Get default statement for use in EXCIMM with specified pkgnamcsn The pkgnamcsn has the encoded isolation level
protected DRDAStatement	Returns: DRDAStatement getDRDAStatement(Pkgnamcsn - key to access statement pkgnamcsn) Get DRDA statement based on pkgnamcsn
public PiggyBackedSessionData	Returns: a reference to the PBSD object or null getPiggyBackedSessionData(boolean if true create the PiggyBackedSessionData on demand createOnDemand) Get a reference (handle) to the PiggyBackedSessionData object.
pack-priv final int	getPrepareIsolation()
public String	getShortDbName()
private void	initializeDefaultStatement()
pack-priv void	makeConnection(Properties Properties for connection attributes to pass to connect p) Make a new connection using the database name and set the connection in the database
pack-priv void	makeDummyConnection() This makes a dummy connection to the database in order to boot and/or create this last one.
protected DRDAStatement	Returns: DRDAStatement newDRDAStatement(Pkgnamcsn Package name and section pkgnamcsn) Get a new DRDA statement and store it in the stmtTable if stortStmt is true.
protected void	removeStatement(DRDAStatement stmt)
public void	reset() This method resets the state of this Database object so that it can be re-used.
protected void	rollback()
pack-priv final void	setConnection(EngineConnection Connection conn) Set connection and create the SQL statement for the default statement
protected void	setCurrentStatement(DRDAStatement stmt) Make statement the current statement
public void	setDatabaseName(String database name, including attributes. dbName) Take database name including attributes and set attrString and shortDbName accordingly.
pack-priv final void	setDrdaID(String drdaID)
pack-priv final void	setPrepareIsolation(int internal isolation level level) Set the internal isolation level to use for preparing statements.
protected void	storeStatement(DRDAStatement DRDA prepared statement stmt) Store DRDA prepared statement
pack-priv boolean	Returns: `true` if locators are supported, `false` otherwise supportsLocator() Checks whether database can support locators.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

accessCount	back to summary
protected int accessCount

attrString	back to summary
pack-priv String attrString

byteOrder	back to summary
protected int byteOrder

ccsidDBC	back to summary
protected int ccsidDBC

ccsidDBCEncoding	back to summary
protected String ccsidDBCEncoding

ccsidMBC	back to summary
protected int ccsidMBC

ccsidMBCEncoding	back to summary
protected String ccsidMBCEncoding

ccsidSBC	back to summary
protected int ccsidSBC

ccsidSBCEncoding	back to summary
protected String ccsidSBCEncoding

conn	back to summary
private EngineConnection conn Connection to the database in the embedded engine.

crrtkn	back to summary
protected byte[] crrtkn

currentStatement	back to summary
private DRDAStatement currentStatement

dbName	back to summary
private String dbName

decryptedPassword	back to summary
protected String decryptedPassword

decryptedUserId	back to summary
protected String decryptedUserId

defaultStatement	back to summary
pack-priv DRDAStatement defaultStatement

locatorSupport	back to summary
private boolean locatorSupport

locatorSupportChecked	back to summary
private boolean locatorSupportChecked

password	back to summary
protected String password

passwordSubstitute	back to summary
protected byte[] passwordSubstitute

pbsd_	back to summary
private PiggyBackedSessionData pbsd_ Piggy-backed session data. Null if no piggy-backing has happened yet. Lazy initialization is acceptable since the client's cache initially is empty so that any request made prior to the first round of piggy-backing will trigger an actual request to the server.

rdbAllowUpdates	back to summary
protected boolean rdbAllowUpdates

RDBUPDRM_sent	back to summary
protected boolean RDBUPDRM_sent

secTokenIn	back to summary
protected byte[] secTokenIn

secTokenOut	back to summary
protected byte[] secTokenOut

securityMechanism	back to summary
protected int securityMechanism

sendTRGDFTRT	back to summary
protected boolean sendTRGDFTRT

shortDbName	back to summary
private String shortDbName

stmtTable	back to summary
private Hashtable<Object, DRDAStatement> stmtTable Hash table for storing statements.

typDefNam	back to summary
protected String typDefNam

userId	back to summary
protected String userId

Constructor Detail

Database	back to summary
pack-priv Database(String dbName) Database constructor Parameters dbName:String database name

Database

back to summary

pack-priv Database(String dbName)

Database constructor

Parameters

dbName:String: database name

Method Detail

appendAttrString	back to summary
pack-priv String appendAttrString(Properties p)

buildRuntimeInfo	back to summary
protected String buildRuntimeInfo(String indent, LocalizedResource localLangUtil)

close	back to summary
protected void close() throws SQLException Database close does following cleanup tasks 1)Rollback any pending transaction on the Connection object (except for a global-XA Connection obejct) before closing the Connection. Without the rollback, the Connection close will result into an exception if there is a pending transaction on that Connection. 2)Clean up the statement table Exceptions SQLException: on conn.close() error to be handled in DRDAConnThread.

back to summary

protected void close() throws SQLException

Database close does following cleanup tasks 1)Rollback any pending transaction on the Connection object (except for a global-XA Connection obejct) before closing the Connection. Without the rollback, the Connection close will result into an exception if there is a pending transaction on that Connection. 2)Clean up the statement table

Exceptions

SQLException:: on conn.close() error to be handled in DRDAConnThread.

commit	back to summary
protected void commit() throws SQLException

getConnection	back to summary
pack-priv final EngineConnection getConnection() Get the connection Returns:EngineConnection connection

getConnection

back to summary

pack-priv final EngineConnection getConnection()

Get the connection

Returns:EngineConnection: connection

getCurrentStatement	back to summary
protected DRDAStatement getCurrentStatement() Get current DRDA statement Returns:DRDAStatement DRDAStatement

getCurrentStatement

back to summary

protected DRDAStatement getCurrentStatement()

Get current DRDA statement

Returns:DRDAStatement: DRDAStatement

getDatabaseName	back to summary
public String getDatabaseName()

getDefaultStatement	back to summary
protected DRDAStatement getDefaultStatement() Get default statement for use in EXCIMM Returns:DRDAStatement DRDAStatement

getDefaultStatement

back to summary

protected DRDAStatement getDefaultStatement()

Get default statement for use in EXCIMM

Returns:DRDAStatement: DRDAStatement

getDefaultStatement	back to summary
protected DRDAStatement getDefaultStatement(Pkgnamcsn pkgnamcsn) Get default statement for use in EXCIMM with specified pkgnamcsn The pkgnamcsn has the encoded isolation level Parameters pkgnamcsn:Pkgnamcsn package/ section # for statement Returns:DRDAStatement DRDAStatement

getDefaultStatement

back to summary

protected DRDAStatement getDefaultStatement(Pkgnamcsn pkgnamcsn)

Get default statement for use in EXCIMM with specified pkgnamcsn The pkgnamcsn has the encoded isolation level

Parameters

pkgnamcsn:Pkgnamcsn: package/ section # for statement

Returns:DRDAStatement

DRDAStatement

getDRDAStatement	back to summary
protected DRDAStatement getDRDAStatement(Pkgnamcsn pkgnamcsn) Get DRDA statement based on pkgnamcsn Parameters pkgnamcsn:Pkgnamcsn - key to access statement Returns:DRDAStatement DRDAStatement

getDRDAStatement

back to summary

protected DRDAStatement getDRDAStatement(Pkgnamcsn pkgnamcsn)

Get DRDA statement based on pkgnamcsn

Parameters

pkgnamcsn:Pkgnamcsn: - key to access statement

Returns:DRDAStatement

DRDAStatement

getPiggyBackedSessionData	back to summary
public PiggyBackedSessionData getPiggyBackedSessionData(boolean createOnDemand) throws SQLException Get a reference (handle) to the PiggyBackedSessionData object. Null will be returned either if Database.conn is not a valid connection, or if the create argument is false and no object has yet been created. Parameters createOnDemand:boolean if true create the PiggyBackedSessionData on demand Returns:PiggyBackedSessionData a reference to the PBSD object or null

getPiggyBackedSessionData

back to summary

public PiggyBackedSessionData getPiggyBackedSessionData(boolean createOnDemand) throws SQLException

Get a reference (handle) to the PiggyBackedSessionData object. Null will be returned either if Database.conn is not a valid connection, or if the create argument is false and no object has yet been created.

Parameters

createOnDemand:boolean: if true create the PiggyBackedSessionData on demand

Returns:PiggyBackedSessionData

a reference to the PBSD object or null

getPrepareIsolation	back to summary
pack-priv final int getPrepareIsolation() throws SQLException

getShortDbName	back to summary
public String getShortDbName()

initializeDefaultStatement	back to summary
private void initializeDefaultStatement()

makeConnection	back to summary
pack-priv void makeConnection(Properties p) throws SQLException Make a new connection using the database name and set the connection in the database Parameters p:Properties Properties for connection attributes to pass to connect

makeConnection

back to summary

pack-priv void makeConnection(Properties p) throws SQLException

Make a new connection using the database name and set the connection in the database

Parameters

p:Properties: Properties for connection attributes to pass to connect

makeDummyConnection

back to summary

pack-priv void makeDummyConnection()

This makes a dummy connection to the database in order to boot and/or create this last one. If database cannot be found or authentication does not succeed, this will throw a SQLException which we catch and do nothing. We don't pass a userid and password here as we don't need to for the purpose of this method - main goal is to cause the database to be booted via a dummy connection.

newDRDAStatement

back to summary

protected DRDAStatement newDRDAStatement(Pkgnamcsn pkgnamcsn) throws SQLException

Get a new DRDA statement and store it in the stmtTable if stortStmt is true. If possible recycle an existing statement. When the server gets a new statement with a previously used pkgnamcsn, it means that client-side statement associated with this pkgnamcsn has been closed. In this case, server can re-use the DRDAStatement by doing the following: 1) Retrieve the old DRDAStatement associated with this pkgnamcsn and close it. 2) Reset the DRDAStatement state for re-use.

Parameters

pkgnamcsn:Pkgnamcsn: Package name and section

Returns:DRDAStatement

DRDAStatement

removeStatement	back to summary
protected void removeStatement(DRDAStatement stmt) throws SQLException

reset

back to summary

public void reset()

This method resets the state of this Database object so that it can be re-used.

Note

currently this method resets the variables related to security mechanisms that have been investigated as needing a reset. TODO: Investigate what all variables in this class need to be reset when this database object is re-used on a connection pooling or transaction pooling. see DRDAConnThread.parseACCSEC (CodePoint.RDBNAM) where database object is re-used on a connection reset.

rollback	back to summary
protected void rollback() throws SQLException

setConnection

back to summary

pack-priv final void setConnection(EngineConnection conn) throws SQLException

Set connection and create the SQL statement for the default statement

Parameters

conn:EngineConnection: Connection

setCurrentStatement	back to summary
protected void setCurrentStatement(DRDAStatement stmt) Make statement the current statement

setDatabaseName

back to summary

public void setDatabaseName(String dbName)

Take database name including attributes and set attrString and shortDbName accordingly.

Parameters

dbName:String: database name, including attributes.

setDrdaID	back to summary
pack-priv final void setDrdaID(String drdaID)

setPrepareIsolation back to summary

pack-priv final void setPrepareIsolation(int level) throws SQLException

Set the internal isolation level to use for preparing statements. Subsequent prepares will use this isoalation level

Parameters

level:int: internal isolation level

See Also

EngineConnection#setPrepareIsolation

storeStatement

back to summary

protected void storeStatement(DRDAStatement stmt) throws SQLException

Store DRDA prepared statement

Parameters

stmt:DRDAStatement: DRDA prepared statement

supportsLocator back to summary

pack-priv boolean supportsLocator() throws SQLException

Checks whether database can support locators. This is done by checking whether one of the stored procedures needed for locators exists. (If the database has been soft-upgraded from an earlier version, the procedures will not exist).

Returns:boolean

true if locators are supported, false otherwise

Exceptions

SQLException:: if metadata call fails

pack-priv Class Database

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail