StartAndStopSQL (JABB 1.0.49 API)

java.lang.Object
- net.sf.jabb.util.db.StartAndStopSQL

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle
```
public class StartAndStopSQL
extends Object
implements org.springframework.context.Lifecycle, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean, org.springframework.context.ApplicationContextAware
```
Helper class to execute SQL when Spring context starts and stops. It should be used as singleton.

Author:

James Hu

Field Summary

Fields
Modifier and Type	Field and Description
`protected org.springframework.context.ApplicationContext`	`context`
`protected DataSource`	`dataSource`
`protected String`	`delimiter`
`protected String`	`delimiterType`
`protected static int`	`RUNNING`
`protected static int`	`STARTING`
`protected String`	`startSQL`
`protected String`	`startSqlCondition`
`protected String`	`startSqlConditionResource`
`protected String`	`startSqlResource`
`protected AtomicInteger`	`state`
`protected static String[]`	`stateNames`
`protected static int`	`STOPPING`
`protected String`	`stopSQL`
`protected String`	`stopSqlCondition`
`protected String`	`stopSqlConditionResource`
`protected String`	`stopSqlResource`
`protected static int`	`UNKNOWN`
`protected boolean`	`useAnt`

Constructor Summary

Constructors
Constructor and Description

StartAndStopSQL()

Constructors
Constructor and Description
`StartAndStopSQL()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterPropertiesSet()`
`void`	`destroy()`
`protected void`	`executeSQL(String sql)` Execute one SQL statement.
`protected void`	`executeSqlResource(String resource)` Execute SQL statements stored in a resource.
`DataSource`	`getDataSource()`
`String`	`getDelimiter()`
`String`	`getDelimiterType()`
`String`	`getStartSQL()`
`String`	`getStartSqlCondition()`
`String`	`getStartSqlConditionResource()`
`String`	`getStartSqlResource()`
`String`	`getStopSQL()`
`String`	`getStopSqlCondition()`
`String`	`getStopSqlConditionResource()`
`String`	`getStopSqlResource()`
`protected boolean`	`isInCondition(String sql)` Check if the database is in a specific condition by checking the result of a SQL statement
`protected boolean`	`isInConditionResource(String resource)` Check if the database is in a specific condition by checking the result of a SQL statement loaded as a resource.
`boolean`	`isRunning()`
`boolean`	`isUseAnt()`
`void`	`setApplicationContext(org.springframework.context.ApplicationContext appContext)`
`void`	`setDataSource(DataSource dataSource)`
`void`	`setDelimiter(String delimiter)`
`void`	`setDelimiterType(String delimiterType)`
`void`	`setStartSQL(String startSQL)` Multiple SQL statements is allowed if useAnt is true.
`void`	`setStartSqlCondition(String startSqlCondition)` This must be a single SQL statement returning a number
`void`	`setStartSqlConditionResource(String startSqlConditionResource)` The resource must contain only a single SQL statement returning a number.
`void`	`setStartSqlResource(String startSqlResource)` Multiple SQL statements can be contained in the resource if useAnt is true.
`void`	`setStopSQL(String shutdownSQL)` Multiple SQL statements is allowed if useAnt is true.
`void`	`setStopSqlCondition(String stopSqlCondition)` This must be a single SQL statement returning a number
`void`	`setStopSqlConditionResource(String stopSqlConditionResource)` The resource must contain only a single SQL statement returning a number.
`void`	`setStopSqlResource(String stopSqlResource)` Multiple SQL statements can be contained in the resource if useAnt is true.
`void`	`setUseAnt(boolean useAnt)`
`void`	`start()`
`void`	`stop()`

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

- Field Detail
  - UNKNOWN
```
protected static final int UNKNOWN
```
    See Also:
    
    Constant Field Values
  - STARTING
```
protected static final int STARTING
```
    See Also:
    
    Constant Field Values
  - RUNNING
```
protected static final int RUNNING
```
    See Also:
    
    Constant Field Values
  - STOPPING
```
protected static final int STOPPING
```
    See Also:
    
    Constant Field Values
  - stateNames
```
protected static final String[] stateNames
```
  - state
```
protected AtomicInteger state
```
  - dataSource
```
protected DataSource dataSource
```
  - startSQL
```
protected String startSQL
```
  - stopSQL
```
protected String stopSQL
```
  - startSqlResource
```
protected String startSqlResource
```
  - stopSqlResource
```
protected String stopSqlResource
```
  - useAnt
```
protected boolean useAnt
```
  - delimiter
```
protected String delimiter
```
  - delimiterType
```
protected String delimiterType
```
  - startSqlCondition
```
protected String startSqlCondition
```
  - stopSqlCondition
```
protected String stopSqlCondition
```
  - startSqlConditionResource
```
protected String startSqlConditionResource
```
  - stopSqlConditionResource
```
protected String stopSqlConditionResource
```
  - context
```
protected org.springframework.context.ApplicationContext context
```
- Constructor Detail
  - StartAndStopSQL
```
public StartAndStopSQL()
```
- Method Detail
  - executeSQL
```
protected void executeSQL(String sql)
```
    Execute one SQL statement. RuntimeException will be thrown if SQLException was caught.
    
    Parameters:
    
    sql - the statement to be executed
  - executeSqlResource
```
protected void executeSqlResource(String resource)
```
    Execute SQL statements stored in a resource. RuntimeException will be thrown if SQLException was caught.
    
    Parameters:
    
    resource - the resource where SQL statements are stored
  - isRunning
```
public boolean isRunning()
```
    Specified by:
    
    isRunning in interface org.springframework.context.Lifecycle
  - start
```
public void start()
```
    Specified by:
    
    start in interface org.springframework.context.Lifecycle
  - stop
```
public void stop()
```
    Specified by:
    
    stop in interface org.springframework.context.Lifecycle
  - isInCondition
```
protected boolean isInCondition(String sql)
```
    Check if the database is in a specific condition by checking the result of a SQL statement
    
    Parameters:
    
    sql - the SQL statement that would return a number
    
    Returns:
    
    true if the returned number is greater than 0
  - isInConditionResource
```
protected boolean isInConditionResource(String resource)
```
    Check if the database is in a specific condition by checking the result of a SQL statement loaded as a resource.
    
    Parameters:
    
    resource - the resource containing the SQL statement that would return a number
    
    Returns:
    
    true if the returned number is greater than 0
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws Exception
```
    Specified by:
    
    afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
    
    Throws:
    
    Exception
  - destroy
```
public void destroy()
             throws Exception
```
    Specified by:
    
    destroy in interface org.springframework.beans.factory.DisposableBean
    
    Throws:
    
    Exception
  - setApplicationContext
```
public void setApplicationContext(org.springframework.context.ApplicationContext appContext)
                           throws org.springframework.beans.BeansException
```
    Specified by:
    
    setApplicationContext in interface org.springframework.context.ApplicationContextAware
    
    Throws:
    
    org.springframework.beans.BeansException
  - getDataSource
```
public DataSource getDataSource()
```
  - setDataSource
```
public void setDataSource(DataSource dataSource)
```
  - getStartSQL
```
public String getStartSQL()
```
  - setStartSQL
```
public void setStartSQL(String startSQL)
```
    Multiple SQL statements is allowed if useAnt is true.
    
    Parameters:
    
    startSQL -
  - getStopSQL
```
public String getStopSQL()
```
  - setStopSQL
```
public void setStopSQL(String shutdownSQL)
```
    Multiple SQL statements is allowed if useAnt is true.
    
    Parameters:
    
    shutdownSQL -
  - getStartSqlResource
```
public String getStartSqlResource()
```
  - getStopSqlResource
```
public String getStopSqlResource()
```
  - setStartSqlResource
```
public void setStartSqlResource(String startSqlResource)
```
    Multiple SQL statements can be contained in the resource if useAnt is true.
    
    Parameters:
    
    startSqlResource -
  - setStopSqlResource
```
public void setStopSqlResource(String stopSqlResource)
```
    Multiple SQL statements can be contained in the resource if useAnt is true.
    
    Parameters:
    
    stopSqlResource -
  - isUseAnt
```
public boolean isUseAnt()
```
  - setUseAnt
```
public void setUseAnt(boolean useAnt)
```
  - getDelimiter
```
public String getDelimiter()
```
  - setDelimiter
```
public void setDelimiter(String delimiter)
```
  - getDelimiterType
```
public String getDelimiterType()
```
  - setDelimiterType
```
public void setDelimiterType(String delimiterType)
```
  - getStartSqlCondition
```
public String getStartSqlCondition()
```
  - setStartSqlCondition
```
public void setStartSqlCondition(String startSqlCondition)
```
    This must be a single SQL statement returning a number
    
    Parameters:
    
    startSqlCondition -
  - getStopSqlCondition
```
public String getStopSqlCondition()
```
  - setStopSqlCondition
```
public void setStopSqlCondition(String stopSqlCondition)
```
    This must be a single SQL statement returning a number
    
    Parameters:
    
    stopSqlCondition -
  - getStopSqlConditionResource
```
public String getStopSqlConditionResource()
```
  - setStopSqlConditionResource
```
public void setStopSqlConditionResource(String stopSqlConditionResource)
```
    The resource must contain only a single SQL statement returning a number.
    
    Parameters:
    
    stopSqlConditionResource -
  - getStartSqlConditionResource
```
public String getStartSqlConditionResource()
```
  - setStartSqlConditionResource
```
public void setStartSqlConditionResource(String startSqlConditionResource)
```
    The resource must contain only a single SQL statement returning a number.
    
    Parameters:
    
    startSqlConditionResource -

Class StartAndStopSQL

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNKNOWN

STARTING

RUNNING

STOPPING

stateNames

state

dataSource

startSQL

stopSQL

startSqlResource

stopSqlResource

useAnt

delimiter

delimiterType

startSqlCondition

stopSqlCondition

startSqlConditionResource

stopSqlConditionResource

context

Constructor Detail

StartAndStopSQL

Method Detail

executeSQL

executeSqlResource

isRunning

start

stop

isInCondition

isInConditionResource

afterPropertiesSet

destroy

setApplicationContext

getDataSource

setDataSource

getStartSQL

setStartSQL

getStopSQL

setStopSQL

getStartSqlResource

getStopSqlResource

setStartSqlResource

setStopSqlResource

isUseAnt

setUseAnt

getDelimiter

setDelimiter

getDelimiterType

setDelimiterType

getStartSqlCondition

setStartSqlCondition

getStopSqlCondition

setStopSqlCondition

getStopSqlConditionResource

setStopSqlConditionResource

getStartSqlConditionResource

setStartSqlConditionResource