org.parosproxy.paros.extension.history

Class ExtensionHistory

java.lang.Object

org.parosproxy.paros.extension.ExtensionAdaptor

org.parosproxy.paros.extension.history.ExtensionHistory

All Implemented Interfaces:

Extension, SessionChangedListener

public class ExtensionHistory
extends ExtensionAdaptor
implements SessionChangedListener

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
ExtensionHistory()

Method Summary

Modifier and Type	Method and Description
void	addHistory(HistoryReference historyRef)
void	addHistory(HttpMessage msg, int type)
void	clearLogPanelDisplayQueue() Deprecated. (2.6.0) No longer used/needed.
void	delete(HistoryReference href)
String	getAuthor() Gets the author of the extension.
HistoryReference	getHistoryReference(int historyId)
HistoryReferencesTable	getHistoryReferencesTable()
int	getLastHistoryId()
ManualRequestEditorDialog	getResendDialog() This method initializes resendDialog
HistoryReference	getSelectedHistoryReference()
List<HistoryReference>	getSelectedHistoryReferences()
String	getUIName() By default returns the name returned by getName().
void	hideNotesAddDialog() Deprecated. (2.7.0) No longer used/needed.
void	hook(ExtensionHook extensionHook) Called during extension's initialisation to allow to add new functionality to core components.
void	init() Initialize plugin during startup.
boolean	isShowJustInScope()
void	notifyHistoryItemChanged(HistoryReference href)
void	purge(SiteMap map, SiteNode node)
void	purgeHistory(List<HistoryReference> hrefs) Deletes the given history references from the History tab and the session (database), along with the corresponding SiteNodes and Alerts.
void	registerProxy(ProxyServer ps)
void	removeFromHistoryList(HistoryReference href)
void	sessionAboutToChange(Session session) Called just prior to the session changing.
void	sessionChanged(Session session) Called just after the session has changed.
void	sessionModeChanged(Control.Mode mode) Called when the user changes the mode.
void	sessionScopeChanged(Session session) Called when the user has changes the session scope.
void	setShowJustInScope(boolean showJustInScope)
void	showAlertAddDialog(Alert alert) Deprecated. (2.7.0) Use ExtensionAlert.showAlertEditDialog(Alert) instead.
void	showAlertAddDialog(HistoryReference ref) Deprecated. (2.7.0) Use ExtensionAlert.showAlertAddDialog(HistoryReference) instead.
void	showAlertAddDialog(HttpMessage httpMessage, int historyType) Deprecated. (2.7.0) Use ExtensionAlert.showAlertAddDialog(HttpMessage, int) instead.
protected int	showFilterPlusDialog()
void	showInHistory(HistoryReference href)
void	showManageTagsDialog(HistoryReference ref, List<String> tags)
void	showNotesAddDialog(HistoryReference ref, String note)
boolean	supportsDb(String type) Part of the core set of features that should be supported by all db types
boolean	supportsLowMemory() Return true it the extension can run with the 'low memory' option.
void	unregisterProxy(ProxyServer ps)

Methods inherited from class org.parosproxy.paros.extension.ExtensionAdaptor

canUnload, databaseOpen, destroy, getActiveActions, getAddOn, getDependencies, getDescription, getExtensionMenu, getExtensionView, getI18nPrefix, getMessages, getModel, getName, getOrder, getUnsavedResources, getView, hasView, initModel, initView, initXML, isCore, isDepreciated, isEnabled, optionsLoaded, postInit, postInstall, setAddOn, setDescription, setEnabled, setI18nPrefix, setMessages, setName, setOrder, start, stop, unload

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.extension.SessionChangedListener

sessionPropertiesChanged

Methods inherited from interface org.parosproxy.paros.extension.Extension

getURL, getVersion

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

ExtensionHistory

public ExtensionHistory()

Method Detail

getUIName

public String getUIName()

Description copied from class: ExtensionAdaptor

By default returns the name returned by getName().

Specified by:

getUIName in interface Extension

Overrides:

getUIName in class ExtensionAdaptor

Returns:

the UI name of the extension, never null

See Also:

ExtensionAdaptor.getName()

clearLogPanelDisplayQueue

@Deprecated
public void clearLogPanelDisplayQueue()

Deprecated. (2.6.0) No longer used/needed.

getSelectedHistoryReference

public HistoryReference getSelectedHistoryReference()

getSelectedHistoryReferences

public List<HistoryReference> getSelectedHistoryReferences()

init

public void init()

Description copied from interface: Extension

Initialize plugin during startup. This phase is carried out before all others.

Specified by:

init in interface Extension

Overrides:

init in class ExtensionAdaptor

hook

public void hook(ExtensionHook extensionHook)

Description copied from interface: Extension

Called during extension's initialisation to allow to add new functionality to core components.

Specified by:

hook in interface Extension

Overrides:

hook in class ExtensionAdaptor

Parameters:

extensionHook - the hook to add the components.

sessionChanged

public void sessionChanged(Session session)

Description copied from interface: SessionChangedListener

Called just after the session has changed. sessionChanged may be called by non-event thread. Should handle with care in all the listener. Use EventThread for each GUI event.

Specified by:

sessionChanged in interface SessionChangedListener

Parameters:

session - the new session

registerProxy

public void registerProxy(ProxyServer ps)

unregisterProxy

public void unregisterProxy(ProxyServer ps)

removeFromHistoryList

public void removeFromHistoryList(HistoryReference href)

notifyHistoryItemChanged

public void notifyHistoryItemChanged(HistoryReference href)

delete

public void delete(HistoryReference href)

getHistoryReference

public HistoryReference getHistoryReference(int historyId)

getLastHistoryId

public int getLastHistoryId()

addHistory

public void addHistory(HttpMessage msg,
                       int type)

addHistory

public void addHistory(HistoryReference historyRef)

showFilterPlusDialog

protected int showFilterPlusDialog()

getResendDialog

public ManualRequestEditorDialog getResendDialog()

This method initializes resendDialog

Returns:

org.parosproxy.paros.extension.history.ResendDialog

showNotesAddDialog

public void showNotesAddDialog(HistoryReference ref,
                               String note)

hideNotesAddDialog

@Deprecated
public void hideNotesAddDialog()

Deprecated. (2.7.0) No longer used/needed.

showAlertAddDialog

@Deprecated
public void showAlertAddDialog(HistoryReference ref)

Deprecated. (2.7.0) Use ExtensionAlert.showAlertAddDialog(HistoryReference) instead.

Parameters:

ref - the HistoryReference that will have the new alert, if created.

showAlertAddDialog

@Deprecated
public void showAlertAddDialog(HttpMessage httpMessage,
                                           int historyType)

Deprecated. (2.7.0) Use ExtensionAlert.showAlertAddDialog(HttpMessage, int) instead.

Sets the HttpMessage and the history type of the HistoryReference that will be created if the user creates the alert. The current session will be used to create the HistoryReference. The alert created will be added to the newly created HistoryReference.

Should be used when the alert is added to a temporary HistoryReference as the temporary HistoryReferences are deleted when the session is closed.

Parameters:

httpMessage - the HttpMessage that will be used to create the HistoryReference, must not be null

historyType - the type of the history reference that will be used to create the HistoryReference

See Also:

Model.getSession(), HistoryReference(org.parosproxy.paros.model.Session, int, HttpMessage)

showAlertAddDialog

@Deprecated
public void showAlertAddDialog(Alert alert)

Deprecated. (2.7.0) Use ExtensionAlert.showAlertEditDialog(Alert) instead.

Parameters:

alert - the alert to edit

showManageTagsDialog

public void showManageTagsDialog(HistoryReference ref,
                                 List<String> tags)

showInHistory

public void showInHistory(HistoryReference href)

sessionAboutToChange

public void sessionAboutToChange(Session session)

Description copied from interface: SessionChangedListener

Called just prior to the session changing. Listeners should close down any resources associated with this session. sessionAboutToChange may be called by non-event thread. Should handle with care in all the listener. Use EventThread for each GUI event.

Specified by:

sessionAboutToChange in interface SessionChangedListener

Parameters:

session - the session about to be closed

getAuthor

public String getAuthor()

Description copied from interface: Extension

Gets the author of the extension.

Since 2.9.0 defaults to the author of the add-on, if set, otherwise an empty string.

Specified by:

getAuthor in interface Extension

Returns:

the author of the extension, might be null.

isShowJustInScope

public boolean isShowJustInScope()

setShowJustInScope

public void setShowJustInScope(boolean showJustInScope)

purge

public void purge(SiteMap map,
                  SiteNode node)

sessionScopeChanged

public void sessionScopeChanged(Session session)

Description copied from interface: SessionChangedListener

Called when the user has changes the session scope. sessionScopeChanged may be called by non-event thread. Should handle with care in all the listener. Use EventThread for each GUI event.

Specified by:

sessionScopeChanged in interface SessionChangedListener

Parameters:

session - the current session

sessionModeChanged

public void sessionModeChanged(Control.Mode mode)

Description copied from interface: SessionChangedListener

Called when the user changes the mode. sessionModeChanged may be called by non-event thread. Should handle with care in all the listener. Use EventThread for each GUI event.

Specified by:

sessionModeChanged in interface SessionChangedListener

Parameters:

mode - the new mode

supportsLowMemory

public boolean supportsLowMemory()

Description copied from interface: Extension

Return true it the extension can run with the 'low memory' option. If the low memory option is set (and the extension supports it) then code should minimize the data stored in memory, using the db for all significant data. Extensions that do not support the low memory option will not be run if the option is set.

Specified by:

supportsLowMemory in interface Extension

Overrides:

supportsLowMemory in class ExtensionAdaptor

Returns:

true if the extension support the 'low memory' option, false otherwise

supportsDb

public boolean supportsDb(String type)

Part of the core set of features that should be supported by all db types

Specified by:

supportsDb in interface Extension

Overrides:

supportsDb in class ExtensionAdaptor

Parameters:

type - the db type

Returns:

true if the specified db type is supported by the extension (or if it doesn't use any db)

See Also:

Database.getType()

getHistoryReferencesTable

public HistoryReferencesTable getHistoryReferencesTable()

Since:

2.8.0

purgeHistory

public void purgeHistory(List<HistoryReference> hrefs)

Deletes the given history references from the History tab and the session (database), along with the corresponding SiteNodes and Alerts.

Parameters:

hrefs - the history entries to delete.

Since:

2.7.0

See Also:

View.getDefaultDeleteKeyStroke()