Awake SQL v1.2.1

org.awakefw.sql.api.client
Class AwakeConnection

java.lang.Object
  extended by org.awakefw.sql.api.client.AwakeConnection
All Implemented Interfaces:
Connection, Wrapper

public final class AwakeConnection
extends Object
implements Connection

Provides a Connection implementation that enable to use a virtual JDBC Connection that is mapped to a Server JDBC Connection in order to access a remote SQL database through HTTP.

This Connection implementation supports:

Supplementary specific methods that are not of instance of Connection are also added. After creating the AwakeConnection, just use it like a regular Connection to execute your PreparedStatement and Statement, and to navigate through your ResultSet.

All thrown exceptions are of type SQLException. Use Throwable.getCause() to get the original wrapped Exception.
If an Exception is thrown by the Awake Server, the original Exception will be a RemoteException. The cause will be available with Throwable.getCause() and the remote stack trace as a string available with RemoteException.getRemoteStackTrace()

The SQL Exceptions specific to an Awake failure all start with the "[AWAKE FAILURE]" string.

Example:

 // Define URL of the path to the AwakeSqlManager Servlet
 // We will use a secure SSL/TLS session. All uploads/downloads of SQL
 // data will be encrypted.
 String url = "https://www.acme.org/AwakeSqlManager";
  
 // The login info for strong authentication on server side:
 String username = "myUsername";
 char[] password = { 'm', 'y', 'P', 'a', 's', 's', 'w', 'o', 'r', 'd' };
  
 // Create the JDBC Connection to the remote database:
 Connection connection = new AwakeConnection(url, username, password);
  
 // We can now use our Remote JDBC Connection as a regular JDBC Connection
 // for our queries and updates:
  
 String sql = "SELECT CUSTOMER_ID, FNAME, LNAME FROM CUSTOMER WHERE CUSTOMER_ID = ?";
 PreparedStatement prepStatement = connection.prepareStatement(sql);
 prepStatement.setInt(1, 1);
  
 ResultSet rs = prepStatement.executeQuery();
  
 while (rs.next()) {
     String customerId = rs.getString("customer_id");
     String fname = rs.getString("fname");
     String lname = rs.getString("lname");
  
     System.out.println("customer_id: " + customerId);
     System.out.println("fname      : " + fname);
     System.out.println("lname      : " + lname);
     // Etc.
 }
 

Communication via an (authenticating) proxy server is done using a HttpProxy instance:

 // Define the http proxy to use:
 HttpProxy httpProxy = new HttpProxy("myproxyhost", 8080);
  
 // Create the JDBC Connection to the remote database using a proxy:
 Connection connection = new AwakeConnection(url, username,
        password.toCharArray(), httpProxy);
  
 // Etc.
 

The following dedicated AwakeConnection methods are not implemented in java.sql.Connection:


All long Blobs update/reading that need to be run on a separated thread may be followed in Swing using a JProgressBar or ProgressMonitor:

Example:
  // Create a default AwakeProgressManager
  AwakeProgressManager awakeProgressManager = new DefaultAwakeProgressManager();
   
  // Pass it to our Connection
  ((AwakeConnection)connection).setAwakeProgressManager(awakeProgressManager);
  
See the source code of AwakeSqlProgressMonitorDemo.java that demonstrates the use of an AwakeProgressManager when inserting a Blob.

Since:
1.0

Field Summary
 
Fields inherited from interface java.sql.Connection
TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE
 
Constructor Summary
AwakeConnection(String url, String username, char[] password)
          Creates a remote Connection.
AwakeConnection(String url, String username, char[] password, HttpProxy httpProxy)
          Creates a remote Connection with a proxy.
AwakeConnection(String url, String username, char[] password, HttpProxy httpProxy, HttpProtocolParameters httpProtocolParameters)
          Creates a remote Connection with a proxy and http protocol parameters.
 
Method Summary
 void abort(Executor executor)
          Method not implemented in Awake SQL v1.0.
 void clearWarnings()
          Does nothing in Awake SQL v1.0.
 Connection clone()
          Allows to get a copy of the current AwakeConnection: use it to do some simultaneous operations in a different thread (in order to avoid conflicts).
 void close()
          Releases this Connection object's database and JDBC resources immediately instead of waiting for them to be automatically released.
 void commit()
          Makes all changes made since the previous commit/rollback permanent and releases any database locks currently held by this Connection object.
 Array createArrayOf(String typeName, Object[] elements)
          Method not implemented in Awake SQL v1.0.
 Blob createBlob()
          Method not implemented in Awake SQL v1.0.
 Clob createClob()
          Method not implemented in Awake SQL v1.0.
 NClob createNClob()
          Method not implemented in Awake SQL v1.0.
 SQLXML createSQLXML()
          Method not implemented in Awake SQL v1.0.
 Statement createStatement()
          Creates a Statement object for sending SQL statements to the database.
 Statement createStatement(int resultSetType, int resultSetConcurrency)
          Creates a Statement object that will generate ResultSet objects with the given type and concurrency.
 Statement createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability)
          Creates a Statement object that will generate ResultSet objects with the given type, concurrency, and holdability.
 Struct createStruct(String typeName, Object[] attributes)
          Method not implemented in Awake SQL v1.0.
 boolean getAutoCommit()
          Retrieves the current auto-commit mode for this Connection object.
 AwakeFileSession getAwakeFileSession()
          Gets the current AwakeFileSession instance (used for file transfers of Clobs and Blobs).
 AwakeProgressManager getAwakeProgressManager()
          Returns the AwakeProgresManager in use.
 String getCatalog()
          Retrieves this Connection object's current catalog name.
 Properties getClientInfo()
          Method not implemented in Awake SQL v1.0.
 String getClientInfo(String name)
          Method not implemented in Awake SQL v1.0.
 int getHoldability()
          Retrieves the current holdability of ResultSet objects created using this Connection object.
 HttpProtocolParameters getHttpProtocolParameters()
          Returns the HttpProtocolParameters instance in use for the Awake SQL session.
 HttpProxy getHttpProxy()
          Returns the AwakeProgresManager in use.
 int getHttpStatusCode()
          Returns the http status code of the last executed JDBC command that called the remote Awake SQL Manager.
 int getMaxStatementsForMemoryTransport()
          Returns the maximum Number Of Statements that may be transported in memory.
 DatabaseMetaData getMetaData()
          Retrieves a DatabaseMetaData object that contains metadata about the database to which this Connection object represents a connection.
 int getNetworkTimeout()
          Method not implemented in Awake SQL v1.0.
 String getSchema()
          Method not implemented in Awake SQL v1.0.
 int getTransactionIsolation()
          Retrieves this Connection object's current transaction isolation level.
 Map<String,Class<?>> getTypeMap()
          Method not implemented in Awake SQL v1.0.
 String getUrl()
          Returns the URL of the path to the AwakeSqlManager Servlet.
 String getUsername()
          Returns the username in use.
 String getVersion()
          Returns the current Awake SQL Version.
 SQLWarning getWarnings()
          Returns null in Awake SQL v1.0.
 boolean isClosed()
          Retrieves whether this Connection object has been closed.
 boolean isEncryptStatementParameters()
          Returns true if the statement are to be encrypted.
 boolean isReadOnly()
          Retrieves whether this Connection object is in read-only mode.
 boolean isValid(int timeout)
          Method not implemented in Awake SQL v1.0.
 boolean isWrapperFor(Class<?> iface)
          Method not implemented in Awake SQL v1.0.
 String nativeSQL(String sql)
          Method not implemented in Awake SQL v1.0.
 CallableStatement prepareCall(String sql)
          Method not implemented in Awake SQL v1.0.
 CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency)
          Method not implemented in Awake SQL v1.0.
 CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
          Method not implemented in Awake SQL v1.0.
 PreparedStatement prepareStatement(String sql)
          Creates a PreparedStatement object for sending parameterized SQL statements to the database.
 PreparedStatement prepareStatement(String sql, int autoGeneratedKeys)
          Creates a default PreparedStatement object that has the capability to retrieve auto-generated keys.
 PreparedStatement prepareStatement(String sql, int[] columnIndexes)
          Method not implemented in Awake SQL v1.0.
 PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency)
          Creates a PreparedStatement object that will generate ResultSet objects with the given type and concurrency.
 PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
          Creates a PreparedStatement object that will generate ResultSet objects with the given type, concurrency, and holdability.
 PreparedStatement prepareStatement(String sql, String[] columnNames)
          Method not implemented in Awake SQL v1.0.
 void releaseSavepoint(Savepoint savepoint)
          Method not implemented in Awake SQL v1.0.
 void rollback()
          Undoes all changes made in the current transaction and releases any database locks currently held by this Connection object.
 void rollback(Savepoint savepoint)
          Method not implemented in Awake SQL v1.0.
 void setAutoCommit(boolean autoCommit)
          Sets this connection's auto-commit mode to the given state.
 void setAwakeProgressManager(AwakeProgressManager awakeProgressManager)
          Allows to specify an AwakeProgresManager to use.
 void setCatalog(String catalog)
          Sets the given catalog name in order to select a subspace of this Connection object's database in which to work.
 void setClientInfo(Properties properties)
          Method not implemented in Awake SQL v1.0.
 void setClientInfo(String name, String value)
          Method not implemented in Awake SQL v1.0.
 void setEncryptStatementParameters(boolean encryptStatementParameters)
          Set if the statement parameters are to be encrypted
 void setHoldability(int holdability)
          Changes the default holdability of ResultSet objects created using this Connection object to the given holdability.
 void setMaxStatementsForMemoryTransport(int maxStatementsForMemoryTransport)
          Sets the maximum Number Of Statements that may be transported in memory from client to server. if maximum is reached, transport is done using a file.
 void setNetworkTimeout(Executor executor, int milliseconds)
          Method not implemented in Awake SQL v1.0.
 void setReadOnly(boolean readOnly)
          Puts this connection in read-only mode as a hint to the driver to enable database optimizations.
 Savepoint setSavepoint()
          Method not implemented in Awake SQL v1.0.
 Savepoint setSavepoint(String name)
          Method not implemented in Awake SQL v1.0.
 void setSchema(String schema)
          Method not implemented in Awake SQL v1.0.
 void setTransactionIsolation(int level)
          Attempts to change the transaction isolation level for this Connection object to the one given.
 void setTypeMap(Map<String,Class<?>> map)
          Method not implemented in Awake SQL v1.0.
<T> T
unwrap(Class<T> iface)
          Method not implemented in Awake SQL v1.0.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AwakeConnection

public AwakeConnection(String url,
                       String username,
                       char[] password)
                throws SQLException
Creates a remote Connection.

Parameters:
url - the URL of the path to the AwakeSqlManager Servlet
username - the user username for authentication
password - the authentication password
Throws:
SQLException - if any Exception occurs. The SQLException wraps the original Exception that may be accessed using getCause()

AwakeConnection

public AwakeConnection(String url,
                       String username,
                       char[] password,
                       HttpProxy httpProxy)
                throws SQLException
Creates a remote Connection with a proxy.

Parameters:
url - the URL of the path to the AwakeSqlManager Servlet
username - the user username for authentication
password - the authentication password
httpProxy - the proxy parameters (maybe null if none)
Throws:
SQLException - if any Exception occurs. The SQLException wraps the original Exception that may be accessed using getCause()

AwakeConnection

public AwakeConnection(String url,
                       String username,
                       char[] password,
                       HttpProxy httpProxy,
                       HttpProtocolParameters httpProtocolParameters)
                throws SQLException
Creates a remote Connection with a proxy and http protocol parameters.

Parameters:
url - the URL of the path to the AwakeSqlManager Servlet
username - the user username for authentication
password - the authentication password
httpProxy - the proxy parameters (maybe null if none)
Throws:
IllegalArgumentException - if url, username, password is null
SQLException - if any Exception occurs. The SQLException wraps the original Exception that may be accessed using getCause()
Method Detail

abort

public void abort(Executor executor)
           throws SQLException
Method not implemented in Awake SQL v1.0.

Terminates an open connection. Calling abort results in:

Calling abort marks the connection closed and releases any resources. Calling abort on a closed connection is a no-op.

It is possible that the aborting and releasing of the resources that are held by the connection can take an extended period of time. When the abort method returns, the connection will have been marked as closed and the Executor that was passed as a parameter to abort may still be executing tasks to release resources.

This method checks to see that there is an SQLPermission object before allowing the method to proceed. If a SecurityManager exists and its checkPermission method denies calling abort, this method throws a java.lang.SecurityException.

Parameters:
executor - The Executor implementation which will be used by abort.
Throws:
SQLException - if a database access error occurs or the executor is null,
SecurityException - if a security manager exists and its checkPermission method denies calling abort
Since:
1.7
See Also:
SecurityManager.checkPermission(java.security.Permission), Executor

clearWarnings

public void clearWarnings()
                   throws SQLException
Does nothing in Awake SQL v1.0.

Specified by:
clearWarnings in interface Connection
Throws:
SQLException - if a database access error occurs

clone

public Connection clone()
Allows to get a copy of the current AwakeConnection: use it to do some simultaneous operations in a different thread (in order to avoid conflicts).

Overrides:
clone in class Object

close

public void close()
           throws SQLException
Releases this Connection object's database and JDBC resources immediately instead of waiting for them to be automatically released.

Calling the method close on a Connection object that is already closed is a no-op.

Note: A Connection object is automatically closed when it is garbage collected. Certain fatal errors also close a Connection object.

Specified by:
close in interface Connection
Throws:
SQLException - if a database access error occurs

commit

public void commit()
            throws SQLException
Makes all changes made since the previous commit/rollback permanent and releases any database locks currently held by this Connection object. This method should be used only when auto-commit mode has been disabled.

Specified by:
commit in interface Connection
Throws:
SQLException - if a database access error occurs or this Connection object is in auto-commit mode
See Also:
setAutoCommit(boolean)

createArrayOf

public Array createArrayOf(String typeName,
                           Object[] elements)
                    throws SQLException
Method not implemented in Awake SQL v1.0.

Factory method for creating Array objects.

Note: When createArrayOf is used to create an array object that maps to a primitive data type, then it is implementation-defined whether the Array object is an array of that primitive data type or an array of Object.

Note: The JDBC driver is responsible for mapping the elements Object array to the default JDBC SQL type defined in java.sql.Types for the given class of Object. The default mapping is specified in Appendix B of the JDBC specification. If the resulting JDBC type is not the appropriate type for the given typeName then it is implementation defined whether an SQLException is thrown or the driver supports the resulting conversion.

Specified by:
createArrayOf in interface Connection
Parameters:
typeName - the SQL name of the type the elements of the array map to. The typeName is a database-specific name which may be the name of a built-in type, a user-defined type or a standard SQL type supported by this database. This is the value returned by Array.getBaseTypeName
elements - the elements that populate the returned object
Returns:
an Array object whose elements map to the specified SQL type
Throws:
SQLException - if a database error occurs, the JDBC type is not appropriate for the typeName and the conversion is not supported, the typeName is null or this method is called on a closed connection
SQLFeatureNotSupportedException - if the JDBC driver does not support this data type
Since:
1.6

createBlob

public Blob createBlob()
                throws SQLException
Method not implemented in Awake SQL v1.0.

Constructs an object that implements the Blob interface. The object returned initially contains no data. The setBinaryStream and setBytes methods of the Blob interface may be used to add data to the Blob.

Specified by:
createBlob in interface Connection
Returns:
An object that implements the Blob interface
Throws:
SQLException - if an object that implements the Blob interface can not be constructed, this method is called on a closed connection or a database access error occurs.
SQLFeatureNotSupportedException - if the JDBC driver does not support this data type
Since:
1.6

createClob

public Clob createClob()
                throws SQLException
Method not implemented in Awake SQL v1.0.

Constructs an object that implements the Clob interface. The object returned initially contains no data. The setAsciiStream, setCharacterStream and setString methods of the Clob interface may be used to add data to the Clob.

Specified by:
createClob in interface Connection
Returns:
An object that implements the Clob interface
Throws:
SQLException - if an object that implements the Clob interface can not be constructed, this method is called on a closed connection or a database access error occurs.
SQLFeatureNotSupportedException - if the JDBC driver does not support this data type
Since:
1.6

createNClob

public NClob createNClob()
                  throws SQLException
Method not implemented in Awake SQL v1.0.

Constructs an object that implements the NClob interface.The object returned initially contains no data. The setAsciiStream, setCharacterStream and setString methods of the NClob interface may be used to add data to the NClob.

Specified by:
createNClob in interface Connection
Returns:
An object that implements the NClob interface
Throws:
SQLException - if an object that implements the NClob interface can not be constructed, this method is called on a closed connection or a database access error occurs.
SQLFeatureNotSupportedException - if the JDBC driver does not support this data type
Since:
1.6

createSQLXML

public SQLXML createSQLXML()
                    throws SQLException
Method not implemented in Awake SQL v1.0.

Constructs an object that implements the SQLXML interface. The object returned initially contains no data. The createXmlStreamWriter object and setString method of the SQLXML interface may be used to add data to the SQLXML object.

Specified by:
createSQLXML in interface Connection
Returns:
An object that implements the SQLXML interface
Throws:
SQLException - if an object that implements the SQLXML interface can not be constructed, this method is called on a closed connection or a database access error occurs.
SQLFeatureNotSupportedException - if the JDBC driver does not support this data type
Since:
1.6

createStatement

public Statement createStatement()
                          throws SQLException
Creates a Statement object for sending SQL statements to the database. SQL statements without parameters are normally executed using Statement objects. If the same SQL statement is executed many times, it may be more efficient to use a PreparedStatement object.

Result sets created using the returned Statement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY.

Specified by:
createStatement in interface Connection
Returns:
a new default Statement object
Throws:
SQLException - if a database access error occurs

createStatement

public Statement createStatement(int resultSetType,
                                 int resultSetConcurrency)
                          throws SQLException
Creates a Statement object that will generate ResultSet objects with the given type and concurrency. This method is the same as the createStatement method above, but it allows the default result set type and concurrency to be overridden. The holdability of the created result sets can be determined by calling getHoldability().

Specified by:
createStatement in interface Connection
Parameters:
resultSetType - a result set type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency - a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
Returns:
a new Statement object that will generate ResultSet objects with the given type and concurrency
Throws:
SQLException - if a database access error occurs, this method is called on a closed connection or the given parameters are not ResultSet constants indicating type and concurrency
SQLFeatureNotSupportedException - if the JDBC driver does not support this method or this method is not supported for the specified result set type and result set concurrency.
Since:
1.2

createStatement

public Statement createStatement(int resultSetType,
                                 int resultSetConcurrency,
                                 int resultSetHoldability)
                          throws SQLException
Creates a Statement object that will generate ResultSet objects with the given type, concurrency, and holdability. This method is the same as the createStatement method above, but it allows the default result set type, concurrency, and holdability to be overridden.

Specified by:
createStatement in interface Connection
Parameters:
resultSetType - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency - one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
resultSetHoldability - one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
Returns:
a new Statement object that will generate ResultSet objects with the given type, concurrency, and holdability
Throws:
SQLException - if a database access error occurs, this method is called on a closed connection or the given parameters are not ResultSet constants indicating type, concurrency, and holdability
SQLFeatureNotSupportedException - if the JDBC driver does not support this method or this method is not supported for the specified result set type, result set holdability and result set concurrency.
Since:
1.4
See Also:
ResultSet

createStruct

public Struct createStruct(String typeName,
                           Object[] attributes)
                    throws SQLException
Method not implemented in Awake SQL v1.0.

Factory method for creating Struct objects.

Specified by:
createStruct in interface Connection
Parameters:
typeName - the SQL type name of the SQL structured type that this Struct object maps to. The typeName is the name of a user-defined type that has been defined for this database. It is the value returned by Struct.getSQLTypeName.
attributes - the attributes that populate the returned object
Returns:
a Struct object that maps to the given SQL type and is populated with the given attributes
Throws:
SQLException - if a database error occurs, the typeName is null or this method is called on a closed connection
SQLFeatureNotSupportedException - if the JDBC driver does not support this data type
Since:
1.6

getAutoCommit

public boolean getAutoCommit()
                      throws SQLException
Retrieves the current auto-commit mode for this Connection object.

Specified by:
getAutoCommit in interface Connection
Returns:
the current state of this Connection object's auto-commit mode
Throws:
SQLException - if a database access error occurs
See Also:
setAutoCommit(boolean)

getAwakeFileSession

public AwakeFileSession getAwakeFileSession()
Gets the current AwakeFileSession instance (used for file transfers of Clobs and Blobs).

Returns:
the awakeFileSession instance (to be used for file transfers, per example)

getAwakeProgressManager

public AwakeProgressManager getAwakeProgressManager()
Returns the AwakeProgresManager in use.

Returns:
the AwakeProgresManager in use

getCatalog

public String getCatalog()
                  throws SQLException
Retrieves this Connection object's current catalog name.

Specified by:
getCatalog in interface Connection
Returns:
the current catalog name or null if there is none
Throws:
SQLException - if a database access error occurs
See Also:
setCatalog(java.lang.String)

getClientInfo

public Properties getClientInfo()
                         throws SQLException
Method not implemented in Awake SQL v1.0.

Returns a list containing the name and current value of each client info property supported by the driver. The value of a client info property may be null if the property has not been set and does not have a default value.

Specified by:
getClientInfo in interface Connection
Returns:
A Properties object that contains the name and current value of each of the client info properties supported by the driver.

Throws:
SQLException - if the database server returns an error when fetching the client info values from the database or this method is called on a closed connection

Since:
1.6

getClientInfo

public String getClientInfo(String name)
                     throws SQLException
Method not implemented in Awake SQL v1.0.

Returns the value of the client info property specified by name. This method may return null if the specified client info property has not been set and does not have a default value. This method will also return null if the specified client info property name is not supported by the driver.

Applications may use the DatabaseMetaData.getClientInfoProperties method to determine the client info properties supported by the driver.

Specified by:
getClientInfo in interface Connection
Parameters:
name - The name of the client info property to retrieve

Returns:
The value of the client info property specified

Throws:
SQLException - if the database server returns an error when fetching the client info value from the database or this method is called on a closed connection

Since:
1.6

See Also:
DatabaseMetaData.getClientInfoProperties()

getHoldability

public int getHoldability()
                   throws SQLException
Retrieves the current holdability of ResultSet objects created using this Connection object.

Specified by:
getHoldability in interface Connection
Returns:
the holdability, one of ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
Throws:
SQLException - if a database access error occurs or this method is called on a closed connection
Since:
1.4
See Also:
setHoldability(int), DatabaseMetaData.getResultSetHoldability(), ResultSet

getHttpProtocolParameters

public HttpProtocolParameters getHttpProtocolParameters()
Returns the HttpProtocolParameters instance in use for the Awake SQL session.

Returns:
the HttpProtocolParameters instance in use for the Awake SQL session

getHttpProxy

public HttpProxy getHttpProxy()
Returns the AwakeProgresManager in use.

Returns:
the AwakeProgresManager in use

getHttpStatusCode

public int getHttpStatusCode()
Returns the http status code of the last executed JDBC command that called the remote Awake SQL Manager.

Returns:
the http status code of the last executed JDBC command that called the remote Awake SQL Manager. 0 means the status could not be returned.

getMaxStatementsForMemoryTransport

public int getMaxStatementsForMemoryTransport()
Returns the maximum Number Of Statements that may be transported in memory. If maximum is reached, transport is done using a file.

Returns:
the maximum Number Of Statements that may be transported in memory.

getMetaData

public DatabaseMetaData getMetaData()
                             throws SQLException
Retrieves a DatabaseMetaData object that contains metadata about the database to which this Connection object represents a connection. The metadata includes information about the database's tables, its supported SQL grammar, its stored procedures, the capabilities of this connection, and so on.

Specified by:
getMetaData in interface Connection
Returns:
a DatabaseMetaData object for this Connection object
Throws:
SQLException - if a database access error occurs

getNetworkTimeout

public int getNetworkTimeout()
                      throws SQLException
Method not implemented in Awake SQL v1.0.

Retrieves the number of milliseconds the driver will wait for a database request to complete. If the limit is exceeded, a SQLException is thrown.

Returns:
the current timeout limit in milliseconds; zero means there is no limit
Throws:
SQLException - if a database access error occurs or this method is called on a closed Connection
SQLFeatureNotSupportedException - if the JDBC driver does not support this method
Since:
1.7
See Also:
setNetworkTimeout(java.util.concurrent.Executor, int)

getSchema

public String getSchema()
                 throws SQLException
Method not implemented in Awake SQL v1.0.

Retrieves this Connection object's current schema name.

Returns:
the current schema name or null if there is none
Throws:
SQLException - if a database access error occurs or this method is called on a closed connection
Since:
1.7
See Also:
setSchema(java.lang.String)

getTransactionIsolation

public int getTransactionIsolation()
                            throws SQLException
Retrieves this Connection object's current transaction isolation level.

Specified by:
getTransactionIsolation in interface Connection
Returns:
the current transaction isolation level, which will be one of the following constants: Connection.TRANSACTION_READ_UNCOMMITTED, Connection.TRANSACTION_READ_COMMITTED, Connection.TRANSACTION_REPEATABLE_READ, Connection.TRANSACTION_SERIALIZABLE, or Connection.TRANSACTION_NONE.
Throws:
SQLException - if a database access error occurs or this method is called on a closed connection
See Also:
setTransactionIsolation(int)

getTypeMap

public Map<String,Class<?>> getTypeMap()
                                throws SQLException
Method not implemented in Awake SQL v1.0.

Retrieves the Map object associated with this Connection object. Unless the application has added an entry, the type map returned will be empty.

Specified by:
getTypeMap in interface Connection
Returns:
the java.util.Map object associated with this Connection object
Throws:
SQLException - if a database access error occurs
Since:
1.2
See Also:
setTypeMap(java.util.Map>)

getUrl

public String getUrl()
Returns the URL of the path to the AwakeSqlManager Servlet.

Returns:
the URL of the path to the AwakeSqlManager Servlet

getUsername

public String getUsername()
Returns the username in use.

Returns:
the username in use

getVersion

public String getVersion()
Returns the current Awake SQL Version.

Returns:
the Awake SQL Version

getWarnings

public SQLWarning getWarnings()
                       throws SQLException
Returns null in Awake SQL v1.0.

Specified by:
getWarnings in interface Connection
Returns:
null
Throws:
SQLException - if a database access error occurs or this method is called on a closed connection
See Also:
SQLWarning

isClosed

public boolean isClosed()
                 throws SQLException
Retrieves whether this Connection object has been closed. A connection is closed if the method close has been called on it or if certain fatal errors have occurred. This method is guaranteed to return true only when it is called after the method Connection.close has been called.

This method generally cannot be called to determine whether a connection to a database is valid or invalid. A typical client can determine that a connection is invalid by catching any exceptions that might be thrown when an operation is attempted.

Specified by:
isClosed in interface Connection
Returns:
true if this Connection object is closed; false if it is still open
Throws:
SQLException - if a database access error occurs

isEncryptStatementParameters

public boolean isEncryptStatementParameters()
Returns true if the statement are to be encrypted.

Returns:
true if the statement are to be encrypted. (Default to false).

isReadOnly

public boolean isReadOnly()
                   throws SQLException
Retrieves whether this Connection object is in read-only mode.

Specified by:
isReadOnly in interface Connection
Returns:
true if this Connection object is read-only; false otherwise
Throws:
SQLException - if a database access error occurs

isValid

public boolean isValid(int timeout)
                throws SQLException
Method not implemented in Awake SQL v1.0.

Returns true if the connection has not been closed and is still valid. The driver shall submit a query on the connection or use some other mechanism that positively verifies the connection is still valid when this method is called.

The query submitted by the driver to validate the connection shall be executed in the context of the current transaction.

Specified by:
isValid in interface Connection
Parameters:
timeout - - The time in seconds to wait for the database operation used to validate the connection to complete. If the timeout period expires before the operation completes, this method returns false. A value of 0 indicates a timeout is not applied to the database operation.

Returns:
true if the connection is valid, false otherwise
Throws:
SQLException - if the value supplied for timeout is less then 0
Since:
1.6

See Also:
DatabaseMetaData.getClientInfoProperties()

isWrapperFor

public boolean isWrapperFor(Class<?> iface)
                     throws SQLException
Method not implemented in Awake SQL v1.0.

Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does. Returns false otherwise. If this implements the interface then return true, else if this is a wrapper then return the result of recursively calling isWrapperFor on the wrapped object. If this does not implement the interface and is not a wrapper, return false. This method should be implemented as a low-cost operation compared to unwrap so that callers can use this method to avoid expensive unwrap calls that may fail. If this method returns true then calling unwrap with the same argument should succeed.

Specified by:
isWrapperFor in interface Wrapper
Parameters:
iface - a Class defining an interface.
Returns:
true if this implements the interface or directly or indirectly wraps an object that does.
Throws:
SQLException - if an error occurs while determining whether this is a wrapper for an object with the given interface.
Since:
1.6

nativeSQL

public String nativeSQL(String sql)
                 throws SQLException
Method not implemented in Awake SQL v1.0.

Converts the given SQL statement into the system's native SQL grammar. A driver may convert the JDBC SQL grammar into its system's native SQL grammar prior to sending it. This method returns the native form of the statement that the driver would have sent.

Specified by:
nativeSQL in interface Connection
Parameters:
sql - an SQL statement that may contain one or more '?' parameter placeholders
Returns:
the native form of this statement
Throws:
SQLException - if a database access error occurs

prepareCall

public CallableStatement prepareCall(String sql)
                              throws SQLException
Method not implemented in Awake SQL v1.0.

Creates a CallableStatement object for calling database stored procedures. The CallableStatement object provides methods for setting up its IN and OUT parameters, and methods for executing the call to a stored procedure.

Note: This method is optimized for handling stored procedure call statements. Some drivers may send the call statement to the database when the method prepareCall is done; others may wait until the CallableStatement object is executed. This has no direct effect on users; however, it does affect which method throws certain SQLExceptions.

Result sets created using the returned CallableStatement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY.

Specified by:
prepareCall in interface Connection
Parameters:
sql - an SQL statement that may contain one or more '?' parameter placeholders. Typically this statement is a JDBC function call escape string.
Returns:
a new default CallableStatement object containing the pre-compiled SQL statement
Throws:
SQLException - if a database access error occurs

prepareCall

public CallableStatement prepareCall(String sql,
                                     int resultSetType,
                                     int resultSetConcurrency)
                              throws SQLException
Method not implemented in Awake SQL v1.0.

Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency. This method is the same as the prepareCall method above, but it allows the default result set type and concurrency to be overridden.

Specified by:
prepareCall in interface Connection
Parameters:
sql - a String object that is the SQL statement to be sent to the database; may contain on or more ? parameters
resultSetType - a result set type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency - a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
Returns:
a new CallableStatement object containing the pre-compiled SQL statement that will produce ResultSet objects with the given type and concurrency
Throws:
SQLException - if a database access error occurs or the given parameters are not ResultSet constants indicating type and concurrency
Since:
1.2

prepareCall

public CallableStatement prepareCall(String sql,
                                     int resultSetType,
                                     int resultSetConcurrency,
                                     int resultSetHoldability)
                              throws SQLException
Method not implemented in Awake SQL v1.0.

Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency. This method is the same as the prepareCall method above, but it allows the default result set type, result set concurrency type and holdability to be overridden.

Specified by:
prepareCall in interface Connection
Parameters:
sql - a String object that is the SQL statement to be sent to the database; may contain on or more ? parameters
resultSetType - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency - one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
resultSetHoldability - one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
Returns:
a new CallableStatement object, containing the pre-compiled SQL statement, that will generate ResultSet objects with the given type, concurrency, and holdability
Throws:
SQLException - if a database access error occurs or the given parameters are not ResultSet constants indicating type, concurrency, and holdability
Since:
1.4
See Also:
ResultSet

prepareStatement

public PreparedStatement prepareStatement(String sql)
                                   throws SQLException
Creates a PreparedStatement object for sending parameterized SQL statements to the database.

A SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.

Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method prepareStatement will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement object is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLException objects.

Result sets created using the returned PreparedStatement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY.

Specified by:
prepareStatement in interface Connection
Parameters:
sql - an SQL statement that may contain one or more '?' IN parameter placeholders
Returns:
a new default PreparedStatement object containing the pre-compiled SQL statement
Throws:
SQLException - if a database access error occurs

prepareStatement

public PreparedStatement prepareStatement(String sql,
                                          int autoGeneratedKeys)
                                   throws SQLException
Creates a default PreparedStatement object that has the capability to retrieve auto-generated keys. Method not implemented in Awake SQL v1.0. The given constant tells the driver whether it should make auto-generated keys available for retrieval. This parameter is ignored if the SQL statement is not an INSERT statement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).

Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method prepareStatement will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement object is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLExceptions.

Result sets created using the returned PreparedStatement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY. The holdability of the created result sets can be determined by calling getHoldability().

Specified by:
prepareStatement in interface Connection
Parameters:
sql - an SQL statement that may contain one or more '?' IN parameter placeholders
autoGeneratedKeys - a flag indicating whether auto-generated keys should be returned; one of Statement.RETURN_GENERATED_KEYS or Statement.NO_GENERATED_KEYS
Returns:
a new PreparedStatement object, containing the pre-compiled SQL statement, that will have the capability of returning auto-generated keys
Throws:
SQLException - if a database access error occurs, this method is called on a closed connection or the given parameter is not a Statement constant indicating whether auto-generated keys should be returned
SQLFeatureNotSupportedException - if the JDBC driver does not support this method with a constant of Statement.RETURN_GENERATED_KEYS
Since:
1.4

prepareStatement

public PreparedStatement prepareStatement(String sql,
                                          int[] columnIndexes)
                                   throws SQLException
Method not implemented in Awake SQL v1.0.

Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array. This array contains the indexes of the columns in the target table that contain the auto-generated keys that should be made available. This array is ignored if the SQL statement is not an INSERT statement.

An SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.

Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method prepareStatement will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement object is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLExceptions.

Result sets created using the returned PreparedStatement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY.

Specified by:
prepareStatement in interface Connection
Parameters:
sql - an SQL statement that may contain one or more '?' IN parameter placeholders
columnIndexes - an array of column indexes indicating the columns that should be returned from the inserted row or rows
Returns:
a new PreparedStatement object, containing the pre-compiled statement, that is capable of returning the auto-generated keys designated by the given array of column indexes
Throws:
SQLException - if a database access error occurs
Since:
1.4

prepareStatement

public PreparedStatement prepareStatement(String sql,
                                          int resultSetType,
                                          int resultSetConcurrency)
                                   throws SQLException
Creates a PreparedStatement object that will generate ResultSet objects with the given type and concurrency. This method is the same as the prepareStatement method above, but it allows the default result set type and concurrency to be overridden. The holdability of the created result sets can be determined by calling getHoldability().

Specified by:
prepareStatement in interface Connection
Parameters:
sql - a String object that is the SQL statement to be sent to the database; may contain one or more '?' IN parameters
resultSetType - a result set type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency - a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
Returns:
a new PreparedStatement object containing the pre-compiled SQL statement that will produce ResultSet objects with the given type and concurrency
Throws:
SQLException - if a database access error occurs, this method is called on a closed connection or the given parameters are not ResultSet constants indicating type and concurrency
SQLFeatureNotSupportedException - if the JDBC driver does not support this method or this method is not supported for the specified result set type and result set concurrency.
Since:
1.2

prepareStatement

public PreparedStatement prepareStatement(String sql,
                                          int resultSetType,
                                          int resultSetConcurrency,
                                          int resultSetHoldability)
                                   throws SQLException
Creates a PreparedStatement object that will generate ResultSet objects with the given type, concurrency, and holdability.

This method is the same as the prepareStatement method above, but it allows the default result set type, concurrency, and holdability to be overridden.

Specified by:
prepareStatement in interface Connection
Parameters:
sql - a String object that is the SQL statement to be sent to the database; may contain one or more '?' IN parameters
resultSetType - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency - one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
resultSetHoldability - one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
Returns:
a new PreparedStatement object, containing the pre-compiled SQL statement, that will generate ResultSet objects with the given type, concurrency, and holdability
Throws:
SQLException - if a database access error occurs, this method is called on a closed connection or the given parameters are not ResultSet constants indicating type, concurrency, and holdability
SQLFeatureNotSupportedException - if the JDBC driver does not support this method or this method is not supported for the specified result set type, result set holdability and result set concurrency.
Since:
1.4
See Also:
ResultSet

prepareStatement

public PreparedStatement prepareStatement(String sql,
                                          String[] columnNames)
                                   throws SQLException
Method not implemented in Awake SQL v1.0.

Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array. This array contains the names of the columns in the target table that contain the auto-generated keys that should be returned. This array is ignored if the SQL statement is not an INSERT statement.

An SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.

Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method prepareStatement will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement object is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLExceptions.

Result sets created using the returned PreparedStatement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY.

Specified by:
prepareStatement in interface Connection
Parameters:
sql - an SQL statement that may contain one or more '?' IN parameter placeholders
columnNames - an array of column names indicating the columns that should be returned from the inserted row or rows
Returns:
a new PreparedStatement object, containing the pre-compiled statement, that is capable of returning the auto-generated keys designated by the given array of column names
Throws:
SQLException - if a database access error occurs
Since:
1.4

releaseSavepoint

public void releaseSavepoint(Savepoint savepoint)
                      throws SQLException
Method not implemented in Awake SQL v1.0.

Removes the given Savepoint object from the current transaction. Any reference to the savepoint after it have been removed will cause an SQLException to be thrown.

Specified by:
releaseSavepoint in interface Connection
Parameters:
savepoint - the Savepoint object to be removed
Throws:
SQLException - if a database access error occurs or the given Savepoint object is not a valid savepoint in the current transaction
Since:
1.4

rollback

public void rollback()
              throws SQLException
Undoes all changes made in the current transaction and releases any database locks currently held by this Connection object. This method should be used only when auto-commit mode has been disabled.

Specified by:
rollback in interface Connection
Throws:
SQLException - if a database access error occurs or this Connection object is in auto-commit mode
See Also:
setAutoCommit(boolean)

rollback

public void rollback(Savepoint savepoint)
              throws SQLException
Method not implemented in Awake SQL v1.0.

Undoes all changes made after the given Savepoint object was set.

This method should be used only when auto-commit has been disabled.

Specified by:
rollback in interface Connection
Parameters:
savepoint - the Savepoint object to roll back to
Throws:
SQLException - if a database access error occurs, the Savepoint object is no longer valid, or this Connection object is currently in auto-commit mode
Since:
1.4
See Also:
Savepoint, rollback(java.sql.Savepoint)

setAutoCommit

public void setAutoCommit(boolean autoCommit)
                   throws SQLException
Sets this connection's auto-commit mode to the given state. If a connection is in auto-commit mode, then all its SQL statements will be executed and committed as individual transactions. Otherwise, its SQL statements are grouped into transactions that are terminated by a call to either the method commit or the method rollback . By default, new connections are in auto-commit mode.

The commit occurs when the statement completes or the next execute occurs, whichever comes first. In the case of statements returning a ResultSet object, the statement completes when the last row of the ResultSet object has been retrieved or the ResultSet object has been closed. In advanced cases, a single statement may return multiple results as well as output parameter values. In these cases, the commit occurs when all results and output parameter values have been retrieved.

NOTE: If this method is called during a transaction, the transaction is committed.

Specified by:
setAutoCommit in interface Connection
Parameters:
autoCommit - true to enable auto-commit mode; false to disable it
Throws:
SQLException - if a database access error occurs
See Also:
getAutoCommit()

setAwakeProgressManager

public void setAwakeProgressManager(AwakeProgressManager awakeProgressManager)
Allows to specify an AwakeProgresManager to use.

Parameters:
awakeProgressManager - the owner to set - that is the File Transfer Engine

setCatalog

public void setCatalog(String catalog)
                throws SQLException
Sets the given catalog name in order to select a subspace of this Connection object's database in which to work.

Awake SQL v1.0 does not support catalogs, it will silently ignore this request.

Specified by:
setCatalog in interface Connection
Parameters:
catalog - the name of a catalog (subspace in this Connection object's database) in which to work
Throws:
SQLException - if a database access error occurs
See Also:
getCatalog()

setClientInfo

public void setClientInfo(Properties properties)
                   throws SQLClientInfoException
Method not implemented in Awake SQL v1.0.

Sets the value of the connection's client info properties. The Properties object contains the names and values of the client info properties to be set. The set of client info properties contained in the properties list replaces the current set of client info properties on the connection. If a property that is currently set on the connection is not present in the properties list, that property is cleared. Specifying an empty properties list will clear all of the properties on the connection. See setClientInfo (String, String) for more information.

If an error occurs in setting any of the client info properties, a SQLClientInfoException is thrown. The SQLClientInfoException contains information indicating which client info properties were not set. The state of the client information is unknown because some databases do not allow multiple client info properties to be set atomically. For those databases, one or more properties may have been set before the error occurred.

Specified by:
setClientInfo in interface Connection
Parameters:
properties - the list of client info properties to set

Throws:
SQLClientInfoException - if the database server returns an error while setting the clientInfo values on the database server or this method is called on a closed connection

Since:
1.6

See Also:
setClientInfo(String, String)

setClientInfo

public void setClientInfo(String name,
                          String value)
                   throws SQLClientInfoException
Method not implemented in Awake SQL v1.0.

Sets the value of the client info property specified by name to the value specified by value.

Applications may use the DatabaseMetaData.getClientInfoProperties method to determine the client info properties supported by the driver and the maximum length that may be specified for each property.

The driver stores the value specified in a suitable location in the database. For example in a special register, session parameter, or system table column. For efficiency the driver may defer setting the value in the database until the next time a statement is executed or prepared. Other than storing the client information in the appropriate place in the database, these methods shall not alter the behavior of the connection in anyway. The values supplied to these methods are used for accounting, diagnostics and debugging purposes only.

The driver shall generate a warning if the client info name specified is not recognized by the driver.

If the value specified to this method is greater than the maximum length for the property the driver may either truncate the value and generate a warning or generate a SQLClientInfoException. If the driver generates a SQLClientInfoException, the value specified was not set on the connection.

The following are standard client info properties. Drivers are not required to support these properties however if the driver supports a client info property that can be described by one of the standard properties, the standard property name should be used.

Specified by:
setClientInfo in interface Connection
Parameters:
name - The name of the client info property to set
value - The value to set the client info property to. If the value is null, the current value of the specified property is cleared.

Throws:
SQLClientInfoException - if the database server returns an error while setting the client info value on the database server or this method is called on a closed connection

Since:
1.6

setEncryptStatementParameters

public void setEncryptStatementParameters(boolean encryptStatementParameters)
Set if the statement parameters are to be encrypted

Parameters:
encryptStatementParameters - true if the statement parameters are to be encrypted, else false

setHoldability

public void setHoldability(int holdability)
                    throws SQLException
Changes the default holdability of ResultSet objects created using this Connection object to the given holdability. The default holdability of ResultSet objects can be be determined by invoking DatabaseMetaData.getResultSetHoldability().

Specified by:
setHoldability in interface Connection
Parameters:
holdability - a ResultSet holdability constant; one of ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
Throws:
SQLException - if a database access occurs, this method is called on a closed connection, or the given parameter is not a ResultSet constant indicating holdability
SQLFeatureNotSupportedException - if the given holdability is not supported
Since:
1.4
See Also:
getHoldability(), DatabaseMetaData.getResultSetHoldability(), ResultSet

setMaxStatementsForMemoryTransport

public void setMaxStatementsForMemoryTransport(int maxStatementsForMemoryTransport)
Sets the maximum Number Of Statements that may be transported in memory from client to server. if maximum is reached, transport is done using a file.

Parameters:
maxStatementsForMemoryTransport - the maximum Number Of Statements that may be transported in memory.

setNetworkTimeout

public void setNetworkTimeout(Executor executor,
                              int milliseconds)
                       throws SQLException
Method not implemented in Awake SQL v1.0.

Sets the maximum period a Connection or objects created from the Connection will wait for the database to reply to any one request. If any request remains unanswered, the waiting method will return with a SQLException, and the Connection or objects created from the Connection will be marked as closed. Any subsequent use of the objects, with the exception of the close, isClosed or Connection.isValid methods, will result in a SQLException.

Note: This method is intended to address a rare but serious condition where network partitions can cause threads issuing JDBC calls to hang uninterruptedly in socket reads, until the OS TCP-TIMEOUT (typically 10 minutes). This method is related to the abort() method which provides an administrator thread a means to free any such threads in cases where the JDBC connection is accessible to the administrator thread. The setNetworkTimeout method will cover cases where there is no administrator thread, or it has no access to the connection. This method is severe in it's effects, and should be given a high enough value so it is never triggered before any more normal timeouts, such as transaction timeouts.

JDBC driver implementations may also choose to support the setNetworkTimeout method to impose a limit on database response time, in environments where no network is present.

Drivers may internally implement some or all of their API calls with multiple internal driver-database transmissions, and it is left to the driver implementation to determine whether the limit will be applied always to the response to the API call, or to any single request made during the API call.

This method can be invoked more than once, such as to set a limit for an area of JDBC code, and to reset to the default on exit from this area. Invocation of this method has no impact on already outstanding requests.

The Statement.setQueryTimeout() timeout value is independent of the timeout value specified in setNetworkTimeout. If the query timeout expires before the network timeout then the statement execution will be canceled. If the network is still active the result will be that both the statement and connection are still usable. However if the network timeout expires before the query timeout or if the statement timeout fails due to network problems, the connection will be marked as closed, any resources held by the connection will be released and both the connection and statement will be unusable.

When the driver determines that the setNetworkTimeout timeout value has expired, the JDBC driver marks the connection closed and releases any resources held by the connection.

This method checks to see that there is an SQLPermission object before allowing the method to proceed. If a SecurityManager exists and its checkPermission method denies calling setNetworkTimeout, this method throws a java.lang.SecurityException.

Parameters:
executor - The Executor implementation which will be used by setNetworkTimeout.
milliseconds - The time in milliseconds to wait for the database operation to complete. If the JDBC driver does not support milliseconds, the JDBC driver will round the value up to the nearest second. If the timeout period expires before the operation completes, a SQLException will be thrown. A value of 0 indicates that there is not timeout for database operations.
Throws:
SQLException - if a database access error occurs, this method is called on a closed connection, the executor is null, or the value specified for seconds is less than 0.
SecurityException - if a security manager exists and its checkPermission method denies calling setNetworkTimeout.
SQLFeatureNotSupportedException - if the JDBC driver does not support this method
Since:
1.7
See Also:
SecurityManager.checkPermission(java.security.Permission), Statement.setQueryTimeout(int), getNetworkTimeout(), abort(java.util.concurrent.Executor), Executor

setReadOnly

public void setReadOnly(boolean readOnly)
                 throws SQLException
Puts this connection in read-only mode as a hint to the driver to enable database optimizations.

Note: This method cannot be called during a transaction.

Specified by:
setReadOnly in interface Connection
Parameters:
readOnly - true enables read-only mode; false disables it
Throws:
SQLException - if a database access error occurs or this method is called during a transaction

setSavepoint

public Savepoint setSavepoint()
                       throws SQLException
Method not implemented in Awake SQL v1.0.

Creates an unnamed savepoint in the current transaction and returns the new Savepoint object that represents it.

Specified by:
setSavepoint in interface Connection
Returns:
the new Savepoint object
Throws:
SQLException - if a database access error occurs or this Connection object is currently in auto-commit mode
Since:
1.4
See Also:
Savepoint

setSavepoint

public Savepoint setSavepoint(String name)
                       throws SQLException
Method not implemented in Awake SQL v1.0.

Creates a savepoint with the given name in the current transaction and returns the new Savepoint object that represents it.

Specified by:
setSavepoint in interface Connection
Parameters:
name - a String containing the name of the savepoint
Returns:
the new Savepoint object
Throws:
SQLException - if a database access error occurs or this Connection object is currently in auto-commit mode
Since:
1.4
See Also:
Savepoint

setSchema

public void setSchema(String schema)
               throws SQLException
Method not implemented in Awake SQL v1.0.

Sets the given schema name to access.

If the driver does not support schemas, it will silently ignore this request.

Calling setSchema has no effect on previously created or prepared Statement objects. It is implementation defined whether a DBMS prepare operation takes place immediately when the Connection method prepareStatement or prepareCall is invoked. For maximum portability, setSchema should be called before a Statement is created or prepared.

Parameters:
schema - the name of a schema in which to work
Throws:
SQLException - if a database access error occurs or this method is called on a closed connection
Since:
1.7
See Also:
getSchema()

setTransactionIsolation

public void setTransactionIsolation(int level)
                             throws SQLException
Attempts to change the transaction isolation level for this Connection object to the one given. The constants defined in the interface Connection are the possible transaction isolation levels.

Note: If this method is called during a transaction, the result is implementation-defined.

Specified by:
setTransactionIsolation in interface Connection
Parameters:
level - one of the following Connection constants: Connection.TRANSACTION_READ_UNCOMMITTED, Connection.TRANSACTION_READ_COMMITTED, Connection.TRANSACTION_REPEATABLE_READ, or Connection.TRANSACTION_SERIALIZABLE. (Note that Connection.TRANSACTION_NONE cannot be used because it specifies that transactions are not supported.)
Throws:
SQLException - if a database access error occurs, this method is called on a closed connection or the given parameter is not one of the Connection constants
See Also:
DatabaseMetaData.supportsTransactionIsolationLevel(int), getTransactionIsolation()

setTypeMap

public void setTypeMap(Map<String,Class<?>> map)
                throws SQLException
Method not implemented in Awake SQL v1.0.

Installs the given TypeMap object as the type map for this Connection object. The type map will be used for the custom mapping of SQL structured types and distinct types.

Specified by:
setTypeMap in interface Connection
Parameters:
map - the java.util.Map object to install as the replacement for this Connection object's default type map
Throws:
SQLException - if a database access error occurs or the given parameter is not a java.util.Map object
Since:
1.2
See Also:
getTypeMap()

unwrap

public <T> T unwrap(Class<T> iface)
         throws SQLException
Method not implemented in Awake SQL v1.0.

Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy. If the receiver implements the interface then the result is the receiver or a proxy for the receiver. If the receiver is a wrapper and the wrapped object implements the interface then the result is the wrapped object or a proxy for the wrapped object. Otherwise return the the result of calling unwrap recursively on the wrapped object or a proxy for that result. If the receiver is not a wrapper and does not implement the interface, then an SQLException is thrown.

Specified by:
unwrap in interface Wrapper
Parameters:
iface - A Class defining an interface that the result must implement.
Returns:
an object that implements the interface. May be a proxy for the actual implementing object.
Throws:
SQLException - If no object found that implements the interface
Since:
1.6

Awake SQL v1.2.1

Awake SQL - Virtual JDBC Driver over HTTP for Android, Swing and JavaFX
Android & Desktop Edition allow easy access to majors remote SQL databases with regular JDBC calls:
DB2 - H2 - HSQLDB (HyperSQL) - Informix - Ingres - MySQL - Oracle - PostgreSQL - SQL Server - Sybase - Teradata
Copyright © 2012 Kawan Softwares SAS