org.specrunner.sql

Class PluginScripts

java.lang.Object

org.specrunner.parameters.core.ParameterHolder

org.specrunner.plugins.core.AbstractPlugin

org.specrunner.plugins.core.AbstractPluginNamed

org.specrunner.plugins.core.AbstractPluginScoped

org.specrunner.plugins.core.AbstractPluginValue

org.specrunner.sql.PluginScripts

All Implemented Interfaces:

IParameterHolder, IActionType, IParalelPlugin, IPlugin, ISleepPlugin, ITestPlugin, ITimedPlugin, IWaitPlugin

public class PluginScripts
extends AbstractPluginValue

This plugin specifies the scripts to be performed. Scripts are specification relative, and multiple scripts can be added using multiple call or by giving names separated by ';'. If you prefer different separators for scripts or commands you can set 'scriptseparator', 'sqlseparator', and/or 'nameseparator', or set FEATURE_SCRIPT_SEPARATOR, FEATURE_SQL_SEPARATOR or FEATURE_NAME_SEPARATOR.

If scripts are expected to be relative to classpath, set 'classpathrelative' attribute to true, or add the 'FEATURE_CLASSPATH_RELATIVE' to true.

Author:

Thiago Santos

Field Summary

Fields

Modifier and Type	Field and Description
protected static ThreadLocal<ICache<String,String>>	cache Cache of scripts.
static boolean	DEFAULT_CLASSPATH_RELATIVE Default classpath relative.
static String	DEFAULT_NAME_SEPARATOR Default name separator.
static String	FEATURE_CLASSPATH_RELATIVE Feature for classpath relative scripts.
static String	FEATURE_FAILSAFE Fail safe feature means that on command execution command errors will not raise errors but warnings instead.
static String	FEATURE_NAME_SEPARATOR Feature for names separators.
static String	FEATURE_SCRIPT_SEPARATOR Sets the script separator on specification.
static String	FEATURE_SQL_SEPARATOR Sets the SQL command separator.

Fields inherited from class org.specrunner.plugins.core.AbstractPluginValue

eval, value

Fields inherited from class org.specrunner.plugins.core.AbstractPluginScoped

scope

Fields inherited from class org.specrunner.plugins.core.AbstractPluginNamed

name

Fields inherited from class org.specrunner.plugins.core.AbstractPlugin

FEATURE_CONDITION, FEATURE_NORMALIZED, FEATURE_NORMALIZER, FEATURE_SLEEP, FEATURE_THREADSAFE, FEATURE_TIMEOUT, FEATURE_WAIT

Fields inherited from class org.specrunner.parameters.core.ParameterHolder

parameters

Constructor Summary

Constructors

Constructor and Description
PluginScripts()

Method Summary

Modifier and Type	Method and Description
ENext	doStart(IContext context, IResultSet result)
protected int	execute(Statement stmt, String sql, IContext context, IResultSet result) Perform a command, and return the number of errors in execution.
ActionType	getActionType()
Boolean	getFailsafe() Set if commands execution should report errors or warning on command execution failure.
String	getNameseparator() Get the name separator.
URI[]	getScripts() List of scripts as URIs.
String	getScriptseparator() Return the script separator token.
String	getSqlseparator() The SQL commands separator.
void	initialize(IContext context)
boolean	isClasspathrelative() Get if script is classpath relative or not.
protected int	perform(IContext context, IResultSet result, Connection connection, String reference, Reader script, boolean fromCache) Perform script commands.
void	setClasspathrelative(boolean classpathrelative) Set classpath relative script flag.
void	setFailsafe(Boolean failsafe) Set fail safe status.
void	setNameseparator(String nameseparator) Set the name separator.
protected void	setScripts(IContext context) Set script, if necessary.
void	setScripts(URI[] scripts) Set scripts.
void	setScriptseparator(String scriptseparator) Set script separator.
void	setSqlseparator(String sqlseparator) Sets the SQL command separators.

Methods inherited from class org.specrunner.plugins.core.AbstractPluginValue

getValue, getValue, isEval, setEval, setValue

Methods inherited from class org.specrunner.plugins.core.AbstractPluginScoped

getScope, saveGlobal, saveLocal, saveStrict, setScope

Methods inherited from class org.specrunner.plugins.core.AbstractPluginNamed

getName, setName

Methods inherited from class org.specrunner.plugins.core.AbstractPlugin

copy, doEnd, getCondition, getConditionModel, getNormalized, getNormalized, getNormalizer, getParent, getSleep, getSleepModel, getThreadsafe, getTimeout, getTimeoutModel, getWait, getWaitModel, setCondition, setConditionModel, setNormalized, setNormalizer, setParent, setSleep, setSleepModel, setThreadsafe, setTimeout, setTimeoutModel, setWait, setWaitModel, toString

Methods inherited from class org.specrunner.parameters.core.ParameterHolder

getParameters, setParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.specrunner.parameters.IParameterHolder

getParameters, setParameters

Field Detail

cache

protected static ThreadLocal<ICache<String,String>> cache

Cache of scripts.

FEATURE_SCRIPT_SEPARATOR

public static final String FEATURE_SCRIPT_SEPARATOR

Sets the script separator on specification. Default is ";".

FEATURE_SQL_SEPARATOR

public static final String FEATURE_SQL_SEPARATOR

Sets the SQL command separator. Default is ";".

FEATURE_NAME_SEPARATOR

public static final String FEATURE_NAME_SEPARATOR

Feature for names separators.

DEFAULT_NAME_SEPARATOR

public static final String DEFAULT_NAME_SEPARATOR

Default name separator.

See Also:

Constant Field Values

FEATURE_CLASSPATH_RELATIVE

public static final String FEATURE_CLASSPATH_RELATIVE

Feature for classpath relative scripts.

DEFAULT_CLASSPATH_RELATIVE

public static final boolean DEFAULT_CLASSPATH_RELATIVE

Default classpath relative.

See Also:

Constant Field Values

FEATURE_FAILSAFE

public static final String FEATURE_FAILSAFE

Fail safe feature means that on command execution command errors will not raise errors but warnings instead.

Constructor Detail

PluginScripts

public PluginScripts()

Method Detail

getScripts

public URI[] getScripts()

List of scripts as URIs.

Returns:

The script list.

setScripts

public void setScripts(URI[] scripts)

Set scripts.

Parameters:

scripts - The scripts.

getScriptseparator

public String getScriptseparator()

Return the script separator token.

Returns:

The script separator.

setScriptseparator

public void setScriptseparator(String scriptseparator)

Set script separator.

Parameters:

scriptseparator - The separator.

getSqlseparator

public String getSqlseparator()

The SQL commands separator.

Returns:

The separator.

setSqlseparator

public void setSqlseparator(String sqlseparator)

Sets the SQL command separators.

Parameters:

sqlseparator - Separator.

getNameseparator

public String getNameseparator()

Get the name separator.

Returns:

The separator.

setNameseparator

public void setNameseparator(String nameseparator)

Set the name separator.

Parameters:

nameseparator - The separator.

isClasspathrelative

public boolean isClasspathrelative()

Get if script is classpath relative or not.

Returns:

false, if not classpath relative, true, otherwise.

setClasspathrelative

public void setClasspathrelative(boolean classpathrelative)

Set classpath relative script flag.

Parameters:

classpathrelative - true, to set classpath relative, false, otherwise.

getFailsafe

public Boolean getFailsafe()

Set if commands execution should report errors or warning on command execution failure.

Returns:

True, if warnings are expected, false, otherwise.

setFailsafe

public void setFailsafe(Boolean failsafe)

Set fail safe status.

Parameters:

failsafe - Fail safe status.

getActionType

public ActionType getActionType()

initialize

public void initialize(IContext context)
                throws PluginException

Specified by:

initialize in interface IPlugin

Overrides:

initialize in class AbstractPlugin

Throws:

PluginException

setScripts

protected void setScripts(IContext context)
                   throws PluginException

Set script, if necessary.

Parameters:

context - The context.

Throws:

PluginException - On error.

doStart

public ENext doStart(IContext context,
                     IResultSet result)
              throws PluginException

Specified by:

doStart in interface IPlugin

Overrides:

doStart in class AbstractPlugin

Throws:

PluginException

perform

protected int perform(IContext context,
                      IResultSet result,
                      Connection connection,
                      String reference,
                      Reader script,
                      boolean fromCache)
               throws SQLException

Perform script commands.

Parameters:

context - The context.

result - The result.

connection - Database connection.

reference - Script reference as string.

script - Script content.

fromCache - Indicates if reader comes from cache or not.

Returns:

The number of errors.

Throws:

SQLException - On SQL errors, only if fail safe is off.

execute

protected int execute(Statement stmt,
                      String sql,
                      IContext context,
                      IResultSet result)

Perform a command, and return the number of errors in execution.

Parameters:

stmt - A statement.

sql - A command.

context - A text context.

result - A result set.

Returns:

The number of errors in execution.