Database (OWASP Zed Attack Proxy)

All Known Implementing Classes:

AbstractDatabase, HsqldbDatabase, ParosDatabase, SqlDatabase
```
public interface Database
```
This interface was extracted from the previous Paros class of the same name. The Paros class that implements this interface has been moved to the 'paros' sub package and prefixed with 'Paros'

Field Summary

Fields
Modifier and Type Field and Description

static String DB_TYPE_HSQLDB
The default HyperSQL Db: http://hsqldb.org/

Fields
Modifier and Type	Field and Description
`static String`	`DB_TYPE_HSQLDB` The default HyperSQL Db: http://hsqldb.org/

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addDatabaseListener(DatabaseListener listener)`
`void`	`close(boolean compact)` Closes the database.
`void`	`close(boolean compact, boolean cleanup)` Closes the database.
`void`	`deleteSession(String sessionName)` Permanently delete the specified session
`void`	`discardSession(long sessionId)` Discards the history associated with the given session ID, called when a session is not to be saved (and a new one is about to be created).
`DatabaseServer`	`getDatabaseServer()`
`TableAlert`	`getTableAlert()`
`TableAlertTag`	`getTableAlertTag()`
`TableContext`	`getTableContext()`
`TableHistory`	`getTableHistory()`
`TableParam`	`getTableParam()`
`TableScan`	`getTableScan()`
`TableSession`	`getTableSession()`
`TableSessionUrl`	`getTableSessionUrl()`
`TableStructure`	`getTableStructure()`
`TableTag`	`getTableTag()`
`String`	`getType()` The type of the database - e.g.
`void`	`open(String path)`
`void`	`removeDatabaseListener(DatabaseListener listener)`
`void`	`setTableAlert(TableAlert tableAlert)`
`void`	`setTableAlertTag(TableAlertTag tableAlertTag)`
`void`	`setTableScan(TableScan tableScan)`
`void`	`setTableSessionUrl(TableSessionUrl tableSessionUrl)`
`void`	`setTableTag(TableTag tableTag)`

- Field Detail
  - DB_TYPE_HSQLDB
```
static final String DB_TYPE_HSQLDB
```
    The default HyperSQL Db: http://hsqldb.org/
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getDatabaseServer
```
DatabaseServer getDatabaseServer()
```
  - getTableHistory
```
TableHistory getTableHistory()
```
  - getTableSession
```
TableSession getTableSession()
```
    Returns:
    
    Returns the tableSession.
  - addDatabaseListener
```
void addDatabaseListener(DatabaseListener listener)
```
  - removeDatabaseListener
```
void removeDatabaseListener(DatabaseListener listener)
```
  - open
```
void open(String path)
   throws ClassNotFoundException,
          Exception
```
    Throws:
    
    ClassNotFoundException
    
    Exception
  - close
```
void close(boolean compact)
```
    Closes the database. If the parameter compact is true, the database will be compacted, compacting the database ensures a minimal space disk usage but it will also take longer to close. Any necessary cleanups are performed prior to closing the database (the cleanup removes the temporary HistoryReferences).
    Note: Calling this method has the same effects as calling the method close(boolean, boolean) with the parameter cleanup as true.
    
    Parameters:
    
    compact - true if the database should be compacted, false otherwise.
    
    See Also:
    
    HistoryReference
  - deleteSession
```
void deleteSession(String sessionName)
```
    Permanently delete the specified session
    
    Parameters:
    
    sessionName -
  - close
```
void close(boolean compact,
           boolean cleanup)
```
    Closes the database. If the parameter compact is true, the database will be compacted, compacting the database ensures a minimal space disk usage but it will also take longer to close. If the parameter cleanup is true any necessary cleanups are performed prior to closing the database (the cleanup removes the temporary HistoryReferences.)
    
    Parameters:
    
    compact - true if the database should be compacted, false otherwise.
    
    cleanup - true if any necessary cleanups should be performed, false otherwise.
    
    See Also:
    
    HistoryReference
  - getTableAlert
```
TableAlert getTableAlert()
```
    Returns:
    
    Returns the tableAlert.
  - setTableAlert
```
void setTableAlert(TableAlert tableAlert)
```
    Parameters:
    
    tableAlert - The tableAlert to set.
  - getTableAlertTag
```
TableAlertTag getTableAlertTag()
```
  - setTableAlertTag
```
void setTableAlertTag(TableAlertTag tableAlertTag)
```
  - getTableScan
```
TableScan getTableScan()
```
    Returns:
    
    Returns the tableScan.
  - setTableScan
```
void setTableScan(TableScan tableScan)
```
    Parameters:
    
    tableScan - The tableScan to set.
  - getTableTag
```
TableTag getTableTag()
```
  - setTableTag
```
void setTableTag(TableTag tableTag)
```
  - getTableSessionUrl
```
TableSessionUrl getTableSessionUrl()
```
  - setTableSessionUrl
```
void setTableSessionUrl(TableSessionUrl tableSessionUrl)
```
  - getTableParam
```
TableParam getTableParam()
```
  - getTableContext
```
TableContext getTableContext()
```
  - getTableStructure
```
TableStructure getTableStructure()
```
  - getType
```
String getType()
```
    The type of the database - e.g. "hsqldb"
    
    Returns:
  - discardSession
```
void discardSession(long sessionId)
             throws DatabaseException
```
    Discards the history associated with the given session ID, called when a session is not to be saved (and a new one is about to be created).
    Implementations might opt to do nothing, for example, if the database is file based (HSQLDB) and those files are deleted if the session is not saved.
    
    Parameters:
    
    sessionId - the ID of the session
    
    Throws:
    
    DatabaseException - If an error occurred while discarding the history of the session.
    
    Since:
    
    2.5.0

Interface Database

Field Summary

Method Summary

Field Detail

DB_TYPE_HSQLDB

Method Detail

getDatabaseServer

getTableHistory

getTableSession

addDatabaseListener

removeDatabaseListener

open

close

deleteSession

close

getTableAlert

setTableAlert

getTableAlertTag

setTableAlertTag

getTableScan

setTableScan

getTableTag

setTableTag

getTableSessionUrl

setTableSessionUrl

getTableParam

getTableContext

getTableStructure

getType

discardSession