org.parosproxy.paros.db

Class AbstractDatabase

java.lang.Object

org.parosproxy.paros.db.AbstractDatabase

All Implemented Interfaces:

Database

Direct Known Subclasses:

ParosDatabase, SqlDatabase

public abstract class AbstractDatabase
extends Object
implements Database

An abstract implementation of Database, it allows to manage DatabaseListeners.

Since:

2.5.0

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.log4j.Logger	logger Deprecated. (2.10.0) Use getLogger() instead.

Fields inherited from interface org.parosproxy.paros.db.Database

DB_TYPE_HSQLDB

Constructor Summary

Constructors

Constructor and Description
AbstractDatabase()

Method Summary

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.
protected List<DatabaseListener>	getDatabaseListeners() Gets the database listeners added.
protected org.apache.logging.log4j.Logger	getLogger() Gets the logger.
protected void	notifyListenersDatabaseOpen(Collection<DatabaseListener> listeners, DatabaseServer databaseServer) Notifies the given listeners that the given database server was opened.
protected void	notifyListenersDatabaseOpen(DatabaseServer databaseServer) Notifies the database listeners added that the given database server was opened.
void	removeDatabaseListener(DatabaseListener listener)
protected void	removeDatabaseListeners() Removes all database listeners added.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.parosproxy.paros.db.Database

deleteSession, discardSession, getDatabaseServer, getTableAlert, getTableContext, getTableHistory, getTableParam, getTableScan, getTableSession, getTableSessionUrl, getTableStructure, getTableTag, getType, open, setTableAlert, setTableScan, setTableSessionUrl, setTableTag

Field Detail

logger

@Deprecated
protected final org.apache.log4j.Logger logger

Deprecated. (2.10.0) Use getLogger() instead.

Constructor Detail

AbstractDatabase

public AbstractDatabase()

Method Detail

getLogger

protected org.apache.logging.log4j.Logger getLogger()

Gets the logger.

Returns:

the logger, never null.

Since:

2.10.0

getDatabaseListeners

protected List<DatabaseListener> getDatabaseListeners()

Gets the database listeners added.

Returns:

the database listeners

See Also:

addDatabaseListener(DatabaseListener)

addDatabaseListener

public void addDatabaseListener(DatabaseListener listener)

Specified by:

addDatabaseListener in interface Database

removeDatabaseListener

public void removeDatabaseListener(DatabaseListener listener)

Specified by:

removeDatabaseListener in interface Database

close

public void close(boolean compact)

Description copied from interface: Database

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 Database.close(boolean, boolean) with the parameter cleanup as true.

Specified by:

close in interface Database

Parameters:

compact - true if the database should be compacted, false otherwise.

See Also:

HistoryReference

close

public 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.)

Also, removes the database listeners added previously.

Specified by:

close in interface Database

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

removeDatabaseListeners

protected void removeDatabaseListeners()

Removes all database listeners added.

See Also:

removeDatabaseListener(DatabaseListener)

notifyListenersDatabaseOpen

protected void notifyListenersDatabaseOpen(Collection<DatabaseListener> listeners,
                                           DatabaseServer databaseServer)
                                    throws DatabaseException

Notifies the given listeners that the given database server was opened.

Parameters:

listeners - the listeners that will be notified

databaseServer - the database server that was opened

Throws:

DatabaseException - if an error occurred while notifying the database listeners.

notifyListenersDatabaseOpen

protected void notifyListenersDatabaseOpen(DatabaseServer databaseServer)
                                    throws DatabaseException

Notifies the database listeners added that the given database server was opened.

Parameters:

databaseServer - the database server that was opened

Throws:

DatabaseException - if an error occurred while notifying the database listeners.