java.lang.Object

com.mckoi.database.jdbc.MConnection

All Implemented Interfaces:: DatabaseCallBack, AutoCloseable, Connection, Wrapper

public class MConnection extends Object implements Connection, DatabaseCallBack

JDBC implementation of the connection object to a Mckoi database. The implementation specifics for how the connection talks with the database is left up to the implementation of DatabaseInterface.

This object is thread safe. It may be accessed safely from concurrent threads.

Author:: Tobias Downer

Field Summary

Fields inherited from interface java.sql.Connection
TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE
Constructor Summary

Constructors

Constructor

Description

MConnection(String url, DatabaseInterface db_interface, int cache_size, int max_size)

Constructor.
Method Summary

Modifier and Type

Method

Description

void

abort(Executor executor)

protected final void

addSQLWarning(SQLWarning warning)

Adds a new SQLWarning to the chain.

void

clearWarnings()

void

close()

void

commit()

Array

createArrayOf(String typeName, Object[] elements)

Blob

createBlob()

Clob

createClob()

NClob

createNClob()

SQLXML

createSQLXML()

Statement

createStatement()

Statement

createStatement(int resultSetType, int resultSetConcurrency)

Statement

createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability)

Struct

createStruct(String typeName, Object[] attributes)

void

databaseEvent(int event_type, String event_message)

Called when the database has generated an event that this user is listening for.

boolean

getAutoCommit()

String

getCatalog()

Properties

getClientInfo()

String

getClientInfo(String name)

int

getHoldability()

DatabaseMetaData

getMetaData()

int

getNetworkTimeout()

protected final com.mckoi.database.jdbc.RowCache

getRowCache()

Returns the row Cache object for this connection.

String

getSchema()

int

getTransactionIsolation()

Map

getTypeMap()

SQLWarning

getWarnings()

final void

internalClose()

Closes this connection by calling the 'dispose' method in the database interface.

boolean

isCaseInsensitiveIdentifiers()

Returns true if the database has case insensitive identifiers.

boolean

isClosed()

boolean

isReadOnly()

boolean

isStrictGetObject()

Returns true if strict get object is enabled (default).

boolean

isValid(int timeout)

boolean

isWrapperFor(Class iface)

void

login(String default_schema, String username, String password)

Attempts to login to the database interface with the given default schema, username and password.

String

nativeSQL(String sql)

CallableStatement

prepareCall(String sql)

CallableStatement

prepareCall(String sql, int resultSetType, int resultSetConcurrency)

CallableStatement

prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)

PreparedStatement

prepareStatement(String sql)

PreparedStatement

prepareStatement(String sql, int autoGeneratedKeys)

PreparedStatement

prepareStatement(String sql, int[] columnIndexes)

PreparedStatement

prepareStatement(String sql, int resultSetType, int resultSetConcurrency)

PreparedStatement

prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)

PreparedStatement

prepareStatement(String sql, String[] columnNames)

void

releaseSavepoint(Savepoint savepoint)

void

rollback()

void

rollback(Savepoint savepoint)

void

setAutoCommit(boolean autoCommit)

void

setCaseInsensitiveIdentifiers(boolean status)

Toggles whether this connection is handling identifiers as case insensitive or not.

void

setCatalog(String catalog)

void

setClientInfo(String name, String value)

void

setClientInfo(Properties properties)

void

setHoldability(int holdability)

void

setNetworkTimeout(Executor executor, int milliseconds)

void

setReadOnly(boolean readOnly)

Savepoint

setSavepoint()

Savepoint

setSavepoint(String name)

void

setSchema(String schema)

void

setStrictGetObject(boolean status)

Toggles strict get object.

void

setTransactionIsolation(int level)

void

setTypeMap(Map map)

void

setVerboseColumnNames(boolean status)

Toggles verbose column names from ResultSetMetaData.

Object

unwrap(Class iface)

boolean

verboseColumnNames()

Returns true if ResultSetMetaData should return verbose column names.

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

Methods inherited from interface java.sql.Connection
beginRequest, endRequest, setShardingKey, setShardingKey, setShardingKeyIfValid, setShardingKeyIfValid

Constructor Details
- MConnection
  
  public MConnection(String url, DatabaseInterface db_interface, int cache_size, int max_size)
  
  Constructor.
Method Details
- setStrictGetObject
  
  public void setStrictGetObject(boolean status)
  
  Toggles strict get object.
  If the 'getObject' method should return the raw object type (eg. BigDecimal for Integer, String for chars, etc) then this is set to false. If this is true (the default) the 'getObject' methods return the correct object types as specified by the JDBC specification.
  The default is true.
- isStrictGetObject
  
  public boolean isStrictGetObject()
  
  Returns true if strict get object is enabled (default).
- setVerboseColumnNames
  
  public void setVerboseColumnNames(boolean status)
  
  Toggles verbose column names from ResultSetMetaData.
  If this is set to true, getColumnName will return 'APP.Part.id' for a column name. If it is false getColumnName will return 'id'. This property is for compatibility with older Mckoi applications.
- verboseColumnNames
  
  public boolean verboseColumnNames()
  
  Returns true if ResultSetMetaData should return verbose column names.
- setCaseInsensitiveIdentifiers
  
  public void setCaseInsensitiveIdentifiers(boolean status)
  
  Toggles whether this connection is handling identifiers as case insensitive or not. If this is true then 'getString("app.id")' will match against 'APP.id', etc.
- isCaseInsensitiveIdentifiers
  
  public boolean isCaseInsensitiveIdentifiers()
  
  Returns true if the database has case insensitive identifiers.
- getRowCache
  
  protected final com.mckoi.database.jdbc.RowCache getRowCache()
  
  Returns the row Cache object for this connection.
- addSQLWarning
  
  protected final void addSQLWarning(SQLWarning warning)
  
  Adds a new SQLWarning to the chain.
- internalClose
  
  public final void internalClose() throws SQLException
  
  Closes this connection by calling the 'dispose' method in the database interface.
  
  Throws:
  
  SQLException
- login
  
  public void login(String default_schema, String username, String password) throws SQLException
  
  Attempts to login to the database interface with the given default schema, username and password. If the authentication fails an SQL exception is generated.
  
  Throws:
  
  SQLException
- databaseEvent
  
  public void databaseEvent(int event_type, String event_message)
  
  Description copied from interface: DatabaseCallBack
  
  Called when the database has generated an event that this user is listening for.
  NOTE: The thread that calls back these events is always a volatile thread that may not block. It is especially important that no queries are executed when this calls back. To safely act on events, it is advisable to dispatch onto another thread such as the SwingEventDispatcher thread.
  
  Specified by:
  
  databaseEvent in interface DatabaseCallBack
- createStatement
  
  public Statement createStatement() throws SQLException
  
  Specified by:
  
  createStatement in interface Connection
  
  Throws:
  
  SQLException
- prepareStatement
  
  public PreparedStatement prepareStatement(String sql) throws SQLException
  
  Specified by:
  
  prepareStatement in interface Connection
  
  Throws:
  
  SQLException
- prepareCall
  
  public CallableStatement prepareCall(String sql) throws SQLException
  
  Specified by:
  
  prepareCall in interface Connection
  
  Throws:
  
  SQLException
- nativeSQL
  
  public String nativeSQL(String sql) throws SQLException
  
  Specified by:
  
  nativeSQL in interface Connection
  
  Throws:
  
  SQLException
- setAutoCommit
  
  public void setAutoCommit(boolean autoCommit) throws SQLException
  
  Specified by:
  
  setAutoCommit in interface Connection
  
  Throws:
  
  SQLException
- getAutoCommit
  
  public boolean getAutoCommit() throws SQLException
  
  Specified by:
  
  getAutoCommit in interface Connection
  
  Throws:
  
  SQLException
- commit
  
  public void commit() throws SQLException
  
  Specified by:
  
  commit in interface Connection
  
  Throws:
  
  SQLException
- rollback
  
  public void rollback() throws SQLException
  
  Specified by:
  
  rollback in interface Connection
  
  Throws:
  
  SQLException
- close
  
  public void close() throws SQLException
  
  Specified by:
  
  close in interface AutoCloseable
  
  Specified by:
  
  close in interface Connection
  
  Throws:
  
  SQLException
- isClosed
  
  public boolean isClosed() throws SQLException
  
  Specified by:
  
  isClosed in interface Connection
  
  Throws:
  
  SQLException
- getMetaData
  
  public DatabaseMetaData getMetaData() throws SQLException
  
  Specified by:
  
  getMetaData in interface Connection
  
  Throws:
  
  SQLException
- setReadOnly
  
  public void setReadOnly(boolean readOnly) throws SQLException
  
  Specified by:
  
  setReadOnly in interface Connection
  
  Throws:
  
  SQLException
- isReadOnly
  
  public boolean isReadOnly() throws SQLException
  
  Specified by:
  
  isReadOnly in interface Connection
  
  Throws:
  
  SQLException
- setCatalog
  
  public void setCatalog(String catalog) throws SQLException
  
  Specified by:
  
  setCatalog in interface Connection
  
  Throws:
  
  SQLException
- getCatalog
  
  public String getCatalog() throws SQLException
  
  Specified by:
  
  getCatalog in interface Connection
  
  Throws:
  
  SQLException
- setTransactionIsolation
  
  public void setTransactionIsolation(int level) throws SQLException
  
  Specified by:
  
  setTransactionIsolation in interface Connection
  
  Throws:
  
  SQLException
- getTransactionIsolation
  
  public int getTransactionIsolation() throws SQLException
  
  Specified by:
  
  getTransactionIsolation in interface Connection
  
  Throws:
  
  SQLException
- getWarnings
  
  public SQLWarning getWarnings() throws SQLException
  
  Specified by:
  
  getWarnings in interface Connection
  
  Throws:
  
  SQLException
- clearWarnings
  
  public void clearWarnings() throws SQLException
  
  Specified by:
  
  clearWarnings in interface Connection
  
  Throws:
  
  SQLException
- createStatement
  
  public Statement createStatement(int resultSetType, int resultSetConcurrency) throws SQLException
  
  Specified by:
  
  createStatement in interface Connection
  
  Throws:
  
  SQLException
- prepareStatement
  
  public PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency) throws SQLException
  
  Specified by:
  
  prepareStatement in interface Connection
  
  Throws:
  
  SQLException
- prepareCall
  
  public CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency) throws SQLException
  
  Specified by:
  
  prepareCall in interface Connection
  
  Throws:
  
  SQLException
- getTypeMap
  
  public Map getTypeMap() throws SQLException
  
  Specified by:
  
  getTypeMap in interface Connection
  
  Throws:
  
  SQLException
- setTypeMap
  
  public void setTypeMap(Map map) throws SQLException
  
  Specified by:
  
  setTypeMap in interface Connection
  
  Throws:
  
  SQLException
- setHoldability
  
  public void setHoldability(int holdability) throws SQLException
  
  Specified by:
  
  setHoldability in interface Connection
  
  Throws:
  
  SQLException
- getHoldability
  
  public int getHoldability() throws SQLException
  
  Specified by:
  
  getHoldability in interface Connection
  
  Throws:
  
  SQLException
- setSavepoint
  
  public Savepoint setSavepoint() throws SQLException
  
  Specified by:
  
  setSavepoint in interface Connection
  
  Throws:
  
  SQLException
- setSavepoint
  
  public Savepoint setSavepoint(String name) throws SQLException
  
  Specified by:
  
  setSavepoint in interface Connection
  
  Throws:
  
  SQLException
- rollback
  
  public void rollback(Savepoint savepoint) throws SQLException
  
  Specified by:
  
  rollback in interface Connection
  
  Throws:
  
  SQLException
- releaseSavepoint
  
  public void releaseSavepoint(Savepoint savepoint) throws SQLException
  
  Specified by:
  
  releaseSavepoint in interface Connection
  
  Throws:
  
  SQLException
- createStatement
  
  public Statement createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException
  
  Specified by:
  
  createStatement in interface Connection
  
  Throws:
  
  SQLException
- prepareStatement
  
  public PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException
  
  Specified by:
  
  prepareStatement in interface Connection
  
  Throws:
  
  SQLException
- prepareCall
  
  public CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException
  
  Specified by:
  
  prepareCall in interface Connection
  
  Throws:
  
  SQLException
- prepareStatement
  
  public PreparedStatement prepareStatement(String sql, int autoGeneratedKeys) throws SQLException
  
  Specified by:
  
  prepareStatement in interface Connection
  
  Throws:
  
  SQLException
- prepareStatement
  
  public PreparedStatement prepareStatement(String sql, int[] columnIndexes) throws SQLException
  
  Specified by:
  
  prepareStatement in interface Connection
  
  Throws:
  
  SQLException
- prepareStatement
  
  public PreparedStatement prepareStatement(String sql, String[] columnNames) throws SQLException
  
  Specified by:
  
  prepareStatement in interface Connection
  
  Throws:
  
  SQLException
- createClob
  
  public Clob createClob() throws SQLException
  
  Specified by:
  
  createClob in interface Connection
  
  Throws:
  
  SQLException
- createBlob
  
  public Blob createBlob() throws SQLException
  
  Specified by:
  
  createBlob in interface Connection
  
  Throws:
  
  SQLException
- createNClob
  
  public NClob createNClob() throws SQLException
  
  Specified by:
  
  createNClob in interface Connection
  
  Throws:
  
  SQLException
- createSQLXML
  
  public SQLXML createSQLXML() throws SQLException
  
  Specified by:
  
  createSQLXML in interface Connection
  
  Throws:
  
  SQLException
- isValid
  
  public boolean isValid(int timeout) throws SQLException
  
  Specified by:
  
  isValid in interface Connection
  
  Throws:
  
  SQLException
- setClientInfo
  
  public void setClientInfo(String name, String value) throws SQLClientInfoException
  
  Specified by:
  
  setClientInfo in interface Connection
  
  Throws:
  
  SQLClientInfoException
- setClientInfo
  
  public void setClientInfo(Properties properties) throws SQLClientInfoException
  
  Specified by:
  
  setClientInfo in interface Connection
  
  Throws:
  
  SQLClientInfoException
- getClientInfo
  
  public String getClientInfo(String name) throws SQLException
  
  Specified by:
  
  getClientInfo in interface Connection
  
  Throws:
  
  SQLException
- getClientInfo
  
  public Properties getClientInfo() throws SQLException
  
  Specified by:
  
  getClientInfo in interface Connection
  
  Throws:
  
  SQLException
- createArrayOf
  
  public Array createArrayOf(String typeName, Object[] elements) throws SQLException
  
  Specified by:
  
  createArrayOf in interface Connection
  
  Throws:
  
  SQLException
- createStruct
  
  public Struct createStruct(String typeName, Object[] attributes) throws SQLException
  
  Specified by:
  
  createStruct in interface Connection
  
  Throws:
  
  SQLException
- 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
- setSchema
  
  public void setSchema(String schema) throws SQLException
  
  Specified by:
  
  setSchema in interface Connection
  
  Throws:
  
  SQLException
- getSchema
  
  public String getSchema() throws SQLException
  
  Specified by:
  
  getSchema in interface Connection
  
  Throws:
  
  SQLException
- abort
  
  public void abort(Executor executor) throws SQLException
  
  Specified by:
  
  abort in interface Connection
  
  Throws:
  
  SQLException
- setNetworkTimeout
  
  public void setNetworkTimeout(Executor executor, int milliseconds) throws SQLException
  
  Specified by:
  
  setNetworkTimeout in interface Connection
  
  Throws:
  
  SQLException
- getNetworkTimeout
  
  public int getNetworkTimeout() throws SQLException
  
  Specified by:
  
  getNetworkTimeout in interface Connection
  
  Throws:
  
  SQLException

Class MConnection

Field Summary

Fields inherited from interface java.sql.Connection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.sql.Connection

Constructor Details

MConnection

Method Details

setStrictGetObject

isStrictGetObject

setVerboseColumnNames

verboseColumnNames

setCaseInsensitiveIdentifiers

isCaseInsensitiveIdentifiers

getRowCache

addSQLWarning

internalClose

login

databaseEvent

createStatement

prepareStatement

prepareCall

nativeSQL

setAutoCommit

getAutoCommit

commit

rollback

close

isClosed

getMetaData

setReadOnly

isReadOnly

setCatalog

getCatalog

setTransactionIsolation

getTransactionIsolation

getWarnings

clearWarnings

createStatement

prepareStatement

prepareCall

getTypeMap

setTypeMap

setHoldability

getHoldability

setSavepoint

setSavepoint

rollback

releaseSavepoint

createStatement

prepareStatement

prepareCall

prepareStatement

prepareStatement

prepareStatement

createClob

createBlob

createNClob

createSQLXML

isValid

setClientInfo

setClientInfo

getClientInfo

getClientInfo

createArrayOf

createStruct

unwrap

isWrapperFor

setSchema

getSchema

abort

setNetworkTimeout

getNetworkTimeout