org.specrunner.sql

Class PluginConnection

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.PluginConnection

All Implemented Interfaces:

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

public class PluginConnection
extends AbstractPluginValue

Plugin to set connection information. The connection information must be based on a provider (DataSource- see IDataSourceProvider), or direct information with driver/url/user/password.

When threadsafe='true' SpecRunner uses IConcurrentMapping to resolve database url reference.

Author:

Thiago Santos

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CONNECTION_NAME Default connection name.
static String	DEFAULT_SEPARATOR Default string separator.
static String	FEATURE_CONNECTION Full connection descriptor.
static String	FEATURE_DRIVER Connection driver.
static String	FEATURE_PASSWORD Connection password.
static String	FEATURE_PROVIDER Provider name feature.
static String	FEATURE_PROVIDER_INSTANCE Provider instance feature.
static String	FEATURE_REUSE Default connection setting for reuse.
static String	FEATURE_SEPARATOR Connection separator string.
static String	FEATURE_URL Connection url.
static String	FEATURE_USER Connection user.

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
PluginConnection()

Method Summary

Modifier and Type	Method and Description
IDataSourceProvider	createProvider() Creates a given provider.
ENext	doStart(IContext context, IResultSet result)
ActionType	getActionType()
String	getConnection() Connection information.
String	getDriver() Driver information.
String	getPassword() The database password.
String	getProvider() The provide class name.
static IDataSourceProvider	getProvider(IContext context, String name) Gets the datasource provider saved in context.
IDataSourceProvider	getProviderInstance() The instance of a data source.
Boolean	getReuse() Gets the reuse status.
String	getSeparator() Gets the current separator.
String	getUrl() The database URL connection.
String	getUser() The database user.
void	initialize(IContext context)
void	setConnection(String connection) Sets the connection description as '<driver>|<url>|<user>|<password>'.
void	setDriver(String driver) Sets the drive.
void	setPassword(String password) Sets the database password.
void	setProvider(String provider) Sets the datasource provider class name.
void	setProviderInstance(IDataSourceProvider providerInstance) The instance of data source.
void	setReuse(Boolean reuse) Set reusable state.
void	setSeparator(String separator) Set the connection separator.
void	setUrl(String url) Sets the URL.
void	setUser(String user) Sets database user.

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

DEFAULT_CONNECTION_NAME

public static final String DEFAULT_CONNECTION_NAME

Default connection name.

See Also:

Constant Field Values

FEATURE_CONNECTION

public static final String FEATURE_CONNECTION

Full connection descriptor.

FEATURE_SEPARATOR

public static final String FEATURE_SEPARATOR

Connection separator string.

DEFAULT_SEPARATOR

public static final String DEFAULT_SEPARATOR

Default string separator.

See Also:

Constant Field Values

FEATURE_DRIVER

public static final String FEATURE_DRIVER

Connection driver.

FEATURE_URL

public static final String FEATURE_URL

Connection url.

FEATURE_USER

public static final String FEATURE_USER

Connection user.

FEATURE_PASSWORD

public static final String FEATURE_PASSWORD

Connection password.

FEATURE_PROVIDER

public static final String FEATURE_PROVIDER

Provider name feature.

FEATURE_PROVIDER_INSTANCE

public static final String FEATURE_PROVIDER_INSTANCE

Provider instance feature.

FEATURE_REUSE

public static final String FEATURE_REUSE

Default connection setting for reuse.

Constructor Detail

PluginConnection

public PluginConnection()

Method Detail

getConnection

public String getConnection()

Connection information.

Returns:

The connection description as '<driver>|<url>|<user>|<password>'.

setConnection

public void setConnection(String connection)

Sets the connection description as '<driver>|<url>|<user>|<password>'.

Parameters:

connection - The connection.

getSeparator

public String getSeparator()

Gets the current separator.

Returns:

The separator.

setSeparator

public void setSeparator(String separator)

Set the connection separator.

Parameters:

separator - The separator.

getDriver

public String getDriver()

Driver information.

Returns:

The driver name.

setDriver

public void setDriver(String driver)

Sets the drive.

Parameters:

driver - The driver.

getUrl

public String getUrl()

The database URL connection.

Returns:

The URL.

setUrl

public void setUrl(String url)

Sets the URL.

Parameters:

url - Database URL.

getUser

public String getUser()

The database user.

Returns:

The user.

setUser

public void setUser(String user)

Sets database user.

Parameters:

user - The user.

getPassword

public String getPassword()

The database password.

Returns:

The password.

setPassword

public void setPassword(String password)

Sets the database password.

Parameters:

password - The database password.

getProvider

public String getProvider()

The provide class name. Something that implements the interface IDataSourceProvider.

Returns:

The provider class name, fully qualified.

setProvider

public void setProvider(String provider)

Sets the datasource provider class name.

Parameters:

provider - The class which implements IDataSourceProvider provider name.

getProviderInstance

public IDataSourceProvider getProviderInstance()

The instance of a data source.

Returns:

Data source provider.

setProviderInstance

public void setProviderInstance(IDataSourceProvider providerInstance)

The instance of data source.

Parameters:

providerInstance - The instance.

getReuse

public Boolean getReuse()

Gets the reuse status. If reuse is true, the object can be reused by multiple tests.

Returns:

The reuse status.

setReuse

public void setReuse(Boolean reuse)

Set reusable state.

Parameters:

reuse - true, for reuse, false, otherwise.

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

doStart

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

Specified by:

doStart in interface IPlugin

Overrides:

doStart in class AbstractPlugin

Throws:

PluginException

getProvider

public static IDataSourceProvider getProvider(IContext context,
                                              String name)
                                       throws PluginException

Gets the datasource provider saved in context.

Parameters:

context - The context.

name - The datasource provider name.

Returns:

The datasource provider.

Throws:

PluginException - On lookup errors.

createProvider

public IDataSourceProvider createProvider()

Creates a given provider.

Returns:

The datasource provider.