org.zaproxy.zap.db.sql

Class SqlTableHistory

java.lang.Object

org.zaproxy.zap.db.sql.SqlAbstractTable

org.zaproxy.zap.db.sql.SqlTableHistory

All Implemented Interfaces:

DatabaseListener, TableHistory

public class SqlTableHistory
extends SqlAbstractTable
implements TableHistory

Constructor Summary

Constructors

Constructor and Description
SqlTableHistory()

Method Summary

Modifier and Type	Method and Description
boolean	containsURI(long sessionId, int historyType, String method, String uri, byte[] body)
void	delete(int historyId)
void	delete(List<Integer> ids) Deletes from the database all the history records whose ID is in the list ids, in batches of 1000 records.
void	delete(List<Integer> ids, int batchSize) Deletes from the database all the history records whose ID is in the list ids, in batches of given batchSize.
void	deleteHistorySession(long sessionId)
void	deleteHistoryType(long sessionId, int historyType)
void	deleteTemporary() Deletes all records whose history type was marked as temporary.
RecordHistory	getHistoryCache(HistoryReference ref, HttpMessage reqMsg)
List<Integer>	getHistoryIds(long sessionId) Gets all the history record IDs of the given session.
List<Integer>	getHistoryIdsExceptOfHistType(long sessionId, int... histTypes) Returns all the history record IDs of the given session except the ones with the given history types.
List<Integer>	getHistoryIdsExceptOfHistTypeStartingAt(long sessionId, int startAtHistoryId, int... histTypes) Returns the history record IDs of the given session except the ones with the given history types starting at the specified historyId (inclusive).
List<Integer>	getHistoryIdsOfHistType(long sessionId, int... histTypes) Gets all the history record IDs of the given session and with the given history types.
List<Integer>	getHistoryIdsOfHistTypeStartingAt(long sessionId, int startAtHistoryId, int... histTypes) Gets the history record IDs of the given session and with the given history types starting at the specified historyId (inclusive).
List<Integer>	getHistoryIdsStartingAt(long sessionId, int startAtHistoryId) Gets the history record IDs of the given session starting at the specified historyId (inclusive).
List<Integer>	getHistoryList(long sessionId, int histType, String filter, boolean isRequest)
int	lastIndex()
RecordHistory	read(int historyId)
protected void	reconnect(Connection conn)
static void	setHistoryTypeAsTemporary(int historyType) Deprecated. (2.5.0) Use HistoryReference.addTemporaryType(int) instead.
static void	unsetHistoryTypeAsTemporary(int historyType) Deprecated. (2.5.0) Use HistoryReference.removeTemporaryType(int) instead.
void	updateNote(int historyId, String note)
RecordHistory	write(long sessionId, int histType, HttpMessage msg)

Methods inherited from class org.zaproxy.zap.db.sql.SqlAbstractTable

databaseOpen, getConnection

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

databaseOpen

Constructor Detail

SqlTableHistory

public SqlTableHistory()

Method Detail

reconnect

protected void reconnect(Connection conn)
                  throws DatabaseException

Specified by:

reconnect in class SqlAbstractTable

Throws:

DatabaseException

read

public RecordHistory read(int historyId)
                   throws HttpMalformedHeaderException,
                          DatabaseException

Specified by:

read in interface TableHistory

Throws:

HttpMalformedHeaderException

DatabaseException

write

public RecordHistory write(long sessionId,
                           int histType,
                           HttpMessage msg)
                    throws HttpMalformedHeaderException,
                           DatabaseException

Specified by:

write in interface TableHistory

Throws:

HttpMalformedHeaderException

DatabaseException

getHistoryIds

public List<Integer> getHistoryIds(long sessionId)
                            throws DatabaseException

Description copied from interface: TableHistory

Gets all the history record IDs of the given session.

Specified by:

getHistoryIds in interface TableHistory

Parameters:

sessionId - the ID of session of the history records to be returned

Returns:

a List with all the history IDs of the given session, never null

Throws:

DatabaseException - if an error occurred while getting the history IDs

See Also:

TableHistory.getHistoryIdsOfHistType(long, int...)

getHistoryIdsStartingAt

public List<Integer> getHistoryIdsStartingAt(long sessionId,
                                             int startAtHistoryId)
                                      throws DatabaseException

Description copied from interface: TableHistory

Gets the history record IDs of the given session starting at the specified historyId (inclusive).

Specified by:

getHistoryIdsStartingAt in interface TableHistory

Parameters:

sessionId - the ID of session of the history records to be returned

startAtHistoryId - filters historyIds with ≥ startAtHistoryId

Returns:

a List with the history IDs of the given session starting at the specified historyId (inclusive), never null

Throws:

DatabaseException - if an error occurred while getting the history IDs

getHistoryIdsOfHistType

public List<Integer> getHistoryIdsOfHistType(long sessionId,
                                             int... histTypes)
                                      throws DatabaseException

Description copied from interface: TableHistory

Gets all the history record IDs of the given session and with the given history types.

Specified by:

getHistoryIdsOfHistType in interface TableHistory

Parameters:

sessionId - the ID of session of the history records

histTypes - the history types of the history records that should be returned

Returns:

a List with all the history IDs of the given session and history types, never null

Throws:

DatabaseException - if an error occurred while getting the history IDs

See Also:

TableHistory.getHistoryIds(long), TableHistory.getHistoryIdsExceptOfHistType(long, int...)

getHistoryIdsOfHistTypeStartingAt

public List<Integer> getHistoryIdsOfHistTypeStartingAt(long sessionId,
                                                       int startAtHistoryId,
                                                       int... histTypes)
                                                throws DatabaseException

Description copied from interface: TableHistory

Gets the history record IDs of the given session and with the given history types starting at the specified historyId (inclusive).

Specified by:

getHistoryIdsOfHistTypeStartingAt in interface TableHistory

Parameters:

sessionId - the ID of session of the history records

startAtHistoryId - filters historyIds with ≥ startAtHistoryId

histTypes - the history types of the history records that should be returned

Returns:

a List with all the history IDs of the given session and history types starting at the specified historyId (inclusive), never null

Throws:

DatabaseException - if an error occurred while getting the history IDs

getHistoryIdsExceptOfHistType

public List<Integer> getHistoryIdsExceptOfHistType(long sessionId,
                                                   int... histTypes)
                                            throws DatabaseException

Description copied from interface: TableHistory

Returns all the history record IDs of the given session except the ones with the given history types. *

Specified by:

getHistoryIdsExceptOfHistType in interface TableHistory

Parameters:

sessionId - the ID of session of the history records

histTypes - the history types of the history records that should be excluded

Returns:

a List with all the history IDs of the given session and history types, never null

Throws:

DatabaseException - if an error occurred while getting the history IDs

See Also:

TableHistory.getHistoryIdsOfHistType(long, int...)

getHistoryIdsExceptOfHistTypeStartingAt

public List<Integer> getHistoryIdsExceptOfHistTypeStartingAt(long sessionId,
                                                             int startAtHistoryId,
                                                             int... histTypes)
                                                      throws DatabaseException

Description copied from interface: TableHistory

Returns the history record IDs of the given session except the ones with the given history types starting at the specified historyId (inclusive). *

Specified by:

getHistoryIdsExceptOfHistTypeStartingAt in interface TableHistory

Parameters:

sessionId - the ID of session of the history records

startAtHistoryId - filters historyIds with ≥ startAtHistoryId

histTypes - the history types of the history records that should be excluded

Returns:

a List with all the history IDs of the given session and history types starting at the specified historyId (inclusive), never null

Throws:

DatabaseException - if an error occurred while getting the history IDs

getHistoryList

public List<Integer> getHistoryList(long sessionId,
                                    int histType,
                                    String filter,
                                    boolean isRequest)
                             throws DatabaseException

Specified by:

getHistoryList in interface TableHistory

Throws:

DatabaseException

deleteHistorySession

public void deleteHistorySession(long sessionId)
                          throws DatabaseException

Specified by:

deleteHistorySession in interface TableHistory

Throws:

DatabaseException

deleteHistoryType

public void deleteHistoryType(long sessionId,
                              int historyType)
                       throws DatabaseException

Specified by:

deleteHistoryType in interface TableHistory

Throws:

DatabaseException

delete

public void delete(int historyId)
            throws DatabaseException

Specified by:

delete in interface TableHistory

Throws:

DatabaseException

delete

public void delete(List<Integer> ids)
            throws DatabaseException

Description copied from interface: TableHistory

Deletes from the database all the history records whose ID is in the list ids, in batches of 1000 records.

Specified by:

delete in interface TableHistory

Parameters:

ids - a List containing all the IDs of the history records to be deleted

Throws:

DatabaseException - if an error occurred while deleting the history records

See Also:

TableHistory.delete(List, int)

delete

public void delete(List<Integer> ids,
                   int batchSize)
            throws DatabaseException

Description copied from interface: TableHistory

Deletes from the database all the history records whose ID is in the list ids, in batches of given batchSize.

Specified by:

delete in interface TableHistory

Parameters:

ids - a List containing all the IDs of the history records to be deleted

batchSize - the maximum size of records to delete in a single batch

Throws:

DatabaseException - if an error occurred while deleting the history records

setHistoryTypeAsTemporary

@Deprecated
public static void setHistoryTypeAsTemporary(int historyType)

Deprecated. (2.5.0) Use HistoryReference.addTemporaryType(int) instead.

Parameters:

historyType - the history type that will be set as temporary

Since:

2.4

See Also:

deleteTemporary()

unsetHistoryTypeAsTemporary

@Deprecated
public static void unsetHistoryTypeAsTemporary(int historyType)

Deprecated. (2.5.0) Use HistoryReference.removeTemporaryType(int) instead.

Parameters:

historyType - the history type that will be marked as temporary

Since:

2.4

See Also:

deleteTemporary()

deleteTemporary

public void deleteTemporary()
                     throws DatabaseException

Description copied from interface: TableHistory

Deletes all records whose history type was marked as temporary.

Specified by:

deleteTemporary in interface TableHistory

Throws:

DatabaseException - if an error occurred while deleting the temporary history records

See Also:

HistoryReference.getTemporaryTypes()

containsURI

public boolean containsURI(long sessionId,
                           int historyType,
                           String method,
                           String uri,
                           byte[] body)
                    throws DatabaseException

Specified by:

containsURI in interface TableHistory

Throws:

DatabaseException

getHistoryCache

public RecordHistory getHistoryCache(HistoryReference ref,
                                     HttpMessage reqMsg)
                              throws DatabaseException,
                                     HttpMalformedHeaderException

Specified by:

getHistoryCache in interface TableHistory

Throws:

DatabaseException

HttpMalformedHeaderException

updateNote

public void updateNote(int historyId,
                       String note)
                throws DatabaseException

Specified by:

updateNote in interface TableHistory

Throws:

DatabaseException

lastIndex

public int lastIndex()

Specified by:

lastIndex in interface TableHistory