org.deventropy.junithelper.derby.util

Class DerbyScriptRunner

java.lang.Object

org.deventropy.junithelper.derby.util.DerbyScriptRunner

public class DerbyScriptRunner
extends Object

Executes a SQL script on the given Derby embedded instance connection.

The script uses a single character set for reading the scripts as well as writing the logs. The class has a Default Log Stream which it uses when no log stream or file is specified along with the script for execution (executeScript(String)). A log stream may be specified with the script resource using the executeScript(String, File) or executeScript(String, OutputStream, boolean) methods.

The script resources provided to this class should be in the format supported by UrlResourceUtil.

Author:

Bindul Bhowmik

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CHARSET Default system character set to use if none is specified by the user.

Constructor Summary

Constructors

Constructor and Description
DerbyScriptRunner(Connection dbConnection) Initializes a new script runner for the connection.
DerbyScriptRunner(Connection dbConnection, String charset) Initializes a new script runner.

Method Summary

Modifier and Type	Method and Description
int	executeScript(String scriptResource) Executes the given script.
int	executeScript(String scriptResource, File scriptLogFile) Executes the given script.
int	executeScript(String script, OutputStream scriptLogStream, boolean closeScriptLogStream) Executes the given script.
void	setDefaultScriptLogStream(OutputStream defaultScriptLogStream) Sets the log stream to log results to.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CHARSET

public static final String DEFAULT_CHARSET

Default system character set to use if none is specified by the user.

Constructor Detail

DerbyScriptRunner

public DerbyScriptRunner(Connection dbConnection,
                         String charset)

Initializes a new script runner.

Parameters:

dbConnection - The database connection to run the scripts on.

charset - Character set to use for reading the script and writing the log

DerbyScriptRunner

public DerbyScriptRunner(Connection dbConnection)

Initializes a new script runner for the connection. Uses the DEFAULT_CHARSET as the character set.

Parameters:

dbConnection - The database connection to run the scripts on.

Method Detail

setDefaultScriptLogStream

public void setDefaultScriptLogStream(OutputStream defaultScriptLogStream)

Sets the log stream to log results to. This can be overridden on a per script basis, and if not set defaults to DerbyUtils.DEV_NULL stream, which simply ignores all output.

Data will be written to this stream using the character set set in the constructor.

Parameters:

defaultScriptLogStream - The default script log stream

executeScript

public int executeScript(String scriptResource)
                  throws IOException

Executes the given script. The script run logs are written to the setDefaultScriptLogStream(OutputStream).

Parameters:

scriptResource - The script source; should be in a format compatible with UrlResourceUtil

Returns:

0 if the execution succeeds without any errors; non zero value otherwise.

Throws:

IOException - Error reading script file, or writing to the log file.

executeScript

public int executeScript(String scriptResource,
                         File scriptLogFile)
                  throws IOException

Executes the given script. The script run logs are written to the provided scriptLogFile.

Parameters:

scriptResource - The script source; should be in a format compatible with UrlResourceUtil

scriptLogFile - The file to which the output logs are written. If the file already exists, it is appended to

Returns:

0 if the execution succeeds without any errors; non zero value otherwise.

Throws:

IOException - Error reading script file, or writing to the log file.

executeScript

public int executeScript(String script,
                         OutputStream scriptLogStream,
                         boolean closeScriptLogStream)
                  throws IOException

Executes the given script. The script run logs are written to the provided scriptLogStream.

Parameters:

script - The script source; should be in a format compatible with UrlResourceUtil

scriptLogStream - The stream to which the output logs are written.

closeScriptLogStream - If set to true, the log stream is closed at the end of the execution.

Returns:

0 if the execution succeeds without any errors; non zero value otherwise.

Throws:

IOException - Error reading script file, or writing to the log file.