net.sf.jailer.database

Class Session

java.lang.Object

net.sf.jailer.database.Session

public class Session
extends java.lang.Object

Manages database sessions on a 'per thread' basis. Executes SQL-Statements in the context of a session.

Author:

Ralf Wisser

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Session.AbstractResultSetReader Reads a JDBC-result-set.
static interface	Session.ConnectionFactory Connection factory.
static interface	Session.ResultSetReader Reads a JDBC-result-set.

Field Summary

Fields

Modifier and Type	Field and Description
static Logger	_log The logger.
protected java.lang.ThreadLocal<java.sql.Connection>	connection Hold a connection for each thread.
protected Session.ConnectionFactory	connectionFactory Connection factory.
DBMS	dbms The DBMS.
java.lang.String	dbUrl The dbUrl (null if unknown)
protected java.util.concurrent.atomic.AtomicBoolean	down
java.lang.String	driverClassName The DBMS.
static long	lastUpdateTS
java.lang.Object	MD_GETCOLUMNS_LOCK
WorkingTableScope	scope Scope of temporary tables.

Constructor Summary

Constructors

Constructor and Description
Session(javax.sql.DataSource dataSource, DBMS dbms, java.lang.Integer isolationLevel) Constructor.
Session(javax.sql.DataSource dataSource, DBMS dbms, java.lang.Integer isolationLevel, WorkingTableScope scope, boolean transactional) Constructor.
Session(javax.sql.DataSource dataSource, DBMS dbms, java.lang.Integer isolationLevel, WorkingTableScope scope, boolean transactional, boolean local) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	checkQuery(java.lang.String sql) Checks SQL query.
void	commitAll() Commits all connections.
java.sql.Connection	createNewConnection() Create a new connection.
void	disableMetaDataChecking()
long	execute(java.lang.String sql) Executes a SQL-Statement without returning any result.
long	execute(java.lang.String sql, java.lang.Object cancellationContext, boolean acceptQueries) Executes a SQL-Statement without returning any result.
void	executeQuery(java.io.File sqlFile, Session.ResultSetReader reader, boolean withExplicitCommit) Executes a SQL-Query (SELECT).
long	executeQuery(java.lang.String sqlQuery, Session.ResultSetReader reader) Executes a SQL-Query (SELECT).
long	executeQuery(java.lang.String sqlQuery, Session.ResultSetReader reader, boolean withExplicitCommit) Executes a SQL-Query (SELECT).
long	executeQuery(java.lang.String sqlQuery, Session.ResultSetReader reader, java.lang.String alternativeSQL, java.lang.Object context, long limit) Executes a SQL-Query (SELECT).
long	executeQuery(java.lang.String sqlQuery, Session.ResultSetReader reader, java.lang.String alternativeSQL, java.lang.Object context, long limit, boolean withExplicitCommit) Executes a SQL-Query (SELECT).
long	executeQuery(java.lang.String sqlQuery, Session.ResultSetReader reader, java.lang.String alternativeSQL, java.lang.Object context, long limit, int timeout, boolean withExplicitCommit) Executes a SQL-Query (SELECT) with timeout.
int	executeUpdate(java.lang.String sqlUpdate) Executes a SQL-Update (INSERT, DELETE or UPDATE).
int	executeUpdate(java.lang.String sqlUpdate, java.lang.Object[] parameter) Executes a SQL-Update (INSERT, DELETE or UPDATE) with parameters.
java.util.List<java.lang.String>	getCliArguments() Gets CLI connection arguments (UI support)
java.sql.Connection	getConnection() Gets the connection for the current thread.
java.lang.String	getConnectionStats()
InlineViewStyle	getInlineViewStyle() Returns a suitable InlineViewStyle for this session.
java.lang.String	getIntrospectionSchema() Gets optional schema for database analysis.
boolean	getLogStatements() Log statements?
java.sql.DatabaseMetaData	getMetaData() Gets DB meta data.
java.lang.String	getPassword() Gets connection password (UI support)
java.lang.String	getSchema() Gets DB schema name.
java.lang.Object	getSessionProperty(java.lang.Class<?> owner, java.lang.String name) Gets a session property.
boolean	getSilent() No SQL-Exceptions will be logged in silent mode.
protected void	init()
void	insertBlob(java.lang.String table, java.lang.String column, java.lang.String where, java.io.File lobFile) Inserts a BLob.
void	insertClob(java.lang.String table, java.lang.String column, java.lang.String where, java.io.File lobFile, long length) Inserts a CLob.
void	insertSQLXML(java.lang.String table, java.lang.String column, java.lang.String where, java.io.File lobFile, long length) Inserts a SQL-XML.
boolean	isConnectionExclusive()
boolean	isDown()
void	killRunningStatements() Cancels all currently running statements.
void	markConnectionAsPotentiallyInvalid(java.sql.Connection con) Marks a connection as potentially invalid.
void	reconnect() Closes current connection and opens a new one.
void	removeSessionProperties(java.lang.Class<?> owner) Removes all session properties.
static void	resetGlobalFallbackConnection()
void	rollbackAll() Rolls back and closes all connections.
void	setCliArguments(java.util.List<java.lang.String> args) Sets CLI connection arguments (UI support)
protected void	setConnection(java.sql.Connection con)
void	setGlobalFallbackConnection()
void	setIntrospectionSchema(java.lang.String introspectionSchema) Sets optional schema for database analysis.
void	setLogPrefix(java.lang.String logPrefix)
void	setLogStatements(boolean logStatements) Log statements?
void	setPassword(java.lang.String password) Sets connection password (UI support)
void	setSessionProperty(java.lang.Class<?> owner, java.lang.String name, java.lang.Object property) Sets a session property.
void	setSilent(boolean silent) No SQL-Exceptions will be logged in silent mode.
static void	setThreadSharesConnection()
void	shutDown() Closes all connections.

Methods inherited from class java.lang.Object

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

Field Detail

connection

protected java.lang.ThreadLocal<java.sql.Connection> connection

Hold a connection for each thread.

scope

public final WorkingTableScope scope

Scope of temporary tables.

_log

public static final Logger _log

The logger.

connectionFactory

protected final Session.ConnectionFactory connectionFactory

Connection factory.

dbms

public final DBMS dbms

The DBMS.

driverClassName

public final java.lang.String driverClassName

The DBMS.

dbUrl

public final java.lang.String dbUrl

The dbUrl (null if unknown)

down

protected java.util.concurrent.atomic.AtomicBoolean down

MD_GETCOLUMNS_LOCK

public final java.lang.Object MD_GETCOLUMNS_LOCK

lastUpdateTS

public static volatile long lastUpdateTS

Constructor Detail

Session

public Session(javax.sql.DataSource dataSource,
               DBMS dbms,
               java.lang.Integer isolationLevel)
        throws java.sql.SQLException

Constructor.

Parameters:

dataSource - the data source

dbms - the DBMS

Throws:

java.sql.SQLException

Session

public Session(javax.sql.DataSource dataSource,
               DBMS dbms,
               java.lang.Integer isolationLevel,
               WorkingTableScope scope,
               boolean transactional)
        throws java.sql.SQLException

Constructor.

Parameters:

dataSource - the data source

dbms - the DBMS

Throws:

java.sql.SQLException

Session

public Session(javax.sql.DataSource dataSource,
               DBMS dbms,
               java.lang.Integer isolationLevel,
               WorkingTableScope scope,
               boolean transactional,
               boolean local)
        throws java.sql.SQLException

Constructor.

Parameters:

dataSource - the data source

dbms - the DBMS

local - true for the local entity-graph database

Throws:

java.sql.SQLException

Method Detail

setConnection

protected void setConnection(java.sql.Connection con)

markConnectionAsPotentiallyInvalid

public void markConnectionAsPotentiallyInvalid(java.sql.Connection con)

Marks a connection as potentially invalid. Forces to re-validate the connection in getConnection().

Parameters:

con - the connection

init

protected void init()
             throws java.sql.SQLException

Throws:

java.sql.SQLException

reconnect

public void reconnect()

Closes current connection and opens a new one.

setSilent

public void setSilent(boolean silent)

No SQL-Exceptions will be logged in silent mode.

Parameters:

silent - true for silence

getSilent

public boolean getSilent()

No SQL-Exceptions will be logged in silent mode.

Returns:

silent true for silence

setLogStatements

public void setLogStatements(boolean logStatements)

Log statements?

getLogStatements

public boolean getLogStatements()

Log statements?

getSchema

public java.lang.String getSchema()

Gets DB schema name.

Returns:

DB schema name (empty string if unknown)

executeQuery

public long executeQuery(java.lang.String sqlQuery,
                         Session.ResultSetReader reader,
                         boolean withExplicitCommit)
                  throws java.sql.SQLException

Executes a SQL-Query (SELECT).

Parameters:

sqlQuery - the query in SQL

reader - the reader for the result

withExplicitCommit - if true, switch of autocommit and commit explicitly

Throws:

java.sql.SQLException

executeQuery

public long executeQuery(java.lang.String sqlQuery,
                         Session.ResultSetReader reader)
                  throws java.sql.SQLException

Executes a SQL-Query (SELECT).

Parameters:

sqlQuery - the query in SQL

reader - the reader for the result

Throws:

java.sql.SQLException

executeQuery

public long executeQuery(java.lang.String sqlQuery,
                         Session.ResultSetReader reader,
                         java.lang.String alternativeSQL,
                         java.lang.Object context,
                         long limit,
                         boolean withExplicitCommit)
                  throws java.sql.SQLException

Executes a SQL-Query (SELECT).

Parameters:

sqlQuery - the query in SQL

reader - the reader for the result

alternativeSQL - query to be executed if sqlQuery fails

context - cancellation context

limit - row limit, 0 for unlimited

withExplicitCommit - if true, switch of autocommit and commit explicitly

Throws:

java.sql.SQLException

executeQuery

public long executeQuery(java.lang.String sqlQuery,
                         Session.ResultSetReader reader,
                         java.lang.String alternativeSQL,
                         java.lang.Object context,
                         long limit)
                  throws java.sql.SQLException

Executes a SQL-Query (SELECT).

Parameters:

sqlQuery - the query in SQL

reader - the reader for the result

alternativeSQL - query to be executed if sqlQuery fails

context - cancellation context

limit - row limit, 0 for unlimited

Throws:

java.sql.SQLException

executeQuery

public long executeQuery(java.lang.String sqlQuery,
                         Session.ResultSetReader reader,
                         java.lang.String alternativeSQL,
                         java.lang.Object context,
                         long limit,
                         int timeout,
                         boolean withExplicitCommit)
                  throws java.sql.SQLException

Executes a SQL-Query (SELECT) with timeout.

Parameters:

sqlQuery - the query in SQL

reader - the reader for the result

alternativeSQL - query to be executed if sqlQuery fails

limit - row limit, 0 for unlimited

context - cancellation context

timeout - the timeout in sec

withExplicitCommit - if true, switch of autocommit and commit explicitly

Throws:

java.sql.SQLException

executeQuery

public void executeQuery(java.io.File sqlFile,
                         Session.ResultSetReader reader,
                         boolean withExplicitCommit)
                  throws java.sql.SQLException

Executes a SQL-Query (SELECT).

Parameters:

sqlFile - file containing a query in SQL

reader - the reader for the result

withExplicitCommit - if true, switch of autocommit and commit explicitly

Throws:

java.sql.SQLException

executeUpdate

public int executeUpdate(java.lang.String sqlUpdate)
                  throws java.sql.SQLException

Executes a SQL-Update (INSERT, DELETE or UPDATE).

Parameters:

sqlUpdate - the update in SQL

Returns:

update-count

Throws:

java.sql.SQLException

executeUpdate

public int executeUpdate(java.lang.String sqlUpdate,
                         java.lang.Object[] parameter)
                  throws java.sql.SQLException

Executes a SQL-Update (INSERT, DELETE or UPDATE) with parameters.

Parameters:

sqlUpdate - the update in SQL

parameter - the parameters

Returns:

update-count

Throws:

java.sql.SQLException

insertClob

public void insertClob(java.lang.String table,
                       java.lang.String column,
                       java.lang.String where,
                       java.io.File lobFile,
                       long length)
                throws java.sql.SQLException,
                       java.io.IOException

Inserts a CLob.

Throws:

java.sql.SQLException

java.io.IOException

insertSQLXML

public void insertSQLXML(java.lang.String table,
                         java.lang.String column,
                         java.lang.String where,
                         java.io.File lobFile,
                         long length)
                  throws java.sql.SQLException,
                         java.io.IOException

Inserts a SQL-XML.

Throws:

java.sql.SQLException

java.io.IOException

insertBlob

public void insertBlob(java.lang.String table,
                       java.lang.String column,
                       java.lang.String where,
                       java.io.File lobFile)
                throws java.sql.SQLException,
                       java.io.IOException

Inserts a BLob.

Throws:

java.sql.SQLException

java.io.IOException

execute

public long execute(java.lang.String sql)
             throws java.sql.SQLException

Executes a SQL-Statement without returning any result.

Parameters:

sql - the SQL-Statement

Throws:

java.sql.SQLException

execute

public long execute(java.lang.String sql,
                    java.lang.Object cancellationContext,
                    boolean acceptQueries)
             throws java.sql.SQLException

Executes a SQL-Statement without returning any result.

Parameters:

sql - the SQL-Statement

Throws:

java.sql.SQLException

disableMetaDataChecking

public void disableMetaDataChecking()

getMetaData

public java.sql.DatabaseMetaData getMetaData()
                                      throws java.sql.SQLException

Gets DB meta data.

Returns:

DB meta data

Throws:

java.sql.SQLException

shutDown

public void shutDown()

Closes all connections.

isDown

public boolean isDown()

killRunningStatements

public void killRunningStatements()

Cancels all currently running statements.

rollbackAll

public void rollbackAll()
                 throws java.sql.SQLException

Rolls back and closes all connections.

Throws:

java.sql.SQLException

commitAll

public void commitAll()
               throws java.sql.SQLException

Commits all connections.

Throws:

java.sql.SQLException

getIntrospectionSchema

public java.lang.String getIntrospectionSchema()

Gets optional schema for database analysis.

Returns:

optional schema for database analysis

setIntrospectionSchema

public void setIntrospectionSchema(java.lang.String introspectionSchema)

Sets optional schema for database analysis.

Parameters:

introspectionSchema - optional schema for database analysis

getPassword

public java.lang.String getPassword()

Gets connection password (UI support)

setPassword

public void setPassword(java.lang.String password)

Sets connection password (UI support)

setCliArguments

public void setCliArguments(java.util.List<java.lang.String> args)

Sets CLI connection arguments (UI support)

getCliArguments

public java.util.List<java.lang.String> getCliArguments()

Gets CLI connection arguments (UI support)

getConnection

public java.sql.Connection getConnection()
                                  throws java.sql.SQLException

Gets the connection for the current thread.

Returns:

the connection for the current thread

Throws:

java.sql.SQLException

createNewConnection

public java.sql.Connection createNewConnection()
                                        throws java.sql.SQLException

Create a new connection. Must be closed from caller.

Returns:

a new connection

Throws:

java.sql.SQLException

getInlineViewStyle

public InlineViewStyle getInlineViewStyle()

Returns a suitable InlineViewStyle for this session.

Returns:

a suitable InlineViewStyle for this session or null, if no style is found

setSessionProperty

public void setSessionProperty(java.lang.Class<?> owner,
                               java.lang.String name,
                               java.lang.Object property)

Sets a session property.

Parameters:

owner - the class that owns the property

name - name of the property

property - value of the property

getSessionProperty

public java.lang.Object getSessionProperty(java.lang.Class<?> owner,
                                           java.lang.String name)

Gets a session property.

Parameters:

owner - the class that owns the property

name - name of the property

Returns:

value of the property

removeSessionProperties

public void removeSessionProperties(java.lang.Class<?> owner)

Removes all session properties.

Parameters:

owner - the class that owns the properties

checkQuery

public boolean checkQuery(java.lang.String sql)

Checks SQL query.

Parameters:

sql -

Returns:

true iff sql is executable without errors

setThreadSharesConnection

public static void setThreadSharesConnection()

setLogPrefix

public void setLogPrefix(java.lang.String logPrefix)

setGlobalFallbackConnection

public void setGlobalFallbackConnection()

resetGlobalFallbackConnection

public static void resetGlobalFallbackConnection()

isConnectionExclusive

public boolean isConnectionExclusive()

getConnectionStats

public java.lang.String getConnectionStats()