com.cloudant.sync.sqlite

Class SQLDatabaseQueue

java.lang.Object

com.cloudant.sync.sqlite.SQLDatabaseQueue

public class SQLDatabaseQueue
extends java.lang.Object

SQLDatabaseQuue provides the ability to ensure that the only a single thread accesses the SQLDatabase. Tasks submitted to this queue are guaranteed to be executed in the order they are received

API Status: Private - API users are discouraged from using this class as fields, method signatures, and implementation details may be subject to change

Constructor Summary

Constructors

Constructor and Description
SQLDatabaseQueue(java.lang.String filename) Creates an SQLQueue for the database specified.
SQLDatabaseQueue(java.lang.String filename, KeyProvider provider) Creates an SQLQueue for the SQLCipher-based database specified.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getSQLiteVersion() Returns the SQLite Version.
int	getVersion() Returns the current version of the database.
boolean	isShutdown() Checks if shutdown() has been called
void	shutdown() Shuts down this database queue and closes the underlying database connection.
<T> java.util.concurrent.Future<T>	submit(SQLCallable<T> callable) Submits a database task for execution
<T> java.util.concurrent.Future<T>	submitTransaction(SQLCallable<T> callable) Submits a database task for execution in a transaction
void	updateSchema(Migration migration, int version) Updates the schema of the database.

Methods inherited from class java.lang.Object

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

Constructor Detail

SQLDatabaseQueue

public SQLDatabaseQueue(java.lang.String filename)
                 throws java.io.IOException,
                        java.sql.SQLException

Creates an SQLQueue for the database specified.

Parameters:

filename - The file where the database is located

Throws:

java.io.IOException - If an problem is encountered creating the DB

java.sql.SQLException - If the database cannot be opened.

SQLDatabaseQueue

public SQLDatabaseQueue(java.lang.String filename,
                        KeyProvider provider)
                 throws java.io.IOException,
                        java.sql.SQLException

Creates an SQLQueue for the SQLCipher-based database specified.

Parameters:

filename - The file where the database is located

provider - The key provider object that contains the user-defined SQLCipher key. Supply a NullKeyProvider to use a non-encrypted database.

Throws:

java.io.IOException - If a problem occurs creating the database

java.sql.SQLException - If the database cannot be opened.

Method Detail

updateSchema

public void updateSchema(Migration migration,
                         int version)

Updates the schema of the database.

Parameters:

migration - Object which performs migration; should not check or set version

version - The version of the schema

getVersion

public int getVersion()
               throws java.sql.SQLException

Returns the current version of the database.

Returns:

The current version of the database.

Throws:

java.sql.SQLException - Throws if there was an error getting the current database version

submit

public <T> java.util.concurrent.Future<T> submit(SQLCallable<T> callable)

Submits a database task for execution

Type Parameters:

T - The type of object that is returned from the task

Parameters:

callable - The task to be performed

Returns:

Future representing the task to be executed.

Throws:

java.util.concurrent.RejectedExecutionException - Thrown when the queue has been shutdown

submitTransaction

public <T> java.util.concurrent.Future<T> submitTransaction(SQLCallable<T> callable)

Submits a database task for execution in a transaction

Type Parameters:

T - The type of object that is returned from the task

Parameters:

callable - The task to be performed

Returns:

Future representing the task to be executed.

Throws:

java.util.concurrent.RejectedExecutionException - thrown when the queue has been shutdown

shutdown

public void shutdown()

Shuts down this database queue and closes the underlying database connection. Any tasks previously submitted for execution will still be executed, however the queue will not accept additional tasks

isShutdown

public boolean isShutdown()

Checks if shutdown() has been called

Returns:

true if shutdown() has been called.

getSQLiteVersion

public java.lang.String getSQLiteVersion()

Returns the SQLite Version.

Returns:

The SQLite version or "Unknown" if the version could not be determined.