AbstractDatabaseConnectingTestAction (citrus-core 2.4 API)

java.lang.Object
- org.springframework.dao.support.DaoSupport
- - org.springframework.jdbc.core.support.JdbcDaoSupport
  - - com.consol.citrus.actions.AbstractDatabaseConnectingTestAction

All Implemented Interfaces:

TestAction, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

ExecutePLSQLAction, ExecuteSQLAction, ExecuteSQLQueryAction
```
public abstract class AbstractDatabaseConnectingTestAction
extends org.springframework.jdbc.core.support.JdbcDaoSupport
implements TestAction
```
Abstract base class for database connection test actions. Extends JdbcDaoSupport providing access to a DataSource.

Author:

Christoph Deppisch

Field Summary

Fields
Modifier and Type	Field and Description
`protected org.slf4j.Logger`	`log` Logger
`protected static String`	`SQL_COMMENT` Constant representing SQL comment
`protected String`	`sqlResourcePath` SQL file resource path
`protected List<String>`	`statements` List of SQL statements

Fields inherited from class org.springframework.dao.support.DaoSupport
logger

Constructor Summary

Constructors
Constructor and Description

AbstractDatabaseConnectingTestAction()

Constructors
Constructor and Description
`AbstractDatabaseConnectingTestAction()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected List<String>`	`createStatementsFromFileResource(TestContext context)` Reads SQL statements from external file resource.
`protected String`	`decorateLastScriptLine(String line)` Subclasses may want to decorate last script line.
`abstract void`	`doExecute(TestContext context)` Subclasses may add custom execution logic here.
`void`	`execute(TestContext context)` Do basic logging and delegate execution to subclass.
`TestActor`	`getActor()` Gets the actor.
`String`	`getDescription()` Gets this action's description.
`String`	`getName()` Gets the name of the test action.
`String`	`getSqlResourcePath()` Gets the sqlResource.
`protected String`	`getStatemendEndingCharacter()` Gets the SQL statement ending character sequence.
`List<String>`	`getStatements()` Gets the statements.
`boolean`	`isDisabled(TestContext context)` Checks if this test action is disabled.
`AbstractDatabaseConnectingTestAction`	`setActor(TestActor actor)` Sets the actor.
`AbstractDatabaseConnectingTestAction`	`setDescription(String description)` Sets this test action's description.
`AbstractDatabaseConnectingTestAction`	`setName(String name)` Sets this test action's name.
`AbstractDatabaseConnectingTestAction`	`setSqlResourcePath(String sqlResource)` Setter for external file resource containing the SQL statements to execute.
`AbstractDatabaseConnectingTestAction`	`setStatements(List<String> statements)` List of statements to execute.

Methods inherited from class org.springframework.jdbc.core.support.JdbcDaoSupport
checkDaoConfig, createJdbcTemplate, getConnection, getDataSource, getExceptionTranslator, getJdbcTemplate, initTemplateConfig, releaseConnection, setDataSource, setJdbcTemplate

Methods inherited from class org.springframework.dao.support.DaoSupport
afterPropertiesSet, initDao

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - log
```
protected final org.slf4j.Logger log
```
    Logger
  - sqlResourcePath
```
protected String sqlResourcePath
```
    SQL file resource path
  - statements
```
protected List<String> statements
```
    List of SQL statements
  - SQL_COMMENT
```
protected static final String SQL_COMMENT
```
    Constant representing SQL comment
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractDatabaseConnectingTestAction
```
public AbstractDatabaseConnectingTestAction()
```
- Method Detail
  - execute
```
public void execute(TestContext context)
```
    Do basic logging and delegate execution to subclass.
    
    Specified by:
    
    execute in interface TestAction
  - doExecute
```
public abstract void doExecute(TestContext context)
```
    Subclasses may add custom execution logic here.
  - isDisabled
```
public boolean isDisabled(TestContext context)
```
    Checks if this test action is disabled. Delegates to test actor defined for this test action by default. Subclasses may add additional disabled logic here.
    
    Specified by:
    
    isDisabled in interface TestAction
    
    Parameters:
    
    context - the current test context.
    
    Returns:
  - createStatementsFromFileResource
```
protected List<String> createStatementsFromFileResource(TestContext context)
```
    Reads SQL statements from external file resource. File resource can hold several multi-line statements and comments.
    
    Parameters:
    
    context - the current test context.
    
    Returns:
    
    list of SQL statements.
  - getStatemendEndingCharacter
```
protected String getStatemendEndingCharacter()
```
    Gets the SQL statement ending character sequence.
    
    Returns:
  - decorateLastScriptLine
```
protected String decorateLastScriptLine(String line)
```
    Subclasses may want to decorate last script line.
    
    Parameters:
    
    line - the last script line finishing a SQL statement.
    
    Returns:
  - getDescription
```
public String getDescription()
```
    Gets this action's description.
    
    Specified by:
    
    getDescription in interface TestAction
    
    Returns:
    
    the description
  - setDescription
```
public AbstractDatabaseConnectingTestAction setDescription(String description)
```
    Sets this test action's description.
    
    Specified by:
    
    setDescription in interface TestAction
    
    Parameters:
    
    description - the description to set
  - getName
```
public String getName()
```
    Gets the name of the test action.
    
    Specified by:
    
    getName in interface TestAction
    
    Returns:
    
    the test action name.
  - setName
```
public AbstractDatabaseConnectingTestAction setName(String name)
```
    Sets this test action's name.
    
    Specified by:
    
    setName in interface TestAction
    
    Returns:
    
    name as String
  - setStatements
```
public AbstractDatabaseConnectingTestAction setStatements(List<String> statements)
```
    List of statements to execute. Declared inline in the test case.
    
    Parameters:
    
    statements -
  - setSqlResourcePath
```
public AbstractDatabaseConnectingTestAction setSqlResourcePath(String sqlResource)
```
    Setter for external file resource containing the SQL statements to execute.
    
    Parameters:
    
    sqlResource -
  - getSqlResourcePath
```
public String getSqlResourcePath()
```
    Gets the sqlResource.
    
    Returns:
    
    the sqlResource
  - getStatements
```
public List<String> getStatements()
```
    Gets the statements.
    
    Returns:
    
    the statements
  - getActor
```
public TestActor getActor()
```
    Gets the actor.
    
    Specified by:
    
    getActor in interface TestAction
    
    Returns:
    
    the actor the actor to get.
  - setActor
```
public AbstractDatabaseConnectingTestAction setActor(TestActor actor)
```
    Sets the actor.
    
    Parameters:
    
    actor - the actor to set

Class AbstractDatabaseConnectingTestAction

Field Summary

Fields inherited from class org.springframework.dao.support.DaoSupport

Constructor Summary

Method Summary

Methods inherited from class org.springframework.jdbc.core.support.JdbcDaoSupport

Methods inherited from class org.springframework.dao.support.DaoSupport

Methods inherited from class java.lang.Object

Field Detail

log

sqlResourcePath

statements

SQL_COMMENT

Constructor Detail

AbstractDatabaseConnectingTestAction

Method Detail

execute

doExecute

isDisabled

createStatementsFromFileResource

getStatemendEndingCharacter

decorateLastScriptLine

getDescription

setDescription

getName

setName

setStatements

setSqlResourcePath

getSqlResourcePath

getStatements

getActor

setActor