net.sf.jailer.database

Class Session

java.lang.Object

net.sf.jailer.database.Session

public class Session
extends 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.ResultSetReader Reads a JDBC-result-set.

Field Summary

Fields

Modifier and Type	Field and Description
static Logger	_log The logger.
DBMS	dbms The DBMS.
String	dbUrl The dbUrl (null if unknown)
boolean	local
WorkingTableScope	scope Scope of temporary tables.

Constructor Summary

Constructors

Constructor and Description
Session(DataSource dataSource, DBMS dbms) Constructor.
Session(DataSource dataSource, DBMS dbms, WorkingTableScope scope, boolean transactional) Constructor.
Session(DataSource dataSource, DBMS dbms, WorkingTableScope scope, boolean transactional, boolean local) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static void	closeTemporaryTableSession() Closes the session in which temporary tables lives, if any.
void	commitAll() Commits all connections.
void	enableAutomaticReconnect()
long	execute(String sql) Executes a SQL-Statement without returning any result.
void	executeQuery(File sqlFile, Session.ResultSetReader reader) Executes a SQL-Query (SELECT).
long	executeQuery(String sqlQuery, Session.ResultSetReader reader) Executes a SQL-Query (SELECT).
long	executeQuery(String sqlQuery, Session.ResultSetReader reader, String alternativeSQL, Object context, int limit) Executes a SQL-Query (SELECT).
long	executeQuery(String sqlQuery, Session.ResultSetReader reader, String alternativeSQL, Object context, int limit, int timeout) Executes a SQL-Query (SELECT) with timeout.
int	executeUpdate(String sqlUpdate) Executes a SQL-Update (INSERT, DELETE or UPDATE).
int	executeUpdate(String sqlUpdate, Object[] parameter) Executes a SQL-Update (INSERT, DELETE or UPDATE) with parameters.
List<String>	getCliArguments() Gets CLI connection arguments (UI support)
Connection	getConnection() Gets the connection for the current thread.
InlineViewStyle	getInlineViewStyle() Returns a suitable InlineViewStyle for this session.
String	getIntrospectionSchema() Gets optional schema for database analysis.
DatabaseMetaData	getMetaData() Gets DB meta data.
String	getPassword() Gets connection password (UI support)
String	getSchema() Gets DB schema name.
Object	getSessionProperty(Class<?> owner, String name) Gets a session property.
boolean	getSilent() No SQL-Exceptions will be logged in silent mode.
void	insertBlob(String table, String column, String where, File lobFile) Inserts a BLob.
void	insertClob(String table, String column, String where, File lobFile, long length) Inserts a CLob.
void	insertSQLXML(String table, String column, String where, File lobFile, long length) Inserts a SQL-XML.
void	reconnect() Closes current connection and opens a new one.
void	rollbackAll() Rolls back and closes all connections.
void	setCliArguments(List<String> args) Sets CLI connection arguments (UI support)
void	setIntrospectionSchema(String introspectionSchema) Sets optional schema for database analysis.
void	setPassword(String password) Sets connection password (UI support)
void	setSessionProperty(Class<?> owner, String name, Object property) Sets a session property.
void	setSilent(boolean silent) No SQL-Exceptions will be logged in silent mode.
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

scope

public final WorkingTableScope scope

Scope of temporary tables.

local

public final boolean local

_log

public static final Logger _log

The logger.

dbms

public final DBMS dbms

The DBMS.

dbUrl

public final String dbUrl

The dbUrl (null if unknown)

Constructor Detail

Session

public Session(DataSource dataSource,
       DBMS dbms)
        throws SQLException

Constructor.

Parameters:

dataSource - the data source

schema - the schema

dbms - the DBMS

Throws:

SQLException

Session

public Session(DataSource dataSource,
       DBMS dbms,
       WorkingTableScope scope,
       boolean transactional)
        throws SQLException

Constructor.

Parameters:

dataSource - the data source

dbms - the DBMS

Throws:

SQLException

Session

public Session(DataSource dataSource,
       DBMS dbms,
       WorkingTableScope scope,
       boolean transactional,
       boolean local)
        throws SQLException

Constructor.

Parameters:

dataSource - the data source

dbms - the DBMS

local - true for the local entity-graph database

Throws:

SQLException

Method Detail

reconnect

public void reconnect()
               throws SQLException

Closes current connection and opens a new one.

Throws:

SQLException

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

getSchema

public String getSchema()

Gets DB schema name.

Returns:

DB schema name (empty string if unknown)

executeQuery

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

Executes a SQL-Query (SELECT).

Parameters:

sqlQuery - the query in SQL

reader - the reader for the result

Throws:

SQLException

executeQuery

public long executeQuery(String sqlQuery,
                Session.ResultSetReader reader,
                String alternativeSQL,
                Object context,
                int limit)
                  throws 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

limit - row limit, 0 for unlimited

context - cancellation context

Throws:

SQLException

executeQuery

public long executeQuery(String sqlQuery,
                Session.ResultSetReader reader,
                String alternativeSQL,
                Object context,
                int limit,
                int timeout)
                  throws 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

Throws:

SQLException

executeQuery

public void executeQuery(File sqlFile,
                Session.ResultSetReader reader)
                  throws SQLException

Executes a SQL-Query (SELECT).

Parameters:

sqlFile - file containing a query in SQL

reader - the reader for the result

Throws:

SQLException

executeUpdate

public int executeUpdate(String sqlUpdate)
                  throws SQLException

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

Parameters:

sqlUpdate - the update in SQL

Returns:

update-count

Throws:

SQLException

executeUpdate

public int executeUpdate(String sqlUpdate,
                Object[] parameter)
                  throws SQLException

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

Parameters:

sqlUpdate - the update in SQL

parameter - the parameters

Returns:

update-count

Throws:

SQLException

insertClob

public void insertClob(String table,
              String column,
              String where,
              File lobFile,
              long length)
                throws SQLException,
                       IOException

Inserts a CLob.

Throws:

SQLException

IOException

insertSQLXML

public void insertSQLXML(String table,
                String column,
                String where,
                File lobFile,
                long length)
                  throws SQLException,
                         IOException

Inserts a SQL-XML.

Throws:

SQLException

IOException

insertBlob

public void insertBlob(String table,
              String column,
              String where,
              File lobFile)
                throws SQLException,
                       IOException

Inserts a BLob.

Throws:

SQLException

IOException

execute

public long execute(String sql)
             throws SQLException

Executes a SQL-Statement without returning any result.

Parameters:

sql - the SQL-Statement

Throws:

SQLException

getMetaData

public DatabaseMetaData getMetaData()
                             throws SQLException

Gets DB meta data.

Returns:

DB meta data

Throws:

SQLException

shutDown

public void shutDown()
              throws SQLException

Closes all connections.

Throws:

SQLException

rollbackAll

public void rollbackAll()
                 throws SQLException

Rolls back and closes all connections.

Throws:

SQLException

commitAll

public void commitAll()
               throws SQLException

Commits all connections.

Throws:

SQLException

getIntrospectionSchema

public String getIntrospectionSchema()

Gets optional schema for database analysis.

Returns:

optional schema for database analysis

setIntrospectionSchema

public void setIntrospectionSchema(String introspectionSchema)

Sets optional schema for database analysis.

Parameters:

introspectionSchema - optional schema for database analysis

closeTemporaryTableSession

public static void closeTemporaryTableSession()

Closes the session in which temporary tables lives, if any.

getPassword

public String getPassword()

Gets connection password (UI support)

setPassword

public void setPassword(String password)

Sets connection password (UI support)

setCliArguments

public void setCliArguments(List<String> args)

Sets CLI connection arguments (UI support)

getCliArguments

public List<String> getCliArguments()

Gets CLI connection arguments (UI support)

getConnection

public Connection getConnection()
                         throws SQLException

Gets the connection for the current thread.

Returns:

the connection for the current thread

Throws:

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(Class<?> owner,
                      String name,
                      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 Object getSessionProperty(Class<?> owner,
                        String name)

Gets a session property.

Parameters:

owner - the class that owns the property

name - name of the property

Returns:

value of the property

enableAutomaticReconnect

public void enableAutomaticReconnect()