com.heirloomcomputing.epli.runtime

Class SqlContext

java.lang.Object

com.heirloomcomputing.epli.runtime.SqlContext

public class SqlContext
extends java.lang.Object

SQLContext is the SQL context in which a particular program instance is executing.

Author:

Heirloom Computing, Inc.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CAN_STORE_ERROR
static int	CAN_STORE_ERROR_MASK
static int	CAN_STORE_ERROR_NUMERIC_DECIMAL
static int	CAN_STORE_ERROR_NUMERIC_WHOLE
static int	CAN_STORE_ERROR_STRING
static int	CAN_STORE_OK
static int	CAN_STORE_WARNING
static int	CAN_STORE_WARNING_MASK
static int	CAN_STORE_WARNING_SPACES
static int	CAN_STORE_WARNING_TRUNCATION
static java.lang.String	CURRENT_SQL_CONNECTION_NAME
static java.lang.String	DEFAULT_SQL_CONNECTION_NAME
static boolean	implicitTransactions

Method Summary

Modifier and Type	Method and Description
void	beginTransaction() Begin a transaction on the current connection if implicit transactions are enabled.
void	commit()
void	commit(boolean closeCursors)
java.sql.Connection	connect(java.lang.String connectionName, java.lang.Object connectionRef, java.lang.String driverName, java.lang.Object username, java.lang.Object password, java.lang.Object namingContext) Establish and track java.sql.Connection object.
void	disconnect() Disconnect from the current connection.
void	disconnect(java.lang.Object connectionRef) Disconnect from the given object, either Connection or connection name.
void	disconnectAll() Disconnect from all managed connections.
java.sql.SQLWarning	executeImmediate(java.sql.Connection connection, java.lang.String command, java.lang.Object[] params)
java.sql.SQLWarning	executeImmediate(java.sql.Connection connection, java.lang.String command, java.lang.Object[] params, int resultSetType, int resultSetConcurrency)
java.sql.Connection	getConnection() Get the current connection.
java.sql.Connection	getConnection(java.lang.Object connectionName)
java.sql.Connection	getConnection(java.lang.Object transEnv, java.lang.String connectionName) Get the named connection from the transaction environment
java.sql.Connection	getConnection(java.lang.String name, boolean create) Get the current connection, creating the default one if possible when not already present and create is true.
SqlCursors	getCursors() getCursors - return the currently active cursors as SqlCursors
static SqlContext	getInstance()
java.lang.String	getPreparedStatement(java.lang.Object name) getPreparedStatement - return the SQL Prepared Statement previously save with putPreparedStatement
java.lang.Object	getPreparedStatementObject(java.lang.Object name) getPreparedStatementObject - return the SQL Prepared Statement Object previously save with putPreparedStatement
static boolean	isImplicitTransactions()
static void	log(java.sql.SQLException e) Log message.
static void	log(java.lang.String msg) Log message.
static void	log(java.lang.Throwable t) Log message.
static int	mapSqlCode(java.sql.SQLException e)
static java.lang.String	obtainSqlState(java.sql.SQLException e)
java.lang.Object	putPreparedStatement(java.lang.String name, java.lang.Object value) putPreparedStatement - save the prepared statement value under name
java.lang.Object	removePreparedStatement(java.lang.Object name) removePreparedStatement - remove a previously saved prepared statement
void	rollback()
void	rollback(boolean closeCursors)
java.sql.Connection	setConnection(java.lang.Object connectionRef) SET CONNECTION TO name SET CONNECTION TO object SET CONNECTION TO NULL
java.sql.Connection	setConnection(java.lang.String connectionName, java.lang.Object connectionRef)
void	setDriverLogMode(int value) Set by the compiler immediately before setting the connection.
static void	setExplicitTransactions()
static void	setImplicitTransactions()
void	setLogMode(int value) Set by the compiler immediately before setting the connection.
static void	setReconnectConnections(boolean disconnectReconnectConnections) setReconnectConnections [HCI ticket#2787 mnh 2017-02-23] Due to prior tickets, the ETP SQL execution world shares JDBC Connections with the COBOL world (in case an ETP transaction contains COBOL programs that were not compiled with -out:transaction but still perform EXEC SQL).

Methods inherited from class java.lang.Object

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

Field Detail

CAN_STORE_OK

public static final int CAN_STORE_OK

See Also:

Constant Field Values

CAN_STORE_WARNING_SPACES

public static final int CAN_STORE_WARNING_SPACES

See Also:

Constant Field Values

CAN_STORE_WARNING_TRUNCATION

public static final int CAN_STORE_WARNING_TRUNCATION

See Also:

Constant Field Values

CAN_STORE_ERROR_NUMERIC_DECIMAL

public static final int CAN_STORE_ERROR_NUMERIC_DECIMAL

See Also:

Constant Field Values

CAN_STORE_ERROR_NUMERIC_WHOLE

public static final int CAN_STORE_ERROR_NUMERIC_WHOLE

See Also:

Constant Field Values

CAN_STORE_ERROR_STRING

public static final int CAN_STORE_ERROR_STRING

See Also:

Constant Field Values

CAN_STORE_WARNING

public static final int CAN_STORE_WARNING

See Also:

Constant Field Values

CAN_STORE_ERROR

public static final int CAN_STORE_ERROR

See Also:

Constant Field Values

CAN_STORE_WARNING_MASK

public static final int CAN_STORE_WARNING_MASK

See Also:

Constant Field Values

CAN_STORE_ERROR_MASK

public static final int CAN_STORE_ERROR_MASK

See Also:

Constant Field Values

CURRENT_SQL_CONNECTION_NAME

public static java.lang.String CURRENT_SQL_CONNECTION_NAME

DEFAULT_SQL_CONNECTION_NAME

public static final java.lang.String DEFAULT_SQL_CONNECTION_NAME

See Also:

Constant Field Values

implicitTransactions

public static boolean implicitTransactions

Method Detail

getInstance

public static SqlContext getInstance()

setLogMode

public void setLogMode(int value)

Set by the compiler immediately before setting the connection. This can be used by the other SQL modules to know whether or not logging should be done from the runtime.

Parameters:

value - - the log mode to set

setDriverLogMode

public void setDriverLogMode(int value)

Set by the compiler immediately before setting the connection. (Currently only set to enable, not to disable.)

Parameters:

value - - the driver log mode to set

getCursors

public SqlCursors getCursors()

getCursors - return the currently active cursors as SqlCursors

Returns:

the SqlCursors that are active

putPreparedStatement

public java.lang.Object putPreparedStatement(java.lang.String name,
                                             java.lang.Object value)

putPreparedStatement - save the prepared statement value under name

Parameters:

name - - the name of this prepared statement

value - - the SQL Prepared Statement object to save

Returns:

the prior value under this name, or null if there was none

getPreparedStatementObject

public java.lang.Object getPreparedStatementObject(java.lang.Object name)

getPreparedStatementObject - return the SQL Prepared Statement Object previously save with putPreparedStatement

Parameters:

name - - the name of the parepared statement

Returns:

the SQL Prepared Statement object previously saved under name, or null if no statement by that name was saved

getPreparedStatement

public java.lang.String getPreparedStatement(java.lang.Object name)

getPreparedStatement - return the SQL Prepared Statement previously save with putPreparedStatement

Parameters:

name - - the name of the prepared statement

Returns:

the SQL Prepared Statement previously saved under name, or null if no statement by that name was saved

removePreparedStatement

public java.lang.Object removePreparedStatement(java.lang.Object name)

removePreparedStatement - remove a previously saved prepared statement

Parameters:

name - - the name of the prepared statement to remove

Returns:

the value returned by a Hashtable.remove() operation

beginTransaction

public final void beginTransaction()
                            throws java.sql.SQLException

Begin a transaction on the current connection if implicit transactions are enabled.

Throws:

java.sql.SQLException

disconnect

public final void disconnect()
                      throws java.sql.SQLException

Disconnect from the current connection.

Throws:

java.sql.SQLException

disconnect

public final void disconnect(java.lang.Object connectionRef)
                      throws java.sql.SQLException

Disconnect from the given object, either Connection or connection name.

Throws:

java.sql.SQLException

disconnectAll

public final void disconnectAll()
                         throws java.sql.SQLException

Disconnect from all managed connections.

Throws:

java.sql.SQLException

getConnection

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

Get the current connection.

Returns:

current connection

Throws:

java.sql.SQLException

getConnection

public final java.sql.Connection getConnection(java.lang.String name,
                                               boolean create)
                                        throws java.sql.SQLException

Get the current connection, creating the default one if possible when not already present and create is true.

Parameters:

create - allow creation of a default connection

Returns:

current connection

Throws:

java.sql.SQLException

getConnection

public final java.sql.Connection getConnection(java.lang.Object connectionName)
                                        throws java.sql.SQLException

Throws:

java.sql.SQLException

getConnection

public final java.sql.Connection getConnection(java.lang.Object transEnv,
                                               java.lang.String connectionName)
                                        throws java.sql.SQLException

Get the named connection from the transaction environment

Returns:

current connection

Throws:

java.sql.SQLException

setConnection

public final java.sql.Connection setConnection(java.lang.Object connectionRef)
                                        throws java.sql.SQLException

SET CONNECTION TO name SET CONNECTION TO object SET CONNECTION TO NULL

Throws:

java.sql.SQLException

setConnection

public final java.sql.Connection setConnection(java.lang.String connectionName,
                                               java.lang.Object connectionRef)
                                        throws java.sql.SQLException

Throws:

java.sql.SQLException

connect

public java.sql.Connection connect(java.lang.String connectionName,
                                   java.lang.Object connectionRef,
                                   java.lang.String driverName,
                                   java.lang.Object username,
                                   java.lang.Object password,
                                   java.lang.Object namingContext)
                            throws java.sql.SQLException

Establish and track java.sql.Connection object.

Throws:

java.sql.SQLException

setExplicitTransactions

public static final void setExplicitTransactions()

setImplicitTransactions

public static final void setImplicitTransactions()

isImplicitTransactions

public static final boolean isImplicitTransactions()

commit

public final void commit()
                  throws java.sql.SQLException

Throws:

java.sql.SQLException

commit

public final void commit(boolean closeCursors)
                  throws java.sql.SQLException

Throws:

java.sql.SQLException

rollback

public final void rollback()
                    throws java.sql.SQLException

Throws:

java.sql.SQLException

rollback

public final void rollback(boolean closeCursors)
                    throws java.sql.SQLException

Throws:

java.sql.SQLException

log

public static final void log(java.lang.String msg)

Log message. This method _always_ logs, so any checking for log enabled/disabled must occur before calling this method.

Parameters:

msg -

log

public static final void log(java.lang.Throwable t)

Log message. This method _always_ logs, so any checking for log enabled/disabled must occur before calling this method.

Parameters:

t -

log

public static final void log(java.sql.SQLException e)

Log message. This method _always_ logs, so any checking for log enabled/disabled must occur before calling this method.

Parameters:

e -

obtainSqlState

public static final java.lang.String obtainSqlState(java.sql.SQLException e)

mapSqlCode

public static final int mapSqlCode(java.sql.SQLException e)

executeImmediate

public java.sql.SQLWarning executeImmediate(java.sql.Connection connection,
                                            java.lang.String command,
                                            java.lang.Object[] params)
                                     throws java.sql.SQLException

Throws:

java.sql.SQLException

executeImmediate

public java.sql.SQLWarning executeImmediate(java.sql.Connection connection,
                                            java.lang.String command,
                                            java.lang.Object[] params,
                                            int resultSetType,
                                            int resultSetConcurrency)
                                     throws java.sql.SQLException

Throws:

java.sql.SQLException

setReconnectConnections

public static void setReconnectConnections(boolean disconnectReconnectConnections)

setReconnectConnections [HCI ticket#2787 mnh 2017-02-23] Due to prior tickets, the ETP SQL execution world shares JDBC Connections with the COBOL world (in case an ETP transaction contains COBOL programs that were not compiled with -out:transaction but still perform EXEC SQL). tell the COBOL world the result of this ETP world disconnect/reconnect setting so during program exit() processing the SQLContext won't disconnectAll().

Parameters:

disconnectReconnectConnections - - true, disconnect JDBC Connections upon program exit; false, re-use those connections and don't disconnect them.