org.zaproxy.zap.extension.alert

Class ExtensionAlert

java.lang.Object

org.parosproxy.paros.extension.ExtensionAdaptor

org.zaproxy.zap.extension.alert.ExtensionAlert

All Implemented Interfaces:

Extension, OptionsChangedListener, SessionChangedListener, XmlReporterExtension

public class ExtensionAlert
extends ExtensionAdaptor
implements SessionChangedListener, XmlReporterExtension, OptionsChangedListener

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
ExtensionAlert()

Method Summary

Modifier and Type	Method and Description
void	alertFound(Alert alert, HistoryReference ref)
protected void	applyOverrides(Alert alert)
void	deleteAlert(Alert alert)
void	deleteAllAlerts()
void	deleteHistoryReferenceAlerts(HistoryReference hRef)
void	displayAlert(Alert alert)
List<Alert>	getAllAlerts()
String	getAuthor() Gets the author of the extension.
String	getDescription() Returns the description of the extension, to be shown in UI components.
String	getUIName() By default returns the name returned by getName().
String	getXml(SiteNode site)
void	hook(ExtensionHook extensionHook) Called during extension's initialisation to allow to add new functionality to core components.
boolean	isNewAlert(Alert alertToCheck) Check if an alert already exists in the alerts tree.
void	optionsChanged(OptionsParam optionsParam)
void	optionsLoaded() Called after the options for this extension have been loaded, so that the extension can make use of them.
boolean	reloadOverridesFile()
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.
protected void	setAlertOverrideProperty(String key, String value)
void	setAlertTabFocus()
void	setLinkWithSitesTreeSelection(boolean enabled) Sets whether the "Alerts" tree is filtered, or not based on a selected "Sites" tree node.
void	setShowJustInScope(boolean inScope) Sets whether the "Alerts" tree is filtered, or not based on current session scope.
void	showAlertAddDialog(HistoryReference ref) Shows the Add Alert dialogue, to add a new alert for the given HistoryReference.
void	showAlertAddDialog(HttpMessage httpMessage, int historyType) Shows the Add Alert dialogue, using the given HttpMessage and history type for the HistoryReference that will be created if the user creates the alert.
void	showAlertEditDialog(Alert alert) Shows the "Edit Alert" dialogue, with the given alert.
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	updateAlert(Alert alert)
void	updateAlertInTree(Alert originalAlert, Alert alert)

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

canUnload, databaseOpen, destroy, getActiveActions, getAddOn, getDependencies, getExtensionMenu, getExtensionView, getI18nPrefix, getMessages, getModel, getName, getOrder, getUnsavedResources, getView, hasView, init, initModel, initView, initXML, isCore, isDepreciated, isEnabled, 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

ExtensionAlert

public ExtensionAlert()

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()

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.

optionsLoaded

public void optionsLoaded()

Description copied from interface: Extension

Called after the options for this extension have been loaded, so that the extension can make use of them. Note that other add-ons may not have been loaded at this point - if you need them to be then implement postInit()

Specified by:

optionsLoaded in interface Extension

Overrides:

optionsLoaded in class ExtensionAdaptor

See Also:

Extension.postInit()

optionsChanged

public void optionsChanged(OptionsParam optionsParam)

Specified by:

optionsChanged in interface OptionsChangedListener

reloadOverridesFile

public boolean reloadOverridesFile()

alertFound

public void alertFound(Alert alert,
                       HistoryReference ref)

applyOverrides

protected void applyOverrides(Alert alert)

setAlertOverrideProperty

protected void setAlertOverrideProperty(String key,
                                        String value)

updateAlert

public void updateAlert(Alert alert)
                 throws HttpMalformedHeaderException,
                        DatabaseException

Throws:

HttpMalformedHeaderException

DatabaseException

displayAlert

public void displayAlert(Alert alert)

updateAlertInTree

public void updateAlertInTree(Alert originalAlert,
                              Alert alert)

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

deleteAlert

public void deleteAlert(Alert alert)

deleteAllAlerts

public void deleteAllAlerts()

deleteHistoryReferenceAlerts

public void deleteHistoryReferenceAlerts(HistoryReference hRef)

getAllAlerts

public List<Alert> getAllAlerts()

getXml

public String getXml(SiteNode site)

Specified by:

getXml in interface XmlReporterExtension

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.

getDescription

public String getDescription()

Description copied from interface: Extension

Returns the description of the extension, to be shown in UI components. The description must be internationalised.

Specified by:

getDescription in interface Extension

Overrides:

getDescription in class ExtensionAdaptor

Returns:

the description of the extension, never null

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

setAlertTabFocus

public void setAlertTabFocus()

setShowJustInScope

public void setShowJustInScope(boolean inScope)

Sets whether the "Alerts" tree is filtered, or not based on current session scope.

If inScope is true only the alerts that are in the current session scope will be shown.

Calling this method removes the filter "Link with Sites selection", if enabled, as they are mutually exclusive.

Parameters:

inScope - true if the "Alerts" tree should be filtered based on current session scope, false otherwise.

See Also:

setLinkWithSitesTreeSelection(boolean), Session

setLinkWithSitesTreeSelection

public void setLinkWithSitesTreeSelection(boolean enabled)

Sets whether the "Alerts" tree is filtered, or not based on a selected "Sites" tree node.

If enabled is true only the alerts of the selected "Sites" tree node will be shown.

Calling this method removes the filter "Just in Scope", if enabled, as they are mutually exclusive.

Parameters:

enabled - true if the "Alerts" tree should be filtered based on a selected "Sites" tree node, false otherwise.

See Also:

setShowJustInScope(boolean), View.getSiteTreePanel()

showAlertAddDialog

public void showAlertAddDialog(HistoryReference ref)

Shows the Add Alert dialogue, to add a new alert for the given HistoryReference.

Parameters:

ref - the history reference for the alert.

Since:

2.7.0

showAlertAddDialog

public void showAlertAddDialog(HttpMessage httpMessage,
                               int historyType)

Shows the Add Alert dialogue, using the given HttpMessage and history type for 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.

Since:

2.7.0

See Also:

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

showAlertEditDialog

public void showAlertEditDialog(Alert alert)

Shows the "Edit Alert" dialogue, with the given alert.

Parameters:

alert - the alert to be edited.

Since:

2.7.0

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()

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

isNewAlert

public boolean isNewAlert(Alert alertToCheck)

Check if an alert already exists in the alerts tree.

Parameters:

alertToCheck -

Returns:

true if new alert, false otherwise.